Type Alias: Operation
Operation =
object
Defined in: operations/types.ts:50
a standard opearation
Param
the internal name of this opearation (CHANGING THESE WILL BREAK LEGACY VERSIONS)
Param
the name to show upon this operation in the interface
Param
the description of this operation
Param
the parameters associated with this operation
Param
the inlets associated with this operation
Param
refers to any prior name of this operation to aid when loading old files
Param
a function that executes when this operation is performed, takes a series of inputs and resturns an array of drafts
Param
a function that computes the system provided name default based on the inputs. a number can be passed in args to handle cases where the operation needs to assign different names to different draft outputs
Properties
createSketch()?
optionalcreateSketch: (op_params,updateCallback,context?) => (p) =>void
Defined in: operations/types.ts:58
Parameters
op_params
updateCallback
(canvasState) => void
context?
isParameterChange
boolean
Returns
(
p):void
Parameters
p
any
Returns
void
generateName()
generateName: (
op_settings,op_inputs) =>string
Defined in: operations/types.ts:56
Parameters
op_settings
op_inputs
OpInput[]
Returns
string
inlets
inlets:
OperationInlet[]
Defined in: operations/types.ts:53
meta
meta:
OpMeta
Defined in: operations/types.ts:54
name
name:
string
Defined in: operations/types.ts:51
params
params:
OperationParam[]
Defined in: operations/types.ts:52
perform()
perform: (
op_settings,op_inputs) =>Promise<OpOutput[]>
Defined in: operations/types.ts:55
Parameters
op_settings
op_inputs
OpInput[]
Returns
Promise<OpOutput[]>
sizeCheck()
sizeCheck: (
op_settings,op_inputs) =>boolean
Defined in: operations/types.ts:57
Parameters
op_settings
op_inputs
OpInput[]
Returns
boolean