Skip to main content

OrientationMarkerTool

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

Hierarchy

Index

Constructors

constructor

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

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

    Returns OrientationMarkerTool

Properties

publicconfiguration

configuration: Record<string, any>

configuration_invalidated

configuration_invalidated: boolean = true

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

orientationMarkers

orientationMarkers: any

polyDataURL

polyDataURL: any

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

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

Methods

addAxisActorInViewport

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

    • viewport: any

    Returns Promise<void>

publicapplyActiveStrategy

  • applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): any
  • 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
  • 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
  • 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

publicsetActiveStrategy

  • setActiveStrategy(strategyName: string): void
  • 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
  • merges the new configuration with the tool configuration


    Parameters

    • newConfiguration: Record<string, any>

    Returns void