Skip to main content

Custom Tools

A Cornerstone Tool is any class that implements or extends the interface defined by the BaseTool or AnnotationTool abstract classes. Creating a custom tool is as simple as:

import csTools3d, { AnnotationTool, BaseTool } from '@Tools`

class MyCustomTool extends BaseTool {
  // ...
}

csTools3d.addTool(MyCustomTool, { /* Tool Options */ })

BaseTool​

A base tool has a name, configuration, options, strategies, bindings, and more. Base tools are often used to respond to user input and effect some change on the viewport (like its camera). Example BaseTools include:

  • Pan
  • PetThreshold
  • StackScroll
  • StackScrollMouseWheel
  • WindowLevel
  • Zoom

AnnotationTool​

An annotation tool often has "Annotations" that are tied to frame of reference. It has additional methods that allow tools to indicate they should handle/capture an interaction. This is most often used for "interactions near a handle" or "interactions near a rendered tool line".

Annotation tools that are in the Active mode have an addNewAnnotation method that's called when a mouse event is not captured. This allows the active tool to create Annotations for the interaction. Example AnnotationTools include:

  • Bidirectional
  • EllipticalROI
  • CircleROI
  • Length
  • Probe
  • RectangleROI
  • PlanarFreehandROI

Next steps​

For next steps, you can: