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 packages/viewer/src/scene/objects/clippingPlane/ClippingPlane.ts:91

Properties

`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

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

`Readonly`mesh

mesh: Mesh

`Readonly`metalness

metalness: 0

Basic material doesn't have a metalness

`Readonly`name

name: "ClippingPlane" = 'ClippingPlane'

parent

parent: SceneObject | null = null

`Readonly`plane

plane: Plane

planeType

planeType: ClippingPlaneType

`Readonly`roughness

roughness: 1

Basic material doesn't have a roughness

`Readonly`signals

signals: {
onSelectedChanged: ViewerSignal<(...args: any[]) => any>;
onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
} = ...

transformConfig

transformConfig: ObjectTransformConfig = ...

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 packages/viewer/src/scene/objects/SceneObject.ts:164

areEdgesTransparent

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

hover

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

isTransparent

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

opacity

get opacity(): number
Returns number
Overrides SceneMesh.opacity
- Defined in packages/viewer/src/scene/objects/clippingPlane/ClippingPlane.ts:134
set opacity(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.opacity
- Defined in packages/viewer/src/scene/objects/clippingPlane/ClippingPlane.ts:138

selected

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

type

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

visible

get visible(): boolean
Returns boolean
Overrides SceneMesh.visible
- Defined in packages/viewer/src/scene/objects/clippingPlane/ClippingPlane.ts:125
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.visible
- Defined in packages/viewer/src/scene/objects/clippingPlane/ClippingPlane.ts:129

Methods

addChild

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

applyMatrix

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

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:59

dispose

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

getBoundingBox

getBoundingBox(box: Box3): Box3
Parameters
- box: Box3
Returns Box3
Overrides SceneMesh.getBoundingBox
- Defined in packages/viewer/src/scene/objects/clippingPlane/ClippingPlane.ts:258

getBoundingSphere

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

getMatrix

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

getPosition

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

getStateController

getStateController(): ObjectStateController<ClippingPlane>
Returns ObjectStateController<ClippingPlane>
Inherited from SceneMesh.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 SceneMesh.parentsGenerator
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:124

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

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

removeFromParent

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

setMatrix

setMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Overrides SceneMesh.setMatrix
- Defined in packages/viewer/src/scene/objects/clippingPlane/ClippingPlane.ts:158

setPosition

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

setSize

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

showBoundingBoxHelper

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

showNormalsHelper

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

toJson

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

Class ClippingPlane

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ClippingPlane

Properties

Readonlychildren

diffuseColor

ReadonlyedgesColor

ReadonlyedgesOpacity

ReadonlyemissiveColor

ReadonlyisClippingPlane

ReadonlyisDisplayable

isRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneObject

isSelectable

isTransformable

Readonlymesh

Readonlymetalness

Readonlyname

parent

Readonlyplane

planeType

Readonlyroughness

Readonlysignals

transformConfig

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

Returns Sphere

`Readonly`children

`Readonly`edgesColor

`Readonly`edgesOpacity

`Readonly`emissiveColor

`Readonly`isClippingPlane

`Readonly`isDisplayable

`Readonly`isSceneMesh

`Readonly`isSceneObject

`Readonly`mesh

`Readonly`metalness

`Readonly`name

`Readonly`plane

`Readonly`roughness

`Readonly`signals

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD