All files / packages/tools/src/enums ToolModes.ts

0% Statements 0/0
0% Branches 0/0
0% Functions 0/0
0% Lines 0/0

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32                                                               
/**
 * ToolModes - This enum defines the 4 tool states which are available.
 */
enum ToolModes {
  /**
   * Active:
   * - Can be actively used by mouse/touch events mapped to its `ToolBinding`s.
   * - Can add data if an annotation tool.
   * - Can be passively interacted by grabbing a tool or its handles.
   * - Renders data if the tool has a `renderAnnotation` method.
   */
  Active = 'Active',
  /**
   * Passive:
   * - Can be passively interacted by grabbing a tool or its handles.
   * - Renders data if the tool has a `renderAnnotation` method.
   */
  Passive = 'Passive',
  /**
   * Enabled:
   * - Renders data if the tool has a `renderAnnotation` method.
   */
  Enabled = 'Enabled',
  /**
   * Disabled:
   * - Annotation does not render.
   */
  Disabled = 'Disabled',
}
 
export default ToolModes;