OrientationMarkerTool

The OrientationMarker is a tool that includes an orientation marker in viewports when activated

Hierarchy

• BaseTool
  • OrientationMarkerTool

Index

Constructors

• constructor

Properties

• _resizeObservers
• configuration
• mode
• orientationMarkers
• polyDataURL
• supportedInteractionTypes
• toolGroupId
• AXIS
• CUBE
• OVERLAY_MARKER_TYPES
• VTPFILE
• toolName

Methods

• _getViewportsInfo
• _subscribeToViewportEvents
• _unsubscribeToViewportNewVolumeSet
• addAxisActorInViewport
• applyActiveStrategy
• applyActiveStrategyCallback
• createAnnotatedCubeActor
• getToolName
• onSetToolActive
• onSetToolDisabled
• onSetToolEnabled
• resize
• setActiveStrategy
• setConfiguration

Constructors

constructor

• new OrientationMarkerTool(toolProps?: {}, defaultToolProps?: { configuration: { orientationWidget: { enabled: boolean; maxPixelSize: number; minPixelSize: number; viewportCorner: Corners; viewportSize: number }; overlayConfiguration: {}; overlayMarkerType: number } }): OrientationMarkerTool

• Overrides BaseTool.constructor

  Parameters

  • toolProps: {} = {}

  • defaultToolProps: { configuration: { orientationWidget: { enabled: boolean; maxPixelSize: number; minPixelSize: number; viewportCorner: Corners; viewportSize: number }; overlayConfiguration: {}; overlayMarkerType: number } } = ...

  Returns OrientationMarkerTool

Properties

_resizeObservers

_resizeObservers: Map<any, any> = ...

publicconfiguration

configuration: Record<string, any>

Inherited from BaseTool.configuration

publicmode

mode: ToolModes

Inherited from BaseTool.mode

Tool Mode - Active/Passive/Enabled/Disabled/

orientationMarkers

orientationMarkers: any

polyDataURL

polyDataURL: any

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

staticAXIS

AXIS: number = 2

staticCUBE

CUBE: number = 1

staticOVERLAY_MARKER_TYPES

OVERLAY_MARKER_TYPES: { ANNOTATED_CUBE: number; AXES: number; CUSTOM: number } = OverlayMarkerType

Type declaration

• ANNOTATED_CUBE: number

• AXES: number

• CUSTOM: number

staticVTPFILE

VTPFILE: number = 3

statictoolName

toolName: any

Overrides BaseTool.toolName

Methods

_getViewportsInfo

• _getViewportsInfo(): any[]

• Returns any[]

_subscribeToViewportEvents

• _subscribeToViewportEvents(): void

• Returns void

_unsubscribeToViewportNewVolumeSet

• _unsubscribeToViewportNewVolumeSet(): void

• Returns void

addAxisActorInViewport

• addAxisActorInViewport(viewport: any): Promise<void>

• Parameters

  • viewport: any

  Returns Promise<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.

createAnnotatedCubeActor

• createAnnotatedCubeActor(): Promise<vtkAnnotatedCubeActor>

• Returns Promise<vtkAnnotatedCubeActor>

publicgetToolName

• getToolName(): string

• Inherited from BaseTool.getToolName

  Returns the name of the tool

  ---

  Returns string

  The name of the tool.

onSetToolActive

• onSetToolActive(): void

• Returns void

onSetToolDisabled

• onSetToolDisabled(): void

• Returns void

onSetToolEnabled

• onSetToolEnabled(): void

• Returns void

resize

• resize(viewportId: any): void

• Parameters

  • viewportId: any

  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