Navigation
API > API/Plugins > API/Plugins/AvalancheMedia > API/Plugins/AvalancheMedia/Playback > API/Plugins/AvalancheMedia/Playback/Nodes
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UAvaPlaybackNode
- UAvaPlaybackNodeEvent
- UAvaPlaybackNodeAction
- UAvaPlaybackNodeFlow
- UAvaPlaybackNodeTrigger
- UAvaPlaybackNodePlayer
- UAvaPlaybackNodeRoot
References
| Module | AvalancheMedia |
| Header | /Engine/Plugins/Experimental/Avalanche/Source/AvalancheMedia/Public/Playback/Nodes/AvaPlaybackNode.h |
| Include | #include "Playback/Nodes/AvaPlaybackNode.h" |
Syntax
UCLASS (Abstract)
class UAvaPlaybackNode : public UObject
Remarks
Base Class for all the Nodes found in the Motion Design Playback Graph
Variables
| Type | Name | Description | |
|---|---|---|---|
| TMap< int32, double > | ChildLastValidTicks | ||
| TArray< TObjectPtr< UAvaPlaybackNode > > | ChildNodes | ||
| TObjectPtr< UEdGraphNode > | GraphNode | ||
| double | LastValidTick | ||
| FDelegateHandle | PlaybackStateChangedHandle |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddReferencedObjects
(
UObject* InThis, |
||
| void | |||
| void | DryRun
(
const TArray< UAvaPlaybackNode* >& InAncestors |
Called while Dry Running the Graph. This can be called multiple times for nodes that are connected to multiple nodes. | |
| void | DryRunNode
(
TArray< UAvaPlaybackNode* >& InAncestors |
Handles the 'Dry' run of the Node. This is called when Compiling the Graph. | |
| bool | EditorDryRunGraphOnNodeRefresh
(
FPropertyChangedEvent& PropertyChangedEvent |
||
| void | GetAllNodes
(
TArray< UAvaPlaybackNode* >& OutPlaybackNodes |
Recursive call to get all the Nodes connected to this Node (inclusive) | |
| double | GetChildLastTimeTicked
(
int32 ChildIndex |
||
| const TArray< TObjectPtr< UAvaPlaybackNode > > & | |||
| UEdGraphNode * | GetGraphNode () |
||
| FName | GetInputPinName
(
int32 InputPinIndex |
||
| double | |||
| int32 | |||
| int32 | |||
| FText | Gets the Display Category of the Node | ||
| FText | Gets the Display Name of the Node | ||
| FText | Gets the ToolTip of the Node | ||
| UAvaPlaybackGraph * | GetPlayback () |
||
| void | InsertChildNode
(
int32 Index |
||
| void | NotifyChildNodeSucceeded
(
int32 ChildIndex |
Called when the Child at ChildIndex, made a connection to a Player Node successfully This updates the Last Ticked Times and stores them both in This Node and the Child Node that caused the connection | |
| void | NotifyPlaybackStateChanged
(
bool bPlaying |
Called when the UAvaPlaybackGraph changes its state from Playing <-> Stopped | |
| void | Called either when the Node has been Constructed (new node) or from Post Load | ||
| void | PostDryRun () |
Called after Dry Running the Graph. This is called once per node. | |
| void | PreDryRun () |
Called before Dry Running the Graph. This is called once per node. | |
| void | |||
| void | RefreshNode
(
bool bDryRunGraph |
||
| void | RemoveChildNode
(
int32 Index |
||
| void | SetChildNodes
(
TArray< UAvaPlaybackNode* >&& InChildNodes |
||
| void | SetGraphNode
(
UEdGraphNode* InGraphNode |
||
| void | Tick
(
float DeltaTime, |
Handles the 'Raw' ticking of the Node. | |
| void | TickChild
(
float DeltaTime, |
Ticks Childs as well as checking if the Child actually made connection to a Player Node If the Ticking results in valid Channel Parameters, then it calls 'NotifyChildNodeSucceeded' |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | BeginDestroy () |
Called before destroying the object. | |
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. | |
| void | Handles reading, writing, and reference collecting using FArchive. |
Overridden from UObjectBaseUtility
| Type | Name | Description | |
|---|---|---|---|
| bool | Called after load to determine if the object can be a cluster root | ||
| bool | Called during cluster construction if the object can be added to a cluster |
Classes
| Type | Name | Description | |
|---|---|---|---|
| NodeCategory |
Constants
| Name | Description |
|---|---|
| MaxAllowedChildNodes |