Class ViewObject

destroyed

Readonlyid

Readonlylayer

ReadonlyoriginalSystemId

ReadonlysceneObject

Readonlyview

viewTransform

clippable

• get clippable(): boolean

  Gets if this ViewObject is clippable.

  • Clipping is done by the SectionPlanes in View.sectionPlanes.
  • Use View.setObjectsClippable or ViewLayer.setObjectsClippable to batch-update the clippable state of multiple ViewObjects.

  Returns boolean
• set clippable(clippable: boolean): void

  Sets if this ViewObject is clippable.

  • Clipping is done by the SectionPlanes in View.sectionPlanes.
  • Use View.setObjectsClippable or ViewLayer.setObjectsClippable to batch-update the clippable state of multiple ViewObjects.

  Parameters

  • clippable: boolean

  Returns void

collidable

• get collidable(): boolean

  Gets if this ViewObject is included in boundary calculations.

  Returns boolean
• set collidable(collidable: boolean): void

  Sets if this ViewObject included in boundary calculations.

  Parameters

  • collidable: boolean

  Returns void

colorize

• get colorize(): Vec3

  Gets the RGB colorize color for this ViewObject, if set.

  • Multiplies by rendered fragment colors.
  • Each element of the color is in range [0..1].
  • Use ViewLayer.setObjectsColorized to batch-update the colorized state of ViewObjects.

  Returns Vec3
• set colorize(value: Vec3): void

  Sets the RGB colorize color for this ViewObject.

  • Multiplies by rendered fragment colors.
  • Each element of the color is in range [0..1].
  • Set to null or undefined to reset the colorize color to its default value of [1,1,1].
  • Use ViewLayer.setObjectsColorized to batch-update the colorized state of ViewObjects.

  Parameters

  • value: Vec3

  Returns void

culled

• get culled(): boolean

  Gets if this ViewObject is culled.

  • The ViewObject is only rendered when ViewObject.visible is true and ViewObject.culled is false.
  • Use ViewLayer.setObjectsCulled to batch-update the culled state of ViewObjects.

  Returns boolean
• set culled(culled: boolean): void

  Sets if this ViewObject is culled.

  • The ViewObject is only rendered when ViewObject.visible is true and ViewObject.culled is false.
  • Use ViewLayer.setObjectsCulled to batch-update the culled state of ViewObjects.

  Parameters

  • culled: boolean

  Returns void

highlighted

• get highlighted(): boolean

  Gets if this ViewObject is highlighted.

  • When ViewObject.highlighted is true the ViewObject will be registered by ViewObject.id in ViewLayer.highlightedObjects.
  • Use ViewLayer.setObjectsHighlighted to batch-update the highlighted state of ViewObjects.

  Returns boolean
• set highlighted(highlighted: boolean): void

  Sets if this ViewObject is highlighted.

  • When ViewObject.highlighted is true the ViewObject will be registered by ViewObject.id in ViewLayer.highlightedObjects.
  • Use ViewLayer.setObjectsHighlighted to batch-update the highlighted state of ViewObjects.

  Parameters

  • highlighted: boolean

  Returns void

opacity

• get opacity(): number

  Gets the opacity factor for this ViewObject.

  • This is a factor in range [0..1] which multiplies by the rendered fragment alphas.
  • Use ViewLayer.setObjectsOpacity to batch-update the opacities of ViewObjects.

  Returns number
• set opacity(opacity: number): void

  Sets the opacity factor for this ViewObject.

  • This is a factor in range [0..1] which multiplies by the rendered fragment alphas.
  • Set to null or undefined to reset the opacity to its default value of 1.
  • Use ViewLayer.setObjectsOpacity to batch-update the opacities of ViewObjects.

  Parameters

  • opacity: number

  Returns void

opacityUpdated

• get opacityUpdated(): boolean

  true when the ViewObject's opacity is currently overriding the underlying SceneMesh material's alpha — i.e. the caller has set opacity to a value (any number, including 1). Cleared when the caller passes null / undefined to the setter, returning the renderer to the material's native alpha.

  The renderer's mesh-batch state-update bridge reads this flag to distinguish "user wants opacity = 1" (override on, alpha forced to 1.0, naturally-transparent meshes routed through the opaque bin) from "user has cleared the opacity override" (read material alpha — typically how a 4D scheduler returns finished objects to their native appearance).

  Returns boolean

pickable

• get pickable(): boolean

  Gets if this ViewObject is pickable.

  • Picking is done with viewing!viewer.View.pick | View.pick.
  • Use ViewLayer.setObjectsPickable to batch-update the pickable state of ViewObjects.

  Returns boolean
• set pickable(pickable: boolean): void

  Sets if this ViewObject is pickable.

  • Picking is done with viewing!viewer.View.pick | View.pick.
  • Use ViewLayer.setObjectsPickable to batch-update the pickable state of ViewObjects.

  Parameters

  • pickable: boolean

  Returns void

selected

• get selected(): boolean

  Gets if this ViewObject is selected.

  • When ViewObject.selected is true the ViewObject will be registered by ViewObject.id in ViewLayer.selectedObjects.
  • Use ViewLayer.setObjectsSelected to batch-update the selected state of ViewObjects.

  Returns boolean
• set selected(selected: boolean): void

  Sets if this ViewObject is selected.

  • When ViewObject.selected is true the ViewObject will be registered by ViewObject.id in ViewLayer.selectedObjects.
  • Use ViewLayer.setObjectsSelected to batch-update the selected state of ViewObjects.

  Parameters

  • selected: boolean

  Returns void

visible

• get visible(): boolean

  Gets if this ViewObject is visible.

  • When ViewObject.visible is true the ViewObject will be registered by ViewObject.id in ViewLayer.visibleObjects.
  • Each ViewObject is only rendered when ViewObject.visible is true and ViewObject.culled is false.
  • Use ViewLayer.setObjectsVisible to batch-update the visibility of ViewObjects, which fires a single event for the batch.

  Returns boolean
• set visible(visible: boolean): void

  Sets if this ViewObject is visible.

  • When ViewObject.visible is true the ViewObject will be registered by ViewObject.id in ViewLayer.visibleObjects.
  • Each ViewObject is only rendered when ViewObject.visible is true and ViewObject.culled is false.
  • Fires an "objectVisibility" event on ViewerEvents.
  • Use ViewLayer.setObjectsVisible to batch-update the visibility of ViewObjects, which fires a single event for the batch.

  Parameters

  • visible: boolean

  Returns void

xrayed

• get xrayed(): boolean

  Gets if this ViewObject is X-rayed.

  • When ViewObject.xrayed is true the ViewObject will be registered by ViewObject.id in ViewLayer.xrayedObjects.
  • Use ViewLayer.setObjectsXRayed to batch-update the X-rayed state of ViewObjects.

  Returns boolean
• set xrayed(xrayed: boolean): void

  Sets if this ViewObject is X-rayed.

  • When ViewObject.xrayed is true the ViewObject will be registered by ViewObject.id in ViewLayer.xrayedObjects.
  • Use ViewLayer.setObjectsXRayed to batch-update the X-rayed state of ViewObjects.

  Parameters

  • xrayed: boolean

  Returns void