IView
-
class
IView()
Properties
Methods
_setCameraPromise()_setInitialView()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
-
IView.axisTriad Type: AxisTriad()
-
IView.domElements Type: DomElements()
-
IView.floorplanManager Type: FloorplanManager()
-
IView.id Type: ViewKey
-
IView.inputMonitor Type: InputMonitor()
Type: NavCube()
-
IView.operatorManager Type: OperatorManager()
-
IView.overlayManager Type: OverlayManager()
Methods
_setCameraPromise
_setInitialView
-
IView._setInitialView(duration) Arguments: - duration (
number()) – None
Return type: Promise <void>
- duration (
advanceIncrementalSelection
-
IView.advanceIncrementalSelection(handle) Arguments: - handle (
IncrementalSelectionId()) – None
Return type: Promise <[
NodeSelectionItem()] | null>- handle (
beginConvexPolyhedronSelection
-
IView.beginConvexPolyhedronSelection(volumePlanes, heuristicOrigin, config) Arguments: - volumePlanes ([Plane]) – None
- heuristicOrigin (
Point3()) – None - config (
IncrementalPickConfig()) – None
Return type: Promise <
IncrementalSelectionId()>
beginRayDrillSelection
-
IView.beginRayDrillSelection(rayCssOrigin, rayCssBoxRadius, config) Arguments: - rayCssOrigin (
Point2()) – None - rayCssBoxRadius (
number()) – None - config (
IncrementalPickConfig()) – None
Return type: Promise <
IncrementalSelectionId()>- rayCssOrigin (
beginScreenSelectByArea
-
IView.beginScreenSelectByArea(areaCssMin, areaCssMax, config) Arguments: - areaCssMin (
Point2()) – None - areaCssMax (
Point2()) – None - config (
IncrementalPickConfig()) – None
Return type: Promise <
IncrementalSelectionId()>- areaCssMin (
beginSphereSelection
-
IView.beginSphereSelection(sphereCenter, sphereRadius, config) Arguments: - sphereCenter (
Point3()) – None - sphereRadius (
number()) – None - config (
IncrementalPickConfig()) – None
Return type: Promise <
IncrementalSelectionId()>- sphereCenter (
centerCameraOnNode
compositePickFromPoint
-
IView.compositePickFromPoint(point, config) Arguments: - point (
Point2()) – None - config (
PickConfig()) – None
Return type: Promise <
CompositeSelectionItem()>- point (
endIncrementalSelection
-
IView.endIncrementalSelection(handle) Arguments: - handle (
IncrementalSelectionId()) – None
Return type: Promise <void>
- handle (
fitBounding
fitNodes
fitWorld
getAntiAliasingMode
-
IView.getAntiAliasingMode() Return type: AntiAliasingMode
getAxisTriad
-
IView.getAxisTriad() Return type: AxisTriad()
getBackgroundColor
-
IView.getBackgroundColor() Return type: VerticalGradient()
getBloomLayers
-
IView.getBloomLayers() Return type: [ BloomLayerInfo()]
getBoundingCalculationIgnoresInvisible
-
IView.getBoundingCalculationIgnoresInvisible() Return type: boolean
getDrawStrategy
-
IView.getDrawStrategy() Return type: DrawStrategy
getEyeDomeLightingBlurEdgeDistance
-
IView.getEyeDomeLightingBlurEdgeDistance() Return type: Promise <number>
getEyeDomeLightingBlurInterval
-
IView.getEyeDomeLightingBlurInterval() Return type: Promise <number>
getEyeDomeLightingShadingEdgeDistance
-
IView.getEyeDomeLightingShadingEdgeDistance() Return type: Promise <number>
getGroundPlane
-
IView.getGroundPlane() Return type: GroundPlane()
getImageBasedLightingOrientation
-
IView.getImageBasedLightingOrientation() Return type: ImageBasedLightingOrientation()
getInteractiveDrawLimitIncreaseEnabled
-
IView.getInteractiveDrawLimitIncreaseEnabled() Return type: Promise <boolean>
getLight
getPointShape
-
IView.getPointShape() Return type: Promise <PointShape>
getPointSize
-
IView.getPointSize() Return type: Promise <(number, PointSizeUnit)>
getProjectionMode
-
IView.getProjectionMode() Return type: Projection
getSimpleReflectionAttenuation
-
IView.getSimpleReflectionAttenuation() Return type: SimpleReflectionAttenuation()
getSimpleReflectionBlurInterval
-
IView.getSimpleReflectionBlurInterval() Return type: (number, BlurIntervalUnit)
getSimpleShadowInteractiveUpdateEnabled
-
IView.getSimpleShadowInteractiveUpdateEnabled() Return type: boolean
getViewOrientationCamera
-
IView.getViewOrientationCamera(orientation[, bounding[, preserveModelUp]]) Arguments: - orientation (ViewOrientation) – None
- bounding (
Box()) – optional None - preserveModelUp (
boolean()) – optional None
Return type: Promise <
Camera()>
isolateNodes
pickAllFromPoint
-
IView.pickAllFromPoint(point, config) Arguments: - point (
Point2()) – None - config (
PickConfig()) – None
Return type: Promise <[
NodeEntitySelectionItem()]>- point (
pickAllFromRay
-
IView.pickAllFromRay(ray, config) Arguments: - ray (
Ray()) – None - config (
PickConfig()) – None
Return type: Promise <[
NodeEntitySelectionItem()]>- ray (
pickFromPoint
-
IView.pickFromPoint(point, config) Arguments: - point (
Point2()) – None - config (
PickConfig()) – None
Return type: Promise <
SelectionItem()>- point (
pickFromRay
-
IView.pickFromRay(ray, config) Arguments: - ray (
Ray()) – None - config (
PickConfig()) – None
Return type: Promise <
SelectionItem()>- ray (
pointToWindowPosition
projectPoint
raycastFromPoint
redraw
-
IView.redraw([callback]) Arguments: - callback (
function()) – optional None
Return type: void
-
IView.callback() Return type: void
- callback (
resetCamera
-
IView.resetCamera([duration]) Arguments: - duration (
number()) – optional None
Return type: Promise <void>
- duration (
setAmbientLightColor
setAmbientOcclusionEnabled
-
IView.setAmbientOcclusionEnabled([enabled]) Arguments: - enabled (
boolean()) – optional None
Return type: Promise <void>
- enabled (
setAmbientOcclusionRadius
-
IView.setAmbientOcclusionRadius(radius) Arguments: - radius (
number()) – None
Return type: Promise <void>
- radius (
setAntiAliasingMode
-
IView.setAntiAliasingMode(antiAliasingMode) Arguments: - antiAliasingMode (AntiAliasingMode) – None
Return type: Promise <void>
setBackfacesVisible
-
IView.setBackfacesVisible(visible) Arguments: - visible (
boolean()) – None
Return type: Promise <void>
- visible (
setBackgroundColor
setBloomEnabled
-
IView.setBloomEnabled([value]) Arguments: - value (
boolean()) – optional None
Return type: void
- value (
setBloomIntensityScale
-
IView.setBloomIntensityScale(value) Arguments: - value (
number()) – None
Return type: void
- value (
setBloomLayers
-
IView.setBloomLayers(layers) Arguments: - layers ([
BloomLayerInfo()]) – None
Return type: void
- layers ([
setBloomThreshold
-
IView.setBloomThreshold(value) Arguments: - value (
number()) – None
Return type: void
- value (
setBloomThresholdRampWidth
-
IView.setBloomThresholdRampWidth(value) Arguments: - value (
number()) – None
Return type: void
- value (
setBoundingCalculationIgnoresInvisible
-
IView.setBoundingCalculationIgnoresInvisible(value) Arguments: - value (
boolean()) – None
Return type: void
- value (
setCamera
setDisplayIncompleteFrames
-
IView.setDisplayIncompleteFrames(value) Arguments: - value (
boolean()) – None
Return type: Promise <void>
- value (
setDrawMode
setEyeDomeLightingBlurEdgeDistance
-
IView.setEyeDomeLightingBlurEdgeDistance(value) Arguments: - value (
number()) – None
Return type: Promise <void>
- value (
setEyeDomeLightingBlurInterval
-
IView.setEyeDomeLightingBlurInterval(value) Arguments: - value (
number()) – None
Return type: Promise <void>
- value (
setEyeDomeLightingBlurSamples
-
IView.setEyeDomeLightingBlurSamples(value) Arguments: - value (
number()) – None
Return type: Promise <void>
- value (
setEyeDomeLightingEnabled
-
IView.setEyeDomeLightingEnabled([enabled]) Arguments: - enabled (
boolean()) – optional None
Return type: Promise <void>
- enabled (
setEyeDomeLightingOpacity
-
IView.setEyeDomeLightingOpacity(value) Arguments: - value (
number()) – None
Return type: Promise <void>
- value (
setEyeDomeLightingShadingEdgeDistance
-
IView.setEyeDomeLightingShadingEdgeDistance(value) Arguments: - value (
number()) – None
Return type: Promise <void>
- value (
setFaceVisibility
-
IView.setFaceVisibility(faceVisibility) Arguments: - faceVisibility (
boolean()) – None
Return type: Promise <void>
- faceVisibility (
setGoochBaseColorProminence
-
IView.setGoochBaseColorProminence(prominence) Arguments: - prominence (
number()) – None
Return type: void
- prominence (
setGoochLuminanceShiftStrength
-
IView.setGoochLuminanceShiftStrength(shiftStrength) Arguments: - shiftStrength (
number()) – None
Return type: void
- shiftStrength (
setGroundPlane
-
IView.setGroundPlane(plane) Arguments: - plane (
GroundPlane()) – None
Return type: void
- plane (
setHardEdgeOpacity
-
IView.setHardEdgeOpacity(value) Arguments: - value (
number()) – None
Return type: void
- value (
setHardEdgeThreshold
-
IView.setHardEdgeThreshold(degrees) Arguments: - degrees (
number()) – None
Return type: void
- degrees (
setHardEdgeThresholdRampWidth
-
IView.setHardEdgeThresholdRampWidth(degrees) Arguments: - degrees (
number()) – None
Return type: void
- degrees (
setHardEdgesEnabled
-
IView.setHardEdgesEnabled([value]) Arguments: - value (
boolean()) – optional None
Return type: void
- value (
setImageBasedLightingEnabled
-
IView.setImageBasedLightingEnabled(value) Arguments: - value (
boolean()) – None
Return type: void
- value (
setImageBasedLightingEnvironment
-
IView.setImageBasedLightingEnvironment(data) Arguments: - data (
Uint8Array | null()) – None
Return type: void
- data (
setImageBasedLightingIntensity
-
IView.setImageBasedLightingIntensity(value) Arguments: - value (
number()) – None
Return type: void
- value (
setImageBasedLightingOrientation
-
IView.setImageBasedLightingOrientation(value) Arguments: - value (
ImageBasedLightingOrientation()) – None
Return type: void
- value (
setInitialCamera
setInteractiveDrawDelay
-
IView.setInteractiveDrawDelay(value) Arguments: - value (
number()) – None
Return type: Promise <void>
- value (
setInteractiveDrawLimitIncreaseEnabled
-
IView.setInteractiveDrawLimitIncreaseEnabled(enable) Arguments: - enable (
boolean()) – None
Return type: void
- enable (
setLightingEnabled
-
IView.setLightingEnabled([enabled]) Arguments: - enabled (
boolean()) – optional None
Return type: Promise <void>
- enabled (
setLineJitterEnabled
-
IView.setLineJitterEnabled([value]) Arguments: - value (
boolean()) – optional None
Return type: void
- value (
setLineJitterFrequency
-
IView.setLineJitterFrequency(value) Arguments: - value (
number()) – None
Return type: void
- value (
setLineJitterInstanceCount
-
IView.setLineJitterInstanceCount(value) Arguments: - value (
number()) – None
Return type: void
- value (
setLineJitterRadius
-
IView.setLineJitterRadius(value) Arguments: - value (
number()) – None
Return type: void
- value (
setLineVisibility
-
IView.setLineVisibility(lineVisibility) Arguments: - lineVisibility (
boolean()) – None
Return type: Promise <void>
- lineVisibility (
setMassageExtremeCameras
-
IView.setMassageExtremeCameras(value) Arguments: - value (
boolean()) – None
Return type: void
- value (
setMinimumFramerate
-
IView.setMinimumFramerate(minimum) Arguments: - minimum (
number()) – None
Return type: void
- minimum (
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>
- size (
setPointVisibilityTest
-
IView.setPointVisibilityTest(points) Arguments: - points (
[Point3]()) – None
Return type: void
- points (
setProjectionMode
-
IView.setProjectionMode(projectionMode) Arguments: - projectionMode (Projection) – None
Return type: void
setSilhouetteColor
setSilhouetteEnabled
-
IView.setSilhouetteEnabled([value]) Arguments: - value (
boolean()) – optional None
Return type: void
- value (
setSilhouetteOpacity
-
IView.setSilhouetteOpacity(value) Arguments: - value (
number()) – None
Return type: void
- value (
setSilhouetteThreshold
-
IView.setSilhouetteThreshold(value) Arguments: - value (
number()) – None
Return type: void
- value (
setSilhouetteThresholdRampWidth
-
IView.setSilhouetteThresholdRampWidth(value) Arguments: - value (
number()) – None
Return type: void
- value (
setSimpleReflectionAttenuation
-
IView.setSimpleReflectionAttenuation(nearDistance, farDistance[, unit]) Arguments: - nearDistance (
number()) – None - farDistance (
number()) – None - unit (SimpleReflectionAttenuationUnit) – optional None
Return type: void
- nearDistance (
setSimpleReflectionBlurInterval
-
IView.setSimpleReflectionBlurInterval(value[, unit]) Arguments: - value (
number()) – None - unit (BlurIntervalUnit) – optional None
Return type: void
- value (
setSimpleReflectionBlurSamples
-
IView.setSimpleReflectionBlurSamples(value) Arguments: - value (
number()) – None
Return type: void
- value (
setSimpleReflectionEnabled
-
IView.setSimpleReflectionEnabled([value]) Arguments: - value (
boolean()) – optional None
Return type: void
- value (
setSimpleReflectionFadeAngle
-
IView.setSimpleReflectionFadeAngle(degrees) Arguments: - degrees (
number()) – None
Return type: void
- degrees (
setSimpleReflectionOpacity
-
IView.setSimpleReflectionOpacity(value) Arguments: - value (
number()) – None
Return type: void
- value (
setSimpleShadowBlurInterval
-
IView.setSimpleShadowBlurInterval(value) Arguments: - value (
number()) – None
Return type: void
- value (
setSimpleShadowBlurSamples
-
IView.setSimpleShadowBlurSamples(value) Arguments: - value (
number()) – None
Return type: void
- value (
setSimpleShadowColor
setSimpleShadowEnabled
-
IView.setSimpleShadowEnabled([value]) Arguments: - value (
boolean()) – optional None
Return type: void
- value (
setSimpleShadowInteractiveUpdateEnabled
-
IView.setSimpleShadowInteractiveUpdateEnabled([value]) Arguments: - value (
boolean()) – optional None
Return type: void
- value (
setSimpleShadowOpacity
-
IView.setSimpleShadowOpacity(opacity) Arguments: - opacity (
number()) – None
Return type: void
- opacity (
setSimpleShadowResolution
-
IView.setSimpleShadowResolution(pixels) Arguments: - pixels (
number()) – None
Return type: void
- pixels (
setStatisticsDisplayVisibility
-
IView.setStatisticsDisplayVisibility(visibility) Arguments: - visibility (
boolean()) – None
Return type: Promise <void>
- visibility (
setToonShadingBandCount
-
IView.setToonShadingBandCount(bandCount) Arguments: - bandCount (
number()) – None
Return type: void
- bandCount (
setToonShadingSpecularFactor
-
IView.setToonShadingSpecularFactor(specularFactor) Arguments: - specularFactor (
number()) – None
Return type: void
- specularFactor (
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>
- opacity (
setXRayTransparencyMode
-
IView.setXRayTransparencyMode(mode) Arguments: - mode (XRayTransparencyMode) – None
Return type: Promise <void>
startComparison
-
IView.startComparison(nodeIdSet1, nodeIdSet2[, config]) Arguments: - nodeIdSet1 ([NodeId]) – None
- nodeIdSet2 ([NodeId]) – None
- config (
ComparisonConfig()) – optional None
Return type: void
testPointVisibility
-
IView.testPointVisibility(points) Arguments: - points (
[Point3]()) – None
Return type: Promise <[number]>
- points (
unprojectPoint
unsetXRayColor
-
IView.unsetXRayColor(element[, group]) Arguments: - element (ElementType) – None
- group (XRayGroup) – optional None
Return type: Promise <void>