SculptorTool
Hierarchy
- BaseTool
- SculptorTool
Index
Constructors
constructor
Parameters
toolProps: PublicToolProps = {}
defaultToolProps: SharedToolProp = ...
Returns SculptorTool
Properties
publicconfiguration
publicmode
Tool Mode - Active/Passive/Enabled/Disabled/
registeredShapes
publicsupportedInteractionTypes
Supported Interaction Types - currently only Mouse
publictoolGroupId
ToolGroup ID the tool instance belongs to
statictoolName
Methods
publicapplyActiveStrategy
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
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.
publicgetToolName
Returns the name of the tool
Returns string
The name of the tool.
mouseMoveCallback
Parameters
evt: InteractionEventType
Returns void
preMouseDownCallback
Parameters
evt: InteractionEventType
Returns boolean
registerShapes
Register different tool shapes for sculptor tool
Type parameters
Parameters
shapeName: string
name of shape
shapeClass: new () => T
shape class
Returns void
renderAnnotation
Renders the cursor annotation on screen so that the user can choose the annotation size.
Parameters
enabledElement: IEnabledElement
svgDrawingHelper: SVGDrawingHelper
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
publicsetToolShape
Sets the tool shape to the specified tool
Parameters
toolShape: string
Returns void
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.