Class SceneMeshProxy

Base abstract class describing a Mesh that is composed of

a mesh proxy pointing to a mesh container for the mesh triangles
an optional proxy pointing to a line container for the mesh edges

Hierarchy (View Summary)

SceneMesh
- SceneMeshProxy

Constructors

constructor

new SceneMeshProxy(
    meshProxy: MeshProxy,
    edgesProxy?: null | LineProxy<BaseContainer<Material>>,
    uuid?: string,
): SceneMeshProxy
Parameters
- meshProxy: MeshProxy
- edgesProxy: null | LineProxy<BaseContainer<Material>> = null
- Optionaluuid: string
Returns SceneMeshProxy
Overrides SceneMesh.constructor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:27

Properties

`Readonly`availableTransforms

availableTransforms: {
    rotation: boolean;
    scaling: boolean;
    translation: boolean;
} = ...

Indicates which gizmo controls are available for the object

`Readonly`children

children: SceneObject[] = ...

`Readonly`edgesProxy

edgesProxy: null | LineProxy<BaseContainer<Material>>

`Readonly`isDisplayable

isDisplayable: true

`Readonly`isRaycastable

isRaycastable: true

`Readonly`isSceneMesh

isSceneMesh: true

`Readonly`isSceneMeshProxy

isSceneMeshProxy: true

`Readonly`isSceneObject

isSceneObject: true

isSelectable

isSelectable: boolean = true

Indicates whether the object is selectable in the scene

`Readonly`meshProxy

meshProxy: MeshProxy

name

name: string = ''

parent

parent: null | SceneObject = null

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>;
} = ...

transformable

transformable: boolean = false

Indicates whether the object can be transformed in the scene

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 SceneMesh.areEdgesTransparent
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:42

diffuseColor

get diffuseColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.diffuseColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:72
set diffuseColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.diffuseColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:68

edgesColor

get edgesColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.edgesColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:124
set edgesColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.edgesColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:119

edgesOpacity

get edgesOpacity(): number
Returns number
Overrides SceneMesh.edgesOpacity
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:133
set edgesOpacity(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.edgesOpacity
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:128

emissiveColor

get emissiveColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.emissiveColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:115
set emissiveColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.emissiveColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:111

hover

get hover(): boolean
Returns boolean
Overrides SceneMesh.hover
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:58
set hover(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.hover
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:62

isTransparent

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

metalness

get metalness(): number
Returns number
Overrides SceneMesh.metalness
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:99
set metalness(metalness: number): void
Parameters
- metalness: number
Returns void
Overrides SceneMesh.metalness
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:95

opacity

get opacity(): number
Returns number
Overrides SceneMesh.opacity
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:81
set opacity(opacity: number): void
Parameters
- opacity: number
Returns void
Overrides SceneMesh.opacity
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:76

roughness

get roughness(): number
Returns number
Overrides SceneMesh.roughness
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:107
set roughness(roughness: number): void
Parameters
- roughness: number
Returns void
Overrides SceneMesh.roughness
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:103

selected

get selected(): boolean
Returns boolean
Overrides SceneMesh.selected
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:143
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.selected
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:137

type

get type(): string
Returns string
Inherited from SceneMesh.type
- Defined in src/viewer/core/objects/SceneObject.ts:54

visible

get visible(): boolean
Returns boolean
Overrides SceneMesh.visible
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:44
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.visible
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:38

xRay

get xRay(): boolean
Returns boolean
Overrides SceneMesh.xRay
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:91
set xRay(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.xRay
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:85

Methods

addChild

addChild(child: SceneObject): void
Parameters
- child: SceneObject
Returns void
Inherited from SceneMesh.addChild
- Defined in src/viewer/core/objects/SceneObject.ts:80

applyMatrix

applyMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from SceneMesh.applyMatrix
- Defined in src/viewer/core/objects/SceneObject.ts:74

copyMaterials

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

dispose

dispose(): void
Returns void
Inherited from SceneMesh.dispose
- Defined in src/viewer/core/objects/SceneObject.ts:168

getBoundingBox

getBoundingBox(box: Box3): Box3
Parameters
- box: Box3
Returns Box3
Overrides SceneMesh.getBoundingBox
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:167

getBoundingSphere

getBoundingSphere(sphere: Sphere): Sphere
Parameters
- sphere: Sphere
Returns Sphere
Overrides SceneMesh.getBoundingSphere
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:171

getGizmoController

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

getMaterial

getMaterial(): MaterialType
Returns MaterialType
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:219

getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
Overrides SceneMesh.getMatrix
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:175

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Inherited from SceneMesh.getPosition
- Defined in src/viewer/core/objects/SceneObject.ts:62

getStateController

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

parentsGenerator

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

raycast

raycast(raycaster: Raycaster, intersections: SceneIntersection[]): void
Parameters
- raycaster: Raycaster
- intersections: SceneIntersection[]
Returns void
Overrides SceneMesh.raycast
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:147

removeFromParent

removeFromParent(): void
Returns void
Inherited from SceneMesh.removeFromParent
- Defined in src/viewer/core/objects/SceneObject.ts:100

setMatrix

setMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Overrides SceneMesh.setMatrix
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:179

setPosition

setPosition(position: Vector3): void
Parameters
- position: Vector3
Returns void
Inherited from SceneMesh.setPosition
- Defined in src/viewer/core/objects/SceneObject.ts:68

showBoundingBoxHelper

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

showNormalsHelper

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

toJson

toJson(): Record<string, any>
Returns Record<string, any>
Overrides SceneMesh.toJson
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:223

Class SceneMeshProxy

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SceneMeshProxy

Properties

ReadonlyavailableTransforms

Readonlychildren

ReadonlyedgesProxy

ReadonlyisDisplayable

ReadonlyisRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneMeshProxy

ReadonlyisSceneObject

isSelectable

ReadonlymeshProxy

name

parent

showInfoboxOnClick

Readonlysignals

transformable

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

emissiveColor

Returns ColorRepresentation

Parameters

Returns void

hover

Returns boolean

Parameters

Returns void

isTransparent

Returns boolean

metalness

Returns number

Parameters

Returns void

opacity

Returns number

Parameters

Returns void

roughness

Returns number

Parameters

Returns void

selected

Returns boolean

Parameters

Returns void

type

Returns string

visible

Returns boolean

Parameters

Returns void

xRay

Returns boolean

Parameters

`Readonly`availableTransforms

`Readonly`children

`Readonly`edgesProxy

`Readonly`isDisplayable

`Readonly`isRaycastable

`Readonly`isSceneMesh

`Readonly`isSceneMeshProxy

`Readonly`isSceneObject

`Readonly`meshProxy

`Readonly`signals

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD