Skip to main content

Enumeration: StrategyCallbacks

Defines the names of the strategy callbacks used for performing enhanced strategy operations.

Enumeration Members

AcceptPreview

AcceptPreview: "acceptPreview"

Defined in

tools/src/enums/StrategyCallbacks.ts:24


AddPreview

AddPreview: "addPreview"

Adds a preview interpolation from the given data. This allows external methods to set/update the preview and then have it shown/accepted in the normal fashion.

Defined in

tools/src/enums/StrategyCallbacks.ts:56


ComputeInnerCircleRadius

ComputeInnerCircleRadius: "computeInnerCircleRadius"

inner circle size

Defined in

tools/src/enums/StrategyCallbacks.ts:59


CreateIsInThreshold

CreateIsInThreshold: "createIsInThreshold"

For threshold functions, this creates the thresold test. Mostly an internal detail, but might be useful to share between strategies.

Defined in

tools/src/enums/StrategyCallbacks.ts:40


Fill

Fill: "fill"

Fills the given reygion

Defined in

tools/src/enums/StrategyCallbacks.ts:29


GetStatistics

GetStatistics: "getStatistics"

Compute statistics on this instance

Defined in

tools/src/enums/StrategyCallbacks.ts:62


Initialize

Initialize: "initialize"

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.

Defined in

tools/src/enums/StrategyCallbacks.ts:46


INTERNAL_setValue

INTERNAL_setValue: "setValue"

Defined in

tools/src/enums/StrategyCallbacks.ts:49


OnInteractionEnd

OnInteractionEnd: "onInteractionEnd"

finishStrategy is called at the end of a strategy being applied, usually on mouse up.

Defined in

tools/src/enums/StrategyCallbacks.ts:16


OnInteractionStart

OnInteractionStart: "onInteractionStart"

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.

Defined in

tools/src/enums/StrategyCallbacks.ts:11


Preview

Preview: "preview"

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.

Defined in

tools/src/enums/StrategyCallbacks.ts:22


RejectPreview

RejectPreview: "rejectPreview"

Defined in

tools/src/enums/StrategyCallbacks.ts:23


StrategyFunction

StrategyFunction: "strategyFunction"

The default strategy function, often synonymous with fill

Defined in

tools/src/enums/StrategyCallbacks.ts:34