MIPJumpToClickTool
Hierarchy
- BaseTool
- MIPJumpToClickTool
Index
Constructors
constructor
Parameters
toolProps: PublicToolProps = {}
defaultToolProps: SharedToolProp = ...
Returns MIPJumpToClickTool
Properties
_bounds
publicconfiguration
publicmode
Tool Mode - Active/Passive/Enabled/Disabled/
publicsupportedInteractionTypes
Supported Interaction Types - currently only Mouse
publictoolGroupId
ToolGroup ID the tool instance belongs to
statictoolName
Methods
publicapplyActiveStrategy
It applies the active strategy to the enabled element.
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.
publicgetToolName
Returns the name of the tool
Returns string
The name of the tool.
mouseClickCallback
Handles the click event, and move the camera’s focal point the brightest point that is in the line of sight of camera. This function 1) search for the brightest point in the line of sight, 2) move the camera to that point, this triggers a cameraModified event which then 4) moves all other synced viewports and their crosshairs.
Parameters
evt: any
click event
Returns void
publicsetActiveStrategy
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
merges the new configuration with the tool configuration
Parameters
newConfiguration: Record<string, any>
Returns void
On a Maximum Intensity Projection (MIP) viewport, MIPJumpToClickTool allows the user to click on a point in the MIP and the targetViewportIdS (provided in the tool configuration) will be scrolled (jumped) to the location of the point with the highest intensity value in the MIP.