Class SceneMesh`Abstract`

SceneMesh can contain triangles and/or lines representing the edges.

Hierarchy (View Summary)

SceneObject
- SceneMesh

Implements

RaycastableObject

Constructors

constructor

new SceneMesh(uuid?: string): SceneMesh
Parameters
- uuid: string = ...
Returns SceneMesh
Inherited from SceneObject.constructor
- Defined in src/viewer/core/objects/SceneObject.ts:41

Properties

`Readonly`children

children: SceneObject[] = ...

`Abstract`diffuseColor

diffuseColor: ColorRepresentation

`Abstract`edgesColor

edgesColor: ColorRepresentation

`Abstract`edgesOpacity

edgesOpacity: number

`Abstract`emissiveColor

emissiveColor: ColorRepresentation

`Readonly`isMovable

isMovable: boolean = false

Indicates whether the object can be transformed in the scene

`Readonly`isRaycastable

isRaycastable: true

`Readonly`isSceneMesh

isSceneMesh: true

`Readonly`isSceneObject

isSceneObject: true

isSelectable

isSelectable: boolean = true

Indicates whether the object is selectable in the scene

`Abstract`metalness

metalness: number

name

name: string = ''

`Abstract`opacity

opacity: number

parent

parent: null | SceneObject = null

`Abstract`roughness

roughness: number

`Readonly`showInfoboxOnClick

showInfoboxOnClick: boolean = true

Indicates whether the object should open an infobox on click

`Readonly`signals

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

userData

userData: Record<string, any> = {}

`Readonly`uuid

uuid: string

Unique identifier of the object

`Abstract`xRay

xRay: boolean

`Static` `Readonly`TRANSPARENCY_THRESHOLD

TRANSPARENCY_THRESHOLD: 0.95

Accessors

active

get active(): boolean
Returns boolean
Implementation of RaycastableObject.active
Inherited from SceneObject.active
- Defined in src/viewer/core/objects/SceneObject.ts:126

areEdgesTransparent

get areEdgesTransparent(): boolean
Returns boolean
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:44

isTransparent

get isTransparent(): boolean
Returns boolean
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:40

selected

get selected(): boolean
Returns boolean
Implementation of RaycastableObject.selected
Inherited from SceneObject.selected
- Defined in src/viewer/core/objects/SceneObject.ts:137
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of RaycastableObject.selected
Inherited from SceneObject.selected
- Defined in src/viewer/core/objects/SceneObject.ts:130

type

get type(): string
Returns string
Implementation of RaycastableObject.type
Inherited from SceneObject.type
- Defined in src/viewer/core/objects/SceneObject.ts:45

visible

get visible(): boolean
Returns boolean
Implementation of RaycastableObject.visible
Inherited from SceneObject.visible
- Defined in src/viewer/core/objects/SceneObject.ts:112
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of RaycastableObject.visible
Inherited from SceneObject.visible
- Defined in src/viewer/core/objects/SceneObject.ts:105

Methods

addChild

addChild(child: SceneObject): void
Parameters
- child: SceneObject
Returns void
Implementation of RaycastableObject.addChild
Inherited from SceneObject.addChild
- Defined in src/viewer/core/objects/SceneObject.ts:70

applyMatrix

applyMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Implementation of RaycastableObject.applyMatrix
Inherited from SceneObject.applyMatrix
- Defined in src/viewer/core/objects/SceneObject.ts:64

copyMaterials

copyMaterials(src: SceneMesh): void
Copies the
Parameters
- src: SceneMesh
Returns void
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:51

dispose

dispose(): void
Returns void
Implementation of RaycastableObject.dispose
Inherited from SceneObject.dispose
- Defined in src/viewer/core/objects/SceneObject.ts:158

`Abstract`getBoundingBox

getBoundingBox(box: Box3): Box3
Parameters
- box: Box3
Returns Box3
Implementation of RaycastableObject.getBoundingBox
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:33

`Abstract`getBoundingSphere

getBoundingSphere(sphere: Sphere): Sphere
Parameters
- sphere: Sphere
Returns Sphere
Implementation of RaycastableObject.getBoundingSphere
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:34

getGizmoController

getGizmoController(
viewer: Viewer,
transformGroup: TransformGroup,
): ObjectGizmoController<SceneObject>
Parameters
- viewer: Viewer
- transformGroup: TransformGroup
Returns ObjectGizmoController<SceneObject>
Implementation of RaycastableObject.getGizmoController
Inherited from SceneObject.getGizmoController
- Defined in src/viewer/core/objects/SceneObject.ts:97

`Abstract`getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
Implementation of RaycastableObject.getMatrix
Inherited from SceneObject.getMatrix
- Defined in src/viewer/core/objects/SceneObject.ts:49

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Implementation of RaycastableObject.getPosition
Inherited from SceneObject.getPosition
- Defined in src/viewer/core/objects/SceneObject.ts:53

getStateController

getStateController(): ObjectStateController<SceneMesh>
Returns ObjectStateController<SceneMesh>
Implementation of RaycastableObject.getStateController
Overrides SceneObject.getStateController
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:36

parentsGenerator

parentsGenerator(): Generator<SceneObject, void, unknown>
Returns Generator<SceneObject, void, unknown>
Implementation of RaycastableObject.parentsGenerator
Inherited from SceneObject.parentsGenerator
- Defined in src/viewer/core/objects/SceneObject.ts:82

`Abstract`raycast

raycast(raycaster: Raycaster, intersections: SceneIntersection[]): void
Parameters
- raycaster: Raycaster
- intersections: SceneIntersection[]
Returns void
Implementation of RaycastableObject.raycast
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:30

removeFromParent

removeFromParent(): void
Returns void
Implementation of RaycastableObject.removeFromParent
Inherited from SceneObject.removeFromParent
- Defined in src/viewer/core/objects/SceneObject.ts:90

`Abstract`setMatrix

setMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Implementation of RaycastableObject.setMatrix
Inherited from SceneObject.setMatrix
- Defined in src/viewer/core/objects/SceneObject.ts:51

setPosition

setPosition(position: Vector3): void
Parameters
- position: Vector3
Returns void
Implementation of RaycastableObject.setPosition
Inherited from SceneObject.setPosition
- Defined in src/viewer/core/objects/SceneObject.ts:58

`Abstract`showBoundingBoxHelper

showBoundingBoxHelper(helperGroup: Group, value: boolean): void
Parameters
- helperGroup: Group
- value: boolean
Returns void
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:32

`Abstract`showNormalsHelper

showNormalsHelper(helperGroup: Group, value: boolean): void
Parameters
- helperGroup: Group
- value: boolean
Returns void
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:31

toJson

toJson(): Record<string, any>
Returns Record<string, any>
Implementation of RaycastableObject.toJson
Overrides SceneObject.toJson
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:61

Class SceneMeshAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SceneMesh

Properties

Readonlychildren

AbstractdiffuseColor

AbstractedgesColor

AbstractedgesOpacity

AbstractemissiveColor

ReadonlyisMovable

ReadonlyisRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneObject

isSelectable

Abstractmetalness

name

Abstractopacity

parent

Abstractroughness

ReadonlyshowInfoboxOnClick

Readonlysignals

userData

Readonlyuuid

AbstractxRay

Static ReadonlyTRANSPARENCY_THRESHOLD

Accessors

active

Returns boolean

areEdgesTransparent

Returns boolean

isTransparent

Returns boolean

selected

Returns boolean

Parameters

Returns void

type

Returns string

visible

Returns boolean

Parameters

Returns void

Methods

addChild

Parameters

Returns void

applyMatrix

Parameters

Returns void

copyMaterials

Parameters

Returns void

dispose

Returns void

AbstractgetBoundingBox

Parameters

Returns Box3

AbstractgetBoundingSphere

Parameters

Returns Sphere

getGizmoController

Parameters

Returns ObjectGizmoController<SceneObject>

AbstractgetMatrix

Parameters

Returns Matrix4

getPosition

Parameters

Returns Vector3

getStateController

Returns ObjectStateController<SceneMesh>

Class SceneMesh`Abstract`

`Readonly`children

`Abstract`diffuseColor

`Abstract`edgesColor

`Abstract`edgesOpacity

`Abstract`emissiveColor

`Readonly`isMovable

`Readonly`isRaycastable

`Readonly`isSceneMesh

`Readonly`isSceneObject

`Abstract`metalness

`Abstract`opacity

`Abstract`roughness

`Readonly`showInfoboxOnClick

`Readonly`signals

`Readonly`uuid

`Abstract`xRay

`Static` `Readonly`TRANSPARENCY_THRESHOLD

`Abstract`getBoundingBox

`Abstract`getBoundingSphere

`Abstract`getMatrix

`Abstract`raycast

`Abstract`setMatrix

`Abstract`showBoundingBoxHelper

`Abstract`showNormalsHelper