Class: EdgesClipper
components.EdgesClipper
A more advanced version of SimpleClipper that also supports ClippingEdges with customizable lines.
Hierarchy
↳
EdgesClipper
Properties
afterCreate
• afterCreate: Event<EdgesPlane>
Inherited from
Defined in
temp/components/core/SimpleClipper/index.ts:34
afterDelete
• afterDelete: Event<EdgesPlane>
Inherited from
Defined in
temp/components/core/SimpleClipper/index.ts:37
afterDrag
• afterDrag: Event<void>
Event that fires when the user stops dragging a clipping plane.
Inherited from
Defined in
temp/components/core/SimpleClipper/index.ts:66
beforeDrag
• beforeDrag: Event<void>
Event that fires when the user starts dragging a clipping plane.
Inherited from
Defined in
temp/components/core/SimpleClipper/index.ts:63
name
• name: string = "EdgesClipper"
Overrides
Defined in
temp/components/navigation/EdgesClipper/index.ts:17
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.
Inherited from
Defined in
temp/components/core/SimpleClipper/index.ts:53
styles
• styles: EdgesStyles
The list of defined LineStyle instances.
Defined in
temp/components/navigation/EdgesClipper/index.ts:14
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.
Inherited from
SimpleClipper.toleranceOrthogonalY
Defined in
temp/components/core/SimpleClipper/index.ts:60
Accessors
enabled
• get enabled(): boolean
Returns
boolean
Inherited from
SimpleClipper.enabled
Defined in
temp/components/core/SimpleClipper/index.ts:75
• set enabled(state): void
Parameters
| Name | Type |
|---|---|
state | boolean |
Returns
void
Inherited from
SimpleClipper.enabled
Defined in
temp/components/core/SimpleClipper/index.ts:80
material
• get material(): Material
The material of the clipping plane representation.
Returns
Material
Inherited from
SimpleClipper.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
Inherited from
SimpleClipper.material
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
Inherited from
SimpleClipper.size
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
Inherited from
SimpleClipper.size
Defined in
temp/components/core/SimpleClipper/index.ts:121
visible
• get visible(): boolean
Returns
boolean
Inherited from
SimpleClipper.visible
Defined in
temp/components/core/SimpleClipper/index.ts:90
• set visible(state): void
Parameters
| Name | Type |
|---|---|
state | boolean |
Returns
void
Inherited from
SimpleClipper.visible
Defined in
temp/components/core/SimpleClipper/index.ts:95
Methods
create
▸ create(): void
Returns
void
Inherited from
Defined in
temp/components/core/SimpleClipper/index.ts:163
createFromNormalAndCoplanarPoint
▸ createFromNormalAndCoplanarPoint(normal, point): EdgesPlane
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
Inherited from
SimpleClipper.createFromNormalAndCoplanarPoint
Defined in
temp/components/core/SimpleClipper/index.ts:179
delete
▸ delete(plane?): void
Parameters
| Name | Type | Description |
|---|---|---|
plane? | EdgesPlane | the plane to delete. If undefined, the the first plane found under the cursor will be deleted. |
Returns
void
Inherited from
Defined in
temp/components/core/SimpleClipper/index.ts:194
deleteAll
▸ deleteAll(): void
Deletes all the existing clipping planes.
Returns
void
Inherited from
Defined in
temp/components/core/SimpleClipper/index.ts:202
dispose
▸ dispose(): void
Returns
void
Overrides
Defined in
temp/components/navigation/EdgesClipper/index.ts:28
get
▸ get(): EdgesPlane[]
Returns
Inherited from
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
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
updateEdges
▸ updateEdges(): void
Updates all the lines of the ClippingEdges.
Returns
void
Defined in
temp/components/navigation/EdgesClipper/index.ts:36