Class ClipPlaneTool

Hierarchy

Tool
- ClipPlaneTool

Implements

SnappingTool

Index

Constructors

Accessors

allowedSnapTypes controlsVisible enabled intersectingClipPlanes name snapTypes Name

Methods

add clear getClipPlanes remove removeById

Constructors

constructor

new ClipPlaneTool(_inputs, _api, _modelBuilder, _trimbimSettings): ClipPlaneTool
Parameters
- _inputs: InputHandler
- _api: Api
- _modelBuilder: ModelBuilder
- _trimbimSettings: TrimbimSettings
Returns ClipPlaneTool
Overrides Tool.constructor
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:97

Accessors

allowedSnapTypes

get allowedSnapTypes(): SnapType[]
Returns SnapType[]
Implementation of SnappingTool.allowedSnapTypes
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:50

controlsVisible

get controlsVisible(): boolean
Returns boolean
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:164
set controlsVisible(visible): void
Parameters
- visible: boolean
Returns void
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:168

enabled

get enabled(): boolean
Returns boolean
Overrides Tool.enabled
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:93
set enabled(enabled): void
Parameters
- enabled: boolean
Returns void
Overrides Tool.enabled
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:75

intersectingClipPlanes

get intersectingClipPlanes(): boolean
Returns boolean
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:71
set intersectingClipPlanes(value): void
Parameters
- value: boolean
Returns void
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:67

name

get name(): string
Returns string
Overrides Tool.name
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:63

snapTypes

get snapTypes(): SnapType[]
Returns SnapType[]
Implementation of SnappingTool.snapTypes
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:54
set snapTypes(value): void
Parameters
- value: SnapType[]
Returns void
Implementation of SnappingTool.snapTypes
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:58

`Static` Name

get Name(): string
Returns string
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:32

Methods

add

add(position, normal, color?, origin?): ClipPlane
Parameters
- position: Vector3
- normal: Vector3
- Optional color: Color
- Optional origin: any
Returns ClipPlane
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:276

clear

clear(origin?): void
Parameters
- Optional origin: any
Returns void
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:357

getClipPlanes

getClipPlanes(): ClipPlane[]
Returns ClipPlane[]
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:202

remove

remove(plane, origin?): void
Parameters
- plane: Plane
- Optional origin: any
Returns void
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:305

removeById

removeById(id, origin?): void
Parameters
- id: number
- Optional origin: any
Returns void
- Defined in packages/web3d-plugin-trimbim/src/Tools/ClipPlaneTool.ts:310