Class PathController

Base controller for managing meshes. Use this controller only if you want your objects to be considered as standard SceneMesh (i.e. automatic support for selection, xRay, boxTree, BVH, etc). It is made for displaying content not tools.

Hierarchy (View Summary)

SceneMeshController<GuidePath>
- PathController

Implements

GuidePathHandler

Constructors

constructor

new PathController(viewer: Viewer): PathController
Parameters
- viewer: Viewer
Returns PathController
Overrides SceneMeshController.constructor
- Defined in plugins/src/PathPlugin/core/PathController.ts:44

Properties

`Protected` `Readonly`_objects

_objects: Map<string, GuidePath> = ...

`Protected` `Readonly`_viewer

_viewer: Viewer

`Readonly`ignoreViewportRenderMode

ignoreViewportRenderMode: false

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

`Readonly`isPathController

isPathController: true

`Readonly`isSceneMeshController

isSceneMeshController: true

`Readonly`isSceneObjectController

isSceneObjectController: true

`Readonly`signals

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

Accessors

count

get count(): number
Controller objects count

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

firstObject

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

uuids

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

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

visible

get visible(): boolean
Returns boolean
Inherited from SceneMeshController.visible
- Defined in viewer/src/scene/objects/SceneObjectController.ts:46
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 viewer/src/scene/objects/SceneObjectController.ts:37

Methods

`Protected`_createSignals

_createSignals(): {
    onObjectAdded: ViewerSignal<(object: GuidePath) => void>;
    onObjectRemoved: ViewerSignal<(object: GuidePath) => void>;
    onObjectUpdated: ViewerSignal<(object: GuidePath) => void>;
    onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
}
Returns {
    onObjectAdded: ViewerSignal<(object: GuidePath) => void>;
    onObjectRemoved: ViewerSignal<(object: GuidePath) => void>;
    onObjectUpdated: ViewerSignal<(object: GuidePath) => void>;
    onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
}
Inherited from SceneMeshController._createSignals
- Defined in viewer/src/scene/objects/SceneObjectController.ts:23

`Protected`_setVisibility

_setVisibility(value: boolean): void
To be implemented by controllers to set global visibility (at controller level)
Parameters
- value: boolean
Returns void
Overrides SceneMeshController._setVisibility
- Defined in plugins/src/PathPlugin/core/PathController.ts:157

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 plugins/src/PathPlugin/core/PathController.ts:141

addObject

addObject(path: GuidePath, parentUuid?: string | null): void
Adds the given object to the controller. Controllers may not support object hierarchy.
Parameters
- path: GuidePath
  The object to add.
- parentUuid: string | null = null
  The parent uuid of the object if the controller supports it.
Returns void
Overrides SceneMeshController.addObject
- Defined in plugins/src/PathPlugin/core/PathController.ts:68

applyPluginSettings

applyPluginSettings(): void
Returns void
- Defined in plugins/src/PathPlugin/core/PathController.ts:277

clear

clear(path?: GuidePath): void
Clears all objects from the controller
Parameters
- Optionalpath: GuidePath
Returns void
Implementation of GuidePathHandler.clear
Overrides SceneMeshController.clear
- Defined in plugins/src/PathPlugin/core/PathController.ts:109

containers

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

createPath

createPath(points: readonly Vector3[], options?: GuidePathOptions): GuidePath
Parameters
- points: readonly Vector3[]
- Optionaloptions: GuidePathOptions
Returns GuidePath
- Defined in plugins/src/PathPlugin/core/PathController.ts:54

dispose

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

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

edgesContainers

edgesContainers(): Generator<never, void, unknown>
Returns Generator<never, void, unknown>
Overrides SceneMeshController.edgesContainers
- Defined in plugins/src/PathPlugin/core/PathController.ts:153

getAllHiddenObjects

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

Returns Generator<GuidePath>
Inherited from SceneMeshController.getAllHiddenObjects
- Defined in viewer/src/scene/objects/SceneObjectController.ts:189

getAllHiddenObjectUuids

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

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

getAllObjects

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

Returns Generator<GuidePath>
Inherited from SceneMeshController.getAllObjects
- Defined in viewer/src/scene/objects/SceneObjectController.ts:163

getAllObjectUuids

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

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

getAllVisibleObjects

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

Returns Generator<GuidePath>
Inherited from SceneMeshController.getAllVisibleObjects
- Defined in viewer/src/scene/objects/SceneObjectController.ts:177

getAllVisibleObjectUuids

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

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

getFirstObject

getFirstObject(): GuidePath | null
Returns GuidePath | null
Inherited from SceneMeshController.getFirstObject
- Defined in viewer/src/scene/objects/SceneObjectController.ts:113

getObjectByUUID

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

getObjectsByUUID

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

hasObjectUUID

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

lineContainers

lineContainers(): Generator<never, void, unknown>
Returns Generator<never, void, unknown>
Overrides SceneMeshController.lineContainers
- Defined in plugins/src/PathPlugin/core/PathController.ts:149

meshContainers

meshContainers(): Generator<
    InstancedMeshContainer<InstancedBasicMaterial>,
    void,
    unknown,
>
Returns Generator<InstancedMeshContainer<InstancedBasicMaterial>, void, unknown>
Overrides SceneMeshController.meshContainers
- Defined in plugins/src/PathPlugin/core/PathController.ts:145

onSceneClear

onSceneClear(scene: ViewerScene): void
Callback to clean the controller from the scene
Parameters
- scene: ViewerScene
Returns void
Overrides SceneMeshController.onSceneClear
- Defined in plugins/src/PathPlugin/core/PathController.ts:132

onSceneSetup

onSceneSetup(_scene: ViewerScene): void
Callback to setup the controller into the scene
Parameters
- _scene: ViewerScene
Returns void
Overrides SceneMeshController.onSceneSetup
- Defined in plugins/src/PathPlugin/core/PathController.ts:124

removeObject

removeObject(path: GuidePath): void
Removes the given object from the controller.
Parameters
- path: GuidePath
Returns void
Overrides SceneMeshController.removeObject
- Defined in plugins/src/PathPlugin/core/PathController.ts:78

setClippingPlanes

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

setEdgesVisibility

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

setMeshesVisibility

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

update

update(
    path: GuidePath,
    points: readonly Vector3[],
    options?: GuidePathOptions,
): void
Parameters
- path: GuidePath
- points: readonly Vector3[]
- Optionaloptions: GuidePathOptions
Returns void
Implementation of GuidePathHandler.update
- Defined in plugins/src/PathPlugin/core/PathController.ts:84

visibilityChanged

visibilityChanged(_path: GuidePath): void
Parameters
- _path: GuidePath
Returns void
Implementation of GuidePathHandler.visibilityChanged
- Defined in plugins/src/PathPlugin/core/PathController.ts:163

Class PathController

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PathController

Properties

Protected Readonly_objects

Protected Readonly_viewer

ReadonlyignoreViewportRenderMode

ReadonlyisPathController

ReadonlyisSceneMeshController

ReadonlyisSceneObjectController

Readonlysignals

Accessors

count

Returns number

firstObject

Returns TObject | null

uuids

Returns MapIterator<string>

visible

Returns boolean

Parameters

Returns void

Methods

Protected_createSignals

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

Protected_setVisibility

Parameters

Returns void

accepts

Parameters

Returns boolean

addObject

Parameters

Returns void

applyPluginSettings

Returns void

clear

Parameters

Returns void

containers

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

createPath

Parameters

Returns GuidePath

dispose

Returns void

edgesContainers

Returns Generator<never, void, unknown>

getAllHiddenObjects

Returns Generator<GuidePath>

getAllHiddenObjectUuids

Returns Generator<string>

getAllObjects

Returns Generator<GuidePath>

getAllObjectUuids

Returns Generator<string>

getAllVisibleObjects

Returns Generator<GuidePath>

getAllVisibleObjectUuids

Returns Generator<string>

getFirstObject

Returns GuidePath | null

getObjectByUUID

Parameters

Returns GuidePath | null

getObjectsByUUID

Parameters

Returns Generator<GuidePath>

hasObjectUUID

Parameters

Returns boolean

`Protected` `Readonly`_objects

`Protected` `Readonly`_viewer

`Readonly`ignoreViewportRenderMode

`Readonly`isPathController

`Readonly`isSceneMeshController

`Readonly`isSceneObjectController

`Readonly`signals

`Protected`_createSignals

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

`Protected`_setVisibility

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