Class ZoneController

Hierarchy

SceneMeshController<Zone>
- ZoneController

Constructors

constructor

new ZoneController(viewer: Viewer): ZoneController
Parameters
- viewer: Viewer
Returns ZoneController
Overrides SceneMeshController<Zone>.constructor
- Defined in src/viewer/core/objects/zone/ZoneController.ts:38

Properties

`Readonly`ignoreViewportRenderMode

ignoreViewportRenderMode: false

Indicates whether the mesh controller should ignore the render mode changes of the viewport

`Readonly`isSceneMeshController

isSceneMeshController: true

`Readonly`isSceneObjectController

isSceneObjectController: true

`Readonly`isZoneController

isZoneController: true

`Readonly`signals

signals: {
    onObjectAdded: ViewerSignal<(object: Zone) => void>;
    onObjectRemoved: ViewerSignal<(object: Zone) => void>;
    onObjectUpdated: ViewerSignal<(object: Zone) => void>;
    onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
} = ...

Accessors

count

get count(): number
Controller objects count

Returns number
Inherited from SceneMeshController.count
- Defined in src/viewer/core/objects/SceneObjectController.ts:45

firstObject

get firstObject(): null | TObject
Returns null | TObject
Inherited from SceneMeshController.firstObject
- Defined in src/viewer/core/objects/SceneObjectController.ts:72

uuids

get uuids(): MapIterator<string>
Iterator over all the uuids contained in the controller.

Returns MapIterator<string>
Inherited from SceneMeshController.uuids
- Defined in src/viewer/core/objects/SceneObjectController.ts:115

visible

get visible(): boolean
Returns boolean
Inherited from SceneMeshController.visible
- Defined in src/viewer/core/objects/SceneObjectController.ts:38
set visible(value: boolean): void
Controller visibility (independant from object own visibility).

Hiding a controller will hide all its children without modifying their own visibility.
Parameters
- value: boolean
Returns void
Inherited from SceneMeshController.visible
- Defined in src/viewer/core/objects/SceneObjectController.ts:29

Methods

accepts

accepts(object: SceneObject): boolean
Indicates whether the controller accepts the SceneObject as a potential child.
Parameters
- object: SceneObject
Returns boolean
Overrides SceneMeshController.accepts
- Defined in src/viewer/core/objects/zone/ZoneController.ts:110

addObject

addObject(object: Zone, parentUuid: null | string): void
Adds the given object to the controller. Controllers may not support object hierarchy.
Parameters
- object: Zone
  The object to add.
- parentUuid: null | string
  The parent uuid of the object if the controller supports it.
Returns void
Inherited from SceneMeshController.addObject
- Defined in src/viewer/core/objects/SceneObjectController.ts:85

cleanScene

cleanScene(scene: ViewerScene): void
Callback to clean the controller from the scene
Parameters
- scene: ViewerScene
Returns void
Overrides SceneMeshController.cleanScene
- Defined in src/viewer/core/objects/zone/ZoneController.ts:84

clear

clear(): void
Clears all objects from the controller

Returns void
Overrides SceneMeshController.clear
- Defined in src/viewer/core/objects/zone/ZoneController.ts:114

containers

containers(): Generator<
    BatchedLineContainer
    | BatchedMeshContainer
    | InstancedMeshContainer,
    void,
    any,
>
Returns Generator<
    BatchedLineContainer
    | BatchedMeshContainer
    | InstancedMeshContainer,
    void,
    any,
>
Inherited from SceneMeshController.containers
- Defined in src/viewer/core/objects/mesh/SceneMeshController.ts:27

createZone

createZone(box: Box3): Zone
Parameters
- box: Box3
Returns Zone
- Defined in src/viewer/core/objects/zone/ZoneController.ts:89

dispose

dispose(): void
Disposes the controller and destroy its data

Returns void
Inherited from SceneMeshController.dispose
- Defined in src/viewer/core/objects/SceneObjectController.ts:211

edgesContainers

edgesContainers(): Generator<BatchedLineContainer, void, unknown>
Returns Generator<BatchedLineContainer, void, unknown>
Overrides SceneMeshController.edgesContainers
- Defined in src/viewer/core/objects/zone/ZoneController.ts:128

getAllHiddenObjects

getAllHiddenObjects(): Generator<Zone>
Returns a generator of hidden objects of this controller

Returns Generator<Zone>
Inherited from SceneMeshController.getAllHiddenObjects
- Defined in src/viewer/core/objects/SceneObjectController.ts:179

getAllHiddenObjectUuids

getAllHiddenObjectUuids(): Generator<string>
Returns a generator of hidden object uuids of this controller

Returns Generator<string>
Inherited from SceneMeshController.getAllHiddenObjectUuids
- Defined in src/viewer/core/objects/SceneObjectController.ts:201

getAllObjects

getAllObjects(): Generator<Zone>
Returns a generator of objects of this controller

Returns Generator<Zone>
Inherited from SceneMeshController.getAllObjects
- Defined in src/viewer/core/objects/SceneObjectController.ts:153

getAllObjectUuids

getAllObjectUuids(): Generator<string>
Returns a generator of object uuids of this controller

Returns Generator<string>
Inherited from SceneMeshController.getAllObjectUuids
- Defined in src/viewer/core/objects/SceneObjectController.ts:160

getAllVisibleObjects

getAllVisibleObjects(): Generator<Zone>
Returns a generator of visible objects of this controller

Returns Generator<Zone>
Inherited from SceneMeshController.getAllVisibleObjects
- Defined in src/viewer/core/objects/SceneObjectController.ts:167

getAllVisibleObjectUuids

getAllVisibleObjectUuids(): Generator<string>
Returns a generator if visible object uuids of this controller

Returns Generator<string>
Inherited from SceneMeshController.getAllVisibleObjectUuids
- Defined in src/viewer/core/objects/SceneObjectController.ts:191

getFirstObject

getFirstObject(): null | Zone
Returns null | Zone
Inherited from SceneMeshController.getFirstObject
- Defined in src/viewer/core/objects/SceneObjectController.ts:104

getObjectByUUID

getObjectByUUID(uuid: string): null | Zone
Returns the object associated with the given uuid if found
Parameters
- uuid: string
Returns null | Zone
Inherited from SceneMeshController.getObjectByUUID
- Defined in src/viewer/core/objects/SceneObjectController.ts:133

getObjectsByUUID

getObjectsByUUID(uuids: Iterable<string>): Generator<Zone>
Returns a generator of objects with the given uuids
Parameters
- uuids: Iterable<string>
Returns Generator<Zone>
Inherited from SceneMeshController.getObjectsByUUID
- Defined in src/viewer/core/objects/SceneObjectController.ts:141

hasObjectUUID

hasObjectUUID(uuid: string): boolean
Returns whether the controller has the given uuid
Parameters
- uuid: string
Returns boolean
Inherited from SceneMeshController.hasObjectUUID
- Defined in src/viewer/core/objects/SceneObjectController.ts:124

lineContainers

lineContainers(): Generator<never, void, unknown>
Returns Generator<never, void, unknown>
Overrides SceneMeshController.lineContainers
- Defined in src/viewer/core/objects/zone/ZoneController.ts:124

meshContainers

meshContainers(): Generator<BatchedMeshContainer, void, unknown>
Returns Generator<BatchedMeshContainer, void, unknown>
Overrides SceneMeshController.meshContainers
- Defined in src/viewer/core/objects/zone/ZoneController.ts:120

removeObject

removeObject(object: Zone): void
Removes the given object from the controller.
Parameters
- object: Zone
Returns void
Inherited from SceneMeshController.removeObject
- Defined in src/viewer/core/objects/SceneObjectController.ts:97

setClippingPlanes

setClippingPlanes(planes: Plane[]): void
Parameters
- planes: Plane[]
Returns void
Inherited from SceneMeshController.setClippingPlanes
- Defined in src/viewer/core/objects/mesh/SceneMeshController.ts:39

setEdgesVisibility

setEdgesVisibility(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshController.setEdgesVisibility
- Defined in src/viewer/core/objects/mesh/SceneMeshController.ts:54

setMeshesVisibility

setMeshesVisibility(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshController.setMeshesVisibility
- Defined in src/viewer/core/objects/mesh/SceneMeshController.ts:45

setupScene

setupScene(scene: ViewerScene): void
Callback to setup the controller into the scene
Parameters
- scene: ViewerScene
Returns void
Overrides SceneMeshController.setupScene
- Defined in src/viewer/core/objects/zone/ZoneController.ts:79

Class ZoneController

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ZoneController

Properties

ReadonlyignoreViewportRenderMode

ReadonlyisSceneMeshController

ReadonlyisSceneObjectController

ReadonlyisZoneController

Readonlysignals

Accessors

count

Returns number

firstObject

Returns null | TObject

uuids

Returns MapIterator<string>

visible

Returns boolean

Parameters

Returns void

Methods

accepts

Parameters

Returns boolean

addObject

Parameters

Returns void

cleanScene

Parameters

Returns void

clear

Returns void

containers

Returns Generator< BatchedLineContainer | BatchedMeshContainer | InstancedMeshContainer, void, any,>

createZone

Parameters

Returns Zone

dispose

Returns void

edgesContainers

Returns Generator<BatchedLineContainer, void, unknown>

getAllHiddenObjects

Returns Generator<Zone>

getAllHiddenObjectUuids

Returns Generator<string>

getAllObjects

Returns Generator<Zone>

getAllObjectUuids

Returns Generator<string>

getAllVisibleObjects

Returns Generator<Zone>

getAllVisibleObjectUuids

Returns Generator<string>

getFirstObject

Returns null | Zone

getObjectByUUID

Parameters

Returns null | Zone

getObjectsByUUID

Parameters

Returns Generator<Zone>

hasObjectUUID

Parameters

Returns boolean

lineContainers

Returns Generator<never, void, unknown>

meshContainers

Returns Generator<BatchedMeshContainer, void, unknown>

removeObject

Parameters

Returns void

setClippingPlanes

`Readonly`ignoreViewportRenderMode

`Readonly`isSceneMeshController

`Readonly`isSceneObjectController

`Readonly`isZoneController

`Readonly`signals

Returns Generator<
BatchedLineContainer
| BatchedMeshContainer
| InstancedMeshContainer,
void,
any,
>