Class DynamicNode<I, O>`Abstract` `Internal`

Abstract base class for every dynamic node

Type Parameters

I
O

Hierarchy (view full)

Node<Dynamic<I>, Dynamic<O>>
- DynamicNode

Index

Constructors

Properties

_title calculate? events graphInstance? hooks id inputs outputs type

Accessors

Methods

addInput addOutput initializeIo load onDestroy onPlaced registerGraph removeInput removeOutput save

Constructors

constructor

new DynamicNode<I, O>(): DynamicNode<I, O>
Type Parameters
- I
- O
Returns DynamicNode<I, O>
Inherited from Node.constructor

Properties

`Protected`_title

_title: string = ""

`Optional`calculate

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

The default implementation does nothing. Overwrite this method to do calculation.

Param: inputs

Values of all input interfaces

Param: globalValues

Set of values passed to every node by the engine plugin

Returns

Values for output interfaces

events

events: {
    addInput: BaklavaEvent<NodeInterface<any>, AbstractNode>;
    addOutput: BaklavaEvent<NodeInterface<any>, AbstractNode>;
    beforeAddInput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>;
    beforeAddOutput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>;
    beforeRemoveInput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>;
    beforeRemoveOutput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>;
    beforeTitleChanged: PreventableBaklavaEvent<string, AbstractNode>;
    loaded: BaklavaEvent<AbstractNode, AbstractNode>;
    removeInput: BaklavaEvent<NodeInterface<any>, AbstractNode>;
    removeOutput: BaklavaEvent<NodeInterface<any>, AbstractNode>;
    titleChanged: BaklavaEvent<string, AbstractNode>;
    update: BaklavaEvent<null | INodeUpdateEventData, AbstractNode>;
} = ...

`Protected` `Optional`graphInstance

graphInstance?: Graph

hooks

hooks: {
afterSave: SequentialHook<INodeState<any, any>, AbstractNode, INodeState<any, any>>;
beforeLoad: SequentialHook<INodeState<any, any>, AbstractNode, INodeState<any, any>>;
} = ...

id

id: string = ...

Unique identifier of the node

`Abstract`inputs

inputs: NodeInterfaceDefinition<Dynamic<I>>

`Abstract`outputs

outputs: NodeInterfaceDefinition<Dynamic<O>>

`Abstract` `Readonly`type

type: string

Type of the node

Accessors

graph

get graph(): undefined | Graph
The graph instance the node is placed in. undefined if the node hasn't been placed in a graph yet.

Returns undefined | Graph
Inherited from Node.graph
- Defined in core/src/node.ts:74

title

get title(): string
Customizable display name of the node.

Returns string
Inherited from Node.title
- Defined in core/src/node.ts:79
set title(v): void
Parameters
- v: string
Returns void
Inherited from Node.title
- Defined in core/src/node.ts:82

Methods

`Protected`addInput

addInput(key, input): boolean
Add an input interface to the node
Parameters
- key: string
  Key of the input
- input: NodeInterface<any>
  The input instance
Returns boolean
True when the input was added, otherwise false (prevented by an event handler)
Inherited from Node.addInput
- Defined in core/src/node.ts:95

`Protected`addOutput

addOutput(key, output): boolean
Add an output interface to the node
Parameters
- key: string
  Key of the output
- output: NodeInterface<any>
  The output instance
Returns boolean
True when the output was added, otherwise false (prevented by an event handler)
Inherited from Node.addOutput
- Defined in core/src/node.ts:105

`Protected`initializeIo

initializeIo(): void
Returns void
Inherited from Node.initializeIo
- Defined in core/src/node.ts:178

`Abstract`load

load(state): void
Parameters
- state: INodeState<Dynamic<I>, Dynamic<O>>
Returns void
Overrides Node.load
- Defined in core/src/dynamicNode.ts:15

onDestroy

onDestroy(): void
Override this method to perform cleanup when the node is deleted

Returns void
Inherited from Node.onDestroy
- Defined in core/src/node.ts:176

onPlaced

onPlaced(): void
Override this method to execute logic when the node is placed inside a graph

Returns void
Inherited from Node.onPlaced
- Defined in core/src/node.ts:170

registerGraph

registerGraph(graph): void
This function will automatically be called as soon as the node is added to a graph.
Parameters
- graph: Graph
Returns void
Inherited from Node.registerGraph
- Defined in core/src/node.ts:129

`Protected`removeInput

removeInput(key): boolean
Remove an existing input
Parameters
- key: string
  Key of the input.
Returns boolean
Inherited from Node.removeInput
- Defined in core/src/node.ts:113

`Protected`removeOutput

removeOutput(key): boolean
Remove an existing output
Parameters
- key: string
  Key of the output.
Returns boolean
Inherited from Node.removeOutput
- Defined in core/src/node.ts:121

save

save(): INodeState<Dynamic<I>, Dynamic<O>>
Returns INodeState<Dynamic<I>, Dynamic<O>>
Inherited from Node.save
- Defined in core/src/node.ts:246