Class: EdgesPlane
components.EdgesPlane
A more advanced version of SimpleClipper that also includes ClippingEdges with customizable lines.
Hierarchy
↳
EdgesPlane
Properties
afterUpdate
• afterUpdate: Event<Plane>
Inherited from
Defined in
temp/components/core/SimpleClipper/simple-plane.ts:23
beforeUpdate
• beforeUpdate: Event<Plane>
Inherited from
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.
Inherited from
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.
Inherited from
Defined in
temp/components/core/SimpleClipper/simple-plane.ts:29
edgesMaxUpdateRate
• edgesMaxUpdateRate: number = 50
The max rate in milliseconds at which edges can be regenerated. To disable this behaviour set this to 0.
Defined in
temp/components/navigation/EdgesClipper/src/edges-plane.ts:17
name
• name: string = "SimplePlane"
Inherited from
Defined in
temp/components/core/SimpleClipper/simple-plane.ts:20
Accessors
enabled
• get enabled(): boolean
Returns
boolean
Inherited from
SimplePlane.enabled
Defined in
temp/components/core/SimpleClipper/simple-plane.ts:52
• set enabled(state): void
Parameters
| Name | Type |
|---|---|
state | boolean |
Returns
void
Inherited from
SimplePlane.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[]>[]
Inherited from
SimplePlane.meshes
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[]
Inherited from
SimplePlane.planeMaterial
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
Inherited from
SimplePlane.planeMaterial
Defined in
temp/components/core/SimpleClipper/simple-plane.ts:86
size
• get size(): number
The size of the clipping plane representation.
Returns
number
Inherited from
SimplePlane.size
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
Inherited from
SimplePlane.size
Defined in
temp/components/core/SimpleClipper/simple-plane.ts:96
visible
• set visible(state): void
Parameters
| Name | Type |
|---|---|
state | boolean |
Returns
void
Overrides
SimplePlane.visible
Defined in
temp/components/navigation/EdgesClipper/src/edges-plane.ts:34
Methods
dispose
▸ dispose(): void
Returns
void
Overrides
Defined in
temp/components/navigation/EdgesClipper/src/edges-plane.ts:40
get
▸ get(): Plane
Returns
Plane
Inherited from
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
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
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
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
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
Defined in
temp/components/base-types/component.ts:38
update
▸ update(): void
Returns
void
Overrides
Defined in
temp/components/navigation/EdgesClipper/src/edges-plane.ts:46