IView

class core.IView()

Methods


Properties

IView.axisTriad
Type:AxisTriad
IView.domElements
Type:DomElements
IView.floorplanManager
Type:FloorplanManager
IView.id
Type:ViewKey
IView.inputMonitor
Type:InputMonitor
IView.navCube
Type:NavCube
IView.operatorManager
Type:OperatorManager
IView.overlayManager
Type:OverlayManager

Methods

_setCameraPromise

IView._setCameraPromise(camera, duration)
Arguments:
  • camera (Camera()) – None
  • duration (number()) – None
Return type:

Promise <void>

_setInitialView

IView._setInitialView(duration)
Arguments:
  • duration (number()) – None
Return type:

Promise <void>

addLight

IView.addLight(light)
Arguments:
Return type:

Promise <number>

advanceIncrementalSelection

IView.advanceIncrementalSelection(handle)
Arguments:
  • handle (IncrementalSelectionId()) – None
Return type:

Promise <null | [NodeSelectionItem]>

beginConvexPolyhedronSelection

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

Promise <IncrementalSelectionId>

beginRayDrillSelection

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

Promise <IncrementalSelectionId>

beginScreenSelectByArea

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

Promise <IncrementalSelectionId>

beginSphereSelection

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

Promise <IncrementalSelectionId>

centerCameraOnNode

IView.centerCameraOnNode(nodeId[, duration[, camera]])
Arguments:
  • nodeId (number()) – None
  • duration (number()) – optional None
  • camera (Camera()) – optional None
Return type:

Promise <void>

clearLights

IView.clearLights()
Return type:void

compositePickFromPoint

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

Promise <CompositeSelectionItem>

endComparison

IView.endComparison()
Return type:void

endIncrementalSelection

IView.endIncrementalSelection(handle)
Arguments:
  • handle (IncrementalSelectionId()) – None
Return type:

Promise <void>

fitBounding

IView.fitBounding(bounding[, duration[, camera]])
Arguments:
  • bounding (Box()) – None
  • duration (number()) – optional None
  • camera (Camera()) – optional None
Return type:

Promise <void>

fitNodes

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

Promise <void>

fitWorld

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

Promise <void>

getAmbientLightColor

IView.getAmbientLightColor()
Return type:Color

getAmbientOcclusionEnabled

IView.getAmbientOcclusionEnabled()
Return type:boolean

getAmbientOcclusionRadius

IView.getAmbientOcclusionRadius()
Return type:number

getAntiAliasingMode

IView.getAntiAliasingMode()
Return type:AntiAliasingMode

getAxisTriad

IView.getAxisTriad()
Return type:AxisTriad

getBackfacesVisible

IView.getBackfacesVisible()
Return type:boolean

getBackgroundColor

IView.getBackgroundColor()
Return type:VerticalGradient

getBloomEnabled

IView.getBloomEnabled()
Return type:boolean

getBloomIntensityScale

IView.getBloomIntensityScale()
Return type:number

getBloomLayers

IView.getBloomLayers()
Return type:[BloomLayerInfo]

getBloomThreshold

IView.getBloomThreshold()
Return type:number

getBloomThresholdRampWidth

IView.getBloomThresholdRampWidth()
Return type:number

getBoundingCalculationIgnoresInvisible

IView.getBoundingCalculationIgnoresInvisible()
Return type:boolean

getCamera

IView.getCamera()
Return type:Camera

getCanvasSize

IView.getCanvasSize()
Return type:Point2

getDrawMode

IView.getDrawMode()
Return type:DrawMode

getDrawStrategy

IView.getDrawStrategy()
Return type:DrawStrategy

getEyeDomeLightingBlurEdgeDistance

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

getEyeDomeLightingBlurInterval

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

getEyeDomeLightingBlurSamples

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

getEyeDomeLightingEnabled

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

getEyeDomeLightingOpacity

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

getEyeDomeLightingShadingEdgeDistance

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

getFaceVisibility

IView.getFaceVisibility()
Return type:boolean

getFullCameraMatrix

IView.getFullCameraMatrix()
Return type:Matrix

getGoochBaseColorProminence

IView.getGoochBaseColorProminence()
Return type:number

getGoochBlue

IView.getGoochBlue()
Return type:number

getGoochLuminanceShiftStrength

IView.getGoochLuminanceShiftStrength()
Return type:number

getGoochYellow

IView.getGoochYellow()
Return type:number

getGroundPlane

IView.getGroundPlane()
Return type:GroundPlane

getHardEdgeColor

IView.getHardEdgeColor()
Return type:Color

getHardEdgeOpacity

IView.getHardEdgeOpacity()
Return type:number

getHardEdgesEnabled

IView.getHardEdgesEnabled()
Return type:boolean

getHardEdgeThreshold

IView.getHardEdgeThreshold()
Return type:number

getHardEdgeThresholdRampWidth

IView.getHardEdgeThresholdRampWidth()
Return type:number

getHiddenLineSettings

IView.getHiddenLineSettings()
Return type:HiddenLineSettings

getImageBasedLightingEnabled

IView.getImageBasedLightingEnabled()
Return type:boolean

getImageBasedLightingIntensity

IView.getImageBasedLightingIntensity()
Return type:number

getImageBasedLightingOrientation

IView.getImageBasedLightingOrientation()
Return type:ImageBasedLightingOrientation

getInteractiveDrawLimitIncreaseEnabled

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

getLight

IView.getLight(key)
Arguments:
  • key (number()) – None
Return type:

Promise <undefined | Light>

getLightingEnabled

IView.getLightingEnabled()
Return type:boolean

getLightKeys

IView.getLightKeys()
Return type:Promise <[number]>

getLineJitterEnabled

IView.getLineJitterEnabled()
Return type:boolean

getLineJitterFrequency

IView.getLineJitterFrequency()
Return type:number

getLineJitterInstanceCount

IView.getLineJitterInstanceCount()
Return type:number

getLineJitterRadius

IView.getLineJitterRadius()
Return type:number

getLineVisibility

IView.getLineVisibility()
Return type:boolean

getMassageExtremeCameras

IView.getMassageExtremeCameras()
Return type:boolean

getNavCube

IView.getNavCube()
Return type:NavCube

getPointShape

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

getPointSize

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

getProjectionMatrix

IView.getProjectionMatrix()
Return type:Matrix

getProjectionMode

IView.getProjectionMode()
Return type:Projection

getSilhouetteColor

IView.getSilhouetteColor()
Return type:Color

getSilhouetteEnabled

IView.getSilhouetteEnabled()
Return type:boolean

getSilhouetteOpacity

IView.getSilhouetteOpacity()
Return type:number

getSilhouetteThreshold

IView.getSilhouetteThreshold()
Return type:number

getSilhouetteThresholdRampWidth

IView.getSilhouetteThresholdRampWidth()
Return type:number

getSimpleReflectionAttenuation

IView.getSimpleReflectionAttenuation()
Return type:SimpleReflectionAttenuation

getSimpleReflectionBlurInterval

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

getSimpleReflectionBlurSamples

IView.getSimpleReflectionBlurSamples()
Return type:number

getSimpleReflectionEnabled

IView.getSimpleReflectionEnabled()
Return type:boolean

getSimpleReflectionFadeAngle

IView.getSimpleReflectionFadeAngle()
Return type:number

getSimpleReflectionOpacity

IView.getSimpleReflectionOpacity()
Return type:number

getSimpleShadowBlurInterval

IView.getSimpleShadowBlurInterval()
Return type:number

getSimpleShadowBlurSamples

IView.getSimpleShadowBlurSamples()
Return type:number

getSimpleShadowColor

IView.getSimpleShadowColor()
Return type:Color

getSimpleShadowEnabled

IView.getSimpleShadowEnabled()
Return type:boolean

getSimpleShadowInteractiveUpdateEnabled

IView.getSimpleShadowInteractiveUpdateEnabled()
Return type:boolean

getSimpleShadowOpacity

IView.getSimpleShadowOpacity()
Return type:number

getSimpleShadowResolution

IView.getSimpleShadowResolution()
Return type:number

getToonShadingBandCount

IView.getToonShadingBandCount()
Return type:number

getToonShadingSpecularFactor

IView.getToonShadingSpecularFactor()
Return type:number

getViewMatrix

IView.getViewMatrix()
Return type:Matrix

getViewOrientationCamera

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

Promise <Camera>

injectViewOrientationChangeEvent

IView.injectViewOrientationChangeEvent()
Return type:void

isolateNodes

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

Promise <void>

pickAllFromPoint

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

Promise <[NodeEntitySelectionItem]>

pickAllFromRay

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

Promise <[NodeEntitySelectionItem]>

pickFromPoint

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

Promise <SelectionItem>

pickFromRay

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

Promise <SelectionItem>

pointToWindowPosition

IView.pointToWindowPosition(pt)
Arguments:
Return type:

Point2

projectPoint

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

Point3

raycastFromPoint

IView.raycastFromPoint(point)
Arguments:
Return type:

null | Ray

redraw

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

void

IView.callback()
Return type:void

removeLight

IView.removeLight(key)
Arguments:
  • key (number()) – None
Return type:

void

resetCamera

IView.resetCamera([duration])
Arguments:
  • duration (number()) – optional None
Return type:

Promise <void>

setAmbientLightColor

IView.setAmbientLightColor(value)
Arguments:
Return type:

void

setAmbientOcclusionEnabled

IView.setAmbientOcclusionEnabled([enabled])
Arguments:
  • enabled (boolean()) – optional None
Return type:

Promise <void>

setAmbientOcclusionRadius

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

Promise <void>

setAntiAliasingMode

IView.setAntiAliasingMode(antiAliasingMode)
Arguments:
  • antiAliasingMode (AntiAliasingMode()) – None
Return type:

Promise <void>

setBackfacesVisible

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

Promise <void>

setBackgroundColor

IView.setBackgroundColor([top[, bottom]])
Arguments:
  • top (null | Color()) – optional None
  • bottom (null | Color()) – optional None
Return type:

Promise <void>

setBloomEnabled

IView.setBloomEnabled([value])
Arguments:
  • value (boolean()) – optional None
Return type:

void

setBloomIntensityScale

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

void

setBloomLayers

IView.setBloomLayers(layers)
Arguments:
  • layers ([BloomLayerInfo]()) – None
Return type:

void

setBloomThreshold

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

void

setBloomThresholdRampWidth

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

void

setBoundingCalculationIgnoresInvisible

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

void

setCamera

IView.setCamera(camera[, duration])
Arguments:
  • camera (null | Camera()) – None
  • duration (number()) – optional None
Return type:

boolean

setDisplayIncompleteFrames

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

Promise <void>

setDrawMode

IView.setDrawMode(drawMode)
Arguments:
  • drawMode (DrawMode()) – None
Return type:

Promise <void>

setEyeDomeLightingBlurEdgeDistance

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

Promise <void>

setEyeDomeLightingBlurInterval

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

Promise <void>

setEyeDomeLightingBlurSamples

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

Promise <void>

setEyeDomeLightingEnabled

IView.setEyeDomeLightingEnabled([enabled])
Arguments:
  • enabled (boolean()) – optional None
Return type:

Promise <void>

setEyeDomeLightingOpacity

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

Promise <void>

setEyeDomeLightingShadingEdgeDistance

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

Promise <void>

setFaceVisibility

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

Promise <void>

setGoochBaseColorProminence

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

void

setGoochBlue

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

void

setGoochLuminanceShiftStrength

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

void

setGoochYellow

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

void

setGroundPlane

IView.setGroundPlane(plane)
Arguments:
Return type:

void

setHardEdgeColor

IView.setHardEdgeColor(value)
Arguments:
Return type:

void

setHardEdgeOpacity

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

void

setHardEdgesEnabled

IView.setHardEdgesEnabled([value])
Arguments:
  • value (boolean()) – optional None
Return type:

void

setHardEdgeThreshold

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

void

setHardEdgeThresholdRampWidth

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

void

setImageBasedLightingEnabled

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

void

setImageBasedLightingEnvironment

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

void

setImageBasedLightingIntensity

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

void

setImageBasedLightingOrientation

IView.setImageBasedLightingOrientation(value)
Arguments:
Return type:

void

setInitialCamera

IView.setInitialCamera(camera)
Arguments:
Return type:

void

setInteractiveDrawDelay

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

Promise <void>

setInteractiveDrawLimitIncreaseEnabled

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

void

setLightingEnabled

IView.setLightingEnabled([enabled])
Arguments:
  • enabled (boolean()) – optional None
Return type:

Promise <void>

setLineJitterEnabled

IView.setLineJitterEnabled([value])
Arguments:
  • value (boolean()) – optional None
Return type:

void

setLineJitterFrequency

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

void

setLineJitterInstanceCount

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

void

setLineJitterRadius

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

void

setLineVisibility

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

Promise <void>

setMassageExtremeCameras

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

void

setMinimumFramerate

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

void

setPointShape

IView.setPointShape(shape)
Arguments:
  • shape (PointShape()) – None
Return type:

Promise <void>

setPointSize

IView.setPointSize(size, unit)
Arguments:
  • size (number()) – None
  • unit (PointSizeUnit()) – None
Return type:

Promise <void>

setPointVisibilityTest

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

void

setProjectionMode

IView.setProjectionMode(projectionMode)
Arguments:
  • projectionMode (Projection()) – None
Return type:

void

setSilhouetteColor

IView.setSilhouetteColor(value)
Arguments:
Return type:

void

setSilhouetteEnabled

IView.setSilhouetteEnabled([value])
Arguments:
  • value (boolean()) – optional None
Return type:

void

setSilhouetteOpacity

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

void

setSilhouetteThreshold

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

void

setSilhouetteThresholdRampWidth

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

void

setSimpleReflectionAttenuation

IView.setSimpleReflectionAttenuation(nearDistance, farDistance[, unit])
Arguments:
  • nearDistance (number()) – None
  • farDistance (number()) – None
  • unit (SimpleReflectionAttenuationUnit()) – optional None
Return type:

void

setSimpleReflectionBlurInterval

IView.setSimpleReflectionBlurInterval(value[, unit])
Arguments:
  • value (number()) – None
  • unit (BlurIntervalUnit()) – optional None
Return type:

void

setSimpleReflectionBlurSamples

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

void

setSimpleReflectionEnabled

IView.setSimpleReflectionEnabled([value])
Arguments:
  • value (boolean()) – optional None
Return type:

void

setSimpleReflectionFadeAngle

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

void

setSimpleReflectionOpacity

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

void

setSimpleShadowBlurInterval

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

void

setSimpleShadowBlurSamples

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

void

setSimpleShadowColor

IView.setSimpleShadowColor(color)
Arguments:
Return type:

void

setSimpleShadowEnabled

IView.setSimpleShadowEnabled([value])
Arguments:
  • value (boolean()) – optional None
Return type:

void

setSimpleShadowInteractiveUpdateEnabled

IView.setSimpleShadowInteractiveUpdateEnabled([value])
Arguments:
  • value (boolean()) – optional None
Return type:

void

setSimpleShadowOpacity

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

void

setSimpleShadowResolution

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

void

setStatisticsDisplayVisibility

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

Promise <void>

setToonShadingBandCount

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

void

setToonShadingSpecularFactor

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

void

setTransparencyMode

IView.setTransparencyMode(mode)
Arguments:
  • mode (TransparencyMode()) – None
Return type:

void

setViewOrientation

IView.setViewOrientation(orientation[, duration[, bounding]])
Arguments:
  • orientation (ViewOrientation()) – None
  • duration (number()) – optional None
  • bounding (Box()) – optional None
Return type:

Promise <void>

setXRayColor

IView.setXRayColor(element, color[, group])
Arguments:
  • element (ElementType()) – None
  • color (Color()) – None
  • group (XRayGroup()) – optional None
Return type:

Promise <void>

setXRayOpacity

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

Promise <void>

setXRayTransparencyMode

IView.setXRayTransparencyMode(mode)
Arguments:
  • mode (TransparencyMode()) – None
Return type:

Promise <void>

startComparison

IView.startComparison(nodeIdSet1, nodeIdSet2[, config])
Arguments:
  • nodeIdSet1 ([number]()) – None
  • nodeIdSet2 ([number]()) – None
  • config (ComparisonConfig()) – optional None
Return type:

void

testPointVisibility

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

Promise <[number]>

unprojectPoint

IView.unprojectPoint(point, z)
Arguments:
  • point (Point2()) – None
  • z (number()) – None
Return type:

null | Point3

unsetDefaultCamera

IView.unsetDefaultCamera()
Return type:void

unsetXRayColor

IView.unsetXRayColor(element[, group])
Arguments:
  • element (ElementType()) – None
  • group (XRayGroup()) – optional None
Return type:

Promise <void>

updateCamera

IView.updateCamera(camera)
Arguments:
Return type:

Camera

updateLight

IView.updateLight(key, light)
Arguments:
  • key (number()) – None
  • light (Light()) – None
Return type:

void