Class: SimplePlane

components.SimplePlane

Each of the planes created by SimpleClipper.

Hierarchy

• Component<THREE.Plane>

  ↳ SimplePlane

  ↳↳ EdgesPlane

Implements

• Disposable
• Updateable
• Hideable

Properties

afterUpdate

• afterUpdate: Event<Plane>

afterUpdate

Implementation of

Updateable.afterUpdate

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:23

---

beforeUpdate

• beforeUpdate: Event<Plane>

beforeUpdate

Implementation of

Updateable.beforeUpdate

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:26

---

draggingEnded

• draggingEnded: Event<void>

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

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:32

---

draggingStarted

• draggingStarted: Event<void>

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

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:29

---

name

• name: string = "SimplePlane"

name

Overrides

Component.name

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:20

Accessors

enabled

• get enabled(): boolean

enabled

Returns

boolean

Overrides

Component.enabled

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:52

• set enabled(state): void

enabled

Parameters

Name	Type
state	boolean

Returns

void

Overrides

Component.enabled

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:57

---

meshes

• get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

The meshes used for raycasting

Returns

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:76

---

planeMaterial

• get planeMaterial(): Material | Material[]

The material of the clipping plane representation.

Returns

Material | Material[]

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:81

• set planeMaterial(material): void

The material of the clipping plane representation.

Parameters

Name	Type
material	Material | Material[]

Returns

void

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:86

---

size

• get size(): number

The size of the clipping plane representation.

Returns

number

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:91

• set size(size): void

Sets the size of the clipping plane representation.

Parameters

Name	Type
size	number

Returns

void

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:96

---

visible

• get visible(): boolean

visible

Returns

boolean

Implementation of

Hideable.visible

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:63

• set visible(state): void

visible

Parameters

Name	Type
state	boolean

Returns

void

Implementation of

Hideable.visible

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:68

Methods

dispose

▸ dispose(): void

dispose

Returns

void

Implementation of

Disposable.dispose

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:138

---

get

▸ get(): Plane

get

Returns

Plane

Overrides

Component.get

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:133

---

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

---

update

▸ update(): void

update

Returns

void

Implementation of

Updateable.update

Defined in

temp/components/core/SimpleClipper/simple-plane.ts:122