Class Zone

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)

SceneMeshProxy
- Zone

Constructors

constructor

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

Properties

`Readonly`children

children: SceneObject[] = ...

`Readonly`edgesProxy

edgesProxy: null | LineProxy<BaseContainer<Material>>

`Readonly`isMovable

isMovable: true

Indicates whether the object can be transformed in the scene

`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`isZone

isZone: true

`Readonly`meshProxy

meshProxy: MeshProxy

name

name: string = ''

parent

parent: null | SceneObject = null

`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

`Static` `Readonly`TRANSPARENCY_THRESHOLD

TRANSPARENCY_THRESHOLD: 0.95

Accessors

areEdgesTransparent

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

diffuseColor

get diffuseColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from SceneMeshProxy.diffuseColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:59
set diffuseColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from SceneMeshProxy.diffuseColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:55

edgesColor

get edgesColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from SceneMeshProxy.edgesColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:111
set edgesColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from SceneMeshProxy.edgesColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:106

edgesOpacity

get edgesOpacity(): number
Returns number
Inherited from SceneMeshProxy.edgesOpacity
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:120
set edgesOpacity(value: number): void
Parameters
- value: number
Returns void
Inherited from SceneMeshProxy.edgesOpacity
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:115

emissiveColor

get emissiveColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from SceneMeshProxy.emissiveColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:102
set emissiveColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from SceneMeshProxy.emissiveColor
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:98

isTransparent

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

metalness

get metalness(): number
Returns number
Inherited from SceneMeshProxy.metalness
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:86
set metalness(metalness: number): void
Parameters
- metalness: number
Returns void
Inherited from SceneMeshProxy.metalness
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:82

opacity

get opacity(): number
Returns number
Inherited from SceneMeshProxy.opacity
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:68
set opacity(opacity: number): void
Parameters
- opacity: number
Returns void
Inherited from SceneMeshProxy.opacity
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:63

roughness

get roughness(): number
Returns number
Inherited from SceneMeshProxy.roughness
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:94
set roughness(roughness: number): void
Parameters
- roughness: number
Returns void
Inherited from SceneMeshProxy.roughness
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:90

selected

get selected(): boolean
Returns boolean
Inherited from SceneMeshProxy.selected
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:130
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshProxy.selected
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:124

type

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

visible

get visible(): boolean
Returns boolean
Inherited from SceneMeshProxy.visible
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:41
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshProxy.visible
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:35

xRay

get xRay(): boolean
Returns boolean
Inherited from SceneMeshProxy.xRay
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:78
set xRay(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshProxy.xRay
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:72

Methods

addChild

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

applyMatrix

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

copyMaterials

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

dispose

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

getBoundingBox

getBoundingBox(box: Box3): Box3
Parameters
- box: Box3
Returns Box3
Inherited from SceneMeshProxy.getBoundingBox
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:151

getBoundingSphere

getBoundingSphere(sphere: Sphere): Sphere
Parameters
- sphere: Sphere
Returns Sphere
Inherited from SceneMeshProxy.getBoundingSphere
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:155

getGizmoController

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

getMaterial

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

getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
Inherited from SceneMeshProxy.getMatrix
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:159

getPosition

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

getStateController

getStateController(): ObjectStateController<Zone>
Returns ObjectStateController<Zone>
Inherited from SceneMeshProxy.getStateController
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:31

parentsGenerator

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

raycast

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

removeFromParent

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

setMatrix

setMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from SceneMeshProxy.setMatrix
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:163

setPosition

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

showBoundingBoxHelper

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

showNormalsHelper

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

toJson

toJson(): Record<string, any>
Returns Record<string, any>
Inherited from SceneMeshProxy.toJson
- Defined in src/viewer/core/objects/mesh/SceneMeshProxy.ts:203

Class Zone

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Zone

Properties

Readonlychildren

ReadonlyedgesProxy

ReadonlyisMovable

ReadonlyisRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneMeshProxy

ReadonlyisSceneObject

isSelectable

ReadonlyisZone

ReadonlymeshProxy

name

parent

ReadonlyshowInfoboxOnClick

Readonlysignals

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

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

Returns void

Methods

addChild

Parameters

Returns void

`Readonly`children

`Readonly`edgesProxy

`Readonly`isMovable

`Readonly`isRaycastable

`Readonly`isSceneMesh

`Readonly`isSceneMeshProxy

`Readonly`isSceneObject

`Readonly`isZone

`Readonly`meshProxy

`Readonly`showInfoboxOnClick

`Readonly`signals

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD