View
-
class
View()
Properties
Accessors
axisTriadidinputMonitornavCube
Methods
addLight()advanceIncrementalSelection()beginConvexPolyhedronSelection()beginRayDrillSelection()beginScreenSelectByArea()beginSphereSelection()centerCameraOnNode()clearLights()compositePickFromPoint()endComparison()endIncrementalSelection()fitBounding()fitNodes()fitWorld()getAmbientLightColor()getAmbientOcclusionEnabled()getAmbientOcclusionRadius()getAntiAliasingMode()getAxisTriad()getBackfacesVisible()getBackgroundColor()getBloomEnabled()getBloomIntensityScale()getBloomLayers()getBloomThreshold()getBloomThresholdRampWidth()getBoundingCalculationIgnoresInvisible()getCamera()getCanvasSize()getDrawMode()getDrawStrategy()getEyeDomeLightingBlurEdgeDistance()getEyeDomeLightingBlurInterval()getEyeDomeLightingBlurSamples()getEyeDomeLightingEnabled()getEyeDomeLightingOpacity()getEyeDomeLightingShadingEdgeDistance()getFaceVisibility()getFullCameraMatrix()getGoochBaseColorProminence()getGoochBlue()getGoochLuminanceShiftStrength()getGoochYellow()getGroundPlane()getHardEdgeColor()getHardEdgeOpacity()getHardEdgeThreshold()getHardEdgeThresholdRampWidth()getHardEdgesEnabled()getHiddenLineSettings()getImageBasedLightingEnabled()getImageBasedLightingIntensity()getImageBasedLightingOrientation()getInteractiveDrawLimitIncreaseEnabled()getLight()getLightKeys()getLightingEnabled()getLineJitterEnabled()getLineJitterFrequency()getLineJitterInstanceCount()getLineJitterRadius()getLineVisibility()getMassageExtremeCameras()getNavCube()getPointShape()getPointSize()getProjectionMatrix()getProjectionMode()getSilhouetteColor()getSilhouetteEnabled()getSilhouetteOpacity()getSilhouetteThreshold()getSilhouetteThresholdRampWidth()getSimpleReflectionAttenuation()getSimpleReflectionBlurInterval()getSimpleReflectionBlurSamples()getSimpleReflectionEnabled()getSimpleReflectionFadeAngle()getSimpleReflectionOpacity()getSimpleShadowBlurInterval()getSimpleShadowBlurSamples()getSimpleShadowColor()getSimpleShadowEnabled()getSimpleShadowInteractiveUpdateEnabled()getSimpleShadowOpacity()getSimpleShadowResolution()getToonShadingBandCount()getToonShadingSpecularFactor()getViewMatrix()getViewOrientationCamera()injectViewOrientationChangeEvent()isolateNodes()pickAllFromPoint()pickAllFromRay()pickFromPoint()pickFromRay()pointToWindowPosition()projectPoint()raycastFromPoint()redraw()removeLight()resetCamera()setAmbientLightColor()setAmbientOcclusionEnabled()setAmbientOcclusionRadius()setAntiAliasingMode()setBackfacesVisible()setBackgroundColor()setBloomEnabled()setBloomIntensityScale()setBloomLayers()setBloomThreshold()setBloomThresholdRampWidth()setBoundingCalculationIgnoresInvisible()setCamera()setDisplayIncompleteFrames()setDrawMode()setEyeDomeLightingBlurEdgeDistance()setEyeDomeLightingBlurInterval()setEyeDomeLightingBlurSamples()setEyeDomeLightingEnabled()setEyeDomeLightingOpacity()setEyeDomeLightingShadingEdgeDistance()setFaceVisibility()setGoochBaseColorProminence()setGoochBlue()setGoochLuminanceShiftStrength()setGoochYellow()setGroundPlane()setHardEdgeColor()setHardEdgeOpacity()setHardEdgeThreshold()setHardEdgeThresholdRampWidth()setHardEdgesEnabled()setImageBasedLightingEnabled()setImageBasedLightingEnvironment()setImageBasedLightingIntensity()setImageBasedLightingOrientation()setInitialCamera()setInteractiveDrawDelay()setInteractiveDrawLimitIncreaseEnabled()setLightingEnabled()setLineJitterEnabled()setLineJitterFrequency()setLineJitterInstanceCount()setLineJitterRadius()setLineVisibility()setMassageExtremeCameras()setMinimumFramerate()setPointShape()setPointSize()setPointVisibilityTest()setProjectionMode()setSilhouetteColor()setSilhouetteEnabled()setSilhouetteOpacity()setSilhouetteThreshold()setSilhouetteThresholdRampWidth()setSimpleReflectionAttenuation()setSimpleReflectionBlurInterval()setSimpleReflectionBlurSamples()setSimpleReflectionEnabled()setSimpleReflectionFadeAngle()setSimpleReflectionOpacity()setSimpleShadowBlurInterval()setSimpleShadowBlurSamples()setSimpleShadowColor()setSimpleShadowEnabled()setSimpleShadowInteractiveUpdateEnabled()setSimpleShadowOpacity()setSimpleShadowResolution()setStatisticsDisplayVisibility()setToonShadingBandCount()setToonShadingSpecularFactor()setTransparencyMode()setViewOrientation()setXRayColor()setXRayOpacity()setXRayTransparencyMode()startComparison()testPointVisibility()unprojectPoint()unsetDefaultCamera()unsetXRayColor()updateCamera()updateLight()
Properties
-
View.domElements Type: DomElements()
-
View.floorplanManager Type: FloorplanManager()
-
View.operatorManager Type: OperatorManager()
-
View.overlayManager Type: OverlayManager()
Accessors
Methods
advanceIncrementalSelection
-
View.advanceIncrementalSelection(handle) Arguments: - handle (
IncrementalSelectionId()) –
Return type: Promise <[
NodeSelectionItem()] | null>- handle (
beginConvexPolyhedronSelection
-
View.beginConvexPolyhedronSelection(volumePlanes, heuristicOrigin, config) Arguments: - volumePlanes ([Plane]) –
- heuristicOrigin (
Point3()) – - config (
IncrementalPickConfig()) –
Return type: Promise <
IncrementalSelectionId()>
beginRayDrillSelection
-
View.beginRayDrillSelection(rayCssOrigin, rayCssBoxRadius, config) Arguments: - rayCssOrigin (
Point2()) – - rayCssBoxRadius (
number()) – - config (
IncrementalPickConfig()) –
Return type: Promise <
IncrementalSelectionId()>- rayCssOrigin (
beginScreenSelectByArea
-
View.beginScreenSelectByArea(areaCssMin, areaCssMax, config) Arguments: - areaCssMin (
Point2()) – - areaCssMax (
Point2()) – - config (
IncrementalPickConfig()) –
Return type: Promise <
IncrementalSelectionId()>- areaCssMin (
beginSphereSelection
-
View.beginSphereSelection(sphereCenter, sphereRadius, config) Arguments: - sphereCenter (
Point3()) – - sphereRadius (
number()) – - config (
IncrementalPickConfig()) –
Return type: Promise <
IncrementalSelectionId()>- sphereCenter (
centerCameraOnNode
compositePickFromPoint
-
View.compositePickFromPoint(point, config) Arguments: - point (
Point2()) – - config (
PickConfig()) –
Return type: Promise <
CompositeSelectionItem()>- point (
endIncrementalSelection
-
View.endIncrementalSelection(handle) Arguments: - handle (
IncrementalSelectionId()) –
Return type: Promise <void>
- handle (
fitBounding
fitNodes
fitWorld
getAntiAliasingMode
-
View.getAntiAliasingMode() Return type: AntiAliasingMode
getAxisTriad
-
View.getAxisTriad() Return type: AxisTriad()
getBackgroundColor
-
View.getBackgroundColor() Return type: VerticalGradient()
getBloomLayers
-
View.getBloomLayers() Return type: [ BloomLayerInfo()]
getBoundingCalculationIgnoresInvisible
-
View.getBoundingCalculationIgnoresInvisible() Return type: boolean
getDrawStrategy
-
View.getDrawStrategy() Return type: DrawStrategy
getEyeDomeLightingBlurEdgeDistance
-
View.getEyeDomeLightingBlurEdgeDistance() Return type: Promise <number>
getEyeDomeLightingShadingEdgeDistance
-
View.getEyeDomeLightingShadingEdgeDistance() Return type: Promise <number>
getGroundPlane
-
View.getGroundPlane() Return type: GroundPlane()
getImageBasedLightingOrientation
-
View.getImageBasedLightingOrientation() Return type: ImageBasedLightingOrientation()
getInteractiveDrawLimitIncreaseEnabled
-
View.getInteractiveDrawLimitIncreaseEnabled() Return type: Promise <boolean>
getPointShape
-
View.getPointShape() Return type: Promise <PointShape>
getPointSize
-
View.getPointSize() Return type: Promise <(number, PointSizeUnit)>
getProjectionMode
-
View.getProjectionMode() Return type: Projection
getSimpleReflectionBlurInterval
-
View.getSimpleReflectionBlurInterval() Return type: (number, BlurIntervalUnit)
getSimpleShadowInteractiveUpdateEnabled
-
View.getSimpleShadowInteractiveUpdateEnabled() Return type: boolean
getViewOrientationCamera
-
View.getViewOrientationCamera(orientation[, bounding, preserveModelUp]) Arguments: - orientation (ViewOrientation) –
- bounding (
Box()) – optional - preserveModelUp (
boolean()) – None
Return type: Promise <
Camera()>
isolateNodes
pickAllFromPoint
-
View.pickAllFromPoint(point, config) Arguments: - point (
Point2()) – - config (
PickConfig()) –
Return type: Promise <[
NodeEntitySelectionItem()]>- point (
pickAllFromRay
-
View.pickAllFromRay(ray, config) Arguments: - ray (
Ray()) – - config (
PickConfig()) –
Return type: Promise <[
NodeEntitySelectionItem()]>- ray (
pickFromPoint
-
View.pickFromPoint(point, config) Arguments: - point (
Point2()) – - config (
PickConfig()) –
Return type: Promise <
SelectionItem()>- point (
pickFromRay
-
View.pickFromRay(ray, config) Arguments: - ray (
Ray()) – - config (
PickConfig()) –
Return type: Promise <
SelectionItem()>- ray (
pointToWindowPosition
projectPoint
raycastFromPoint
redraw
-
View.redraw([callback]) Arguments: - callback (
function()) – optional
Return type: void
-
View.callback() Return type: void
- callback (
resetCamera
-
View.resetCamera(duration) Arguments: - duration (
number()) –
Return type: Promise <void>
- duration (
setAmbientLightColor
setAmbientOcclusionEnabled
-
View.setAmbientOcclusionEnabled(enabled) Arguments: - enabled (
boolean()) –
Return type: Promise <void>
- enabled (
setAmbientOcclusionRadius
-
View.setAmbientOcclusionRadius(radius) Arguments: - radius (
number()) –
Return type: Promise <void>
- radius (
setAntiAliasingMode
-
View.setAntiAliasingMode(antiAliasingMode) Arguments: - antiAliasingMode (AntiAliasingMode) –
Return type: Promise <void>
setBackfacesVisible
-
View.setBackfacesVisible(visible) Arguments: - visible (
boolean()) –
Return type: Promise <void>
- visible (
setBackgroundColor
setBloomIntensityScale
-
View.setBloomIntensityScale(value) Arguments: - value (
number()) – None
Return type: void
- value (
setBloomLayers
-
View.setBloomLayers(layers) Arguments: - layers ([
BloomLayerInfo()]) – None
Return type: void
- layers ([
setBloomThreshold
-
View.setBloomThreshold(value) Arguments: - value (
number()) – None
Return type: void
- value (
setBloomThresholdRampWidth
-
View.setBloomThresholdRampWidth(value) Arguments: - value (
number()) – None
Return type: void
- value (
setBoundingCalculationIgnoresInvisible
-
View.setBoundingCalculationIgnoresInvisible(value) Arguments: - value (
boolean()) – None
Return type: void
- value (
setCamera
setDisplayIncompleteFrames
-
View.setDisplayIncompleteFrames(value) Arguments: - value (
boolean()) – None
Return type: Promise <void>
- value (
setDrawMode
setEyeDomeLightingBlurEdgeDistance
-
View.setEyeDomeLightingBlurEdgeDistance(value) Arguments: - value (
number()) – None
Return type: Promise <void>
- value (
setEyeDomeLightingBlurInterval
-
View.setEyeDomeLightingBlurInterval(value) Arguments: - value (
number()) – None
Return type: Promise <void>
- value (
setEyeDomeLightingBlurSamples
-
View.setEyeDomeLightingBlurSamples(value) Arguments: - value (
number()) – None
Return type: Promise <void>
- value (
setEyeDomeLightingEnabled
-
View.setEyeDomeLightingEnabled(enabled) Arguments: - enabled (
boolean()) – None
Return type: Promise <void>
- enabled (
setEyeDomeLightingOpacity
-
View.setEyeDomeLightingOpacity(value) Arguments: - value (
number()) –
Return type: Promise <void>
- value (
setEyeDomeLightingShadingEdgeDistance
-
View.setEyeDomeLightingShadingEdgeDistance(value) Arguments: - value (
number()) – None
Return type: Promise <void>
- value (
setFaceVisibility
-
View.setFaceVisibility(faceVisibility) Arguments: - faceVisibility (
boolean()) –
Return type: Promise <void>
- faceVisibility (
setGoochBaseColorProminence
-
View.setGoochBaseColorProminence(prominence) Arguments: - prominence (
number()) –
Return type: void
- prominence (
setGoochLuminanceShiftStrength
-
View.setGoochLuminanceShiftStrength(shiftStrength) Arguments: - shiftStrength (
number()) –
Return type: void
- shiftStrength (
setGroundPlane
-
View.setGroundPlane(plane) Arguments: - plane (
GroundPlane()) –
Return type: void
- plane (
setHardEdgeThreshold
-
View.setHardEdgeThreshold(degrees) Arguments: - degrees (
number()) –
Return type: void
- degrees (
setHardEdgeThresholdRampWidth
-
View.setHardEdgeThresholdRampWidth(degrees) Arguments: - degrees (
number()) – None
Return type: void
- degrees (
setHardEdgesEnabled
-
View.setHardEdgesEnabled(value) Arguments: - value (
boolean()) –
Return type: void
- value (
setImageBasedLightingEnabled
-
View.setImageBasedLightingEnabled(value) Arguments: - value (
boolean()) – None
Return type: void
- value (
setImageBasedLightingEnvironment
-
View.setImageBasedLightingEnvironment(data) Arguments: - data (
Uint8Array | null()) – None
Return type: void
- data (
setImageBasedLightingIntensity
-
View.setImageBasedLightingIntensity(value) Arguments: - value (
number()) – None
Return type: void
- value (
setImageBasedLightingOrientation
-
View.setImageBasedLightingOrientation(value) Arguments: - value (
ImageBasedLightingOrientation()) – None
Return type: void
- value (
setInteractiveDrawDelay
-
View.setInteractiveDrawDelay(value) Arguments: - value (
number()) –
Return type: Promise <void>
- value (
setInteractiveDrawLimitIncreaseEnabled
-
View.setInteractiveDrawLimitIncreaseEnabled(enable) Arguments: - enable (
boolean()) –
Return type: void
- enable (
setLightingEnabled
-
View.setLightingEnabled(enabled) Arguments: - enabled (
boolean()) – None
Return type: Promise <void>
- enabled (
setLineJitterEnabled
-
View.setLineJitterEnabled(value) Arguments: - value (
boolean()) – None
Return type: void
- value (
setLineJitterFrequency
-
View.setLineJitterFrequency(value) Arguments: - value (
number()) – None
Return type: void
- value (
setLineJitterInstanceCount
-
View.setLineJitterInstanceCount(value) Arguments: - value (
number()) – None
Return type: void
- value (
setLineJitterRadius
-
View.setLineJitterRadius(value) Arguments: - value (
number()) – None
Return type: void
- value (
setLineVisibility
-
View.setLineVisibility(lineVisibility) Arguments: - lineVisibility (
boolean()) –
Return type: Promise <void>
- lineVisibility (
setMassageExtremeCameras
-
View.setMassageExtremeCameras(value) Arguments: - value (
boolean()) –
Return type: void
- value (
setMinimumFramerate
-
View.setMinimumFramerate(minimum) Arguments: - minimum (
number()) –
Return type: void
- minimum (
setPointShape
-
View.setPointShape(shape) Arguments: - shape (PointShape) – None
Return type: Promise <void>
setPointSize
-
View.setPointSize(size, unit) Arguments: - size (
number()) – None - unit (PointSizeUnit) – None
Return type: Promise <void>
- size (
setPointVisibilityTest
-
View.setPointVisibilityTest(points) Arguments: - points (
[Point3]()) –
Return type: void
- points (
setProjectionMode
-
View.setProjectionMode(projectionMode) Arguments: - projectionMode (Projection) – None
Return type: void
setSilhouetteEnabled
-
View.setSilhouetteEnabled(value) Arguments: - value (
boolean()) –
Return type: void
- value (
setSilhouetteOpacity
-
View.setSilhouetteOpacity(value) Arguments: - value (
number()) –
Return type: void
- value (
setSilhouetteThreshold
-
View.setSilhouetteThreshold(value) Arguments: - value (
number()) –
Return type: void
- value (
setSilhouetteThresholdRampWidth
-
View.setSilhouetteThresholdRampWidth(value) Arguments: - value (
number()) – None
Return type: void
- value (
setSimpleReflectionAttenuation
-
View.setSimpleReflectionAttenuation(nearDistance, farDistance, unit) Arguments: - nearDistance (
number()) – - farDistance (
number()) – - unit (SimpleReflectionAttenuationUnit) –
Return type: void
- nearDistance (
setSimpleReflectionBlurInterval
-
View.setSimpleReflectionBlurInterval(value, unit) Arguments: - value (
number()) – - unit (BlurIntervalUnit) –
Return type: void
- value (
setSimpleReflectionBlurSamples
-
View.setSimpleReflectionBlurSamples(value) Arguments: - value (
number()) – None
Return type: void
- value (
setSimpleReflectionEnabled
-
View.setSimpleReflectionEnabled(value) Arguments: - value (
boolean()) – None
Return type: void
- value (
setSimpleReflectionFadeAngle
-
View.setSimpleReflectionFadeAngle(degrees) Arguments: - degrees (
number()) –
Return type: void
- degrees (
setSimpleReflectionOpacity
-
View.setSimpleReflectionOpacity(value) Arguments: - value (
number()) – None
Return type: void
- value (
setSimpleShadowBlurInterval
-
View.setSimpleShadowBlurInterval(value) Arguments: - value (
number()) –
Return type: void
- value (
setSimpleShadowBlurSamples
-
View.setSimpleShadowBlurSamples(value) Arguments: - value (
number()) –
Return type: void
- value (
setSimpleShadowEnabled
-
View.setSimpleShadowEnabled(value) Arguments: - value (
boolean()) –
Return type: void
- value (
setSimpleShadowInteractiveUpdateEnabled
-
View.setSimpleShadowInteractiveUpdateEnabled(value) Arguments: - value (
boolean()) – None
Return type: void
- value (
setSimpleShadowOpacity
-
View.setSimpleShadowOpacity(opacity) Arguments: - opacity (
number()) –
Return type: void
- opacity (
setSimpleShadowResolution
-
View.setSimpleShadowResolution(pixels) Arguments: - pixels (
number()) –
Return type: void
- pixels (
setStatisticsDisplayVisibility
-
View.setStatisticsDisplayVisibility(visibility) Arguments: - visibility (
boolean()) – None
Return type: Promise <void>
- visibility (
setToonShadingBandCount
-
View.setToonShadingBandCount(bandCount) Arguments: - bandCount (
number()) – None
Return type: void
- bandCount (
setToonShadingSpecularFactor
-
View.setToonShadingSpecularFactor(specularFactor) Arguments: - specularFactor (
number()) – None
Return type: void
- specularFactor (
setTransparencyMode
-
View.setTransparencyMode(mode) Arguments: - mode (TransparencyMode) – None
Return type: void
setViewOrientation
-
View.setViewOrientation(orientation, duration[, bounding, preserveModelUp]) Arguments: - orientation (ViewOrientation) –
- duration (
number()) – - bounding (
Box()) – optional - preserveModelUp (
boolean()) –
Return type: Promise <void>
setXRayColor
-
View.setXRayColor(element, color, group) Arguments: - element (ElementType) –
- color (Color) –
- group (XRayGroup) –
Return type: Promise <void>
setXRayOpacity
-
View.setXRayOpacity(opacity[, element]) Arguments: - opacity (
number()) – - element (ElementType) – optional
Return type: Promise <void>
- opacity (
setXRayTransparencyMode
-
View.setXRayTransparencyMode(mode) Arguments: - mode (XRayTransparencyMode) – None
Return type: Promise <void>
startComparison
-
View.startComparison(nodeIdSet1, nodeIdSet2[, config]) Arguments: - nodeIdSet1 ([NodeId]) –
- nodeIdSet2 ([NodeId]) –
- config (
ComparisonConfig()) – optional
Return type: void
testPointVisibility
-
View.testPointVisibility(points) Arguments: - points (
[Point3]()) –
Return type: Promise <[number]>
- points (
unprojectPoint
unsetXRayColor
-
View.unsetXRayColor(element, group) Arguments: - element (ElementType) –
- group (XRayGroup) –
Return type: Promise <void>