# SectionTool

Default section tool implementation.

WARNING

This extension requires and active CameraController extension implementation.

#

Accessors

enabled visible

#

Methods

getBox on removeListener setBox
toggle

#

Typedefs

SectionToolEvent SectionToolEventPayload

#

Accessors

# enabled

get enabled(): boolean
set enabled(value: boolean)
1
2

Enables/disables the extension.

Returns: boolean

# visible

get visible(): boolean
set visible(value: boolean)
1
2

Gets and sets the visbility of the actual section box.

Returns: boolean

#

Methods

# getBox

getBox(): Box3
1

Gets the current section box bounds.

Returns: Box3 (opens new window)

# on

on(e: CameraEvent, handler: (data: boolean) => void)
1

Function for subscribing to camera events.

Parameters

Returns: void

# removeListener

removeListener(e: CameraEvent, handler: (data: unknown) => void)
1

Function for un-subscribing from camera events.

Parameters

  • e: CameraEvent
  • handler: The handler for the events to unsubscribe

Returns: void

# setBox

setBox(targetBox: Box3, offset = 0): void
1

Sets the section box to the specified bounds Parameters

Returns: void

# toggle

toggle(): void
1

Enables/disables the section tool.

Returns: void

#

Typedefs

# SectionToolEvent

enum SectionToolEvent {
  DragStart = "section-box-drag-start",
  DragEnd = "section-box-drag-end",
  Updated = "section-box-changed",
}
1
2
3
4
5

Events that the extension can emit.

# SectionToolEventPayload

interface SectionToolEventPayload {
  [SectionToolEvent.DragStart]: void
  [SectionToolEvent.DragEnd]: void
  [SectionToolEvent.Updated]: Plane[]
}
1
2
3
4
5

Mapping SectionToolEvent types to handler argument type