Class: SculptorTool
This tool allows modifying the contour data for planar freehand by sculpting it externally using another shape to push the contour in one direction or the other.
Extends
Constructors
new SculptorTool()
new SculptorTool(
toolProps,defaultToolProps):SculptorTool
Parameters
• toolProps: PublicToolProps = {}
• defaultToolProps: SharedToolProp = ...
Returns
Overrides
Defined in
tools/src/tools/SculptorTool.ts:59
Properties
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
registeredShapes
registeredShapes:
Map<any,any>
Defined in
tools/src/tools/SculptorTool.ts:48
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
toolName
statictoolName:string
Overrides
Defined in
tools/src/tools/SculptorTool.ts:47
Methods
activateModify()
protectedactivateModify(element):void
Attaches event listeners to the element such that is is visible, modifiable, and new data can be created.
Parameters
• element: HTMLDivElement
The viewport element to attach event listeners to.
Returns
void
Defined in
tools/src/tools/SculptorTool.ts:464
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
deactivateModify()
protecteddeactivateModify(element):void
Removes event listeners from the element.
Parameters
• element: HTMLDivElement
The viewport element to remove event listeners from.
Returns
void
Defined in
tools/src/tools/SculptorTool.ts:495
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
interpolatePointsWithinMaxSpacing()
protectedinterpolatePointsWithinMaxSpacing(i,points,indicesToInsertAfter,maxSpacing):void
Interpolates or fills in points between two points within a specified maximum spacing constraint.
Parameters
• i: number
• points: Point3[]
• indicesToInsertAfter: number[]
• maxSpacing: number
Returns
void
Defined in
tools/src/tools/SculptorTool.ts:154
mouseMoveCallback()
mouseMoveCallback(
evt):void
Parameters
• evt: InteractionEventType
Returns
void
Defined in
tools/src/tools/SculptorTool.ts:110
preMouseDownCallback()
preMouseDownCallback(
evt):boolean
Parameters
• evt: InteractionEventType
Returns
boolean
Defined in
tools/src/tools/SculptorTool.ts:92
registerShapes()
registerShapes<
T>(shapeName,shapeClass):void
Register different tool shapes for sculptor tool
Type Parameters
• T extends ISculptToolShape
Parameters
• shapeName: string
name of shape
• shapeClass
shape class
Returns
void
Defined in
tools/src/tools/SculptorTool.ts:84
renderAnnotation()
renderAnnotation(
enabledElement,svgDrawingHelper):void
Renders the cursor annotation on screen so that the user can choose the annotation size.
Parameters
• enabledElement: IEnabledElement
• svgDrawingHelper: SVGDrawingHelper
Returns
void
Defined in
tools/src/tools/SculptorTool.ts:534
sculpt()
protectedsculpt(eventData,points):void
Sculpts the freehand ROI with freehandSculpter tool, moving, adding and removing handles as necessary.
Parameters
• eventData: any
Data object associated with the event.
• points: Point3[]
Array of points
Returns
void
Defined in
tools/src/tools/SculptorTool.ts:127
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
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:112
setToolShape()
setToolShape(
toolShape):void
Sets the tool shape to the specified tool
Parameters
• toolShape: string
Returns
void