Class SceneMesh`Abstract`

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

Hierarchy (View Summary)

RaycastableSceneObject
- SceneMesh

Constructors

constructor

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

Properties

`Readonly`children

children: SceneObject[] = ...

`Abstract`diffuseColor

diffuseColor: ColorRepresentation

`Abstract`edgesColor

edgesColor: ColorRepresentation

`Abstract`edgesOpacity

edgesOpacity: number

`Abstract`emissiveColor

emissiveColor: ColorRepresentation

`Readonly`isDisplayable

isDisplayable: true

isRaycastable

isRaycastable: boolean = true

`Readonly`isSceneMesh

isSceneMesh: true

`Readonly`isSceneObject

isSceneObject: true

isSelectable

isSelectable: boolean = true

Indicates whether the object is selectable in the scene

isTransformable

isTransformable: boolean = true

`Abstract`metalness

metalness: number

name

name: string = ''

`Abstract`opacity

opacity: number

parent

parent: SceneObject | null = null

`Abstract`roughness

roughness: number

`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

`Abstract`xRay

xRay: boolean

`Static` `Readonly`TRANSPARENCY_THRESHOLD

TRANSPARENCY_THRESHOLD: 0.95

Accessors

active

get active(): boolean
Returns boolean
Inherited from DrawableSceneObject.active
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:164

areEdgesTransparent

get areEdgesTransparent(): boolean
Returns boolean
- Defined in packages/viewer/src/scene/objects/mesh/SceneMesh.ts:42

hover

get hover(): boolean
Returns boolean
- Defined in packages/viewer/src/scene/objects/mesh/SceneMesh.ts:52
set hover(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/viewer/src/scene/objects/mesh/SceneMesh.ts:46

isTransparent

get isTransparent(): boolean
Returns boolean
- Defined in packages/viewer/src/scene/objects/mesh/SceneMesh.ts:38

selected

get selected(): boolean
Returns boolean
Inherited from DrawableSceneObject.selected
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:175
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from DrawableSceneObject.selected
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:168

type

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

visible

get visible(): boolean
Returns boolean
Inherited from RaycastableSceneObject.visible
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:150
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from RaycastableSceneObject.visible
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:143

Methods

addChild

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

applyMatrix

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

copyMaterials

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

dispose

dispose(): void
Returns void
Inherited from RaycastableSceneObject.dispose
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:196

`Abstract`getBoundingBox

getBoundingBox(box: Box3): Box3
Parameters
- box: Box3
Returns Box3
Inherited from RaycastableSceneObject.getBoundingBox
- Defined in packages/viewer/src/scene/objects/utils/DrawableSceneObject.ts:11

`Abstract`getBoundingSphere

getBoundingSphere(sphere: Sphere): Sphere
Parameters
- sphere: Sphere
Returns Sphere
Inherited from RaycastableSceneObject.getBoundingSphere
- Defined in packages/viewer/src/scene/objects/utils/DrawableSceneObject.ts:12

`Abstract`getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
Inherited from RaycastableSceneObject.getMatrix
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:90

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Inherited from RaycastableSceneObject.getPosition
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:94

getStateController

getStateController(): ObjectStateController<SceneMesh>
Returns ObjectStateController<SceneMesh>
Overrides RaycastableSceneObject.getStateController
- Defined in packages/viewer/src/scene/objects/mesh/SceneMesh.ts:34

parentsGenerator

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

`Abstract`projectPointOnEdges

projectPointOnEdges(
    point: Vector3,
    target: Vector3,
    maxEdgeDistance: number,
): boolean
Parameters
- point: Vector3
- target: Vector3
- maxEdgeDistance: number
Returns boolean
Inherited from RaycastableSceneObject.projectPointOnEdges
- Defined in packages/viewer/src/scene/objects/utils/RaycastableSceneObject.ts:44

`Abstract`raycast

raycast(
    raycaster: Raycaster,
    intersections: SceneIntersection[],
    marginError?: number,
): void
Performs raycasting on the mesh.
Parameters
- raycaster: Raycaster
  The raycaster to use
- intersections: SceneIntersection[]
  The array of resulting intersections
- OptionalmarginError: number
Returns void
Inherited from RaycastableSceneObject.raycast
- Defined in packages/viewer/src/scene/objects/utils/RaycastableSceneObject.ts:32

removeFromParent

removeFromParent(): void
Returns void
Inherited from RaycastableSceneObject.removeFromParent
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:132

`Abstract`setMatrix

setMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from RaycastableSceneObject.setMatrix
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:92

setPosition

setPosition(position: Vector3): void
Parameters
- position: Vector3
Returns void
Inherited from RaycastableSceneObject.setPosition
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:100

`Abstract`showBoundingBoxHelper

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

`Abstract`showNormalsHelper

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

toJson

toJson(): Record<string, any>
Returns Record<string, any>
Overrides RaycastableSceneObject.toJson
- Defined in packages/viewer/src/scene/objects/mesh/SceneMesh.ts:69

Class SceneMeshAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SceneMesh

Properties

Readonlychildren

AbstractdiffuseColor

AbstractedgesColor

AbstractedgesOpacity

AbstractemissiveColor

ReadonlyisDisplayable

isRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneObject

isSelectable

isTransformable

Abstractmetalness

name

Abstractopacity

parent

Abstractroughness

Readonlysignals

ReadonlytransformConfig

userData

Readonlyuuid

AbstractxRay

Static ReadonlyTRANSPARENCY_THRESHOLD

Accessors

active

Returns boolean

areEdgesTransparent

Returns boolean

hover

Returns boolean

Parameters

Returns void

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

AbstractgetMatrix

Parameters

Returns Matrix4

getPosition

Parameters

Returns Vector3

getStateController

Class SceneMesh`Abstract`

`Readonly`children

`Abstract`diffuseColor

`Abstract`edgesColor

`Abstract`edgesOpacity

`Abstract`emissiveColor

`Readonly`isDisplayable

`Readonly`isSceneMesh

`Readonly`isSceneObject

`Abstract`metalness

`Abstract`opacity

`Abstract`roughness

`Readonly`signals

`Readonly`transformConfig

`Readonly`uuid

`Abstract`xRay

`Static` `Readonly`TRANSPARENCY_THRESHOLD

`Abstract`getBoundingBox

`Abstract`getBoundingSphere

`Abstract`getMatrix

`Abstract`projectPointOnEdges

`Abstract`raycast

`Abstract`setMatrix

`Abstract`showBoundingBoxHelper

`Abstract`showNormalsHelper