View

class View()

Properties

Accessors

  • axisTriad
  • id
  • inputMonitor
  • navCube

Methods

Properties

View.domElements
Type:DomElements()
View.floorplanManager
Type:FloorplanManager()
View.operatorManager
Type:OperatorManager()
View.overlayManager
Type:OverlayManager()

Accessors

Methods

addLight

View.addLight(light)
Arguments:
Return type:

Promise <LightKey>

advanceIncrementalSelection

View.advanceIncrementalSelection(handle)
Arguments:
Return type:

Promise <[NodeSelectionItem()] | null>

beginConvexPolyhedronSelection

View.beginConvexPolyhedronSelection(volumePlanes, heuristicOrigin, config)
Arguments:
Return type:

Promise <IncrementalSelectionId()>

beginRayDrillSelection

View.beginRayDrillSelection(rayCssOrigin, rayCssBoxRadius, config)
Arguments:
Return type:

Promise <IncrementalSelectionId()>

beginScreenSelectByArea

View.beginScreenSelectByArea(areaCssMin, areaCssMax, config)
Arguments:
Return type:

Promise <IncrementalSelectionId()>

beginSphereSelection

View.beginSphereSelection(sphereCenter, sphereRadius, config)
Arguments:
Return type:

Promise <IncrementalSelectionId()>

centerCameraOnNode

View.centerCameraOnNode(nodeId, duration, camera)
Arguments:
  • nodeId (NodeId) –
  • duration (number()) –
  • camera (Camera()) – None
Return type:

Promise <void>

clearLights

View.clearLights()
Return type:void

compositePickFromPoint

View.compositePickFromPoint(point, config)
Arguments:
Return type:

Promise <CompositeSelectionItem()>

endComparison

View.endComparison()
Return type:void

endIncrementalSelection

View.endIncrementalSelection(handle)
Arguments:
Return type:

Promise <void>

fitBounding

View.fitBounding(bounding, duration, camera)
Arguments:
  • bounding (Box()) –
  • duration (number()) –
  • camera (Camera()) – None
Return type:

Promise <void>

fitNodes

View.fitNodes(ids, duration)
Arguments:
  • ids ([NodeId]) – None
  • duration (number()) –
Return type:

Promise <void>

fitWorld

View.fitWorld(duration[, camera])
Arguments:
  • duration (number()) –
  • camera (Camera()) – optional None
Return type:

Promise <void>

getAmbientLightColor

View.getAmbientLightColor()
Return type:Color

getAmbientOcclusionEnabled

View.getAmbientOcclusionEnabled()
Return type:boolean

getAmbientOcclusionRadius

View.getAmbientOcclusionRadius()
Return type:number

getAntiAliasingMode

View.getAntiAliasingMode()
Return type:AntiAliasingMode

getAxisTriad

View.getAxisTriad()
Return type:AxisTriad()

getBackfacesVisible

View.getBackfacesVisible()
Return type:boolean

getBackgroundColor

View.getBackgroundColor()
Return type:VerticalGradient()

getBloomEnabled

View.getBloomEnabled()
Return type:boolean

getBloomIntensityScale

View.getBloomIntensityScale()
Return type:number

getBloomLayers

View.getBloomLayers()
Return type:[BloomLayerInfo()]

getBloomThreshold

View.getBloomThreshold()
Return type:number

getBloomThresholdRampWidth

View.getBloomThresholdRampWidth()
Return type:number

getBoundingCalculationIgnoresInvisible

View.getBoundingCalculationIgnoresInvisible()
Return type:boolean

getCamera

View.getCamera()
Return type:Camera()

getCanvasSize

View.getCanvasSize()
Return type:Point2

getDrawMode

View.getDrawMode()
Return type:DrawMode

getDrawStrategy

View.getDrawStrategy()
Return type:DrawStrategy

getEyeDomeLightingBlurEdgeDistance

View.getEyeDomeLightingBlurEdgeDistance()
Return type:Promise <number>

getEyeDomeLightingBlurInterval

View.getEyeDomeLightingBlurInterval()
Return type:Promise <number>

getEyeDomeLightingBlurSamples

View.getEyeDomeLightingBlurSamples()
Return type:Promise <number>

getEyeDomeLightingEnabled

View.getEyeDomeLightingEnabled()
Return type:Promise <boolean>

getEyeDomeLightingOpacity

View.getEyeDomeLightingOpacity()
Return type:Promise <number>

getEyeDomeLightingShadingEdgeDistance

View.getEyeDomeLightingShadingEdgeDistance()
Return type:Promise <number>

getFaceVisibility

View.getFaceVisibility()
Return type:boolean

getFullCameraMatrix

View.getFullCameraMatrix()
Return type:Matrix

getGoochBaseColorProminence

View.getGoochBaseColorProminence()
Return type:number

getGoochBlue

View.getGoochBlue()
Return type:number

getGoochLuminanceShiftStrength

View.getGoochLuminanceShiftStrength()
Return type:number

getGoochYellow

View.getGoochYellow()
Return type:number

getGroundPlane

View.getGroundPlane()
Return type:GroundPlane()

getHardEdgeColor

View.getHardEdgeColor()
Return type:Color

getHardEdgeOpacity

View.getHardEdgeOpacity()
Return type:number

getHardEdgeThreshold

View.getHardEdgeThreshold()
Return type:number

getHardEdgeThresholdRampWidth

View.getHardEdgeThresholdRampWidth()
Return type:number

getHardEdgesEnabled

View.getHardEdgesEnabled()
Return type:boolean

getHiddenLineSettings

View.getHiddenLineSettings()
Return type:HiddenLineSettings()

getImageBasedLightingEnabled

View.getImageBasedLightingEnabled()
Return type:boolean

getImageBasedLightingIntensity

View.getImageBasedLightingIntensity()
Return type:number

getImageBasedLightingOrientation

View.getImageBasedLightingOrientation()
Return type:ImageBasedLightingOrientation()

getInteractiveDrawLimitIncreaseEnabled

View.getInteractiveDrawLimitIncreaseEnabled()
Return type:Promise <boolean>

getLight

View.getLight(key)
Arguments:
Return type:

Promise <Light() | undefined>

getLightKeys

View.getLightKeys()
Return type:Promise <[LightKey]>

getLightingEnabled

View.getLightingEnabled()
Return type:boolean

getLineJitterEnabled

View.getLineJitterEnabled()
Return type:boolean

getLineJitterFrequency

View.getLineJitterFrequency()
Return type:number

getLineJitterInstanceCount

View.getLineJitterInstanceCount()
Return type:number

getLineJitterRadius

View.getLineJitterRadius()
Return type:number

getLineVisibility

View.getLineVisibility()
Return type:boolean

getMassageExtremeCameras

View.getMassageExtremeCameras()
Return type:boolean

getNavCube

View.getNavCube()
Return type:NavCube()

getPointShape

View.getPointShape()
Return type:Promise <PointShape>

getPointSize

View.getPointSize()
Return type:Promise <(number, PointSizeUnit)>

getProjectionMatrix

View.getProjectionMatrix()
Return type:Matrix

getProjectionMode

View.getProjectionMode()
Return type:Projection

getSilhouetteColor

View.getSilhouetteColor()
Return type:Color

getSilhouetteEnabled

View.getSilhouetteEnabled()
Return type:boolean

getSilhouetteOpacity

View.getSilhouetteOpacity()
Return type:number

getSilhouetteThreshold

View.getSilhouetteThreshold()
Return type:number

getSilhouetteThresholdRampWidth

View.getSilhouetteThresholdRampWidth()
Return type:number

getSimpleReflectionAttenuation

View.getSimpleReflectionAttenuation()
Return type:function

getSimpleReflectionBlurInterval

View.getSimpleReflectionBlurInterval()
Return type:(number, BlurIntervalUnit)

getSimpleReflectionBlurSamples

View.getSimpleReflectionBlurSamples()
Return type:number

getSimpleReflectionEnabled

View.getSimpleReflectionEnabled()
Return type:boolean

getSimpleReflectionFadeAngle

View.getSimpleReflectionFadeAngle()
Return type:number

getSimpleReflectionOpacity

View.getSimpleReflectionOpacity()
Return type:number

getSimpleShadowBlurInterval

View.getSimpleShadowBlurInterval()
Return type:number

getSimpleShadowBlurSamples

View.getSimpleShadowBlurSamples()
Return type:number

getSimpleShadowColor

View.getSimpleShadowColor()
Return type:Color

getSimpleShadowEnabled

View.getSimpleShadowEnabled()
Return type:boolean

getSimpleShadowInteractiveUpdateEnabled

View.getSimpleShadowInteractiveUpdateEnabled()
Return type:boolean

getSimpleShadowOpacity

View.getSimpleShadowOpacity()
Return type:number

getSimpleShadowResolution

View.getSimpleShadowResolution()
Return type:number

getToonShadingBandCount

View.getToonShadingBandCount()
Return type:number

getToonShadingSpecularFactor

View.getToonShadingSpecularFactor()
Return type:number

getViewMatrix

View.getViewMatrix()
Return type:Matrix

getViewOrientationCamera

View.getViewOrientationCamera(orientation[, bounding, preserveModelUp])
Arguments:
  • orientation (ViewOrientation) –
  • bounding (Box()) – optional
  • preserveModelUp (boolean()) – None
Return type:

Promise <Camera()>

injectViewOrientationChangeEvent

View.injectViewOrientationChangeEvent()
Return type:void

isolateNodes

View.isolateNodes(nodeIds, duration, fitNodes, initiallyHiddenStayHidden)
Arguments:
  • nodeIds ([NodeId]) –
  • duration (number()) –
  • fitNodes (boolean()) –
  • initiallyHiddenStayHidden (boolean | null()) –
Return type:

Promise <void>

pickAllFromPoint

View.pickAllFromPoint(point, config)
Arguments:
Return type:

Promise <[NodeEntitySelectionItem()]>

pickAllFromRay

View.pickAllFromRay(ray, config)
Arguments:
Return type:

Promise <[NodeEntitySelectionItem()]>

pickFromPoint

View.pickFromPoint(point, config)
Arguments:
Return type:

Promise <SelectionItem()>

pickFromRay

View.pickFromRay(ray, config)
Arguments:
Return type:

Promise <SelectionItem()>

pointToWindowPosition

View.pointToWindowPosition(pt)
Arguments:
Return type:

Point2

projectPoint

View.projectPoint(source[, camera])
Arguments:
Return type:

Point3

raycastFromPoint

View.raycastFromPoint(point)
Arguments:
Return type:

Ray | null

redraw

View.redraw([callback])
Arguments:
  • callback (function()) – optional
Return type:

void
View.callback()
Return type:void

removeLight

View.removeLight(key)
Arguments:
Return type:

void

resetCamera

View.resetCamera(duration)
Arguments:
  • duration (number()) –
Return type:

Promise <void>

setAmbientLightColor

View.setAmbientLightColor(value)
Arguments:
Return type:

void

setAmbientOcclusionEnabled

View.setAmbientOcclusionEnabled(enabled)
Arguments:
  • enabled (boolean()) –
Return type:

Promise <void>

setAmbientOcclusionRadius

View.setAmbientOcclusionRadius(radius)
Arguments:
  • radius (number()) –
Return type:

Promise <void>

setAntiAliasingMode

View.setAntiAliasingMode(antiAliasingMode)
Arguments:
Return type:

Promise <void>

setBackfacesVisible

View.setBackfacesVisible(visible)
Arguments:
  • visible (boolean()) –
Return type:

Promise <void>

setBackgroundColor

View.setBackgroundColor(top, bottom)
Arguments:
  • top (Color | null) –
  • bottom (Color | null) –
Return type:

Promise <void>

setBloomEnabled

View.setBloomEnabled(value)
Arguments:
  • value (boolean()) – None
Return type:

void

setBloomIntensityScale

View.setBloomIntensityScale(value)
Arguments:
  • value (number()) – None
Return type:

void

setBloomLayers

View.setBloomLayers(layers)
Arguments:
Return type:

void

setBloomThreshold

View.setBloomThreshold(value)
Arguments:
  • value (number()) – None
Return type:

void

setBloomThresholdRampWidth

View.setBloomThresholdRampWidth(value)
Arguments:
  • value (number()) – None
Return type:

void

setBoundingCalculationIgnoresInvisible

View.setBoundingCalculationIgnoresInvisible(value)
Arguments:
  • value (boolean()) – None
Return type:

void

setCamera

View.setCamera(camera, duration)
Arguments:
  • camera (Camera() | null) –
  • duration (number()) –
Return type:

boolean

setDisplayIncompleteFrames

View.setDisplayIncompleteFrames(value)
Arguments:
  • value (boolean()) – None
Return type:

Promise <void>

setDrawMode

View.setDrawMode(drawMode)
Arguments:
Return type:

Promise <void>

setEyeDomeLightingBlurEdgeDistance

View.setEyeDomeLightingBlurEdgeDistance(value)
Arguments:
  • value (number()) – None
Return type:

Promise <void>

setEyeDomeLightingBlurInterval

View.setEyeDomeLightingBlurInterval(value)
Arguments:
  • value (number()) – None
Return type:

Promise <void>

setEyeDomeLightingBlurSamples

View.setEyeDomeLightingBlurSamples(value)
Arguments:
  • value (number()) – None
Return type:

Promise <void>

setEyeDomeLightingEnabled

View.setEyeDomeLightingEnabled(enabled)
Arguments:
  • enabled (boolean()) – None
Return type:

Promise <void>

setEyeDomeLightingOpacity

View.setEyeDomeLightingOpacity(value)
Arguments:
  • value (number()) –
Return type:

Promise <void>

setEyeDomeLightingShadingEdgeDistance

View.setEyeDomeLightingShadingEdgeDistance(value)
Arguments:
  • value (number()) – None
Return type:

Promise <void>

setFaceVisibility

View.setFaceVisibility(faceVisibility)
Arguments:
  • faceVisibility (boolean()) –
Return type:

Promise <void>

setGoochBaseColorProminence

View.setGoochBaseColorProminence(prominence)
Arguments:
  • prominence (number()) –
Return type:

void

setGoochBlue

View.setGoochBlue(blue)
Arguments:
  • blue (number()) –
Return type:

void

setGoochLuminanceShiftStrength

View.setGoochLuminanceShiftStrength(shiftStrength)
Arguments:
  • shiftStrength (number()) –
Return type:

void

setGoochYellow

View.setGoochYellow(yellow)
Arguments:
  • yellow (number()) –
Return type:

void

setGroundPlane

View.setGroundPlane(plane)
Arguments:
Return type:

void

setHardEdgeColor

View.setHardEdgeColor(value)
Arguments:
Return type:

void

setHardEdgeOpacity

View.setHardEdgeOpacity(value)
Arguments:
  • value (number()) –
Return type:

void

setHardEdgeThreshold

View.setHardEdgeThreshold(degrees)
Arguments:
  • degrees (number()) –
Return type:

void

setHardEdgeThresholdRampWidth

View.setHardEdgeThresholdRampWidth(degrees)
Arguments:
  • degrees (number()) – None
Return type:

void

setHardEdgesEnabled

View.setHardEdgesEnabled(value)
Arguments:
  • value (boolean()) –
Return type:

void

setImageBasedLightingEnabled

View.setImageBasedLightingEnabled(value)
Arguments:
  • value (boolean()) – None
Return type:

void

setImageBasedLightingEnvironment

View.setImageBasedLightingEnvironment(data)
Arguments:
  • data (Uint8Array | null()) – None
Return type:

void

setImageBasedLightingIntensity

View.setImageBasedLightingIntensity(value)
Arguments:
  • value (number()) – None
Return type:

void

setImageBasedLightingOrientation

View.setImageBasedLightingOrientation(value)
Arguments:
Return type:

void

setInitialCamera

View.setInitialCamera(camera)
Arguments:
Return type:

void

setInteractiveDrawDelay

View.setInteractiveDrawDelay(value)
Arguments:
  • value (number()) –
Return type:

Promise <void>

setInteractiveDrawLimitIncreaseEnabled

View.setInteractiveDrawLimitIncreaseEnabled(enable)
Arguments:
  • enable (boolean()) –
Return type:

void

setLightingEnabled

View.setLightingEnabled(enabled)
Arguments:
  • enabled (boolean()) – None
Return type:

Promise <void>

setLineJitterEnabled

View.setLineJitterEnabled(value)
Arguments:
  • value (boolean()) – None
Return type:

void

setLineJitterFrequency

View.setLineJitterFrequency(value)
Arguments:
  • value (number()) – None
Return type:

void

setLineJitterInstanceCount

View.setLineJitterInstanceCount(value)
Arguments:
  • value (number()) – None
Return type:

void

setLineJitterRadius

View.setLineJitterRadius(value)
Arguments:
  • value (number()) – None
Return type:

void

setLineVisibility

View.setLineVisibility(lineVisibility)
Arguments:
  • lineVisibility (boolean()) –
Return type:

Promise <void>

setMassageExtremeCameras

View.setMassageExtremeCameras(value)
Arguments:
  • value (boolean()) –
Return type:

void

setMinimumFramerate

View.setMinimumFramerate(minimum)
Arguments:
  • minimum (number()) –
Return type:

void

setPointShape

View.setPointShape(shape)
Arguments:
Return type:

Promise <void>

setPointSize

View.setPointSize(size, unit)
Arguments:
Return type:

Promise <void>

setPointVisibilityTest

View.setPointVisibilityTest(points)
Arguments:
  • points ([Point3]()) –
Return type:

void

setProjectionMode

View.setProjectionMode(projectionMode)
Arguments:
Return type:

void

setSilhouetteColor

View.setSilhouetteColor(value)
Arguments:
Return type:

void

setSilhouetteEnabled

View.setSilhouetteEnabled(value)
Arguments:
  • value (boolean()) –
Return type:

void

setSilhouetteOpacity

View.setSilhouetteOpacity(value)
Arguments:
  • value (number()) –
Return type:

void

setSilhouetteThreshold

View.setSilhouetteThreshold(value)
Arguments:
  • value (number()) –
Return type:

void

setSilhouetteThresholdRampWidth

View.setSilhouetteThresholdRampWidth(value)
Arguments:
  • value (number()) – None
Return type:

void

setSimpleReflectionAttenuation

View.setSimpleReflectionAttenuation(nearDistance, farDistance, unit)
Arguments:
Return type:

void

setSimpleReflectionBlurInterval

View.setSimpleReflectionBlurInterval(value, unit)
Arguments:
Return type:

void

setSimpleReflectionBlurSamples

View.setSimpleReflectionBlurSamples(value)
Arguments:
  • value (number()) – None
Return type:

void

setSimpleReflectionEnabled

View.setSimpleReflectionEnabled(value)
Arguments:
  • value (boolean()) – None
Return type:

void

setSimpleReflectionFadeAngle

View.setSimpleReflectionFadeAngle(degrees)
Arguments:
  • degrees (number()) –
Return type:

void

setSimpleReflectionOpacity

View.setSimpleReflectionOpacity(value)
Arguments:
  • value (number()) – None
Return type:

void

setSimpleShadowBlurInterval

View.setSimpleShadowBlurInterval(value)
Arguments:
  • value (number()) –
Return type:

void

setSimpleShadowBlurSamples

View.setSimpleShadowBlurSamples(value)
Arguments:
  • value (number()) –
Return type:

void

setSimpleShadowColor

View.setSimpleShadowColor(color)
Arguments:
Return type:

void

setSimpleShadowEnabled

View.setSimpleShadowEnabled(value)
Arguments:
  • value (boolean()) –
Return type:

void

setSimpleShadowInteractiveUpdateEnabled

View.setSimpleShadowInteractiveUpdateEnabled(value)
Arguments:
  • value (boolean()) – None
Return type:

void

setSimpleShadowOpacity

View.setSimpleShadowOpacity(opacity)
Arguments:
  • opacity (number()) –
Return type:

void

setSimpleShadowResolution

View.setSimpleShadowResolution(pixels)
Arguments:
  • pixels (number()) –
Return type:

void

setStatisticsDisplayVisibility

View.setStatisticsDisplayVisibility(visibility)
Arguments:
  • visibility (boolean()) – None
Return type:

Promise <void>

setToonShadingBandCount

View.setToonShadingBandCount(bandCount)
Arguments:
  • bandCount (number()) – None
Return type:

void

setToonShadingSpecularFactor

View.setToonShadingSpecularFactor(specularFactor)
Arguments:
  • specularFactor (number()) – None
Return type:

void

setTransparencyMode

View.setTransparencyMode(mode)
Arguments:
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:
Return type:

Promise <void>

setXRayOpacity

View.setXRayOpacity(opacity[, element])
Arguments:
  • opacity (number()) –
  • element (ElementType) – optional
Return type:

Promise <void>

setXRayTransparencyMode

View.setXRayTransparencyMode(mode)
Arguments:
Return type:

Promise <void>

startComparison

View.startComparison(nodeIdSet1, nodeIdSet2[, config])
Arguments:
Return type:

void

testPointVisibility

View.testPointVisibility(points)
Arguments:
  • points ([Point3]()) –
Return type:

Promise <[number]>

unprojectPoint

View.unprojectPoint(point, z)
Arguments:
Return type:

Point3 | null

unsetDefaultCamera

View.unsetDefaultCamera()
Return type:void

unsetXRayColor

View.unsetXRayColor(element, group)
Arguments:
Return type:

Promise <void>

updateCamera

View.updateCamera(camera)
Arguments:
Return type:

Camera()

updateLight

View.updateLight(key, light)
Arguments:
Return type:

void