Class CodeGeneratingGraphNode`Abstract` `Hidden Children`

The CodeGeneratingGraphNode implements a GraphNode that emits code when visited.

Hierarchy (view full)

GraphNode
- CodeGeneratingGraphNode

Constructors

constructor

new CodeGeneratingGraphNode(): CodeGeneratingGraphNode
Returns CodeGeneratingGraphNode
Inherited from GraphNode.constructor

Accessors

customName

get customName(): string
The custom name for the node.

Returns string
Note
By default, names should be inferred from the GraphNodeReflection data. Only set this field if the name cannot or should not be inferred from reflection data.

Inherited from GraphNode.customName
set customName(value): void
Parameters
- value: string
Returns void
Inherited from GraphNode.customName

graph

get graph(): ImmutableGraph
The owning graph.

Returns ImmutableGraph
Inherited from GraphNode.graph
set graph(value): void
Parameters
- value: ImmutableGraph
Returns void
Inherited from GraphNode.graph

id

get id(): UUID
The ID.

Returns UUID
Inherited from GraphNode.id

inputPins

get inputPins(): GraphPin[]
The input pins.

Returns GraphPin[]
Inherited from GraphNode.inputPins

isCustomInvocationRequired

get isCustomInvocationRequired(): boolean
Virtual
To enable custom invocation for your Graph during code generation this function must return true.

Returns boolean
true if your class implemented a custom invocation.

`Abstract`isEmittingBodyCode

get isEmittingBodyCode(): boolean
Virtual
Determines if the Graph is being invoked during code generation to emit it's function body. If this function returns false emitCode will not be invoked.

Returns boolean
Returs
true if your class generates code or false if only an invocation is required.

outputPins

get outputPins(): GraphPin[]
The output pins.

Returns GraphPin[]
Inherited from GraphNode.outputPins

position

get position(): Immutable<Vector2>
The position.

Returns Immutable<Vector2>
Inherited from GraphNode.position
set position(value): void
Parameters
- value: Immutable<Vector2>
Returns void
Inherited from GraphNode.position

userData

get userData(): Map<string, any>
A map suitable for storing custom user-defined data.

Returns Map<string, any>
Inherited from GraphNode.userData

Methods

addPin

addPin(pin): void
Add a GraphPin.
Parameters
- pin: GraphPin
Returns void
Inherited from GraphNode.addPin

clone

clone(): GraphNode
Clones the GraphNode and it's GraphPin. All connections will be removed from the clone.

Returns GraphNode
Inherited from GraphNode.clone

disconnect

disconnect(): void
Removes all connections to this node.

Returns void
Inherited from GraphNode.disconnect

emitCode

emitCode(context): void
Virtual
This function emits the graph's function header and body.
Parameters
- context: GraphCodeGenerationContext
  The evaluation context.
Returns void

emitCustomInvocation

emitCustomInvocation(context): void
Virtual
Graph function invocation during code generation follows language specified rules. Typically a method is being invoked in c-style. This can require emitting temporaries and other variables. In certain cases Graphs might have to override the nvocation model to implement specific behavior.

Implement this function in your child class to fully control the code generation for your Graph. To enable your custom invocation during code generation override isCustomInvocationRequired to return true.
Parameters
- context: GraphCodeGenerationContext
  The evaluation context.
Returns void
Note
Context type specific behavior must be implemented by the developer.

enable

enable(graph): void
Enables the node and its pins in the specified graph.
Parameters
- graph: ImmutableGraph
Returns void
Inherited from GraphNode.enable

getCompatiblePin

getCompatiblePin(otherPin): GraphPin
Gets a pin that supports a connection to (or from) the otherPin.
Parameters
- otherPin: GraphPin
  The pin to find a compatible pin for.
Returns GraphPin
The first pin that matches the connection criteria.
Note
The orientation of the test depends on the type of the otherPin. The input pin denotes the type that must be supported by the output pin in the form
```
	`outputPin isSubclassOf inputPin`
```
Inherited from GraphNode.getCompatiblePin

getConnectedValue

getConnectedValue<T>(type, pinOrPinName, executionState, defaultValue?): ValueTypeOf<T>
Gets the value that is connected to the input pin. If the pin is not connected, the defaultValue is returned.
Type Parameters
- T
Parameters
- type: GraphType | ClassOf<T>
  The pin type
- pinOrPinName: string | GraphPin
  The GraphPin or the name of the pin.
- executionState: GraphExecutionState
- OptionaldefaultValue: ValueTypeOf<T>
  An optional default value. Default: undefined
Returns ValueTypeOf<T>
The connected value, or if not connected the defaultValue.

Inherited from GraphNode.getConnectedValue

getIndexofPin

getIndexofPin(nameOrPin, direction): number
Get either an input or output pin.
Parameters
- nameOrPin: string | GraphPin
- direction: EnumValueTyped<GraphPinType, number>
Returns number
Inherited from GraphNode.getIndexofPin

getInternalFieldStorageValueForPin

getInternalFieldStorageValueForPin(pin): any
The internal field value used as automatic value storage for templated nodes.
Parameters
- pin: GraphPin
Returns any
Inherited from GraphNode.getInternalFieldStorageValueForPin

getPin

getPin(nameOrUUID, direction): GraphPin
Gets the specified pin by name or id.
Parameters
- nameOrUUID: string | UUID
- direction: EnumValueTyped<GraphPinType, number>
Returns GraphPin
Inherited from GraphNode.getPin

getPins

getPins(type): GraphPin[]
Returns all pins connected of the specified type.
Parameters
- type: EnumValueTyped<GraphPinType, number>
Returns GraphPin[]
Inherited from GraphNode.getPins

getUserData

getUserData<T>(node, key, defaultValue?): T
Gets the value for the specified user data key. If the key does not exist the defaultValue will be returned instead. If no defaultValue is specified, undefined is returned.
Type Parameters
- T
Parameters
- node: GraphNode
- key: string
  A key that uniquely identifies the property to be fetched.
- OptionaldefaultValue: T
  The default value, to be returned in case the property is not defined.
Returns T
The user defined property or defaultValue if not defined.

Inherited from GraphNode.getUserData

isConnectedToNode

isConnectedToNode(otherNode, direction): boolean
Determines if this node is connected to the other node.
Parameters
- otherNode: GraphNode
- direction: EnumValueTyped<GraphPinType, number>
Returns boolean
Inherited from GraphNode.isConnectedToNode

isValidTypeForPin

isValidTypeForPin(pin, type): boolean
Virtual
Determines if the specified pin is valid for the given type.
Parameters
- pin: GraphPin
- type: GraphType
Returns boolean
Inherited from GraphNode.isValidTypeForPin

iterateAllPins

iterateAllPins(): Generator<GraphPin, any, any>
Iterates all connections to pins of this node. First input pins are iterated over, then output pins.

Returns Generator<GraphPin, any, any>
Inherited from GraphNode.iterateAllPins

makeCanvasName

makeCanvasName(reflectionData): string
Virtual
Gets the name of the node as it should be displayed in the canvas.
Parameters
- reflectionData: GraphNodeReflectionData
Returns string
Inherited from GraphNode.makeCanvasName

markAsDirty

markAsDirty(flags): void
Marks the node contents as changed and signals events.
Parameters
- flags: EnumValue<GraphNodeDirtyFlags, number>
Returns void
Inherited from GraphNode.markAsDirty

onClone

onClone(): void
Virtual
Invoked when the node was cloned, invoked after invoking GraphPin.onClone.

Returns void
Inherited from GraphNode.onClone

onCreate

onCreate(): void
Called when the node has been instanced and is about to be added to a graph. This is a good place to initialize the default values for the node pins as it will then not be done during deserialization, which might otherwise discard newly instances values immediately.

Returns void
Inherited from GraphNode.onCreate

onEmitInvocation

onEmitInvocation(context): void
Emits the invocation for the node.
Parameters
- context: GraphCodeGenerationContext
  The evaluation context.
Returns void
The symbol name.

Note
If temporaries are invloved, the temporary symbol will be emitted instead.

onEmitInvocationCode

onEmitInvocationCode(context): void
Virtual
Emits the invocation for the node.
Parameters
- context: GraphCodeGenerationContext
  The evaluation context.
Returns void
The symbol name.

onEmitTemporaries

onEmitTemporaries(context): void
Virtual
Emits the code.
Parameters
- context: GraphCodeGenerationContext
  The evaluation context.
Returns void
The symbol name.

onEnable

onEnable(): void
Virtual
Called when the Graph is being enabled or when the node is added to the graph via Graph.addNode />

Returns void
Inherited from GraphNode.onEnable

onFieldValueChanged

onFieldValueChanged(currentReflectionData, editableData): void
Virtual
Invoked when an inspectable field data was changed through the UI.
Parameters
- currentReflectionData: GraphNodeReflectionData
- editableData: GraphInspectableFieldReflectionData
Returns void
Note
Implementing classes must call super.

Inherited from GraphNode.onFieldValueChanged

onPinConnected

onPinConnected(pin, connection): void
Virtual
Invoked when a GraphPin was connected.
Parameters
- pin: GraphPin
- connection: GraphConnection
Returns void
Inherited from GraphNode.onPinConnected

onPinDisconnected

onPinDisconnected(pin, connection): void
Virtual
Invoked when a GraphPin was disconnected.
Parameters
- pin: GraphPin
- connection: GraphConnection
Returns void
Inherited from GraphNode.onPinDisconnected

onPinValueChanged

onPinValueChanged(pin, nodeReflectionData, pinReflectionPin): void
Virtual
Invoked when the pin field data was changed through the UI.
Parameters
- pin: GraphPin
- nodeReflectionData: GraphNodeReflectionData
- pinReflectionPin: GraphPinReflectionData
Returns void
Note
Implementing classes must call super.

Inherited from GraphNode.onPinValueChanged

onRemove

onRemove(): void
Called before the node is removed from a graph.

Returns void
Inherited from GraphNode.onRemove

onRequestValue

onRequestValue(pin, executionState): any
Virtual
Requests the value associated with the given pin.
Parameters
- pin: GraphPin
  The GraphPin for whom the data is requested.
- executionState: GraphExecutionState
  THhe GraphExecutionState state containing the execution data.
Returns any
The pin data.

Inherited from GraphNode.onRequestValue

onSerialize

onSerialize(): void
Invoked when serialization begins by the owning Graph.

Returns void
Inherited from GraphNode.onSerialize

onVisit

onVisit(context): void
Virtual
Visits the node during code generation to determine if temporaries are required.
Parameters
- context: GraphCodeGenerationContext
  The evaluation context.
Returns void

`Protected`onVisitInputPins

onVisitInputPins(context): void
Virtual
Visits the node's input pins during code generation to determine if temporaries are required.
Parameters
- context: GraphCodeGenerationContext
  The evaluation context.
Returns void

registerOutdatedConnection

registerOutdatedConnection(pin, connection): void
Registers an outdated GraphConnection if it wasn't enabled during initialization. Outdated connections are attempted to be re-enabled during the call to enable
Parameters
- pin: GraphPin
- connection: GraphConnection
Returns void
Inherited from GraphNode.registerOutdatedConnection

removePin

removePin(pin): void
Removes a GraphPin.
Parameters
- pin: GraphPin
Returns void
Inherited from GraphNode.removePin

removeUserData

removeUserData(key): void
Removes the user data key.
Parameters
- key: string
Returns void
Inherited from GraphNode.removeUserData

setUserData

setUserData<T>(key, value): void
Sets the user data key to the specified value.
Type Parameters
- T
Parameters
- key: string
  A key that uniquely identifies the property to be defined.
- value: T
  The value to set the property to. The value type must support serialization.
Returns void
Inherited from GraphNode.setUserData

synchronizePinsWithReflectionData

synchronizePinsWithReflectionData(): void
Synchronizes the node pins with the reflection data by adding missing pins and removing superfluous pins on the node.

Returns void
Inherited from GraphNode.synchronizePinsWithReflectionData

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from GraphNode.toString

validate

validate(validationStatus): GraphValidationStatus
Virtual
Ensures that the state of the node is valid.
Parameters
- validationStatus: Map<GraphObject, string>
Returns GraphValidationStatus
Note
Implementing classes must call super. The method is typically called after deserialization or major edits to the graph. If validation fails, error information must be added to the validationStatus map.

Inherited from GraphNode.validate

withBlockedEvents

withBlockedEvents(callback): void
Invokes the callback while prevent events to be dispatched.
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from GraphNode.withBlockedEvents

Events

`Readonly`onDirty

onDirty: Event<[EnumValueTyped<GraphNodeDirtyFlags, number>], void>

An event when the node is dirtied.

Class CodeGeneratingGraphNodeAbstract Hidden Children

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Returns CodeGeneratingGraphNode

Accessors

customName

Returns string

Note

Parameters

Returns void

graph

Returns ImmutableGraph

Parameters

Returns void

id

Returns UUID

inputPins

Returns GraphPin[]

isCustomInvocationRequired

Returns boolean

AbstractisEmittingBodyCode

Returns boolean

Returs

outputPins

Returns GraphPin[]

position

Returns Immutable<Vector2>

Parameters

Returns void

userData

Returns Map<string, any>

Methods

addPin

Parameters

Returns void

clone

Returns GraphNode

disconnect

Returns void

emitCode

Parameters

Returns void

emitCustomInvocation

Parameters

Returns void

Note

enable

Parameters

Returns void

getCompatiblePin

Parameters

Returns GraphPin

Note

getConnectedValue

Type Parameters

Parameters

Returns ValueTypeOf<T>

getIndexofPin

Parameters

Returns number

getInternalFieldStorageValueForPin

Parameters

Returns any

getPin

Parameters

Returns GraphPin

getPins

Parameters

Returns GraphPin[]

getUserData

Type Parameters

Parameters

Returns T

Class CodeGeneratingGraphNode`Abstract` `Hidden Children`

`Abstract`isEmittingBodyCode

`Protected`onVisitInputPins