Clipper

A lightweight component to easily create, delete and handle clipping planes. 📕 Tutorial. 📘 API.

Extends

• Component

Implements

• Createable
• Disposable
• Hideable
• Configurable<ClipperConfigManager, ClipperConfig>

Properties

Type()

Type: (...args) => SimplePlane = SimplePlane

The type of clipping plane to be created. Default is SimplePlane.

Parameters

Parameter	Type
...args	any

Returns

SimplePlane

---

autoScalePlanes

autoScalePlanes: boolean = true

Whether clipping planes should automatically scale based on camera distance. When true, the plane surface stays proportional to the arrow gizmo as you zoom in/out. Default is true.

---

config

config: ClipperConfigManager

Configurable.config

Implementation of

Configurable . config

---

isSetup

isSetup: boolean = false

Configurable.isSetup

Implementation of

Configurable . isSetup

---

list

readonly list: DataMap<string, SimplePlane>

A list of all the clipping planes created by this component.

---

onAfterCancel

readonly onAfterCancel: Event<unknown>

Event that fires after the user cancels the creation of a clipping plane.

---

onAfterCreate

readonly onAfterCreate: Event <SimplePlane>

Event that fires after a clipping plane has been created.

Param

The newly created clipping plane.

---

onAfterDelete

readonly onAfterDelete: Event <SimplePlane>

Event that fires after a clipping plane has been deleted.

Param

The deleted clipping plane.

---

onAfterDrag

readonly onAfterDrag: Event <SimplePlane>

Event that fires when the user stops dragging a clipping plane.

---

onBeforeCancel

readonly onBeforeCancel: Event<unknown>

Event that fires when the user cancels the creation of a clipping plane.

---

onBeforeCreate

readonly onBeforeCreate: Event<unknown>

Event that fires when the user starts creating a clipping plane.

---

onBeforeDelete

readonly onBeforeDelete: Event<unknown>

Event that fires when the user starts deleting a clipping plane.

---

onBeforeDrag

readonly onBeforeDrag: Event <SimplePlane>

Event that fires when the user starts dragging a clipping plane.

---

onDisposed

readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of

Disposable . onDisposed

---

onSetup

readonly onSetup: Event<unknown>

Configurable.onSetup

Implementation of

Configurable . onSetup

---

orthogonalY

orthogonalY: boolean = false

Whether to force the clipping plane to be orthogonal in the Y direction (up). This is desirable when clipping a building horizontally and a clipping plane is created in its roof, which might have a slight slope for draining purposes.

---

toleranceOrthogonalY

toleranceOrthogonalY: number = 0.7

The tolerance that determines whether an almost-horizontal clipping plane will be forced to be orthogonal to the Y direction. orthogonalY has to be true for this to apply.

---

uuid

static readonly uuid: "66290bc5-18c4-4cd1-9379-2e17a0617611"

A unique identifier for the component. This UUID is used to register the component within the Components system.

Accessors

enabled

get enabled(): boolean

Component.enabled

set enabled(state): void

Component.enabled

Parameters

Parameter	Type
state	boolean

Returns

boolean

---

material

get material(): MeshBasicMaterial

The material of the clipping plane representation.

set material(material): void

The material of the clipping plane representation.

Parameters

Parameter	Type
material	MeshBasicMaterial

Returns

MeshBasicMaterial

---

size

get size(): number

The size of the geometric representation of the clippings planes.

set size(size): void

The size of the geometric representation of the clippings planes.

Parameters

Parameter	Type
size	number

Returns

number

---

visible

get visible(): boolean

Hideable.visible

set visible(state): void

Hideable.visible

Parameters

Parameter	Type
state	boolean

Returns

boolean

Methods

create()

create(world): Promise<null | SimplePlane>

Createable.create

Parameters

Parameter	Type
world	World

Returns

Promise<null | SimplePlane>

Implementation of

Createable . create

---

createFromNormalAndCoplanarPoint()

createFromNormalAndCoplanarPoint(world, normal, point): string

Creates a plane in a certain place and with a certain orientation, without the need of the mouse.

Parameters

Parameter	Type	Description
world	World	the world where this plane should be created.
normal	Vector3	the orientation of the clipping plane.
point	Vector3	the position of the clipping plane.
navigation.

Returns

string

---

delete()

delete(world, planeId?): Promise<void>

Createable.delete

Parameters

Parameter	Type	Description
world	World	the world where the plane to delete is.
planeId?	string	the plane to delete. If undefined, the first plane
found under the cursor will be deleted.

Returns

Promise<void>

Implementation of

Createable . delete

---

deleteAll()

deleteAll(types?): void

Deletes all the existing clipping planes.

Parameters

Parameter	Type	Description
types?	Set<string>	the types of planes to be deleted. If not provided, all planes will be deleted.

Returns

void

---

dispose()

dispose(): void

Disposable.dispose

Returns

void

Implementation of

Disposable . dispose

---

isConfigurable()

isConfigurable(): this is Configurable<any, any>

Whether is component is Configurable.

Returns

this is Configurable<any, any>

Inherited from

Component . isConfigurable

---

isDisposeable()

isDisposeable(): this is Disposable

Whether is component is Disposable.

Returns

this is Disposable

Inherited from

Component . isDisposeable

---

isHideable()

isHideable(): this is Hideable

Whether is component is Hideable.

Returns

this is Hideable

Inherited from

Component . isHideable

---

isResizeable()

isResizeable(): this is Resizeable

Whether is component is Resizeable.

Returns

this is Resizeable

Inherited from

Component . isResizeable

---

isSerializable()

isSerializable(): this is Serializable<any, Record<string, any>>

Whether is component is Serializable.

Returns

this is Serializable<any, Record<string, any>>

Inherited from

Component . isSerializable

---

isUpdateable()

isUpdateable(): this is Updateable

Whether is component is Updateable.

Returns

this is Updateable

Inherited from

Component . isUpdateable

---

setup()

setup(config?): void

Configurable.setup

Parameters

Parameter	Type
config?	Partial<ClipperConfig>

Returns

void

Implementation of

Configurable . setup