1. Epic GamesDeveloper
  3. UAnimDataController

UAnimDataController

API > API/Developer > API/Developer/AnimationDataController

Inheritance Hierarchy

References

   
Module AnimationDataController
Header /Engine/Source/Developer/AnimationDataController/Public/AnimDataController.h
Include #include "AnimDataController.h"

Syntax

class UAnimDataController :  
    public UObject,  
    public IAnimationDataController

Constructors

  Type Name Description
Public function    

Overridden from IAnimationDataController

  Type Name Description
Public function Virtual bool

AddAttribute ( const FAnimationAttributeIdentifier& AttributeIdentifier,
bool bShouldTransact
)

 Adds a new attribute with the provided information.
Public function Virtual bool

AddBoneCurve ( FName BoneName,
bool bShouldTransact
)

  
Public function Virtual bool

AddCurve ( const FAnimationCurveIdentifier& CurveId,
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& AttributeIdentifier,
const FAnimationAttributeIdentifier& NewAttributeIdentifier,
bool bShouldTransact
)

 Duplicated the attribute (curve) with the identifier.
Public function Virtual bool

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

 Duplicated the curve with the identifier.
Public function Virtual Const const IAnimationDataModel *const  
Public function Virtual Const TScriptInterface< IAnimationDataModel >  
Public function Virtual void Initializes model data structures
Protected function Virtual void  
Protected function Virtual void Functionality used by FOpenBracketAction and FCloseBracketAction to broadcast their equivalent notifies without actually opening a bracket.
Public function Virtual void 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 void Copies any animation relevant data from an already existing IAnimationDataModel object
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 SupportedCurveType,
bool bShouldTransact
)

 Removes all the curves of the provided type.
Public function Virtual bool

RemoveAttribute ( const FAnimationAttributeIdentifier& AttributeIdentifier,
bool bShouldTransact
)

 Removes an attribute, if found, with the provided information.
Public function Virtual bool

RemoveAttributeKey ( const FAnimationAttributeIdentifier& AttributeIdentifier,
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& CurveId,
bool bShouldTransact
)

 Remove the curve with provided identifier.
Public function Virtual bool

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

 Remove a single key from the curve with provided identifier and name.
Public function Virtual bool

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

 Removes a single key for the transform curve with provided identifier.
Public function Virtual bool

RenameCurve ( const FAnimationCurveIdentifier& CurveToRenameId,
const FAnimationCurveIdentifier& NewCurveId,
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

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

 Sets the total play-able length in seconds and resizes curves.
Public function Virtual void

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

  
Public function Virtual bool

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

 Scales the curve with provided identifier.
Public function Virtual 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 Virtual 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 Virtual 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 Virtual 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 Virtual bool

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

 Changes the attributes of the curve with provided identifier.
Public function Virtual bool

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

 Changes the color of the curve with provided identifier.
Public function Virtual bool

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

 Set an individual flag for the curve with provided identifier.
Public function Virtual bool

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

 Replace the flags for the curve with provided identifier.
Public function Virtual bool

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

 Sets a single key for the curve with provided identifier and name.
Public function Virtual bool

SetCurveKeys ( const FAnimationCurveIdentifier& CurveId,
const TArray< FRichCurveKey >& CurveKeys,
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 Begin IAnimationDataController overrides
Public function Virtual void

SetNumberOfFrames ( FFrameNumber NewLengthInFrames,
bool bShouldTransact
)

 Sets the total play-able length in seconds.
Public function Virtual 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 Virtual 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 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 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 Virtual 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 void

UpdateWithSkeleton ( USkeleton* TargetSkeleton,
bool bShouldTransact
)

 Updates/removes/remaps contained animation data according to the newly assigned skeleton

Deprecated Functions

  Type Name Description
Public function Virtual int32

InsertBoneTrack ( FName BoneName,
int32 DesiredIndex,
bool bShouldTransact
)

 InsertBoneTrack has been deprecated, use AddBoneTrack instead
Public function Virtual void

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

 Resize with length in seconds in deprecated use ResizeInFrames using FFrameNumber instead
Public function Virtual void

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

 ResizePlayLength with length in seconds in deprecated use ResizeNumberOfFrames using FFrameNumber instead
Public function Virtual void

SetPlayLength ( float Length,
bool bShouldTransact
)

 SetPlayLength with length in seconds in deprecated use SetNumberOfFrames using FFrameNumber instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page