Class CarbonAnimationGraph

The CarbonAnimationGraph class implements a CarbonGraph that can be used to create logic based animation behaviors that are executed when assigned to a CarbonAnimation

Hierarchy (view full)

CarbonStateGraph
- CarbonAnimationGraph

Index

Constructors

constructor

new CarbonAnimationGraph(uuid?, isInternalConstructor?): CarbonAnimationGraph
Internal function for construction.
Parameters
- Optionaluuid: UUID
- OptionalisInternalConstructor: boolean
Returns CarbonAnimationGraph
Note
You should never override the constructor for resources. Always rely on onCreate or onInitialize to initialize your resource.

Inherited from CarbonStateGraph.constructor

Properties

`Protected`_isEnabling

_isEnabling

`Readonly`comments

comments: GraphComment[]

All GraphComment objects to display in the editor for this Graph

isValidationCritical

isValidationCritical: boolean

The status of the validation, undefined until validate was called.

`Readonly`nodes

nodes: GraphNode[]

All GraphNode objects registerded with this graph.

referenceMesh

referenceMesh: ResourceHandle<Mesh>

The reference mesh used when picking bones and mesh specific data.

referenceTemplate

referenceTemplate: ResourceHandle<Template>

The reference template used when picking bones and mesh specific data, or when testing the state machine.

`Readonly`userData

userData: Map<string, any>

A Map suitable for storing custom user-defined data.

validationStatus

validationStatus: Map<GraphObject, string>

The status of the validation since the last call to validate.

`Readonly`variables

variables: GraphVariable[]

All GraphVariable objects registered with this graph.

`Readonly`viewportPosition

viewportPosition: Vector2

Determines the panning position of the user has last moved the graph canvas to.

viewportZoomScale

viewportZoomScale: number

Determines the zoom scale of the user has the graph canvas at.

`Static` `Readonly`controlFlowInputPinName

controlFlowInputPinName = "CF[In]"

`Static` `Readonly`controlFlowOutputPinName

controlFlowOutputPinName = "CF[Out]"

Accessors

defaultVariableType

get defaultVariableType(): Type
Virtual
Gets the default type of a newly constructed empty variable.

Returns Type
Inherited from CarbonStateGraph.defaultVariableType

handle

get handle(): ResourceHandle<CarbonAnimationGraph>
Returns a resource handle.

Returns ResourceHandle<CarbonAnimationGraph>
Overrides CarbonStateGraph.handle

isDestroyed

get isDestroyed(): boolean
Determines if the resource is destroyed.

Returns boolean
Note
This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

Inherited from CarbonStateGraph.isDestroyed

metaData

get metaData(): ResourceMetaData
Returns the meta data of this resource.

Returns ResourceMetaData
Inherited from CarbonStateGraph.metaData

name

get name(): string
Name of the resource. Use primarily for easier identification and not important to the engine itself.

Returns string
Inherited from CarbonStateGraph.name

referenceResource

get referenceResource(): ResourceHandle<Template> | ResourceHandle<Mesh>
Gets the current reference resource.

Returns ResourceHandle<Template> | ResourceHandle<Mesh>

uuid

get uuid(): UUID
Returns a universally unique identifier of this resource.

Returns UUID
Inherited from CarbonStateGraph.uuid

variableGetterType

get variableGetterType(): SubclassOf<PropertyGetterNode>
Virtual
Gets the default type of a newly constructed variable getter.

Returns SubclassOf<PropertyGetterNode>
Inherited from CarbonStateGraph.variableGetterType

variableSetterType

get variableSetterType(): SubclassOf<PropertySetterNode>
Virtual
Gets the default type of a newly constructed variable setter.

Returns SubclassOf<PropertySetterNode>
Inherited from CarbonStateGraph.variableSetterType

Methods

addComment

addComment(comment): void
Adds the GraphComment to the scene.
Parameters
- comment: GraphComment
Returns void
Inherited from CarbonStateGraph.addComment

addCommentWithRegion

addCommentWithRegion(region, title, description?): GraphComment
Adds a new comment to the graph.
Parameters
- region: Immutable<Rect2>
  The region to create the new comment on, including the origin and it's size.
- title: string
  A string that represents the title for the comment.
- Optionaldescription: string
  A string that represents a description for the comment.
Returns GraphComment
The newly created commented object.

Inherited from CarbonStateGraph.addCommentWithRegion

addConnection

addConnection(connectionOrPins): void
Adds the specified GraphConnection.
Parameters
- connectionOrPins: GraphConnection | {
  input: GraphPin;
  output: GraphPin;
  }
Returns void
Note
The connection will be registered with both the input and output GraphPin. Before the connection is registered onFilterAddConnection will be invoked to allow the graph to dynamically replace the connection.

Inherited from CarbonStateGraph.addConnection

addNode

addNode(node): boolean
Adds the specified GraphNode.
Parameters
- node: GraphNode
Returns boolean
Inherited from CarbonStateGraph.addNode

addVariable

addVariable(variable): boolean
Adds the specified GraphVariable.
Parameters
- variable: GraphVariable
  The variable to add.
Returns boolean
true if the variable was added, false on error.

Note
If a variable with the same name already exists, a suffix will be appened.

Inherited from CarbonStateGraph.addVariable

duplicate

duplicate(): Resource
Duplicates the resource and creates a unique UUID for the duplicated resource.

Returns Resource
The duplicated resource or null, if the duplication failed.

Inherited from CarbonStateGraph.duplicate

`Protected`enable

enable(): void
Invoken when the graph was deserialized and objects need to be enabled. This typically entails restoring object pointers that cannot be serialized.

Returns void
Inherited from CarbonStateGraph.enable

`Protected`enterNode

enterNode(node, layerData, animationData): void
Enters the node for the specified layerData.
Parameters
- node: CarbonAnimationStateNodeBase
  The node to enter.
- layerData: CarbonAnimationLayerData
  The layer that executes the node.
- animationData: CarbonAnimationData
  The animation data.
Returns void

execute

execute<T>(type, controlFlowData, warnNotFound?): void
Executes the node of the specified type and controlFlowData.
Type Parameters
- T extends ControlFlowNodeBase
Parameters
- type: ClassOf<T>
- controlFlowData: ControlFlowData
- OptionalwarnNotFound: boolean
Returns void
Inherited from CarbonStateGraph.execute

executeNode

executeNode(node, connection, controlFlowData): GraphConnection
Executes the node.
Parameters
- node: ControlFlowNodeBase
  The node to execute.
- connection: GraphConnection
  The visiting connection from the preivous node.
- controlFlowData: ControlFlowData
  The control flow data.
Returns GraphConnection
Inherited from CarbonStateGraph.executeNode

executeRoot

executeRoot(rootOrConnection, controlFlowData): void
Executes the specified root node in the graph with the controlFlowData.
Parameters
- rootOrConnection: GraphConnection | ControlFlowNodeBase
  The root node to execution or a connection to execute as root. When a ControlFlowNodeBase is specified, the node is immediately executed as the first node. When a GraphConnection is specified, the node that is connected to the connections input pin is executed as the first node.
- controlFlowData: ControlFlowData
  The control flow data for the current execution.
Returns void
Note
Each call to executeNode returns the next connection to be executed. The execution will run until null is returned.

Inherited from CarbonStateGraph.executeRoot

findNode

findNode(id): GraphNode
Searches for the GraphNode with the specified id.
Parameters
- id: UUID
Returns GraphNode
Inherited from CarbonStateGraph.findNode

findNodeWithType

findNodeWithType<T>(type): T
Searches for a node on the Graph with that is an instanceof type.
Type Parameters
- T extends GraphNode
Parameters
- type: ClassOf<T>
Returns T
Inherited from CarbonStateGraph.findNodeWithType

findTransitionFromState

findTransitionFromState(animationData, currentState, previousStates, minimumPriority?): CarbonAnimationStateNodeBase
Attempts to transition to next state.
Parameters
- animationData: CarbonAnimationData
- currentState: CarbonAnimationStateNodeBase
- previousStates: CarbonAnimationStateNodeBase[]
- OptionalminimumPriority: number
Returns CarbonAnimationStateNodeBase

findVariable

findVariable(nameOrUUID): GraphVariable
Gets the variable with the specified name.
Parameters
- nameOrUUID: string | UUID
Returns GraphVariable
Inherited from CarbonStateGraph.findVariable

getComment

getComment(titleOrUUID): GraphComment
Gets the GraphComment with the specified title or UUID.
Parameters
- titleOrUUID: string | UUID
Returns GraphComment
Inherited from CarbonStateGraph.getComment

iterateAccessorsForVariable

iterateAccessorsForVariable(variable): Generator<PropertyGetterNode | PropertySetterNode, any, any>
Gets all nodes of the specified type.
Parameters
- variable: GraphVariable
Returns Generator<PropertyGetterNode | PropertySetterNode, any, any>
Inherited from CarbonStateGraph.iterateAccessorsForVariable

iterateNodesWithType

iterateNodesWithType<T>(type): Generator<T, any, any>
Iterates through all nodes that are an instanceof type.
Type Parameters
- T extends GraphNode
Parameters
- type: ClassOf<T>
Returns Generator<T, any, any>
Inherited from CarbonStateGraph.iterateNodesWithType

markAsDirty

markAsDirty(object, flags?): void
Method that must be called whenever the Graph is dirtied.
Parameters
- object: GraphObject | Graph
- Optionalflags: EnumValue<GraphNodeDirtyFlags, number>
Returns void
Inherited from CarbonStateGraph.markAsDirty

onComponentDisable

onComponentDisable(animationData): void
Executes the CarbonLogicOnDisable event node.
Parameters
- animationData: CarbonAnimationData
  The animation data.
Returns void

onComponentEnable

onComponentEnable(component, animationData): void
Executes the CarbonLogicOnEnable event node.
Parameters
- component: CarbonAnimation
- animationData: CarbonAnimationData
  The animation data.
Returns void

onComponentFixedUpdate

onComponentFixedUpdate(animationData): void
Executes the CarbonLogicOnFixedUpdate event node.
Parameters
- animationData: CarbonAnimationData
  The animation data.
Returns void

onComponentLateUpdate

onComponentLateUpdate(animationData): void
Executes the CarbonLogicOnLateUpdate event node.
Parameters
- animationData: CarbonAnimationData
  The animation data.
Returns void

onComponentUpdate

onComponentUpdate(animationData): void
Executes the CarbonLogicOnUpdate event node.
Parameters
- animationData: CarbonAnimationData
  The animation data.
Returns void

onCreate

onCreate(this): void
Virtual
Method called by RSX to perform actions required after the creation of the resource.
Parameters
- this: Writable<Graph>
Returns void
Overrides CarbonStateGraph.onCreate

onDeserializationEnded

onDeserializationEnded(): void
Virtual
Method called by RSX to perform any operations needed after deserialization.

Returns void
Note
Use this API to restore your serializable data into live objects.

Inherited from CarbonStateGraph.onDeserializationEnded

onDisable

onDisable(): void
Virtual
Method called by RSX to disable the resource.

Returns void
Note
Use this API to deactivate the resource before it is serialized.

Inherited from CarbonStateGraph.onDisable

onEnable

onEnable(): void
Virtual
Method called by RSX to enable the resource.

Returns void
Note
Use this API to activate the resource after it has been disabled by serialization.

Inherited from CarbonStateGraph.onEnable

`Protected`onExecuteNode

onExecuteNode(node, animationData): void
Invoked when the graph will execute the node.
Parameters
- node: CarbonAnimationStateNodeBase
- animationData: CarbonAnimationData
Returns void
Note
This should be called right before executing a node to improve execution performance.

`Protected`onFilterAddConnection

onFilterAddConnection(connection): GraphConnection
Parameters
- connection: GraphConnection
Returns GraphConnection

onInitialize

onInitialize(this): void
Virtual
Method called by RSX to perform initialization of the resource.
Parameters
- this: Writable<Graph>
Returns void
Note
Use this API to initialize data and default construct all fields.

Inherited from CarbonStateGraph.onInitialize

onLayerTransitionEnterGate

onLayerTransitionEnterGate(layerData, animationData): void
Invoked when an open gate transition is being executed.
Parameters
- layerData: CarbonAnimationLayerData
- animationData: CarbonAnimationData
Returns void

onLayerTransitionGateClosed

onLayerTransitionGateClosed(layerData, animationData): void
Invoked when an open gate transition is no longer available.
Parameters
- layerData: CarbonAnimationLayerData
- animationData: CarbonAnimationData
Returns void

onSerializationStart

onSerializationStart(): void
Virtual
Method called by RSX to perform any operations before serialization.

Returns void
Note
Use this API to bake your live data into serializable data.

Inherited from CarbonStateGraph.onSerializationStart

`Protected`onVisitOpenGate

onVisitOpenGate(transitionConnection, animationData): void
Invoked when the state discovery moves along a connection.
Parameters
- transitionConnection: CarbonStateConnection
- animationData: CarbonAnimationData
Returns void
Note
Does not imply a state change.

removeComment

removeComment(comment): void
Removes the GraphComment to the scene.
Parameters
- comment: GraphComment
Returns void
Inherited from CarbonStateGraph.removeComment

removeConnection

removeConnection(connection): void
Removes the specified GraphConnection.
Parameters
- connection: GraphConnection
Returns void
Overrides CarbonStateGraph.removeConnection

removeNode

removeNode(node): void
Removes the specified GraphNode.
Parameters
- node: GraphNode
Returns void
Inherited from CarbonStateGraph.removeNode

removeOutdatedVariableValues

removeOutdatedVariableValues(variableValues): void
Removes all persisted GraphVariable data from variableValues that have been removed or are no longer public.
Parameters
- variableValues: Map<bigint, any>
  The persistent variable values that will be modified.
Returns void
Inherited from CarbonStateGraph.removeOutdatedVariableValues

removeVariable

removeVariable(variable): boolean
Removes the specified GraphVariable.
Parameters
- variable: GraphVariable
Returns boolean
Inherited from CarbonStateGraph.removeVariable

renameVariable

renameVariable(variable, newName): void
Renames the specified variable.
Parameters
- variable: GraphVariable
- newName: string
Returns void
Inherited from CarbonStateGraph.renameVariable

revert

revert(): boolean
Reverts the resource to the on-disk representation.

Returns boolean
Note
This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

Inherited from CarbonStateGraph.revert

setVariableDefaultValue

setVariableDefaultValue(variable, value, forceUpdate?): void
Changes the default value of a variable.
Parameters
- variable: GraphVariable
- value: any
- OptionalforceUpdate: boolean
Returns void
Inherited from CarbonStateGraph.setVariableDefaultValue

transitionLayerToNextState

transitionLayerToNextState(layerData, animationData): void
Attempts to transition to next state.
Parameters
- layerData: CarbonAnimationLayerData
- animationData: CarbonAnimationData
Returns void

unload

unload(): void
Forcefully unloads the resource.

Returns void
Inherited from CarbonStateGraph.unload

updateStateForLayer

updateStateForLayer(layerData, animationData): void
Updates the state information such as play speed for the specified layer.
Parameters
- layerData: CarbonAnimationLayerData
  The animation layer.
- animationData: CarbonAnimationData
  The animation data execution info.
Returns void

validate

validate(): void
Virtual
Ensures that the state of the graph is valid.

Returns void
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 CarbonStateGraph.validate

Events

`Readonly`onDirty

onDirty: Event<[GraphObject | Graph, EnumValue<GraphNodeDirtyFlags, number>], void>

An event called when a change on the graph was made.

`Readonly`onDirty

onDirty: Event<[GraphObject | Graph, EnumValue<GraphNodeDirtyFlags, number>], void>

An event called when a change on the graph was made.

`Readonly`onNodeAdded

onNodeAdded: Event<[GraphNode], void>

An event called whenever a new GraphNode is added.

`Readonly`onNodeRemoved

onNodeRemoved: Event<[GraphNode], void>

An event called whenever a GraphNode is removed.

`Readonly`onConnectionAdded

onConnectionAdded: Event<[GraphConnection], void>

An event called whenever a new connection was made.

`Readonly`onConnectionRemoved

onConnectionRemoved: Event<[GraphConnection], void>

An event called whenever a connection is removed.

`Readonly`onVariableAdded

onVariableAdded: Event<[GraphVariable], void>

An event called whenever a new GraphVariable is added.

`Readonly`onVariableRemoved

onVariableRemoved: Event<[GraphVariable], void>

An event called whenever a new GraphVariable was removed.

`Readonly`onVariableChanged

onVariableChanged: Event<[GraphVariable], void>

An event called whenever a new GraphVariable was changed, e.g. name, type or meta-data.

`Readonly`onVariableDefaultValueChanged

onVariableDefaultValueChanged: Event<[GraphVariable], void>

An event called whenever a new GraphVariable was default value changed.

`Readonly`onCommentAdded

onCommentAdded: Event<[GraphComment], void>

An event called whenever a new GraphComment is added.

`Readonly`onCommentRemoved

onCommentRemoved: Event<[GraphComment], void>

An event called whenever a new GraphComment was removed.

`Readonly`onValidationError

onValidationError: Event<[Map<GraphObject, string>], void>

An event called whenever validation resulted in errors.

`Readonly`onExecutionConnectionVisited

onExecutionConnectionVisited: Event<[GraphConnection, GraphExecutionState], void>

An event called whenever a connection was visited by the execution.

Editor Only

`Readonly`onExecutionRootVisited

onExecutionRootVisited: Event<[GraphNode, GraphExecutionState], void>

An event called whenever a root node was visited by the execution.

Class CarbonAnimationGraph

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Parameters

Returns CarbonAnimationGraph

Note

Properties

Protected_isEnabling

Readonlycomments

isValidationCritical

Readonlynodes

referenceMesh

referenceTemplate

ReadonlyuserData

validationStatus

Readonlyvariables

ReadonlyviewportPosition

viewportZoomScale

Static ReadonlycontrolFlowInputPinName

Static ReadonlycontrolFlowOutputPinName

Accessors

defaultVariableType

Returns Type

handle

Returns ResourceHandle<CarbonAnimationGraph>

isDestroyed

Returns boolean

Note

metaData

Returns ResourceMetaData

name

Returns string

referenceResource

Returns ResourceHandle<Template> | ResourceHandle<Mesh>

uuid

Returns UUID

variableGetterType

Returns SubclassOf<PropertyGetterNode>

variableSetterType

Returns SubclassOf<PropertySetterNode>

Methods

addComment

Parameters

Returns void

addCommentWithRegion

Parameters

Returns GraphComment

addConnection

Parameters

Returns void

Note

addNode

Parameters

Returns boolean

addVariable

Parameters

Returns boolean

Note

duplicate

Returns Resource

Protectedenable

Returns void

ProtectedenterNode

Parameters

Returns void

execute

Type Parameters

Parameters

Returns void

executeNode

Parameters

Returns GraphConnection

executeRoot

`Protected`_isEnabling

`Readonly`comments

`Readonly`nodes

`Readonly`userData

`Readonly`variables

`Readonly`viewportPosition

`Static` `Readonly`controlFlowInputPinName

`Static` `Readonly`controlFlowOutputPinName

`Protected`enable

`Protected`enterNode

`Protected`onExecuteNode

`Protected`onFilterAddConnection