1. Epic GamesDeveloper
  3. IAnimationDataController

IAnimationDataController

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Animation > API/Runtime/Engine/Animation/AnimData

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Animation/AnimData/IAnimationDataController.h
Include #include "Animation/AnimData/IAnimationDataController.h"

Syntax

class IAnimationDataController

Variables

  Type Name Description
Protected variable UE::FChangeTransactor ChangeTransactor  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category bool

AddAttribute ( const FAnimationAttributeIdentifier& AttributeIdentifier,
bool bShouldTransact
)

 Adds a new attribute with the provided information.
Public function UFunction BlueprintCallable, Category bool

AddBoneCurve ( FName BoneName,
bool bShouldTransact
)

  
Public function Virtual UFunction BlueprintCallable, Category, Meta int32

AddBoneTrack ( FName BoneName,
bool bShouldTransact
)

 Adds a new bone animation track for the provided name.
Public function UFunction BlueprintCallable, Category bool

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

 Adds a new curve with the provided information.
Protected function Const bool

CheckOuterClass ( UClass* InClass
)

 Verifies whether or not the Model's outer object is (or is derived from) the specified UClass
Public function UFunction BlueprintCallable, Category void

CloseBracket ( bool bShouldTransact
)

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

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

  
Protected function FBracket

ConditionalBracket ( const FText& Description,
bool bCondition
)

  
Protected function FTransaction

ConditionalTransaction ( const FText& Description,
bool bCondition
)

  
Public function Const FFrameNumber

ConvertSecondsToFrameNumber ( double Seconds
)

 Returns the final frame number calculating according to the Model its frame-rate, additionally outputs log information for invalid/loss of precision
Public function UFunction BlueprintCallable, Category bool

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

 Duplicated the attribute (curve) with the identifier.
Public function UFunction BlueprintCallable, Category bool

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

 Duplicated the curve with the identifier.
Public function Virtual UFunction BlueprintCallable, Category, Meta 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.
Protected function Static FString Returns the string representation of the provided curve enum type value
Public function Const const IAnimationDataModel *const  
Public function Const UFunction BlueprintCallable, Category TScriptInterface< IAnimationDataModel >  
Public function void Initializes model data structures
Public function UFunction BlueprintCallable, Category, Meta int32

InsertBoneTrack ( FName BoneName,
int32 DesiredIndex,
bool bShouldTransact
)

 Inserts a new bone animation track for the provided name, at the provided index.
Protected function Static bool Returns whether or not the supplied curve type is supported by the controller functionality
Protected function void  
Protected function void Functionality used by FOpenBracketAction and FCloseBracketAction to broadcast their equivalent notifies without actually opening a bracket.
Public function void Broadcast a EAnimDataModelNotifyType::Populated notify.
Public function UFunction BlueprintCallable, Category void

OpenBracket ( const FText& InTitle,
bool bShouldTransact
)

 Opens an interaction bracket, used for combining a set of controller actions.
Public function void Copies any animation relevant data from an already existing IAnimationDataModel object
Public function UFunction BlueprintCallable, Category int32

RemoveAllAttributes ( bool bShouldTransact
)

 Removes all stored attributes.
Public function UFunction BlueprintCallable, Category int32

RemoveAllAttributesForBone ( const FName& BoneName,
bool bShouldTransact
)

 Removes all attributes for the specified bone name, if any.
Public function UFunction BlueprintCallable, Category void

RemoveAllBoneTracks ( bool bShouldTransact
)

 Removes all existing Bone Animation tracks.
Public function UFunction BlueprintCallable, Category void

RemoveAllCurvesOfType ( ERawCurveTrackTypes SupportedCurveType,
bool bShouldTransact
)

 Removes all the curves of the provided type.
Public function UFunction BlueprintCallable, Category bool

RemoveAttribute ( const FAnimationAttributeIdentifier& AttributeIdentifier,
bool bShouldTransact
)

 Removes an attribute, if found, with the provided information.
Public function UFunction BlueprintCallable, Category bool

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

 Remove a single key from the attribute with provided identifier.
Public function UFunction BlueprintCallable, Category bool

RemoveBoneTrack ( FName BoneName,
bool bShouldTransact
)

 Removes an existing bone animation track with the provided name.
Public function bool

RemoveBoneTracksMissingFromSkeleton ( const USkeleton* Skeleton,
bool bShouldTransact
)

 Removes any bone track for which the name was not found in the provided skeleton.
Public function UFunction BlueprintCallable, Category bool

RemoveCurve ( const FAnimationCurveIdentifier& CurveId,
bool bShouldTransact
)

 Remove the curve with provided identifier.
Public function UFunction BlueprintCallable, Category bool

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

 Remove a single key from the curve with provided identifier and name.
Public function UFunction BlueprintCallable, Category bool

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

 Removes a single key for the transform curve with provided identifier.
Public function UFunction BlueprintCallable, Category bool

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

 Renames the curve with provided identifier.
Protected function Const void

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

  
Protected function Const void

ReportError ( const FText& Message
)

  
Protected function Const void

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

  
Protected function Const void

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

  
Public function Static void

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

  
Public function Static void

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

  
Public function Static void

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

  
Public function Static void

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

  
Protected function Const void

ReportWarning ( const FText& Message
)

  
Protected function Const void

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

  
Public function 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 UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category void

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

 Sets the total play-able length in seconds and resizes curves.
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category bool

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

 Scales the curve with provided identifier.
Public function 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.
Public function 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.
Public function UFunction BlueprintCallable, Category 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.
Public function 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.
Public function bool

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

 Changes the attributes of the curve with provided identifier.
Public function UFunction BlueprintCallable, Category bool

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

 Changes the color of the curve with provided identifier.
Public function UFunction BlueprintCallable, Category bool

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

 Changes the comment of the curve with provided identifier.
Public function UFunction BlueprintCallable, Category bool

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

 Set an individual flag for the curve with provided identifier.
Public function UFunction BlueprintCallable, Category bool

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

 Replace the flags for the curve with provided identifier.
Public function UFunction BlueprintCallable, Category bool

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

 Sets a single key for the curve with provided identifier and name.
Public function UFunction BlueprintCallable, Category bool

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

 Replace the keys for the curve with provided identifier and name.
Public function UFunction BlueprintCallable, Category void

SetFrameRate ( FFrameRate FrameRate,
bool bShouldTransact
)

 Sets the frame rate according to which the bone animation is expected to be sampled.
Public function UFunction BlueprintCallable, Category void Sets the AnimDataModel instance this controller is supposed to be targeting
Public function UFunction BlueprintCallable, Category void

SetNumberOfFrames ( FFrameNumber NewLengthInFrames,
bool bShouldTransact
)

 Sets the total play-able length in seconds.
Public function UFunction BlueprintCallable, Category, Meta void

SetPlayLength ( float Length,
bool bShouldTransact
)

  
Public function UFunction BlueprintCallable, Category bool

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

 Sets a single key for the transform curve with provided identifier.
Public function UFunction BlueprintCallable, Category 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.
Public function bool

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

 Sets a single key for the attribute with provided identifier.
Public function bool

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

 Replace the keys for the attribute with provided identifier.
Public function void

UpdateAttributesFromSkeleton ( const USkeleton* Skeleton,
bool bShouldTransact
)

 Removes any bone attribute for which the name was not found in the provided skeleton.
Public function 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.
Public function 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.
Public function Virtual UFunction BlueprintCallable, Category, Meta 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.
Public function void

UpdateWithSkeleton ( USkeleton* TargetSkeleton,
bool bShouldTransact
)

 Updates/removes/remaps contained animation data according to the newly assigned skeleton
Protected function Const void Ensures that a valid model is currently targeted

Classes

  Type Name Description
Public struct FScopedBracket RAII helper to define a scoped-based bracket, opens and closes a controller bracket automatically  

Typedefs

Name Description
FBracket  
FTransaction  

Constants

Name Description
DefaultCurveFlags  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page