Class SectionBox

Gizmo for section box, it acts as a proxy between renderer and user.

Hierarchy

SectionBox

Index

Constructors

Accessors

box clip interactive onBoxConfirm onHover onStateChanged visible

Methods

dispose fitBox update

Constructors

constructor

new SectionBox(viewer: Viewer): SectionBox
Parameters
- viewer: Viewer
Returns SectionBox
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:64

Accessors

box

get box(): Box3
Section bounding box, to update the box use fitBox.

Returns Box3
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:104

clip

get clip(): boolean
When true the section gizmo will section the model with clipping planes.

Returns boolean
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:111
set clip(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:115

interactive

get interactive(): boolean
When true the section gizmo will react to user inputs.

Returns boolean
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:125
set interactive(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:129

onBoxConfirm

get onBoxConfirm(): ISimpleEvent<Box3>
Signal dispatched when user is done manipulating the box.

Returns ISimpleEvent<Box3>
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:45

onHover

get onHover(): ISimpleEvent<boolean>
Signal dispatched with true when pointer enters box and false when pointer leaves.

Returns ISimpleEvent<boolean>
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:52

onStateChanged

get onStateChanged(): ISignal
Signal dispatched when clip, show, or interactive are updated.

Returns ISignal
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:38

visible

get visible(): boolean
When true the section gizmo will be rendered.

Returns boolean
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:141
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:145

Methods

dispose

dispose(): void
Removes gizmo from rendering and inputs and dispose all resources.

Returns void
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:178

fitBox

fitBox(box: Box3, padding?: number): void
Sets the section gizmo size to match given box
Parameters
- box: Box3
- padding: number = 1
Returns void
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:159

update

update(): void
Call this if there were direct changes to renderer.section

Returns void
- Defined in src/viewer/gizmos/sectionBox/sectionBox.ts:171

Generated using TypeDoc