IView

class IView()

Index

Properties

Methods

Properties

IView.axisTriad

readonly

axisTriad: AxisTriad
IView.domElements

readonly

domElements: DomElements
IView.floorplanManager

readonly

floorplanManager: FloorplanManager
IView.id

readonly

IView.inputMonitor

readonly

inputMonitor: InputMonitor
IView.navCube

readonly

navCube: NavCube
IView.operatorManager

readonly

operatorManager: OperatorManager
IView.overlayManager

readonly

overlayManager: OverlayManager

Methods

IView._setCameraPromise()
_setCameraPromise(camera: Camera, duration: number): Promise

Parameters

camera: Camera

duration: number

Returns: Promise

IView._setInitialView()
_setInitialView(duration: number): Promise

Parameters

duration: number

Returns: Promise

IView.addLight()
addLight(light: Light): Promise

Parameters

light: Light

Returns: Promise

IView.advanceIncrementalSelection()
advanceIncrementalSelection(handle: IncrementalSelectionId): Promise

Parameters

Returns: Promise

IView.beginConvexPolyhedronSelection()
beginConvexPolyhedronSelection(volumePlanes: Plane[], heuristicOrigin: Point3, config: IncrementalPickConfig): Promise

Parameters

volumePlanes: Plane[]

heuristicOrigin: Point3

config: IncrementalPickConfig

Returns: Promise

IView.beginRayDrillSelection()
beginRayDrillSelection(rayCssOrigin: Point2, rayCssBoxRadius: number, config: IncrementalPickConfig): Promise

Parameters

rayCssOrigin: Point2

rayCssBoxRadius: number

config: IncrementalPickConfig

Returns: Promise

IView.beginScreenSelectByArea()
beginScreenSelectByArea(areaCssMin: Point2, areaCssMax: Point2, config: IncrementalPickConfig): Promise

Parameters

areaCssMin: Point2

areaCssMax: Point2

config: IncrementalPickConfig

Returns: Promise

IView.beginSphereSelection()
beginSphereSelection(sphereCenter: Point3, sphereRadius: number, config: IncrementalPickConfig): Promise

Parameters

sphereCenter: Point3

sphereRadius: number

config: IncrementalPickConfig

Returns: Promise

IView.centerCameraOnNode()
centerCameraOnNode(nodeId: number, duration: number, camera: Camera): Promise

Parameters

nodeId: number

duration: number

camera: Camera

Returns: Promise

IView.clearLights()
clearLights(): void

Returns: void

IView.compositePickFromPoint()
compositePickFromPoint(point: Point2, config: PickConfig): Promise

Parameters

point: Point2

config: PickConfig

Returns: Promise

IView.endComparison()
endComparison(): void

Returns: void

IView.endIncrementalSelection()
endIncrementalSelection(handle: IncrementalSelectionId): Promise

Parameters

Returns: Promise

IView.fitBounding()
fitBounding(bounding: Box, duration: number, camera: Camera): Promise

Parameters

bounding: Box

duration: number

camera: Camera

Returns: Promise

IView.fitNodes()
fitNodes(ids: number[], duration: number): Promise

Parameters

ids: number[]

duration: number

Returns: Promise

IView.fitWorld()
fitWorld(duration: number, camera: Camera): Promise

Parameters

duration: number

camera: Camera

Returns: Promise

IView.getAmbientLightColor()
getAmbientLightColor(): Color

Returns: Color

IView.getAmbientOcclusionEnabled()
getAmbientOcclusionEnabled(): boolean

Returns: boolean

IView.getAmbientOcclusionRadius()
getAmbientOcclusionRadius(): number

Returns: number

IView.getAntiAliasingMode()
getAntiAliasingMode(): AntiAliasingMode

Returns: AntiAliasingMode

IView.getAxisTriad()
getAxisTriad(): AxisTriad

Returns: AxisTriad

IView.getBackfacesVisible()
getBackfacesVisible(): boolean

Returns: boolean

IView.getBackgroundColor()
getBackgroundColor(): VerticalGradient

Returns: VerticalGradient

IView.getBloomEnabled()
getBloomEnabled(): boolean

Returns: boolean

IView.getBloomIntensityScale()
getBloomIntensityScale(): number

Returns: number

IView.getBloomLayers()
getBloomLayers(): BloomLayerInfo[]

Returns: BloomLayerInfo[]

IView.getBloomThreshold()
getBloomThreshold(): number

Returns: number

IView.getBloomThresholdRampWidth()
getBloomThresholdRampWidth(): number

Returns: number

IView.getBoundingCalculationIgnoresInvisible()
getBoundingCalculationIgnoresInvisible(): boolean

Returns: boolean

IView.getCamera()
getCamera(): Camera

Returns: Camera

IView.getCanvasSize()
getCanvasSize(): Point2

Returns: Point2

IView.getDrawMode()
getDrawMode(): DrawMode

Returns: DrawMode

IView.getDrawStrategy()
getDrawStrategy(): DrawStrategy

Returns: DrawStrategy

IView.getEyeDomeLightingBlurEdgeDistance()
getEyeDomeLightingBlurEdgeDistance(): Promise

Returns: Promise

IView.getEyeDomeLightingBlurInterval()
getEyeDomeLightingBlurInterval(): Promise

Returns: Promise

IView.getEyeDomeLightingBlurSamples()
getEyeDomeLightingBlurSamples(): Promise

Returns: Promise

IView.getEyeDomeLightingEnabled()
getEyeDomeLightingEnabled(): Promise

Returns: Promise

IView.getEyeDomeLightingOpacity()
getEyeDomeLightingOpacity(): Promise

Returns: Promise

IView.getEyeDomeLightingShadingEdgeDistance()
getEyeDomeLightingShadingEdgeDistance(): Promise

Returns: Promise

IView.getFaceVisibility()
getFaceVisibility(): boolean

Returns: boolean

IView.getFullCameraMatrix()
getFullCameraMatrix(): Matrix

Returns: Matrix

IView.getGoochBaseColorProminence()
getGoochBaseColorProminence(): number

Returns: number

IView.getGoochBlue()
getGoochBlue(): number

Returns: number

IView.getGoochLuminanceShiftStrength()
getGoochLuminanceShiftStrength(): number

Returns: number

IView.getGoochYellow()
getGoochYellow(): number

Returns: number

IView.getGroundPlane()
getGroundPlane(): GroundPlane

Returns: GroundPlane

IView.getHardEdgeColor()
getHardEdgeColor(): Color

Returns: Color

IView.getHardEdgeOpacity()
getHardEdgeOpacity(): number

Returns: number

IView.getHardEdgesEnabled()
getHardEdgesEnabled(): boolean

Returns: boolean

IView.getHardEdgeThreshold()
getHardEdgeThreshold(): number

Returns: number

IView.getHardEdgeThresholdRampWidth()
getHardEdgeThresholdRampWidth(): number

Returns: number

IView.getHiddenLineSettings()
getHiddenLineSettings(): HiddenLineSettings

Returns: HiddenLineSettings

IView.getImageBasedLightingEnabled()
getImageBasedLightingEnabled(): boolean

Returns: boolean

IView.getImageBasedLightingIntensity()
getImageBasedLightingIntensity(): number

Returns: number

IView.getImageBasedLightingOrientation()
getImageBasedLightingOrientation(): ImageBasedLightingOrientation

Returns: ImageBasedLightingOrientation

IView.getInteractiveDrawLimitIncreaseEnabled()
getInteractiveDrawLimitIncreaseEnabled(): Promise

Returns: Promise

IView.getLight()
getLight(key: number): Promise

Parameters

key: number

Returns: Promise

IView.getLightingEnabled()
getLightingEnabled(): boolean

Returns: boolean

IView.getLightKeys()
getLightKeys(): Promise

Returns: Promise

IView.getLineJitterEnabled()
getLineJitterEnabled(): boolean

Returns: boolean

IView.getLineJitterFrequency()
getLineJitterFrequency(): number

Returns: number

IView.getLineJitterInstanceCount()
getLineJitterInstanceCount(): number

Returns: number

IView.getLineJitterRadius()
getLineJitterRadius(): number

Returns: number

IView.getLineVisibility()
getLineVisibility(): boolean

Returns: boolean

IView.getMassageExtremeCameras()
getMassageExtremeCameras(): boolean

Returns: boolean

IView.getNavCube()
getNavCube(): NavCube

Returns: NavCube

IView.getPointShape()
getPointShape(): Promise

Returns: Promise

IView.getPointSize()
getPointSize(): Promise

Returns: Promise

IView.getProjectionMatrix()
getProjectionMatrix(): Matrix

Returns: Matrix

IView.getProjectionMode()
getProjectionMode(): Projection

Returns: Projection

IView.getSilhouetteColor()
getSilhouetteColor(): Color

Returns: Color

IView.getSilhouetteEnabled()
getSilhouetteEnabled(): boolean

Returns: boolean

IView.getSilhouetteOpacity()
getSilhouetteOpacity(): number

Returns: number

IView.getSilhouetteThreshold()
getSilhouetteThreshold(): number

Returns: number

IView.getSilhouetteThresholdRampWidth()
getSilhouetteThresholdRampWidth(): number

Returns: number

IView.getSimpleReflectionAttenuation()
getSimpleReflectionAttenuation(): SimpleReflectionAttenuation

Returns: SimpleReflectionAttenuation

IView.getSimpleReflectionBlurInterval()
getSimpleReflectionBlurInterval(): [number, BlurIntervalUnit]

Returns: [number, BlurIntervalUnit]

IView.getSimpleReflectionBlurSamples()
getSimpleReflectionBlurSamples(): number

Returns: number

IView.getSimpleReflectionEnabled()
getSimpleReflectionEnabled(): boolean

Returns: boolean

IView.getSimpleReflectionFadeAngle()
getSimpleReflectionFadeAngle(): number

Returns: number

IView.getSimpleReflectionOpacity()
getSimpleReflectionOpacity(): number

Returns: number

IView.getSimpleShadowBlurInterval()
getSimpleShadowBlurInterval(): number

Returns: number

IView.getSimpleShadowBlurSamples()
getSimpleShadowBlurSamples(): number

Returns: number

IView.getSimpleShadowColor()
getSimpleShadowColor(): Color

Returns: Color

IView.getSimpleShadowEnabled()
getSimpleShadowEnabled(): boolean

Returns: boolean

IView.getSimpleShadowInteractiveUpdateEnabled()
getSimpleShadowInteractiveUpdateEnabled(): boolean

Returns: boolean

IView.getSimpleShadowOpacity()
getSimpleShadowOpacity(): number

Returns: number

IView.getSimpleShadowResolution()
getSimpleShadowResolution(): number

Returns: number

IView.getToonShadingBandCount()
getToonShadingBandCount(): number

Returns: number

IView.getToonShadingSpecularFactor()
getToonShadingSpecularFactor(): number

Returns: number

IView.getViewMatrix()
getViewMatrix(): Matrix

Returns: Matrix

IView.getViewOrientationCamera()
getViewOrientationCamera(orientation: ViewOrientation, bounding: Box, preserveModelUp: boolean): Promise

Parameters

orientation: ViewOrientation

bounding: Box

preserveModelUp: boolean

Returns: Promise

IView.injectViewOrientationChangeEvent()
injectViewOrientationChangeEvent(): void

Returns: void

IView.isolateNodes()
isolateNodes(nodeIds: number[], duration: number, fitNodes: boolean, initiallyHiddenStayHidden: (None | boolean)): Promise

Parameters

nodeIds: number[]

duration: number

fitNodes: boolean

initiallyHiddenStayHidden: (None | boolean)

Returns: Promise

IView.pickAllFromPoint()
pickAllFromPoint(point: Point2, config: PickConfig): Promise

Parameters

point: Point2

config: PickConfig

Returns: Promise

IView.pickAllFromRay()
pickAllFromRay(ray: Ray, config: PickConfig): Promise

Parameters

ray: Ray

config: PickConfig

Returns: Promise

IView.pickFromPoint()
pickFromPoint(point: Point2, config: PickConfig): Promise

Parameters

point: Point2

config: PickConfig

Returns: Promise

IView.pickFromRay()
pickFromRay(ray: Ray, config: PickConfig): Promise

Parameters

ray: Ray

config: PickConfig

Returns: Promise

IView.pointToWindowPosition()
pointToWindowPosition(pt: Point2): Point2

Parameters

pt: Point2

Returns: Point2

IView.projectPoint()
projectPoint(source: Point3, camera: Camera): Point3

Parameters

source: Point3

camera: Camera

Returns: Point3

IView.raycastFromPoint()
raycastFromPoint(point: Point2): (None | Ray)

Parameters

point: Point2

Returns: (None | Ray)

IView.redraw()
redraw(callback: () => void): void

Parameters

callback: () => void

Returns: void

IView.removeLight()
removeLight(key: number): void

Parameters

key: number

Returns: void

IView.resetCamera()
resetCamera(duration: number): Promise

Parameters

duration: number

Returns: Promise

IView.setAmbientLightColor()
setAmbientLightColor(value: Color): void

Parameters

value: Color

Returns: void

IView.setAmbientOcclusionEnabled()
setAmbientOcclusionEnabled(enabled: boolean): Promise

Parameters

enabled: boolean

Returns: Promise

IView.setAmbientOcclusionRadius()
setAmbientOcclusionRadius(radius: number): Promise

Parameters

radius: number

Returns: Promise

IView.setAntiAliasingMode()
setAntiAliasingMode(antiAliasingMode: AntiAliasingMode): Promise

Parameters

antiAliasingMode: AntiAliasingMode

Returns: Promise

IView.setBackfacesVisible()
setBackfacesVisible(visible: boolean): Promise

Parameters

visible: boolean

Returns: Promise

IView.setBackgroundColor()
setBackgroundColor(top: (None | Color), bottom: (None | Color)): Promise

Parameters

top: (None | Color)

bottom: (None | Color)

Returns: Promise

IView.setBloomEnabled()
setBloomEnabled(value: boolean): void

Parameters

value: boolean

Returns: void

IView.setBloomIntensityScale()
setBloomIntensityScale(value: number): void

Parameters

value: number

Returns: void

IView.setBloomLayers()
setBloomLayers(layers: BloomLayerInfo[]): void

Parameters

layers: BloomLayerInfo[]

Returns: void

IView.setBloomThreshold()
setBloomThreshold(value: number): void

Parameters

value: number

Returns: void

IView.setBloomThresholdRampWidth()
setBloomThresholdRampWidth(value: number): void

Parameters

value: number

Returns: void

IView.setBoundingCalculationIgnoresInvisible()
setBoundingCalculationIgnoresInvisible(value: boolean): void

Parameters

value: boolean

Returns: void

IView.setCamera()
setCamera(camera: (None | Camera), duration: number): boolean

Parameters

camera: (None | Camera)

duration: number

Returns: boolean

IView.setDisplayIncompleteFrames()
setDisplayIncompleteFrames(value: boolean): Promise

Parameters

value: boolean

Returns: Promise

IView.setDrawMode()
setDrawMode(drawMode: DrawMode): Promise

Parameters

drawMode: DrawMode

Returns: Promise

IView.setEyeDomeLightingBlurEdgeDistance()
setEyeDomeLightingBlurEdgeDistance(value: number): Promise

Parameters

value: number

Returns: Promise

IView.setEyeDomeLightingBlurInterval()
setEyeDomeLightingBlurInterval(value: number): Promise

Parameters

value: number

Returns: Promise

IView.setEyeDomeLightingBlurSamples()
setEyeDomeLightingBlurSamples(value: number): Promise

Parameters

value: number

Returns: Promise

IView.setEyeDomeLightingEnabled()
setEyeDomeLightingEnabled(enabled: boolean): Promise

Parameters

enabled: boolean

Returns: Promise

IView.setEyeDomeLightingOpacity()
setEyeDomeLightingOpacity(value: number): Promise

Parameters

value: number

Returns: Promise

IView.setEyeDomeLightingShadingEdgeDistance()
setEyeDomeLightingShadingEdgeDistance(value: number): Promise

Parameters

value: number

Returns: Promise

IView.setFaceVisibility()
setFaceVisibility(faceVisibility: boolean): Promise

Parameters

faceVisibility: boolean

Returns: Promise

IView.setGoochBaseColorProminence()
setGoochBaseColorProminence(prominence: number): void

Parameters

prominence: number

Returns: void

IView.setGoochBlue()
setGoochBlue(blue: number): void

Parameters

blue: number

Returns: void

IView.setGoochLuminanceShiftStrength()
setGoochLuminanceShiftStrength(shiftStrength: number): void

Parameters

shiftStrength: number

Returns: void

IView.setGoochYellow()
setGoochYellow(yellow: number): void

Parameters

yellow: number

Returns: void

IView.setGroundPlane()
setGroundPlane(plane: GroundPlane): void

Parameters

Returns: void

IView.setHardEdgeColor()
setHardEdgeColor(value: Color): void

Parameters

value: Color

Returns: void

IView.setHardEdgeOpacity()
setHardEdgeOpacity(value: number): void

Parameters

value: number

Returns: void

IView.setHardEdgesEnabled()
setHardEdgesEnabled(value: boolean): void

Parameters

value: boolean

Returns: void

IView.setHardEdgeThreshold()
setHardEdgeThreshold(degrees: number): void

Parameters

degrees: number

Returns: void

IView.setHardEdgeThresholdRampWidth()
setHardEdgeThresholdRampWidth(degrees: number): void

Parameters

degrees: number

Returns: void

IView.setImageBasedLightingEnabled()
setImageBasedLightingEnabled(value: boolean): void

Parameters

value: boolean

Returns: void

IView.setImageBasedLightingEnvironment()
setImageBasedLightingEnvironment(data: (None | Uint8Array)): void

Parameters

data: (None | Uint8Array)

Returns: void

IView.setImageBasedLightingIntensity()
setImageBasedLightingIntensity(value: number): void

Parameters

value: number

Returns: void

IView.setImageBasedLightingOrientation()
setImageBasedLightingOrientation(value: ImageBasedLightingOrientation): void

Parameters

Returns: void

IView.setInitialCamera()
setInitialCamera(camera: Camera): void

Parameters

camera: Camera

Returns: void

IView.setInteractiveDrawDelay()
setInteractiveDrawDelay(value: number): Promise

Parameters

value: number

Returns: Promise

IView.setInteractiveDrawLimitIncreaseEnabled()
setInteractiveDrawLimitIncreaseEnabled(enable: boolean): void

Parameters

enable: boolean

Returns: void

IView.setLightingEnabled()
setLightingEnabled(enabled: boolean): Promise

Parameters

enabled: boolean

Returns: Promise

IView.setLineJitterEnabled()
setLineJitterEnabled(value: boolean): void

Parameters

value: boolean

Returns: void

IView.setLineJitterFrequency()
setLineJitterFrequency(value: number): void

Parameters

value: number

Returns: void

IView.setLineJitterInstanceCount()
setLineJitterInstanceCount(value: number): void

Parameters

value: number

Returns: void

IView.setLineJitterRadius()
setLineJitterRadius(value: number): void

Parameters

value: number

Returns: void

IView.setLineVisibility()
setLineVisibility(lineVisibility: boolean): Promise

Parameters

lineVisibility: boolean

Returns: Promise

IView.setMassageExtremeCameras()
setMassageExtremeCameras(value: boolean): void

Parameters

value: boolean

Returns: void

IView.setMinimumFramerate()
setMinimumFramerate(minimum: number): void

Parameters

minimum: number

Returns: void

IView.setPointShape()
setPointShape(shape: PointShape): Promise

Parameters

shape: PointShape

Returns: Promise

IView.setPointSize()
setPointSize(size: number, unit: PointSizeUnit): Promise

Parameters

size: number

unit: PointSizeUnit

Returns: Promise

IView.setPointVisibilityTest()
setPointVisibilityTest(points: Point3[]): void

Parameters

points: Point3[]

Returns: void

IView.setProjectionMode()
setProjectionMode(projectionMode: Projection): void

Parameters

projectionMode: Projection

Returns: void

IView.setSilhouetteColor()
setSilhouetteColor(value: Color): void

Parameters

value: Color

Returns: void

IView.setSilhouetteEnabled()
setSilhouetteEnabled(value: boolean): void

Parameters

value: boolean

Returns: void

IView.setSilhouetteOpacity()
setSilhouetteOpacity(value: number): void

Parameters

value: number

Returns: void

IView.setSilhouetteThreshold()
setSilhouetteThreshold(value: number): void

Parameters

value: number

Returns: void

IView.setSilhouetteThresholdRampWidth()
setSilhouetteThresholdRampWidth(value: number): void

Parameters

value: number

Returns: void

IView.setSimpleReflectionAttenuation()
setSimpleReflectionAttenuation(nearDistance: number, farDistance: number, unit: SimpleReflectionAttenuationUnit): void

Parameters

nearDistance: number

farDistance: number

unit: SimpleReflectionAttenuationUnit

Returns: void

IView.setSimpleReflectionBlurInterval()
setSimpleReflectionBlurInterval(value: number, unit: BlurIntervalUnit): void

Parameters

value: number

unit: BlurIntervalUnit

Returns: void

IView.setSimpleReflectionBlurSamples()
setSimpleReflectionBlurSamples(value: number): void

Parameters

value: number

Returns: void

IView.setSimpleReflectionEnabled()
setSimpleReflectionEnabled(value: boolean): void

Parameters

value: boolean

Returns: void

IView.setSimpleReflectionFadeAngle()
setSimpleReflectionFadeAngle(degrees: number): void

Parameters

degrees: number

Returns: void

IView.setSimpleReflectionOpacity()
setSimpleReflectionOpacity(value: number): void

Parameters

value: number

Returns: void

IView.setSimpleShadowBlurInterval()
setSimpleShadowBlurInterval(value: number): void

Parameters

value: number

Returns: void

IView.setSimpleShadowBlurSamples()
setSimpleShadowBlurSamples(value: number): void

Parameters

value: number

Returns: void

IView.setSimpleShadowColor()
setSimpleShadowColor(color: Color): void

Parameters

color: Color

Returns: void

IView.setSimpleShadowEnabled()
setSimpleShadowEnabled(value: boolean): void

Parameters

value: boolean

Returns: void

IView.setSimpleShadowInteractiveUpdateEnabled()
setSimpleShadowInteractiveUpdateEnabled(value: boolean): void

Parameters

value: boolean

Returns: void

IView.setSimpleShadowOpacity()
setSimpleShadowOpacity(opacity: number): void

Parameters

opacity: number

Returns: void

IView.setSimpleShadowResolution()
setSimpleShadowResolution(pixels: number): void

Parameters

pixels: number

Returns: void

IView.setStatisticsDisplayVisibility()
setStatisticsDisplayVisibility(visibility: boolean): Promise

Parameters

visibility: boolean

Returns: Promise

IView.setToonShadingBandCount()
setToonShadingBandCount(bandCount: number): void

Parameters

bandCount: number

Returns: void

IView.setToonShadingSpecularFactor()
setToonShadingSpecularFactor(specularFactor: number): void

Parameters

specularFactor: number

Returns: void

IView.setTransparencyMode()
setTransparencyMode(mode: TransparencyMode): void

Parameters

Returns: void

IView.setViewOrientation()
setViewOrientation(orientation: ViewOrientation, duration: number, bounding: Box): Promise

Parameters

orientation: ViewOrientation

duration: number

bounding: Box

Returns: Promise

IView.setXRayColor()
setXRayColor(element: ElementType, color: Color, group: XRayGroup): Promise

Parameters

element: ElementType

color: Color

group: XRayGroup

Returns: Promise

IView.setXRayOpacity()
setXRayOpacity(opacity: number, element: ElementType): Promise

Parameters

opacity: number

element: ElementType

Returns: Promise

IView.setXRayTransparencyMode()
setXRayTransparencyMode(mode: TransparencyMode): Promise

Parameters

Returns: Promise

IView.startComparison()
startComparison(nodeIdSet1: number[], nodeIdSet2: number[], config: ComparisonConfig): void

Parameters

nodeIdSet1: number[]

nodeIdSet2: number[]

config: ComparisonConfig

Returns: void

IView.testPointVisibility()
testPointVisibility(points: Point3[]): Promise

Parameters

points: Point3[]

Returns: Promise

IView.unprojectPoint()
unprojectPoint(point: Point2, z: number): (None | Point3)

Parameters

point: Point2

z: number

Returns: (None | Point3)

IView.unsetDefaultCamera()
unsetDefaultCamera(): void

Returns: void

IView.unsetXRayColor()
unsetXRayColor(element: ElementType, group: XRayGroup): Promise

Parameters

element: ElementType

group: XRayGroup

Returns: Promise

IView.updateCamera()
updateCamera(camera: Camera): Camera

Parameters

camera: Camera

Returns: Camera

IView.updateLight()
updateLight(key: number, light: Light): void

Parameters

key: number

light: Light

Returns: void