SegmentSelectTool

Represents a tool used for segment selection. It is used to select a segment by hovering over it.

Hierarchy

• BaseTool
  • SegmentSelectTool

Index

Constructors

• constructor

Properties

• configuration
• mode
• supportedInteractionTypes
• toolGroupId
• SelectMode
• toolName

Methods

• _setActiveSegment
• _setActiveSegmentForType
• applyActiveStrategy
• applyActiveStrategyCallback
• getToolName
• mouseMoveCallback
• onSetToolActive
• onSetToolDisabled
• onSetToolEnabled
• setActiveStrategy
• setConfiguration

Constructors

constructor

• new SegmentSelectTool(toolProps?: PublicToolProps, defaultToolProps?: SharedToolProp): SegmentSelectTool

• Overrides BaseTool.constructor

  Parameters

  • toolProps: PublicToolProps = {}

  • defaultToolProps: SharedToolProp = ...

  Returns SegmentSelectTool

Properties

publicconfiguration

configuration: Record<string, any>

Inherited from BaseTool.configuration

publicmode

mode: ToolModes

Inherited from BaseTool.mode

Tool Mode - Active/Passive/Enabled/Disabled/

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Inherited from BaseTool.supportedInteractionTypes

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

Inherited from BaseTool.toolGroupId

ToolGroup ID the tool instance belongs to

staticSelectMode

SelectMode: { Border: string; Inside: string } = ...

Type declaration

• Border: string

• Inside: string

statictoolName

toolName: any

Overrides BaseTool.toolName

Methods

_setActiveSegment

• _setActiveSegment(evt?: InteractionEventType): void

• Parameters

  • evt: InteractionEventType = ...

  Returns void

_setActiveSegmentForType

• _setActiveSegmentForType(activeSegmentationReps: ToolGroupSpecificRepresentation, worldPoint: Point3, viewport: default | default): void

• Parameters

  • activeSegmentationReps: ToolGroupSpecificRepresentation

  • worldPoint: Point3

  • viewport: default | default

  Returns void

publicapplyActiveStrategy

• applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): any

• Inherited from BaseTool.applyActiveStrategy

  Applies the active strategy function to the enabled element with the specified operation data.

  ---

  Parameters

  • enabledElement: IEnabledElement

    The element that is being operated on.

  • operationData: unknown

    The data that needs to be passed to the strategy.

  Returns any

  The result of the strategy.

publicapplyActiveStrategyCallback

• applyActiveStrategyCallback(enabledElement: IEnabledElement, operationData: unknown, callbackType: string): any

• Inherited from BaseTool.applyActiveStrategyCallback

  Applies the active strategy, with a given event type being applied. The event type function is found by indexing it on the active strategy function.

  ---

  Parameters

  • enabledElement: IEnabledElement

    The element that is being operated on.

  • operationData: unknown

    The data that needs to be passed to the strategy.

  • callbackType: string

    the type of the callback

  Returns any

  The result of the strategy.

publicgetToolName

• getToolName(): string

• Inherited from BaseTool.getToolName

  Returns the name of the tool

  ---

  Returns string

  The name of the tool.

mouseMoveCallback

• mouseMoveCallback(evt: InteractionEventType): boolean

• Parameters

  • evt: InteractionEventType

  Returns boolean

onSetToolActive

• onSetToolActive(): void

• Returns void

onSetToolDisabled

• onSetToolDisabled(): void

• Returns void

onSetToolEnabled

• onSetToolEnabled(): void

• Returns void

publicsetActiveStrategy

• setActiveStrategy(strategyName: string): void

• Inherited from BaseTool.setActiveStrategy

  Sets the active strategy for a tool. Strategies are multiple implementations of tool behavior that can be switched by tool configuration.

  ---

  Parameters

  • strategyName: string

    name of the strategy to be set as active

  Returns void

publicsetConfiguration

• setConfiguration(newConfiguration: Record<string, any>): void

• Inherited from BaseTool.setConfiguration

  merges the new configuration with the tool configuration

  ---

  Parameters

  • newConfiguration: Record<string, any>

  Returns void