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:78
Properties
_resizeObservers
_resizeObservers:
Map<any,any>
Defined in
tools/src/tools/OrientationMarkerTool.ts:74
configuration
configuration:
Record<string,any>
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:19
memo
protectedmemo:Memo
A memo recording the starting state of a tool. This will be updated as changes are made, and reflects the fact that a memo has been created.
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:28
mode
mode:
ToolModes
Tool Mode - Active/Passive/Enabled/Disabled/
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:23
orientationMarkers
orientationMarkers:
any
Defined in
tools/src/tools/OrientationMarkerTool.ts:71
polyDataURL
polyDataURL:
any
Defined in
tools/src/tools/OrientationMarkerTool.ts:73
supportedInteractionTypes
supportedInteractionTypes:
InteractionTypes[]
Supported Interaction Types - currently only Mouse
Inherited from
BaseTool.supportedInteractionTypes
Defined in
tools/src/tools/base/BaseTool.ts:17
toolGroupId
toolGroupId:
string
ToolGroup ID the tool instance belongs to
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:21
updatingOrientationMarker
updatingOrientationMarker:
any
Defined in
tools/src/tools/OrientationMarkerTool.ts:72
AXIS
staticAXIS:number=2
Defined in
tools/src/tools/OrientationMarkerTool.ts:69
CUBE
staticCUBE:number=1
Defined in
tools/src/tools/OrientationMarkerTool.ts:68
defaults
staticdefaults:object
Has the defaults associated with the base tool.
configuration
configuration:
object
configuration.activeStrategy
activeStrategy:
any=undefined
configuration.defaultStrategy
defaultStrategy:
any=undefined
configuration.strategies
strategies:
object={}
configuration.strategyOptions
strategyOptions:
object={}
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:33
OVERLAY_MARKER_TYPES
staticOVERLAY_MARKER_TYPES: typeofOverlayMarkerType=OverlayMarkerType
Defined in
tools/src/tools/OrientationMarkerTool.ts:76
toolName
statictoolName:any
Overrides
Defined in
tools/src/tools/OrientationMarkerTool.ts:67
VTPFILE
staticVTPFILE:number=3
Defined in
tools/src/tools/OrientationMarkerTool.ts:70
Accessors
toolName
gettoolName():string
Newer method for getting the tool name as a property
Returns
string
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:82
Methods
_getViewportsInfo()
_getViewportsInfo():
any[]
Returns
any[]
Defined in
tools/src/tools/OrientationMarkerTool.ts:147
_subscribeToViewportEvents()
_subscribeToViewportEvents():
void
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:192
_unsubscribeToViewportNewVolumeSet()
_unsubscribeToViewportNewVolumeSet():
void
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:163
addAxisActorInViewport()
addAxisActorInViewport(
viewport):Promise<void>
Parameters
• viewport: any
Returns
Promise<void>
Defined in
tools/src/tools/OrientationMarkerTool.ts:288
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:102
applyActiveStrategyCallback()
applyActiveStrategyCallback(
enabledElement,operationData,callbackType, ...extraArgs):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
• ...extraArgs: any[]
Returns
any
The result of the strategy.
Inherited from
BaseTool.applyActiveStrategyCallback
Defined in
tools/src/tools/base/BaseTool.ts:126
createAnnotatedCubeActor()
createAnnotatedCubeActor():
Promise<vtkAnnotatedCubeActor>
Returns
Promise<vtkAnnotatedCubeActor>
Defined in
tools/src/tools/OrientationMarkerTool.ts:399
doneEditMemo()
doneEditMemo():
void
This clears and edit memo storage to allow for further history functions to be called. Calls the complete function if present, and pushes the memo to the history memo stack.
This should be called when a tool has finished making a change which should be separated from future/other changes in terms of the history. Usually that means on endCallback (mouse up), but some tools also make changes on the initial creation of an object or have alternate flows and the doneEditMemo has to be called on mouse down or other initiation events to ensure that new changes are correctly recorded.
If the tool has no end callback, then the doneEditMemo is called from the pre mouse down callback. See ZoomTool for an example of this usage.
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:305
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:238
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:181
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:90
onSetToolActive()
onSetToolActive():
void
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:136
onSetToolDisabled()
onSetToolDisabled():
void
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:142
onSetToolEnabled()
onSetToolEnabled():
void
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:131
redo()
redo():
void
Redo an action (undo the undo)
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:261
resize()
resize(
viewportId):void
Parameters
• viewportId: any
Returns
void
Defined in
tools/src/tools/OrientationMarkerTool.ts:153
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:167
setConfiguration()
setConfiguration(
newConfiguration):void
merges the new configuration with the tool configuration
Parameters
• newConfiguration: Record<string, any>
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:153
undo()
undo():
void
Undoes an action
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:251
createZoomPanMemo()
staticcreateZoomPanMemo(viewport):object
Creates a zoom/pan memo that remembers the original zoom/pan position for the given viewport.
Parameters
• viewport: any
Returns
object
restoreMemo()
restoreMemo: () =>
void
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:269
mergeDefaultProps()
staticmergeDefaultProps(defaultProps,additionalProps?):any
Does a deep merge of property options. Allows extending the default values for a child class.
Parameters
• defaultProps = {}
this is a base set of defaults to merge into
• additionalProps?: any
the additional properties to merge into the default props
Returns
any
defaultProps if additional props not defined, or a merge into a new object containing additionalProps adding onto and overriding defaultProps.