Class: OrientationMarkerTool
The OrientationMarker is a tool that includes an orientation marker in viewports when activated
Extends
Constructors
new OrientationMarkerTool()
new OrientationMarkerTool(
toolProps,defaultToolProps):OrientationMarkerTool
Parameters
• toolProps = {}
• defaultToolProps = ...
• defaultToolProps.configuration = ...
• defaultToolProps.configuration.orientationWidget = ...
• defaultToolProps.configuration.orientationWidget.enabled: boolean = true
• defaultToolProps.configuration.orientationWidget.maxPixelSize: number = 300
• defaultToolProps.configuration.orientationWidget.minPixelSize: number = 100
• defaultToolProps.configuration.orientationWidget.viewportCorner: Corners = vtkOrientationMarkerWidget.Corners.BOTTOM_RIGHT
• defaultToolProps.configuration.orientationWidget.viewportSize: number = 0.15
• defaultToolProps.configuration.overlayConfiguration: OverlayConfiguration = ...
• defaultToolProps.configuration.overlayMarkerType: OverlayMarkerType = OrientationMarkerTool.OVERLAY_MARKER_TYPES.ANNOTATED_CUBE
Returns
Overrides
Defined in
tools/src/tools/OrientationMarkerTool.ts:77
Properties
_resizeObservers
_resizeObservers:
Map<any,any>
Defined in
tools/src/tools/OrientationMarkerTool.ts:73
configuration
configuration:
Record<string,any>
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:17
mode
mode:
ToolModes
Tool Mode - Active/Passive/Enabled/Disabled/
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:21
orientationMarkers
orientationMarkers:
any
Defined in
tools/src/tools/OrientationMarkerTool.ts:71
polyDataURL
polyDataURL:
any
Defined in
tools/src/tools/OrientationMarkerTool.ts:72
supportedInteractionTypes
supportedInteractionTypes:
InteractionTypes[]
Supported Interaction Types - currently only Mouse
Inherited from
BaseTool.supportedInteractionTypes
Defined in
tools/src/tools/base/BaseTool.ts:15
toolGroupId
toolGroupId:
string
ToolGroup ID the tool instance belongs to
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:19
AXIS
staticAXIS:number=2
Defined in
tools/src/tools/OrientationMarkerTool.ts:69
CUBE
staticCUBE:number=1
Defined in
tools/src/tools/OrientationMarkerTool.ts:68
OVERLAY_MARKER_TYPES
staticOVERLAY_MARKER_TYPES: typeofOverlayMarkerType=OverlayMarkerType
Defined in
tools/src/tools/OrientationMarkerTool.ts:75
toolName
statictoolName:any
Overrides
Defined in
tools/src/tools/OrientationMarkerTool.ts:67
VTPFILE
staticVTPFILE:number=3
Defined in
tools/src/tools/OrientationMarkerTool.ts:70
Methods
_getViewportsInfo()
_getViewportsInfo():
any[]
Returns
any[]
Defined in
tools/src/tools/OrientationMarkerTool.ts:145
_subscribeToViewportEvents()
_subscribeToViewportEvents():
void
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:190
_unsubscribeToViewportNewVolumeSet()
_unsubscribeToViewportNewVolumeSet():
void
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:161
addAxisActorInViewport()
addAxisActorInViewport(
viewport):Promise<void>
Parameters
• viewport: any
Returns
Promise<void>
Defined in
tools/src/tools/OrientationMarkerTool.ts:284
applyActiveStrategy()
applyActiveStrategy(
enabledElement,operationData):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.
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:62
applyActiveStrategyCallback()
applyActiveStrategyCallback(
enabledElement,operationData,callbackType):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.
Inherited from
BaseTool.applyActiveStrategyCallback
Defined in
tools/src/tools/base/BaseTool.ts:86
createAnnotatedCubeActor()
createAnnotatedCubeActor():
Promise<vtkAnnotatedCubeActor>
Returns
Promise<vtkAnnotatedCubeActor>
Defined in
tools/src/tools/OrientationMarkerTool.ts:389
getTargetId()
protectedgetTargetId(viewport):string
Get the target Id for the viewport which will be used to store the cached statistics scoped to that target in the annotations. For StackViewport, targetId is the viewportId, but for the volume viewport, the targetId will be grabbed from the volumeId if particularly specified in the tool configuration, or if not, the first actorUID in the viewport.
Parameters
• viewport: Viewport
viewport to get the targetId for
Returns
string
targetId
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:197
getTargetImageData()
protectedgetTargetImageData(targetId):IImageData|CPUIImageData
Get the image that is displayed for the targetId in the cachedStats which can be
imageId:<imageId>volumeId:<volumeId>videoId:<basePathForVideo>/frames/<frameSpecifier>
Parameters
• targetId: string
annotation targetId stored in the cached stats
Returns
IImageData | CPUIImageData
The image data for the target.
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:140
getToolName()
getToolName():
string
Returns the name of the tool
Returns
string
The name of the tool.
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:50
onSetToolActive()
onSetToolActive():
void
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:134
onSetToolDisabled()
onSetToolDisabled():
void
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:140
onSetToolEnabled()
onSetToolEnabled():
void
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:129
resize()
resize(
viewportId):void
Parameters
• viewportId: any
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:151
setActiveStrategy()
setActiveStrategy(
strategyName):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
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:126
setConfiguration()
setConfiguration(
newConfiguration):void
merges the new configuration with the tool configuration
Parameters
• newConfiguration: Record<string, any>
Returns
void