Class CarbonGraphExecutionState

The execution state for a carbon graph.

Hierarchy (View Summary)

GraphExecutionState
- CarbonGraphExecutionState

Constructors

constructor

new CarbonGraphExecutionState(
    inputVariableData: Map<bigint, any>,
    component: CarbonComponentBase,
    sceneInstance: SceneInstance,
    sceneObject: SceneObject,
): CarbonGraphExecutionState
Parameters
- inputVariableData: Map<bigint, any>
- component: CarbonComponentBase
- sceneInstance: SceneInstance
- sceneObject: SceneObject
Returns CarbonGraphExecutionState

Overrides GraphExecutionState.constructor

Properties

`Protected` `Readonly`_executionCache

_executionCache: Map<GraphPin, GraphStateValue>

`Protected`_executionCacheTargetUUID

_executionCacheTargetUUID: bigint

`Protected` `Readonly`_inputVariableData

_inputVariableData: Map<bigint, GraphStateValue>

`Protected` `Readonly`_nodeValues

_nodeValues: WeakMap<GraphNode, GraphStateValue>

`Protected` `Readonly`_pinValues

_pinValues: WeakMap<GraphPin, GraphStateValue>

`Protected` `Readonly`_variableValues

_variableValues: WeakMap<GraphVariable, GraphStateValue>

`Readonly`component

component: CarbonComponentBase

The CarbonComponentBase that is executing the CarbonGraph.

`Readonly`eventSubscribers

eventSubscribers: Map<Function, () => void>

A set of all active event subscribers. Must be cleaned up when the graph finishes execution.

`Readonly`scene

scene: SceneInstance

The SceneInstance which is executing the CarbonGraph.

`Readonly`sceneObject

sceneObject: SceneObject

The SceneObject which is executing the CarbonGraph.

Methods

finalize

finalize(): void

Returns void

Inherited from GraphExecutionState.finalize

getExecutionCachedValueForOutputPin

getExecutionCachedValueForOutputPin(pin: GraphPin): any
Gets the cached value for the specified output pin.
Parameters
- pin: GraphPin
  The pin to retrieve the pin for.
Returns any

Inherited from GraphExecutionState.getExecutionCachedValueForOutputPin

getValueForNode

getValueForNode(node: GraphNode, defaultValue?: any): any
Gets a previously inserted value for the node.
Parameters
- node: GraphNode
- OptionaldefaultValue: any
Returns any

Inherited from GraphExecutionState.getValueForNode

getValueForPin

getValueForPin(pin: GraphPin, defaultValue?: any): any
Gets a previously inserted value for the pin.
Parameters
- pin: GraphPin
- OptionaldefaultValue: any
Returns any

Inherited from GraphExecutionState.getValueForPin

getValueForVariable

getValueForVariable(variable: GraphVariable): any
Gets the input value for the specified variable, if not specified, the default value is returned.
Parameters
- variable: GraphVariable
Returns any

Inherited from GraphExecutionState.getValueForVariable

setExecutingNode

setExecutingNode(node: GraphNode): void
Sets the next node to be executed.
Parameters
- node: GraphNode
Returns void

Note
This is an important call to optimize the execution of expression trees. Values and nodes that are visited multiple times from the same node will require full evaluation of the tree until the lowest level, unless this function is called to mark the current node as executing. It allows the graph system to cache all retrieves values and each expression must only be visited once.

Inherited from GraphExecutionState.setExecutingNode

setExecutionCachedValueForOutputPin

setExecutionCachedValueForOutputPin(
pin: GraphPin,
value: any,
): Map<GraphPin, GraphStateValue>
Sets the cached value for the specified output pin.
Parameters
- pin: GraphPin
  The pin to retrieve the pin for.
- value: any
Returns Map<GraphPin, GraphStateValue>

Inherited from GraphExecutionState.setExecutionCachedValueForOutputPin

setValueForNode

setValueForNode(node: GraphNode, value: any): void
Sets the value for the node.
Parameters
- node: GraphNode
- value: any
Returns void

Inherited from GraphExecutionState.setValueForNode

setValueForPin

setValueForPin(pin: GraphPin, value: any): void
Sets the value for the pin.
Parameters
- pin: GraphPin
- value: any
Returns void

Inherited from GraphExecutionState.setValueForPin

setValueForVariable

setValueForVariable(variable: GraphVariable, value: any): void
Gets the input value for the specified variable, if not specified, the default value is returned.
Parameters
- variable: GraphVariable
- value: any
Returns void

Inherited from GraphExecutionState.setValueForVariable