1. Epic GamesDeveloper
  3. IAnimationDataController

IAnimationDataController

API > API/Runtime > API/Runtime/Engine

   
Name IAnimationDataController
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Animation/AnimData/IAnimationDataController.h
Include Path #include "Animation/AnimData/IAnimationDataController.h"

Syntax

class IAnimationDataController

Derived Classes

Structs

Name Remarks
FScopedBracket RAII helper to define a scoped-based bracket, opens and closes a controller bracket automatically

Typedefs

Name Type Remarks Include Path
FBracket TUniquePtr< IAnimationDataController::FScopedBracket >   Animation/AnimData/IAnimationDataController.h
FTransaction TUniquePtr< UE::FScopedCompoundTransaction >   Animation/AnimData/IAnimationDataController.h

Constants

Name Type Remarks Include Path
DefaultCurveFlags int32   Animation/AnimData/IAnimationDataController.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddAttribute ( const FAnimationAttributeIdentifier& AttributeIdentifier,
bool bShouldTransact
)

 Adds a new attribute with the provided information. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AttributeData

bool AddBoneCurve ( FName BoneName,
bool bShouldTransact
)

   Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

virtual int32 AddBoneTrack ( FName BoneName,
bool bShouldTransact
)

 Adds a new bone animation track for the provided name. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData
  • Meta=(DeprecatedFunction, DeprecationMessage="AddBoneTrack returning index is deprecated use AddBoneCurve returning bool instead.")

bool AddCurve ( const FAnimationCurveIdentifier& CurveId,
int32 CurveFlags,
bool bShouldTransact
)

 Adds a new curve with the provided information. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

void CloseBracket ( bool bShouldTransact
)

 Closes a previously opened interaction bracket, used for combining a set of controller actions. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

FFrameNumber ConvertSecondsToFrameNumber ( double Seconds
) const

 Returns the final frame number calculating according to the Model its frame-rate, additionally outputs log information for invalid/loss of precision Animation/AnimData/IAnimationDataController.h  

bool DuplicateAttribute ( const FAnimationAttributeIdentifier& AttributeIdentifier,
const FAnimationAttributeIdentifier& NewAttributeIdentifier,
bool bShouldTransact
)

 Duplicated the attribute (curve) with the identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AttributeData

bool DuplicateCurve ( const FAnimationCurveIdentifier& CopyCurveId,
const FAnimationCurveIdentifier& NewCurveId,
bool bShouldTransact
)

 Duplicated the curve with the identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

virtual void FindOrAddCurveNamesOnSkeleton ( USkeleton* Skeleton,
ERawCurveTrackTypes SupportedCurveType,
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. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is no longer used.")

const IAnimationDataModel *const GetModel()

   Animation/AnimData/IAnimationDataController.h  

TScriptInterface< IAnimationDataModel > GetModelInterface()

   Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

void InitializeModel()

 Initializes model data structures Animation/AnimData/IAnimationDataController.h  

int32 InsertBoneTrack ( FName BoneName,
int32 DesiredIndex,
bool bShouldTransact
)

 Inserts a new bone animation track for the provided name, at the provided index. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData
  • Meta=(DeprecatedFunction, DeprecationMessage="InsertBoneTrack is deprecated use AddBoneTrack instead.")

void NotifyPopulated()

 Broadcast a EAnimDataModelNotifyType::Populated notify. Animation/AnimData/IAnimationDataController.h  

void OpenBracket ( const FText& InTitle,
bool bShouldTransact
)

 Opens an interaction bracket, used for combining a set of controller actions. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

void PopulateWithExistingModel ( TScriptInterface< IAnimationDataModel > InModel
)

 Copies any animation relevant data from an already existing IAnimationDataModel object Animation/AnimData/IAnimationDataController.h  

int32 RemoveAllAttributes ( bool bShouldTransact
)

 Removes all stored attributes. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AttributeData

int32 RemoveAllAttributesForBone ( const FName& BoneName,
bool bShouldTransact
)

 Removes all attributes for the specified bone name, if any. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AttributeData

void RemoveAllBoneTracks ( bool bShouldTransact
)

 Removes all existing Bone Animation tracks. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

void RemoveAllCurvesOfType ( ERawCurveTrackTypes SupportedCurveType,
bool bShouldTransact
)

 Removes all the curves of the provided type. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool RemoveAttribute ( const FAnimationAttributeIdentifier& AttributeIdentifier,
bool bShouldTransact
)

 Removes an attribute, if found, with the provided information. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AttributeData

bool RemoveAttributeKey ( const FAnimationAttributeIdentifier& AttributeIdentifier,
float Time,
bool bShouldTransact
)

 Remove a single key from the attribute with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AttributeData

bool RemoveBoneTrack ( FName BoneName,
bool bShouldTransact
)

 Removes an existing bone animation track with the provided name. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

bool RemoveBoneTracksMissingFromSkeleton ( const USkeleton* Skeleton,
bool bShouldTransact
)

 Removes any bone track for which the name was not found in the provided skeleton. Animation/AnimData/IAnimationDataController.h  

bool RemoveCurve ( const FAnimationCurveIdentifier& CurveId,
bool bShouldTransact
)

 Remove the curve with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool RemoveCurveKey ( const FAnimationCurveIdentifier& CurveId,
float Time,
bool bShouldTransact
)

 Remove a single key from the curve with provided identifier and name. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool RemoveTransformCurveKey ( const FAnimationCurveIdentifier& CurveId,
float Time,
bool bShouldTransact
)

 Removes a single key for the transform curve with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool RenameCurve ( const FAnimationCurveIdentifier& CurveToRenameId,
const FAnimationCurveIdentifier& NewCurveId,
bool bShouldTransact
)

 Renames the curve with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

void ResetModel ( bool bShouldTransact
)

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

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

   Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData
  • Meta=(DeprecatedFunction, DeprecationMessage="Resize is deprecated use ResizeInFrames instead.")

void ResizeInFrames ( FFrameNumber NewLengthInFrames,
FFrameNumber T0,
FFrameNumber T1,
bool bShouldTransact
)

 Sets the total play-able length in seconds and resizes curves. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

void ResizeNumberOfFrames ( FFrameNumber NewLengthInFrames,
FFrameNumber T0,
FFrameNumber T1,
bool bShouldTransact
)

   Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

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

   Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData
  • Meta=(DeprecatedFunction, DeprecationMessage="ResizePlayLength is deprecated use ResizeNumberOfFrames instead.")

bool ScaleCurve ( const FAnimationCurveIdentifier& CurveId,
float Origin,
float Factor,
bool bShouldTransact
)

 Scales the curve with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool SetAttributeKey ( const FAnimationAttributeIdentifier& AttributeIdentifier,
float Time,
const void* KeyValue,
const UScriptStruct* TypeStruct,
bool bShouldTransact
)

 Sets a single key for the attribute with provided identifier. Animation/AnimData/IAnimationDataController.h  

bool SetAttributeKeys ( const FAnimationAttributeIdentifier& AttributeIdentifier,
TArrayView< const float > Times,
TArrayView< const void* > KeyValues,
const UScriptStruct* TypeStruct,
bool bShouldTransact
)

 Replace the keys for the attribute with provided identifier. Animation/AnimData/IAnimationDataController.h  

bool SetBoneTrackKeys ( FName BoneName,
const TArray< FVector >& PositionalKeys,
const TArray< FQuat >& RotationalKeys,
const TArray< FVector >& ScalingKeys,
bool bShouldTransact
)

 Removes an existing bone animation track with the provided name. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

bool SetBoneTrackKeys ( FName BoneName,
const TArray< FVector3f >& PositionalKeys,
const TArray< FQuat4f >& RotationalKeys,
const TArray< FVector3f >& ScalingKeys,
bool bShouldTransact
)

 Removes an existing bone animation track with the provided name. Animation/AnimData/IAnimationDataController.h  

bool SetCurveAttributes ( const FAnimationCurveIdentifier& CurveId,
const FCurveAttributes& Attributes,
bool bShouldTransact
)

 Changes the attributes of the curve with provided identifier. Animation/AnimData/IAnimationDataController.h  

bool SetCurveColor ( const FAnimationCurveIdentifier& CurveId,
FLinearColor Color,
bool bShouldTransact
)

 Changes the color of the curve with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool SetCurveComment ( const FAnimationCurveIdentifier& CurveId,
const FString& Comment,
bool bShouldTransact
)

 Changes the comment of the curve with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool SetCurveFlag ( const FAnimationCurveIdentifier& CurveId,
EAnimAssetCurveFlags Flag,
bool bState,
bool bShouldTransact
)

 Set an individual flag for the curve with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool SetCurveFlags ( const FAnimationCurveIdentifier& CurveId,
int32 Flags,
bool bShouldTransact
)

 Replace the flags for the curve with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool SetCurveKey ( const FAnimationCurveIdentifier& CurveId,
const FRichCurveKey& Key,
bool bShouldTransact
)

 Sets a single key for the curve with provided identifier and name. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool SetCurveKeys ( const FAnimationCurveIdentifier& CurveId,
const TArray< FRichCurveKey >& CurveKeys,
bool bShouldTransact
)

 Replace the keys for the curve with provided identifier and name. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

void SetFrameRate ( FFrameRate FrameRate,
bool bShouldTransact
)

 Sets the frame rate according to which the bone animation is expected to be sampled. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

void SetModel ( TScriptInterface< IAnimationDataModel > InModel
)

 Sets the AnimDataModel instance this controller is supposed to be targeting Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

void SetNumberOfFrames ( FFrameNumber NewLengthInFrames,
bool bShouldTransact
)

 Sets the total play-able length in seconds. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData

void SetPlayLength ( float Length,
bool bShouldTransact
)

   Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=AnimationData
  • Meta=(DeprecatedFunction, DeprecationMessage="SetPlayLength is deprecated use SetNumberOfFrames instead.")

bool SetTransformCurveKey ( const FAnimationCurveIdentifier& CurveId,
float Time,
const FTransform& Value,
bool bShouldTransact
)

 Sets a single key for the transform curve with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool SetTransformCurveKeys ( const FAnimationCurveIdentifier& CurveId,
const TArray< FTransform >& TransformValues,
const TArray< float >& TimeKeys,
bool bShouldTransact
)

 Replace the keys for the transform curve with provided identifier. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData

bool SetTypedAttributeKey ( const FAnimationAttributeIdentifier& AttributeIdentifier,
float Time,
const AttributeType& KeyValue,
bool bShouldTransact
)

 Sets a single key for the attribute with provided identifier. Animation/AnimData/IAnimationDataController.h  

bool SetTypedAttributeKeys ( const FAnimationAttributeIdentifier& AttributeIdentifier,
TArrayView< const float > Times,
TArrayView< const AttributeType > KeyValues,
bool bShouldTransact
)

 Replace the keys for the attribute with provided identifier. Animation/AnimData/IAnimationDataController.h  

void UpdateAttributesFromSkeleton ( const USkeleton* Skeleton,
bool bShouldTransact
)

 Removes any bone attribute for which the name was not found in the provided skeleton. Animation/AnimData/IAnimationDataController.h  

bool UpdateBoneTrackKeys ( FName BoneName,
const FInt32Range& KeyRangeToSet,
const TArray< FVector3f >& PositionalKeys,
const TArray< FQuat4f >& RotationalKeys,
const TArray< FVector3f >& ScalingKeys,
bool bShouldTransact
)

 Sets a range of keys for an existing bone animation track with the provided name. Animation/AnimData/IAnimationDataController.h  

bool UpdateBoneTrackKeys ( FName BoneName,
const FInt32Range& KeyRangeToSet,
const TArray< FVector >& PositionalKeys,
const TArray< FQuat >& RotationalKeys,
const TArray< FVector >& ScalingKeys,
bool bShouldTransact
)

 Sets a range of keys for an existing bone animation track with the provided name. Animation/AnimData/IAnimationDataController.h  

virtual void UpdateCurveNamesFromSkeleton ( const USkeleton* Skeleton,
ERawCurveTrackTypes SupportedCurveType,
bool bShouldTransact
)

 Updates the display name values for any stored curve, with the names being retrieved from the provided skeleton. Animation/AnimData/IAnimationDataController.h
  • BlueprintCallable
  • Category=CurveData
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is no longer used.")

void UpdateWithSkeleton ( USkeleton* TargetSkeleton,
bool bShouldTransact
)

 Updates/removes/remaps contained animation data according to the newly assigned skeleton Animation/AnimData/IAnimationDataController.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool CheckOuterClass ( UClass* InClass
) const

 Verifies whether or not the Model's outer object is (or is derived from) the specified UClass Animation/AnimData/IAnimationDataController.h  

void ConditionalAction ( bool bCondition,
ActionArguments&&... Arguments
)

   Animation/AnimData/IAnimationDataController.h  

FBracket ConditionalBracket ( const FText& Description,
bool bCondition
)

   Animation/AnimData/IAnimationDataController.h  

FTransaction ConditionalTransaction ( const FText& Description,
bool bCondition
)

   Animation/AnimData/IAnimationDataController.h  

void NotifyBracketClosed()

   Animation/AnimData/IAnimationDataController.h  

void NotifyBracketOpen()

 Functionality used by FOpenBracketAction and FCloseBracketAction to broadcast their equivalent notifies without actually opening a bracket. Animation/AnimData/IAnimationDataController.h  

void Report ( ELogVerbosity::Type Verbosity,
const FText& Message
) const

   Animation/AnimData/IAnimationDataController.h  

void ReportError ( const FText& Message
) const

   Animation/AnimData/IAnimationDataController.h  

void ReportErrorf ( const FmtType& Fmt,
Types... Args
) const

   Animation/AnimData/IAnimationDataController.h  

void Reportf ( ELogVerbosity::Type Verbosity,
const FmtType& Fmt,
Types... Args
) const

   Animation/AnimData/IAnimationDataController.h  

void ReportWarning ( const FText& Message
) const

   Animation/AnimData/IAnimationDataController.h  

void ReportWarningf ( const FmtType& Fmt,
Types... Args
) const

   Animation/AnimData/IAnimationDataController.h  

void ValidateModel()

 Ensures that a valid model is currently targeted Animation/AnimData/IAnimationDataController.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString GetCurveTypeValueName ( ERawCurveTrackTypes InType
)

 Returns the string representation of the provided curve enum type value Animation/AnimData/IAnimationDataController.h  

static bool IsSupportedCurveType ( ERawCurveTrackTypes CurveType
)

 Returns whether or not the supplied curve type is supported by the controller functionality Animation/AnimData/IAnimationDataController.h  

static void Reportf ( ELogVerbosity::Type LogVerbosity,
const UObject* ErrorObject,
const FmtType& Fmt,
Types... Args
)

   Animation/AnimData/IAnimationDataController.h  

static void ReportMessage ( const UObject* ErrorObject,
const FText& InMessage,
ELogVerbosity::Type LogVerbosity
)

   Animation/AnimData/IAnimationDataController.h  

static void ReportObjectErrorf ( const UObject* ErrorObject,
const FmtType& Fmt,
Types... Args
)

   Animation/AnimData/IAnimationDataController.h  

static void ReportObjectWarningf ( const UObject* ErrorObject,
const FmtType& Fmt,
Types... Args
)

   Animation/AnimData/IAnimationDataController.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page