Class ViewObject

An object within a View.

Proxies a SceneObject and controls its visual state in the View.
Stored in View.objects and ViewLayer.objects.
Viewer automatically creates one of these in each View whenever a SceneObject is created.
SceneObject.layerId optionally specifies a ViewLayer to put the ViewObject in.

Overview

Every View automatically maintains within itself a ViewObject for each SceneObject that exists in the Viewer.

Whenever we create a SceneObject, each View will automatically create a corresponding ViewObject within itself. When we destroy a SceneObject, each View will automatically destroy its corresponding ViewObject. The ViewObjects in a View are therefore a manifest of the ViewerObjects in the View.

See @xeokit/sdk/viewer for usage.

Index

Properties

destroyed id layer originalSystemId sceneObject view viewTransform

Accessors

clippable collidable colorize culled highlighted opacity pickable selected visible xrayed

Properties

destroyed

destroyed: boolean = false

True if this ViewObject has been destroyed.

`Readonly`id

id: string

Unique ID of this ViewObject within ViewLayer.objects.

`Readonly`layer

layer: ViewLayer

The ViewLayer to which this ViewObject belongs.

`Readonly`originalSystemId

originalSystemId: string

ID of this ViewObject within the originating system.

`Readonly`sceneObject

sceneObject: SceneObject

The corresponding scene!SceneObject.

`Readonly`view

view: View

The View to which this ViewObject belongs.

viewTransform

viewTransform: ViewTransform

The ViewTransform that defines the local transform of this ViewObject, if any.

Accessors

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
- Defined in packages/sdk/src/viewer/ViewObject.ts:309
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
- Defined in packages/sdk/src/viewer/ViewObject.ts:319

collidable

get collidable(): boolean
Gets if this ViewObject is included in boundary calculations.

Returns boolean
- Defined in packages/sdk/src/viewer/ViewObject.ts:338
set collidable(collidable: boolean): void
Sets if this ViewObject included in boundary calculations.
Parameters
- collidable: boolean
Returns void
- Defined in packages/sdk/src/viewer/ViewObject.ts:345

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
- Defined in packages/sdk/src/viewer/ViewObject.ts:406
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
- Defined in packages/sdk/src/viewer/ViewObject.ts:418

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
- Defined in packages/sdk/src/viewer/ViewObject.ts:277
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
- Defined in packages/sdk/src/viewer/ViewObject.ts:287

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
- Defined in packages/sdk/src/viewer/ViewObject.ts:213
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
- Defined in packages/sdk/src/viewer/ViewObject.ts:223

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
- Defined in packages/sdk/src/viewer/ViewObject.ts:447
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
- Defined in packages/sdk/src/viewer/ViewObject.ts:458

pickable

get pickable(): boolean
Gets if this ViewObject is pickable.
- Picking is done with View.pick.
- Use ViewLayer.setObjectsPickable to batch-update the pickable state of ViewObjects.
Returns boolean
- Defined in packages/sdk/src/viewer/ViewObject.ts:372
set pickable(pickable: boolean): void
Sets if this ViewObject is pickable.
- Picking is done with View.pick.
- Use ViewLayer.setObjectsPickable to batch-update the pickable state of ViewObjects.
Parameters
- pickable: boolean
Returns void
- Defined in packages/sdk/src/viewer/ViewObject.ts:382

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
- Defined in packages/sdk/src/viewer/ViewObject.ts:245
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
- Defined in packages/sdk/src/viewer/ViewObject.ts:255

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
- Defined in packages/sdk/src/viewer/ViewObject.ts:130
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
- Defined in packages/sdk/src/viewer/ViewObject.ts:142

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
- Defined in packages/sdk/src/viewer/ViewObject.ts:181
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
- Defined in packages/sdk/src/viewer/ViewObject.ts:191

Class ViewObject

Overview

Index

Properties

Accessors

Properties

destroyed

Readonlyid

Readonlylayer

ReadonlyoriginalSystemId

ReadonlysceneObject

Readonlyview

viewTransform

Accessors

clippable

Returns boolean

Parameters

Returns void

collidable

Returns boolean

Parameters

Returns void

colorize

Returns Vec3

Parameters

Returns void

culled

Returns boolean

Parameters

Returns void

highlighted

Returns boolean

Parameters

Returns void

opacity

Returns number

Parameters

Returns void

pickable

Returns boolean

Parameters

Returns void

selected

Returns boolean

Parameters

Returns void

visible

Returns boolean

Parameters

Returns void

xrayed

Returns boolean

Parameters

Returns void

Settings

On This Page

`Readonly`id

`Readonly`layer

`Readonly`originalSystemId

`Readonly`sceneObject

`Readonly`view