UAnimDataController

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAnimDataController

References

Module

AnimationDataController

Header

/Engine/Source/Developer/AnimationDataController/Public/AnimDataController.h

Include

#include "AnimDataController.h"

Syntax

class UAnimDataController :
    public UObject,
    public IAnimationDataController

Constructors

Name Description

Public function

UAnimDataController()

Overridden from IAnimationDataController

Name Description

Public function Virtual

bool

 

AddAttribute

(
    const FAnimationAttributeIdentifier...,
    bool bShouldTransact
)

Adds a new attribute with the provided information.

Public function Virtual

int32

 

AddBoneTrack

(
    FName BoneName,
    bool bShouldTransact
)

Adds a new bone animation track for the provided name.

Public function Virtual

bool

 

AddCurve

(
    const FAnimationCurveIdentifier& C...,
    int32 CurveFlags,
    bool bShouldTransact
)

Adds a new curve with the provided information.

Public function Virtual

void

 

CloseBracket

(
    bool bShouldTransact
)

Closes a previously opened interaction bracket, used for combining a set of controller actions.

Public function Virtual

bool

 

DuplicateAttribute

(
    const FAnimationAttributeIdentifier...,
    const FAnimationAttributeIdentifier...,
    bool bShouldTransact
)

Duplicated the attribute (curve) with the identifier.

Public function Virtual

bool

 

DuplicateCurve

(
    const FAnimationCurveIdentifier& C...,
    const FAnimationCurveIdentifier& N...,
    bool bShouldTransact
)

Duplicated the curve with the identifier.

Public function Virtual

void

 

FindOrAddCurveNamesOnSkeleton

(
    USkeleton* Skeleton,
    ERawCurveTrackTypes SupportedCurveT...,
    bool bShouldTransact
)

Updates the curve names with the provided skeleton, if a display name is not found it will be added thus modifying the skeleton.

Public function Virtual Const

const UAnimD...

 

GetModel()

Public function Virtual

UAnimDataMod...

 

GetModel()

Public function Virtual

int32

 

InsertBoneTrack

(
    FName BoneName,
    int32 DesiredIndex,
    bool bShouldTransact
)

Inserts a new bone animation track for the provided name, at the provided index.

Protected function Virtual

void

 

NotifyBracketClosed()

Protected function Virtual

void

 

NotifyBracketOpen()

Functionality used by FOpenBracketAction and FCloseBracketAction to broadcast their equivalent notifies without actually opening a bracket.

Public function Virtual

void

 

NotifyPopulated()

Broadcast a EAnimDataModelNotifyType::Populated notify.

Public function Virtual

void

 

OpenBracket

(
    const FText& InTitle,
    bool bShouldTransact
)

Opens an interaction bracket, used for combining a set of controller actions.

Public function Virtual

int32

 

RemoveAllAttributes

(
    bool bShouldTransact
)

Removes all stored attributes.

Public function Virtual

int32

 

RemoveAllAttributesForBone

(
    const FName& BoneName,
    bool bShouldTransact
)

Removes all attributes for the specified bone name, if any.

Public function Virtual

void

 

RemoveAllBoneTracks

(
    bool bShouldTransact
)

Removes all existing Bone Animation tracks.

Public function Virtual

void

 

RemoveAllCurvesOfType

(
    ERawCurveTrackTypes SupportedCurveT...,
    bool bShouldTransact
)

Removes all the curves of the provided type.

Public function Virtual

bool

 

RemoveAttribute

(
    const FAnimationAttributeIdentifier...,
    bool bShouldTransact
)

Removes an attribute, if found, with the provided information.

Public function Virtual

bool

 

RemoveAttributeKey

(
    const FAnimationAttributeIdentifier...,
    float Time,
    bool bShouldTransact
)

Remove a single key from the attribute with provided identifier.

Public function Virtual

bool

 

RemoveBoneTrack

(
    FName BoneName,
    bool bShouldTransact
)

Removes an existing bone animation track with the provided name.

Public function Virtual

bool

 

RemoveBoneTracksMissingFromSkeleton

(
    const USkeleton* Skeleton,
    bool bShouldTransact
)

Removes any bone track for which the name was not found in the provided skeleton.

Public function Virtual

bool

 

RemoveCurve

(
    const FAnimationCurveIdentifier& C...,
    bool bShouldTransact
)

Remove the curve with provided identifier.

Public function Virtual

bool

 

RemoveCurveKey

(
    const FAnimationCurveIdentifier& C...,
    float Time,
    bool bShouldTransact
)

Remove a single key from the curve with provided identifier and name.

Public function Virtual

bool

 

RemoveTransformCurveKey

(
    const FAnimationCurveIdentifier& C...,
    float Time,
    bool bShouldTransact
)

Removes a single key for the transform curve with provided identifier.

Public function Virtual

bool

 

RenameCurve

(
    const FAnimationCurveIdentifier& C...,
    const FAnimationCurveIdentifier& N...,
    bool bShouldTransact
)

Renames the curve with provided identifier.

Public function Virtual

void

 

ResetModel

(
    bool bShouldTransact
)

Resets all data stored in the model, broadcasts a EAnimDataModelNotifyType::Reset and wraps all actions within BracketOpened/BracketClosed notifies.

Public function Virtual

void

 

Resize

(
    float Length,
    float T0,
    float T1,
    bool bShouldTransact
)

Sets the total play-able length in seconds and resizes curves.

Public function Virtual

void

 

ResizePlayLength

(
    float NewLength,
    float T0,
    float T1,
    bool bShouldTransact
)

Public function Virtual

bool

 

ScaleCurve

(
    const FAnimationCurveIdentifier& C...,
    float Origin,
    float Factor,
    bool bShouldTransact
)

Scales the curve with provided identifier.

Public function Virtual

bool

 

SetAttributeKey

(
    const FAnimationAttributeIdentifier...,
    float Time,
    const void* KeyValue,
    const UScriptStruct* TypeStruc...,
    bool bShouldTransact
)

Sets a single key for the attribute with provided identifier.

Public function Virtual

bool

 

SetAttributeKeys

(
    const FAnimationAttributeIdentifier...,
    TArrayView< const float > Times,
    TArrayView< const void* > KeyV...,
    const UScriptStruct* TypeStruc...,
    bool bShouldTransact
)

Replace the keys for the attribute with provided identifier.

Public function Virtual

bool

 

SetBoneTrackKeys

(
    FName BoneName,
    const TArray< FVector3f >& Positio...,
    const TArray< FQuat4f >& Rotationa...,
    const TArray< FVector3f >& Scaling...,
    bool bShouldTransact
)

Removes an existing bone animation track with the provided name.

Public function Virtual

bool

 

SetBoneTrackKeys

(
    FName BoneName,
    const TArray< FVector >& Positiona...,
    const TArray< FQuat >& RotationalK...,
    const TArray< FVector >& ScalingKe...,
    bool bShouldTransact
)

Removes an existing bone animation track with the provided name.

Public function Virtual

bool

 

SetCurveColor

(
    const FAnimationCurveIdentifier& C...,
    FLinearColor Color,
    bool bShouldTransact
)

Changes the color of the curve with provided identifier.

Public function Virtual

bool

 

SetCurveFlag

(
    const FAnimationCurveIdentifier& C...,
    EAnimAssetCurveFlags Flag,
    bool bState,
    bool bShouldTransact
)

Set an individual flag for the curve with provided identifier.

Public function Virtual

bool

 

SetCurveFlags

(
    const FAnimationCurveIdentifier& C...,
    int32 Flags,
    bool bShouldTransact
)

Replace the flags for the curve with provided identifier.

Public function Virtual

bool

 

SetCurveKey

(
    const FAnimationCurveIdentifier& C...,
    const FRichCurveKey& Key,
    bool bShouldTransact
)

Sets a single key for the curve with provided identifier and name.

Public function Virtual

bool

 

SetCurveKeys

(
    const FAnimationCurveIdentifier& C...,
    const TArray< FRichCurveKey >& Cur...,
    bool bShouldTransact
)

Replace the keys for the curve with provided identifier and name.

Public function Virtual

void

 

SetFrameRate

(
    FFrameRate FrameRate,
    bool bShouldTransact
)

Sets the frame rate according to which the bone animation is expected to be sampled.

Public function Virtual

void

 

SetModel

(
    UAnimDataModel* InModel
)

Begin IAnimationDataController overrides

Public function Virtual

void

 

SetPlayLength

(
    float Length,
    bool bShouldTransact
)

Sets the total play-able length in seconds.

Public function Virtual

bool

 

SetTransformCurveKey

(
    const FAnimationCurveIdentifier& C...,
    float Time,
    const FTransform& Value,
    bool bShouldTransact
)

Sets a single key for the transform curve with provided identifier.

Public function Virtual

bool

 

SetTransformCurveKeys

(
    const FAnimationCurveIdentifier& C...,
    const TArray< FTransform >& Transf...,
    const TArray< float >& TimeKeys,
    bool bShouldTransact
)

Replace the keys for the transform curve with provided identifier.

Public function Virtual

void

 

UpdateAttributesFromSkeleton

(
    const USkeleton* Skeleton,
    bool bShouldTransact
)

Removes any bone attribute for which the name was not found in the provided skeleton.

Public function Virtual

void

 

UpdateCurveNamesFromSkeleton

(
    const USkeleton* Skeleton,
    ERawCurveTrackTypes SupportedCurveT...,
    bool bShouldTransact
)

Updates the display name values for any stored curve, with the names being retrieved from the provided skeleton.