Class GuidePath

A guide path scene object: the ordered control points and options a PathController uses to build and animate its line and point markers.

Hierarchy (View Summary)

SceneMeshGroup<GuidePathLine | GuidePathPoint>
- GuidePath

Constructors

constructor

new GuidePath(
    handler: GuidePathHandler,
    points: readonly Vector3[],
    options: ResolvedGuidePathOptions,
): GuidePath
Parameters
- handler: GuidePathHandler
- points: readonly Vector3[]
- options: ResolvedGuidePathOptions
Returns GuidePath
Overrides SceneMeshGroup.constructor
- Defined in plugins/src/PathPlugin/core/GuidePath.ts:36

Properties

`Readonly`children

children: SceneObject[] = ...

`Readonly`isDisplayable

isDisplayable: true

`Readonly`isGuidePath

isGuidePath: true

isRaycastable

isRaycastable: boolean = true

`Readonly`isSceneMesh

isSceneMesh: true

`Readonly`isSceneMeshGroup

isSceneMeshGroup: true

`Readonly`isSceneObject

isSceneObject: true

isSelectable

isSelectable: boolean = true

Indicates whether the object is selectable in the scene

isTransformable

isTransformable: boolean = true

`Readonly`meshes

meshes: (GuidePathLine | GuidePathPoint)[] = ...

name

name: string = ''

parent

parent: SceneObject | null = null

`Readonly`signals

signals: {
onSelectedChanged: ViewerSignal<(...args: any[]) => any>;
onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
} = ...

`Readonly`transformConfig

transformConfig: ObjectTransformConfig = ...

userData

userData: Record<string, any> = {}

`Readonly`uuid

uuid: string

Unique identifier of the object

`Static` `Readonly`TRANSPARENCY_THRESHOLD

TRANSPARENCY_THRESHOLD: 0.95

Accessors

areEdgesTransparent

get areEdgesTransparent(): boolean
Returns boolean
Inherited from SceneMeshGroup.areEdgesTransparent
- Defined in viewer/src/scene/objects/mesh/SceneMesh.ts:60

diffuseColor

get diffuseColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from SceneProjection.diffuseColor
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:182
set diffuseColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from SceneProjection.diffuseColor
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:176

edgesColor

get edgesColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from SceneMeshGroup.edgesColor
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:222
set edgesColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from SceneMeshGroup.edgesColor
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:216

edgesOpacity

get edgesOpacity(): number
Returns number
Inherited from SceneMeshGroup.edgesOpacity
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:232
set edgesOpacity(value: number): void
Parameters
- value: number
Returns void
Inherited from SceneMeshGroup.edgesOpacity
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:226

edgesVisible

get edgesVisible(): boolean
Returns boolean
Inherited from SceneMeshGroup.edgesVisible
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:243
set edgesVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshGroup.edgesVisible
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:236

emissiveColor

get emissiveColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from SceneMeshGroup.emissiveColor
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:192
set emissiveColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from SceneMeshGroup.emissiveColor
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:186

hover

get hover(): boolean
Returns boolean
Inherited from SceneMeshGroup.hover
- Defined in viewer/src/scene/objects/mesh/SceneMesh.ts:70
set hover(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshGroup.hover
- Defined in viewer/src/scene/objects/mesh/SceneMesh.ts:64

isTransparent

get isTransparent(): boolean
Returns boolean
Inherited from SceneMeshGroup.isTransparent
- Defined in viewer/src/scene/objects/mesh/SceneMesh.ts:56

line

get line(): GuidePathLine | null
Returns GuidePathLine | null
- Defined in plugins/src/PathPlugin/core/GuidePath.ts:59

materialName

get materialName(): string
Returns string
Inherited from SceneMeshGroup.materialName
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:32
set materialName(value: string): void
Parameters
- value: string
Returns void
Inherited from SceneMeshGroup.materialName
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:28

metalness

get metalness(): number
Returns number
Inherited from SceneMeshGroup.metalness
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:212
set metalness(value: number): void
Parameters
- value: number
Returns void
Inherited from SceneMeshGroup.metalness
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:206

opacity

get opacity(): number
Returns number
Inherited from SceneMeshGroup.opacity
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:162
set opacity(value: number): void
Parameters
- value: number
Returns void
Inherited from SceneMeshGroup.opacity
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:156

options

get options(): Readonly<ResolvedGuidePathOptions>
Returns Readonly<ResolvedGuidePathOptions>
- Defined in plugins/src/PathPlugin/core/GuidePath.ts:55

points

get points(): readonly Vector3[]
Returns readonly Vector3[]
- Defined in plugins/src/PathPlugin/core/GuidePath.ts:51

renderPoints

get renderPoints(): readonly GuidePathPoint[]
Returns readonly GuidePathPoint[]
- Defined in plugins/src/PathPlugin/core/GuidePath.ts:63

roughness

get roughness(): number
Returns number
Inherited from SceneMeshGroup.roughness
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:202
set roughness(value: number): void
Parameters
- value: number
Returns void
Inherited from SceneMeshGroup.roughness
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:196

selected

get selected(): boolean
Returns boolean
Inherited from SceneMeshGroup.selected
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:141
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshGroup.selected
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:134

type

get type(): string
Returns string
Inherited from SceneMeshGroup.type
- Defined in viewer/src/scene/objects/SceneObject.ts:102

visible

get visible(): boolean
Returns boolean
Inherited from SceneMeshGroup.visible
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:152
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshGroup.visible
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:145

xRay

get xRay(): boolean
Returns boolean
Inherited from SceneMeshGroup.xRay
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:172
set xRay(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshGroup.xRay
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:166

Methods

addChild

addChild(child: SceneObject): void
Parameters
- child: SceneObject
Returns void
Inherited from SceneMeshGroup.addChild
- Defined in viewer/src/scene/objects/SceneObject.ts:128

addSubMesh

addSubMesh(mesh: GuidePathLine | GuidePathPoint): void
Parameters
- mesh: GuidePathLine | GuidePathPoint
Returns void
Inherited from SceneMeshGroup.addSubMesh
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:40

applyMatrix

applyMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from SceneMeshGroup.applyMatrix
- Defined in viewer/src/scene/objects/SceneObject.ts:122

clear

clear(): void
Returns void
- Defined in plugins/src/PathPlugin/core/GuidePath.ts:81

copyMaterials

copyMaterials(src: SceneMesh): void
Copies the
Parameters
- src: SceneMesh
Returns void
Inherited from SceneMeshGroup.copyMaterials
- Defined in viewer/src/scene/objects/mesh/SceneMesh.ts:85

dispose

dispose(): void
Returns void
Inherited from SceneMeshGroup.dispose
- Defined in viewer/src/scene/objects/SceneObject.ts:212

getBoundingBox

getBoundingBox(box: Box3): Box3
Parameters
- box: Box3
Returns Box3
Inherited from SceneMeshGroup.getBoundingBox
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:97

getBoundingSphere

getBoundingSphere(sphere: Sphere): Sphere
Parameters
- sphere: Sphere
Returns Sphere
Inherited from SceneMeshGroup.getBoundingSphere
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:107

getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
Inherited from SceneMeshGroup.getMatrix
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:55

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Inherited from SceneMeshGroup.getPosition
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:71

getStateController

getStateController(): MeshGroupStateController<GuidePath>
Returns MeshGroupStateController<GuidePath>
Inherited from SceneMeshGroup.getStateController
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:117

hide

hide(): void
Returns void
- Defined in plugins/src/PathPlugin/core/GuidePath.ts:72

parentsGenerator

parentsGenerator(): Generator<SceneObject, void, unknown>
Returns Generator<SceneObject, void, unknown>
Inherited from SceneMeshGroup.parentsGenerator
- Defined in viewer/src/scene/objects/SceneObject.ts:140

projectPointOnEdges

projectPointOnEdges(
    point: Vector3,
    target: Vector3,
    maxEdgeDistance: number,
): boolean
Parameters
- point: Vector3
- target: Vector3
- maxEdgeDistance: number
Returns boolean
Inherited from SceneMeshGroup.projectPointOnEdges
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:253

raycast

raycast(raycaster: Raycaster, intersections: SceneIntersection[]): void
Performs raycasting on the mesh.
Parameters
- raycaster: Raycaster
  The raycaster to use
- intersections: SceneIntersection[]
  The array of resulting intersections
Returns void
Inherited from SceneMeshGroup.raycast
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:247

removeFromParent

removeFromParent(): void
Returns void
Inherited from SceneMeshGroup.removeFromParent
- Defined in viewer/src/scene/objects/SceneObject.ts:148

removeSubMesh

removeSubMesh(mesh: GuidePathLine | GuidePathPoint): void
Parameters
- mesh: GuidePathLine | GuidePathPoint
Returns void
Inherited from SceneMeshGroup.removeSubMesh
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:49

setMatrix

setMatrix(matrix: Matrix4): Matrix4
Parameters
- matrix: Matrix4
Returns Matrix4
Inherited from SceneMeshGroup.setMatrix
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:63

setPosition

setPosition(position: Vector3): void
Parameters
- position: Vector3
Returns void
Inherited from SceneMeshGroup.setPosition
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:79

show

show(): void
Returns void
- Defined in plugins/src/PathPlugin/core/GuidePath.ts:67

showBoundingBoxHelper

showBoundingBoxHelper(helperGroup: Group, value: boolean): void
Parameters
- helperGroup: Group
- value: boolean
Returns void
Inherited from SceneMeshGroup.showBoundingBoxHelper
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:85

showNormalsHelper

showNormalsHelper(helperGroup: Group, value: boolean): void
Parameters
- helperGroup: Group
- value: boolean
Returns void
Inherited from SceneMeshGroup.showNormalsHelper
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:91

toJson

toJson(): Record<string, any>
Returns Record<string, any>
Inherited from SceneMeshGroup.toJson
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:271

update

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

Class GuidePath

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GuidePath

Properties

Readonlychildren

ReadonlyisDisplayable

ReadonlyisGuidePath

isRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneMeshGroup

ReadonlyisSceneObject

isSelectable

isTransformable

Readonlymeshes

name

parent

Readonlysignals

ReadonlytransformConfig

userData

Readonlyuuid

Static ReadonlyTRANSPARENCY_THRESHOLD

Accessors

areEdgesTransparent

Returns boolean

diffuseColor

Returns ColorRepresentation

Parameters

Returns void

edgesColor

Returns ColorRepresentation

Parameters

Returns void

edgesOpacity

Returns number

Parameters

Returns void

edgesVisible

Returns boolean

Parameters

Returns void

emissiveColor

Returns ColorRepresentation

Parameters

Returns void

hover

Returns boolean

Parameters

Returns void

isTransparent

Returns boolean

line

Returns GuidePathLine | null

materialName

Returns string

Parameters

Returns void

metalness

Returns number

Parameters

Returns void

opacity

Returns number

Parameters

Returns void

options

Returns Readonly<ResolvedGuidePathOptions>

points

Returns readonly Vector3[]

renderPoints

Returns readonly GuidePathPoint[]

roughness

Returns number

`Readonly`children

`Readonly`isDisplayable

`Readonly`isGuidePath

`Readonly`isSceneMesh

`Readonly`isSceneMeshGroup

`Readonly`isSceneObject

`Readonly`meshes

`Readonly`signals

`Readonly`transformConfig

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD