Class SceneMeshProxy

A SceneMesh backed by a mesh proxy into a batched/instanced container for its triangles, and an optional line proxy into a container for its edges. It holds no geometry of its own — every operation forwards to the proxies' containers.

Hierarchy (View Summary)

SceneMesh
- SceneMeshProxy

Constructors

constructor

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

Properties

`Readonly`children

children: SceneObject[] = ...

`Readonly`edgesProxy

edgesProxy: LineProxy<BaseContainer<Material<MaterialEventMap>>> | null

`Readonly`isDisplayable

isDisplayable: true

isRaycastable

isRaycastable: boolean = 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

isTransformable

isTransformable: boolean = true

`Readonly`meshProxy

meshProxy: MeshProxy

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

diffuseColor

get diffuseColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.diffuseColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:84
set diffuseColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.diffuseColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:80

edgesColor

get edgesColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.edgesColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:136
set edgesColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.edgesColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:131

edgesOpacity

get edgesOpacity(): number
Returns number
Overrides SceneMesh.edgesOpacity
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:145
set edgesOpacity(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.edgesOpacity
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:140

edgesVisible

get edgesVisible(): boolean
Returns boolean
Overrides SceneMesh.edgesVisible
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:56
set edgesVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.edgesVisible
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:51

emissiveColor

get emissiveColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.emissiveColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:127
set emissiveColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.emissiveColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:123

hover

get hover(): boolean
Returns boolean
Overrides ClippingPlane.hover
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:70
set hover(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides ClippingPlane.hover
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:74

isTransparent

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

materialName

get materialName(): string
Returns string
Inherited from SceneMesh.materialName
- Defined in packages/viewer/src/scene/objects/mesh/SceneMesh.ts:78
set materialName(value: string): void
Parameters
- value: string
Returns void
Inherited from SceneMesh.materialName
- Defined in packages/viewer/src/scene/objects/mesh/SceneMesh.ts:74

metalness

get metalness(): number
Returns number
Overrides SceneMesh.metalness
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:111
set metalness(metalness: number): void
Parameters
- metalness: number
Returns void
Overrides SceneMesh.metalness
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:107

opacity

get opacity(): number
Returns number
Overrides SceneMesh.opacity
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:93
set opacity(opacity: number): void
Parameters
- opacity: number
Returns void
Overrides SceneMesh.opacity
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:88

roughness

get roughness(): number
Returns number
Overrides SceneMesh.roughness
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:119
set roughness(roughness: number): void
Parameters
- roughness: number
Returns void
Overrides SceneMesh.roughness
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:115

selected

get selected(): boolean
Returns boolean
Overrides SceneMesh.selected
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:155
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.selected
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:149

type

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

visible

get visible(): boolean
Returns boolean
Overrides SceneMesh.visible
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:47
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.visible
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:41

xRay

get xRay(): boolean
Returns boolean
Overrides SceneMesh.xRay
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:103
set xRay(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.xRay
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:97

Methods

addChild

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

applyMatrix

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

copyMaterials

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

dispose

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

getBoundingBox

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

getBoundingSphere

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

getMaterial

getMaterial(): MaterialType
Returns MaterialType
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:239

getMatrix

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

getPosition

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

getStateController

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

parentsGenerator

parentsGenerator(): Generator<SceneObject, void, unknown>
Returns Generator<SceneObject, void, unknown>
Inherited from SceneMesh.parentsGenerator
- Defined in packages/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
Overrides SceneMesh.projectPointOnEdges
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:171

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
Overrides SceneMesh.raycast
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshProxy.ts:159

removeFromParent

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

setMatrix

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

setPosition

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

showBoundingBoxHelper

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

showNormalsHelper

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

toJson

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

Class SceneMeshProxy

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SceneMeshProxy

Properties

Readonlychildren

ReadonlyedgesProxy

ReadonlyisDisplayable

isRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneMeshProxy

ReadonlyisSceneObject

isSelectable

isTransformable

ReadonlymeshProxy

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

materialName

Returns string

Parameters

Returns void

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

`Readonly`children

`Readonly`edgesProxy

`Readonly`isDisplayable

`Readonly`isSceneMesh

`Readonly`isSceneMeshProxy

`Readonly`isSceneObject

`Readonly`meshProxy

`Readonly`signals

`Readonly`transformConfig

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD