All files / packages/tools/src/enums StrategyCallbacks.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 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56                                                                                                               
/**
 * Defines the names of the strategy callbacks used for performing enhanced
 * strategy operations.
 */
enum StrategyCallbacks {
  /**
   * startStrategy is called at the start of a strategy, typically on mouse down
   * Note this is separate from preview and the endings for preview, which could
   * be called alternatively, but this may be nested within a preview.
   */
  OnInteractionStart = 'onInteractionStart',
  /**
   * finishStrategy is called at the end of a strategy being applied, usually on
   * mouse up.
   */
  OnInteractionEnd = 'onInteractionEnd',
  /**
   * The preview can be used for tools to show what would happen on accepting
   * before the change is actually done.  For example, a spline tool might
   * show a preview state, and allow that to be accepted or rejected.
   */
  Preview = 'preview',
  RejectPreview = 'rejectPreview',
  AcceptPreview = 'acceptPreview',
 
  /**
   * Fills the given reygion
   */
  Fill = 'fill',
 
  /**
   * The default strategy function, often synonymous with fill
   */
  StrategyFunction = 'strategyFunction',
 
  /**
   * For threshold functions, this creates the thresold test.  Mostly an internal
   * detail, but might be useful to share between strategies.
   */
  CreateIsInThreshold = 'createIsInThreshold',
 
  /**
   *  Some strategy functions need to initialize some data before being runnable.
   * This is mostly an internal detail, just useful to have an enum here for this.
   */
  Initialize = 'initialize',
 
  // Internal Details
  INTERNAL_setValue = 'setValue',
 
  /** inner circle size  */
  ComputeInnerCircleRadius = 'computeInnerCircleRadius',
}
 
export default StrategyCallbacks;