Class ClippingPlane

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

Hierarchy (View Summary)

SceneMesh
- ClippingPlane

Constructors

constructor

new ClippingPlane(
initialPlaneType: ClippingPlaneType,
position: Vector3,
): ClippingPlane
Parameters
- initialPlaneType: ClippingPlaneType
- position: Vector3
Returns ClippingPlane
Overrides SceneMesh.constructor
- Defined in src/viewer/core/objects/clippingPlane/ClippingPlane.ts:90

Properties

`Readonly`availableTransforms

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

Indicates which gizmo controls are available for the object

`Readonly`children

children: SceneObject[] = ...

diffuseColor

diffuseColor: ColorRepresentation = 0xffffff

`Readonly`edgesColor

edgesColor: 0 = 0x000000

`Readonly`edgesOpacity

edgesOpacity: 1

`Readonly`emissiveColor

emissiveColor: 0 = 0x000000

Basic material doesn't have an emissive color

`Readonly`isClippingPlane

isClippingPlane: true

`Readonly`isDisplayable

isDisplayable: true

`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

`Readonly`mesh

mesh: Mesh

`Readonly`metalness

metalness: 0

Basic material doesn't have a metalness

`Readonly`name

name: "Clipping plane object" = 'Clipping plane object'

parent

parent: null | SceneObject = null

`Readonly`plane

plane: Plane

planeType

planeType: ClippingPlaneType

`Readonly`roughness

roughness: 1

Basic material doesn't have a roughness

`Readonly`showInfoboxOnClick

showInfoboxOnClick: false

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 = true

Indicates whether the object can be transformed in the scene

userData

userData: Record<string, any> = {}

`Readonly`uuid

uuid: string

Unique identifier of the object

xRay

xRay: boolean = false

`Static` `Readonly`TRANSPARENCY_THRESHOLD

TRANSPARENCY_THRESHOLD: 0.95

Accessors

active

get active(): boolean
Returns boolean
Inherited from SceneMesh.active
- Defined in src/viewer/core/objects/SceneObject.ts:136

areEdgesTransparent

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

hover

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

isTransparent

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

opacity

get opacity(): number
Returns number
Overrides SceneMesh.opacity
- Defined in src/viewer/core/objects/clippingPlane/ClippingPlane.ts:132
set opacity(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.opacity
- Defined in src/viewer/core/objects/clippingPlane/ClippingPlane.ts:136

selected

get selected(): boolean
Returns boolean
Inherited from SceneMesh.selected
- Defined in src/viewer/core/objects/SceneObject.ts:147
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMesh.selected
- Defined in src/viewer/core/objects/SceneObject.ts:140

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/clippingPlane/ClippingPlane.ts:123
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.visible
- Defined in src/viewer/core/objects/clippingPlane/ClippingPlane.ts:127

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/clippingPlane/ClippingPlane.ts:244

getBoundingSphere

getBoundingSphere(sphere: Sphere): Sphere
Parameters
- sphere: Sphere
Returns Sphere
Overrides SceneMesh.getBoundingSphere
- Defined in src/viewer/core/objects/clippingPlane/ClippingPlane.ts:248

getGizmoController

getGizmoController(
viewer: Viewer,
transformGroup: TransformGroup<ClippingPlane>,
): ClippingPlaneGizmoController
Parameters
- viewer: Viewer
- transformGroup: TransformGroup<ClippingPlane>
Returns ClippingPlaneGizmoController
Overrides SceneMesh.getGizmoController
- Defined in src/viewer/core/objects/clippingPlane/ClippingPlane.ts:254

getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
Overrides SceneMesh.getMatrix
- Defined in src/viewer/core/objects/clippingPlane/ClippingPlane.ts:150

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Overrides SceneMesh.getPosition
- Defined in src/viewer/core/objects/clippingPlane/ClippingPlane.ts:140

getStateController

getStateController(): ObjectStateController<ClippingPlane>
Returns ObjectStateController<ClippingPlane>
Inherited from SceneMesh.getStateController
- Defined in src/viewer/core/objects/mesh/SceneMesh.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/clippingPlane/ClippingPlane.ts:211

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/clippingPlane/ClippingPlane.ts:156

setPosition

setPosition(position: Vector3): void
Parameters
- position: Vector3
Returns void
Overrides SceneMesh.setPosition
- Defined in src/viewer/core/objects/clippingPlane/ClippingPlane.ts:144

setSize

setSize(size: number): void
Parameters
- size: number
Returns void
- Defined in src/viewer/core/objects/clippingPlane/ClippingPlane.ts:119

showBoundingBoxHelper

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

showNormalsHelper

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

toJson

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

Class ClippingPlane

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ClippingPlane

Properties

ReadonlyavailableTransforms

Readonlychildren

diffuseColor

ReadonlyedgesColor

ReadonlyedgesOpacity

ReadonlyemissiveColor

ReadonlyisClippingPlane

ReadonlyisDisplayable

ReadonlyisRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneObject

isSelectable

Readonlymesh

Readonlymetalness

Readonlyname

parent

Readonlyplane

planeType

Readonlyroughness

ReadonlyshowInfoboxOnClick

Readonlysignals

transformable

userData

Readonlyuuid

xRay

Static ReadonlyTRANSPARENCY_THRESHOLD

Accessors

active

Returns boolean

areEdgesTransparent

Returns boolean

hover

Returns boolean

Parameters

Returns void

isTransparent

Returns boolean

opacity

Returns number

Parameters

Returns void

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

getBoundingBox

Parameters

Returns Box3

getBoundingSphere

Parameters

`Readonly`availableTransforms

`Readonly`children

`Readonly`edgesColor

`Readonly`edgesOpacity

`Readonly`emissiveColor

`Readonly`isClippingPlane

`Readonly`isDisplayable

`Readonly`isRaycastable

`Readonly`isSceneMesh

`Readonly`isSceneObject

`Readonly`mesh

`Readonly`metalness

`Readonly`name

`Readonly`plane

`Readonly`roughness

`Readonly`showInfoboxOnClick

`Readonly`signals

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD