Interface IDynamicNodeDefinition<I, O>

interface IDynamicNodeDefinition<I, O> {
    calculate?: CalculateFunction<Dynamic<I>, Dynamic<O>>;
    inputs?: InterfaceFactory<I>;
    onCreate?: ((this: DynamicNode<I, O>) => void);
    onDestroy?: ((this: DynamicNode<I, O>) => void);
    onPlaced?: ((this: DynamicNode<I, O>) => void);
    onUpdate: ((inputs: I, outputs: O) => DynamicNodeUpdateResult);
    outputs?: InterfaceFactory<O>;
    title?: string;
    type: string;
}

Type Parameters

  • I
  • O

Properties

calculate? inputs? onCreate? onDestroy? onPlaced? onUpdate outputs? title? type

Properties

Optionalcalculate

calculate?: CalculateFunction<Dynamic<I>, Dynamic<O>>

This function is called by the engine with the input values. It should perform the necessary calculation and then return the output values

Optionalinputs

inputs?: InterfaceFactory<I>

Inputs of the node

OptionalonCreate

onCreate?: ((this: DynamicNode<I, O>) => void)

Called as soon as an instance of the node is created but before it is placed into a graph

OptionalonDestroy

onDestroy?: ((this: DynamicNode<I, O>) => void)

Called after the node is removed from a graph. Can be used for cleanup

OptionalonPlaced

onPlaced?: ((this: DynamicNode<I, O>) => void)

Called when the node is placed into a graph

onUpdate

onUpdate: ((inputs: I, outputs: O) => DynamicNodeUpdateResult)

This function is called whenever the value of one of the static input or output interfaces is changed. It should return a definition for every dynamic interface based on the values of the static interfaces.

Optionaloutputs

outputs?: InterfaceFactory<O>

Outputs of the node

Optionaltitle

title?: string

Default title when creating the node. If not specified, it is set to the nodeType

type

type: string

NodeType

Settings

Member Visibility

On This Page

Properties