IAnimBlueprintCompilationContext

Interface to the anim BP compiler context for use while compilation is in progress

Choose your operating system:

Windows

macOS

Linux

References

Module

AnimGraph

Header

/Engine/Source/Editor/AnimGraph/Public/IAnimBlueprintCompilationContext.h

Include

#include "IAnimBlueprintCompilationContext.h"

Syntax

class IAnimBlueprintCompilationContext

Remarks

Interface to the anim BP compiler context for use while compilation is in progress

Destructors

Functions

Name Description

Public function Const

void

 

AddAttributesToNode

(
    UAnimGraphNode_Base* InNode,
    TArrayView< const FName > InAttribu...
)

Add the specified compiled-in attribute uniquely to the specified node.

Protected function Const

void

 

AddAttributesToNodeImpl

(
    UAnimGraphNode_Base* InNode,
    TArrayView< const FName > InAttribu...
)

Add the specified compiled-in attribute uniquely to the specified node.

Public function

void

 

AddPoseLinkMappingRecord

(
    const FPoseLinkMappingRecord& InRe...
)

Adds a pose link mapping record.

Protected function

void

 

AddPoseLinkMappingRecordImpl

(
    const FPoseLinkMappingRecord& InRe...
)

Adds a pose link mapping record.

Public function

void

 

ExpansionStep

(
    UEdGraph* Graph,
    bool bAllowUbergraphExpansions
)

Perform an expansion step for the specified graph.

Protected function

void

 

ExpansionStepImpl

(
    UEdGraph* Graph,
    bool bAllowUbergraphExpansions
)

Perform an expansion step for the specified graph.

Public function Const

FieldType &#...

 

FindClassFProperty

(
    const TCHAR* InFieldPath
)

Find a property in the currently-compiled class.

Public function Static

TUniquePtr< ...

 

Get

(
    FKismetCompilerContext& InKismetCo...
)

Get a compilation context from a kismet compiler context assuming that it is an FAnimBlueprintCompilerContext.

Public function Const

const TMap< ...

 

GetAllocatedAnimNodeIndices()

Index of the nodes (must match up with the runtime discovery process of nodes, which runs thru the property chain)

Protected function Const

const TMap< ...

 

GetAllocatedAnimNodeIndicesImpl()

Index of the nodes (must match up with the runtime discovery process of nodes, which runs thru the property chain)

Public function Const

const TMap< ...

 

GetAllocatedPropertiesByIndex()

Map of anim node indices to node properties.

Protected function Const

const TMap< ...

 

GetAllocatedPropertiesByIndexImpl()

Map of anim node indices to node properties.

Public function Const

const TMap< ...

 

GetAllocatedPropertiesByNode()

Map of anim node indices to node properties.

Protected function Const

const TMap< ...

 

GetAllocatedPropertiesByNodeImpl()

Map of anim node indices to node properties.

Public function Const

int32

 

GetAllocationIndexOfNode

(
    UAnimGraphNode_Base* VisualAni...
)

Returns the allocation index of the specified node, processing it if it was pending.

Protected function Const

int32

 

GetAllocationIndexOfNodeImpl

(
    UAnimGraphNode_Base* VisualAni...
)

Returns the allocation index of the specified node, processing it if it was pending.

Public function Const

const UAnimB...

 

GetAnimBlueprint()

Get the currently-compiled anim blueprint.

Protected function Const

const UAnimB...

 

GetAnimBlueprintImpl()

Get the currently-compiled anim blueprint.

Public function Const

TArrayView< ...

 

GetAttributesFromNode

(
    UAnimGraphNode_Base* InNode
)

Get the current compiled-in attributes uniquely assigned to the specified node.

Protected function Const

TArrayView< ...

 

GetAttributesFromNodeImpl

(
    UAnimGraphNode_Base* InNode
)

Get the current compiled-in attributes uniquely assigned to the specified node.

Public function Const

const UBluep...

 

GetBlueprint()

Get the currently-compiled blueprint.

Protected function Const

const UBluep...

 

GetBlueprintImpl()

Get the currently-compiled blueprint.

Public function Const

UEdGraph ...

 

GetConsolidatedEventGraph()

Get the consolidated uber graph during compilation.

Protected function Const

UEdGraph ...

 

GetConsolidatedEventGraphImpl()

Get the consolidated uber graph during compilation.

Public function Const

const FFolde...

 

GetFoldedPropertyRecord

(
    UAnimGraphNode_Base* InNode,
    FName InPropertyName
)

Get the folded property record, if any, for the supplied node & named property.

Protected function Const

const FFolde...

 

GetFoldedPropertyRecordImpl

(
    UAnimGraphNode_Base* InNode,
    FName InPropertyName
)

Get the folded property record, if any, for the supplied node & named property.

Protected function Const

FKismetCompi...

 

GetKismetCompiler()

Get the compiler as a base class to avoid circular include issues with templated functions/classes.

Public function Const

void

 

GetLinkedAnimNodes

(
    UAnimGraphNode_Base* InGraphNo...,
    TArray< UAnimGraphNode_Base* >...
)

Gets all anim graph nodes that are piped into the provided node (traverses input pins)

Protected function Const

void

 

GetLinkedAnimNodesImpl

(
    UAnimGraphNode_Base* InGraphNo...,
    TArray< UAnimGraphNode_Base* >...
)

Gets all anim graph nodes that are piped into the provided node (traverses input pins)

Public function Const

FCompilerRes...

 

GetMessageLog()

Get the message log for the current compilation.

Protected function Const

FCompilerRes...

 

GetMessageLogImpl()

Get the message log for the current compilation.

Public function Virtual Const

const FStruc...

 

GetMutableDataProperty()

Get the generated property of the class that mutable data is added to.

Protected function Const

const FStruc...

 

GetMutableDataPropertyImpl()

Get the generated property of the class that mutable data is added to.

Public function Const

const TMap< ...

 

GetSourceNodeToProcessedNodeMap()

Map of true source objects (user edited ones) to the cloned ones that are actually compiled.

Protected function Const

const TMap< ...

 

GetSourceNodeToProcessedNodeMapImpl()

Map of true source objects (user edited ones) to the cloned ones that are actually compiled.

Public function Const

bool

 

IsAnimGraphNodeFolded

(
    UAnimGraphNode_Base* InNode
)

Check whether an anim node participates in constant folding.

Protected function Const

bool

 

IsAnimGraphNodeFoldedImpl

(
    UAnimGraphNode_Base* InNode
)

Check whether an anim node participates in constant folding.

Public function

void

 

ProcessAnimationNodes

(
    TArray< UAnimGraphNode_Base* >...
)

Process the passed-in list of nodes.

Protected function

void

 

ProcessAnimationNodesImpl

(
    TArray< UAnimGraphNode_Base* >...
)

Process the passed-in list of nodes.

Public function

void

 

PruneIsolatedAnimationNodes

(
    const TArray< UAnimGraphNode_Base&...,
    TArray< UAnimGraphNode_Base* >...
)

Prunes any nodes that aren't reachable via a pose link.

Protected function

void

 

PruneIsolatedAnimationNodesImpl

(
    const TArray< UAnimGraphNode_Base&...,
    TArray< UAnimGraphNode_Base* >...
)

Prunes any nodes that aren't reachable via a pose link.

Public function

NodeType ...

 

SpawnIntermediateEventNode

(
    UEdGraphNode* SourceNode,
    UEdGraphPin* SourcePin,
    UEdGraph* ParentGraph
)

Spawns an intermediate event node associated with the source node (for error purposes)

Public function

NodeType ...

 

SpawnIntermediateNode

(
    UEdGraphNode* SourceNode,
    UEdGraph* ParentGraph
)

Spawns an intermediate node associated with the source node (for error purposes)

Public function Const

bool

 

ValidateGraphIsWellFormed

(
    UEdGraph* Graph
)

Performs standard validation on the graph (outputs point to inputs, no more than one connection to each input, types match on both ends, etc...)

Protected function Const

bool

 

ValidateGraphIsWellFormedImpl

(
    UEdGraph* Graph
)

Performs standard validation on the graph (outputs point to inputs, no more than one connection to each input, types match on both ends, etc...)

Classes

Name

Description

Public struct

FFoldedPropertyRecord

Record of a property that can be folded into the class members/constant blocks.