Class: SimpleClipper<Plane>

components.SimpleClipper

A lightweight component to easily create and handle clipping planes.

Param

the instance of Components used.

Param

the type of plane to be used by the clipper. E.g. SimplePlane.

Type parameters

Name	Type
Plane	extends SimplePlane

Hierarchy

• Component<Plane[]>

  ↳ SimpleClipper

  ↳↳ EdgesClipper

Implements

• Createable
• Disposable
• Hideable
• UI

Properties

afterCreate

• afterCreate: Event<Plane>

afterCreate

Implementation of

Createable.afterCreate

Defined in

temp/components/core/SimpleClipper/index.ts:34

---

afterDelete

• afterDelete: Event<Plane>

afterDelete

Implementation of

Createable.afterDelete

Defined in

temp/components/core/SimpleClipper/index.ts:37

---

afterDrag

• afterDrag: Event<void>

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

Defined in

temp/components/core/SimpleClipper/index.ts:66

---

beforeDrag

• beforeDrag: Event<void>

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

Defined in

temp/components/core/SimpleClipper/index.ts:63

---

name

• name: string = "SimpleClipper"

name

Overrides

Component.name

Defined in

temp/components/core/SimpleClipper/index.ts:31

---

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 it's roof, which might have a slight slope for draining purposes.

Defined in

temp/components/core/SimpleClipper/index.ts:53

---

toleranceOrthogonalY

• toleranceOrthogonalY: number = 0.7

The tolerance that determines whether a horizontallish clipping plane will be forced to be orthogonal to the Y direction. orthogonalY has to be true for this to apply.

Defined in

temp/components/core/SimpleClipper/index.ts:60

Accessors

enabled

• get enabled(): boolean

enabled

Returns

boolean

Overrides

Component.enabled

Defined in

temp/components/core/SimpleClipper/index.ts:75

• set enabled(state): void

enabled

Parameters

Name	Type
state	boolean

Returns

void

Overrides

Component.enabled

Defined in

temp/components/core/SimpleClipper/index.ts:80

---

material

• get material(): Material

The material of the clipping plane representation.

Returns

Material

Defined in

temp/components/core/SimpleClipper/index.ts:103

• set material(material): void

The material of the clipping plane representation.

Parameters

Name	Type
material	Material

Returns

void

Defined in

temp/components/core/SimpleClipper/index.ts:108

---

size

• get size(): number

The size of the geometric representation of the clippings planes.

Returns

number

Defined in

temp/components/core/SimpleClipper/index.ts:116

• set size(size): void

The size of the geometric representation of the clippings planes.

Parameters

Name	Type
size	number

Returns

void

Defined in

temp/components/core/SimpleClipper/index.ts:121

---

visible

• get visible(): boolean

visible

Returns

boolean

Implementation of

Hideable.visible

Defined in

temp/components/core/SimpleClipper/index.ts:90

• set visible(state): void

visible

Parameters

Name	Type
state	boolean

Returns

void

Implementation of

Hideable.visible

Defined in

temp/components/core/SimpleClipper/index.ts:95

Methods

create

▸ create(): void

create

Returns

void

Implementation of

Createable.create

Defined in

temp/components/core/SimpleClipper/index.ts:163

---

createFromNormalAndCoplanarPoint

▸ createFromNormalAndCoplanarPoint(normal, point): Plane

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

Parameters

Name	Type	Description
normal	Vector3	the orientation of the clipping plane.
point	Vector3	the position of the clipping plane.

Returns

Plane

Defined in

temp/components/core/SimpleClipper/index.ts:179

---

delete

▸ delete(plane?): void

delete

Parameters

Name	Type	Description
plane?	Plane	the plane to delete. If undefined, the the first plane found under the cursor will be deleted.

Returns

void

Implementation of

Createable.delete

Defined in

temp/components/core/SimpleClipper/index.ts:194

---

deleteAll

▸ deleteAll(): void

Deletes all the existing clipping planes.

Returns

void

Defined in

temp/components/core/SimpleClipper/index.ts:202

---

dispose

▸ dispose(): void

get

Returns

void

Implementation of

Disposable.dispose

Defined in

temp/components/core/SimpleClipper/index.ts:151

---

get

▸ get(): Plane[]

get

Returns

Plane[]

Overrides

Component.get

Defined in

temp/components/core/SimpleClipper/index.ts:146

---

hasUI

▸ hasUI(): this is UI

Whether is component implements any kind of UI.

Returns

this is UI

Inherited from

Component.hasUI

Defined in

temp/components/base-types/component.ts:48

---

isDisposeable

▸ isDisposeable(): this is Disposable

Whether is component is Disposable.

Returns

this is Disposable

Inherited from

Component.isDisposeable

Defined in

temp/components/base-types/component.ts:28

---

isHideable

▸ isHideable(): this is Hideable

Whether is component is Hideable.

Returns

this is Hideable

Inherited from

Component.isHideable

Defined in

temp/components/base-types/component.ts:43

---

isResizeable

▸ isResizeable(): this is Resizeable

Whether is component is Resizeable.

Returns

this is Resizeable

Inherited from

Component.isResizeable

Defined in

temp/components/base-types/component.ts:33

---

isUpdateable

▸ isUpdateable(): this is Updateable

Whether is component is Updateable.

Returns

this is Updateable

Inherited from

Component.isUpdateable

Defined in

temp/components/base-types/component.ts:38