Choose your operating system:
Windows
macOS
Linux
| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Animation/AnimSequence.h |
Include |
#include "Animation/AnimSequence.h" |
class UAnimSequence : public UAnimSequenceBase
Name | Description | ||
---|---|---|---|
|
TEnumAsByte< en... |
AdditiveAnimType |
Additive animation type. |
|
TObjectPtr< cla... |
AssetImportData |
Importing data and options used for this mesh |
|
AttributeCurves |
||
|
AuthoredSyncMarkers |
Authored Sync markers |
|
|
bAllowFrameStripping |
Allow frame stripping to be performed on this animation if the platform requests it Can be disabled if animation has high frequency movements that are being lost. |
|
|
bBlockCompressionRequests |
||
|
uint32: 1 |
bDoNotOverrideCompression |
Do not attempt to override compression scheme when running CompressAnimations commandlet. |
|
bEnableRootMotion |
If this is on, it will allow extracting of root motion |
|
|
bForceRootLock |
Force Root Bone Lock even if Root Motion is not enabled |
|
|
TObjectPtr< cla... |
BoneCompressionSettings |
The bone compression settings used to compress bones in this sequence. |
|
bRootMotionSettingsCopiedFromMontage |
Have we copied root motion settings from an owning montage |
|
|
bUseNormalizedRootMotionScale |
If this is on, it will use a normalized scale value for the root motion extracted: FVector(1.0, 1.0, 1.0) |
|
|
bUseRawDataOnly |
Should we be always using our raw data (i.e is our compressed data stale) |
|
|
CompressCommandletVersion |
Saved version number with CompressAnimations commandlet. To help with doing it in multiple passes. |
|
|
CompressedData |
||
|
float |
CompressionErrorThresholdScale |
Set a scale for error threshold on compression. |
|
TObjectPtr< cla... |
CurveCompressionSettings |
The curve compression settings used to compress curves in this sequence. |
|
float |
ImportFileFramerate |
The DCC framerate of the imported file. UI information only, unit are Hz |
|
ImportResampleFramerate |
The resample framerate that was computed during import. UI information only, unit are Hz |
|
|
Interpolation |
This defines how values between keys are calculated |
|
|
MarkerDataUpdateCounter |
Track whether we have updated markers so cached data can be updated. |
|
|
NumberOfSampledFrames |
||
|
NumberOfSampledKeys |
||
|
RawDataGuid |
Update this if the contents of RawAnimationData changes;. |
|
|
RefFrameIndex |
Additve reference frame if RefPoseType == AnimFrame |
|
|
TObjectPtr< cla... |
RefPoseSeq |
Additive reference animation if it's relevant - i.e. AnimScaled or AnimFrame |
|
TEnumAsByte< en... |
RefPoseType |
Additive refrerence pose type. Refer above enum type |
|
ResampledAnimationTrackData |
||
|
RetargetSource |
Base pose to use when retargeting |
|
|
TSoftObjectPtr<... |
RetargetSourceAsset |
If RetargetSource is set to Default (None), this is asset for the base pose to use when retargeting. |
|
RetargetSourceAssetReferencePose |
When using RetargetSourceAsset, use the post stored here |
|
|
TEnumAsByte< ER... |
RootMotionRootLock |
Root Bone will be locked to that position when extracting root motion. |
|
TargetFrameRate |
||
|
UniqueMarkerNames |
List of Unique marker names in this animation sequence |
Name | Description | |
---|---|---|
|
UAnimSequence ( |
Name | Description | ||
---|---|---|---|
|
AddKeyToSequence ( |
Add Key to Transform Curves |
|
|
AddReferencedObjects ( |
||
|
ApplyCompressedData |
||
|
ApplyCompressedData |
||
|
BakeOutAdditiveIntoRawData ( |
Bakes out the additive version of this animation into the raw data. |
|
|
BakeOutVirtualBoneTracks ( |
Bakes out track data for the skeletons virtual bones into the raw data. |
|
|
BakeTrackCurvesToRawAnimationTracks ( |
||
|
CanBakeAdditive() |
Is this animation valid for baking into additive. |
|
|
CreateAnimation ( |
Create Animation Sequence from the Mesh Component's current bone transform |
|
|
CreateAnimation ( |
Create Animation Sequence from the given animation |
|
|
CreateAnimation ( |
Create Animation Sequence from Reference Pose of the Mesh |
|
|
DeleteBoneAnimationData() |
||
|
DeleteDeprecatedRawAnimationData() |
||
|
DeleteNotifyTrackData() |
||
|
DoesNeedRecompress() |
Return true if compressed data is out of date / missing and so animation needs to use raw data |
|
|
DoesSequenceContainZeroScale() |
Test whether at any point we will scale a bone to 0 (needed for validating additive anims) |
|
|
EnsureValidRawDataGuid() |
||
|
EvaluateAttributes ( |
||
|
ExtractRootMotion ( |
Extract Root Motion transform from the animation. |
|
|
ExtractRootMotionFromRange ( |
Extract Root Motion transform from a contiguous position range (no looping) |
|
|
ExtractRootTrackTransform ( |
Extract the transform from the root track for the given animation position. |
|
|
uint8 * |
FindSyncMarkerPropertyData ( |
Get a pointer to the data for a given Anim Notify. |
|
FlagDependentAnimationsAsRawDataOnly() |
Helper function to allow us to notify animations that depend on us that they need to update. |
|
|
GenerateGuidFromRawData() |
Generate a GUID from a hash of our own raw data. |
|
|
GetApproxBoneCompressedSize() |
||
|
GetApproxCompressedSize() |
||
|
GetApproxRawSize() |
||
|
GetBonePose ( |
Get Bone Transform of the Time given, relative to Parent for all RequiredBones This returns different transform based on additive or not. |
|
|
GetBoneTransform ( |
Get Bone Transform of the Time given, relative to Parent for the Track Given |
|
|
GetBoneTransform ( |
Get Bone Transform of the Time given, relative to Parent for the Track Given |
|
|
const TArray... |
GetCompressedCurveNames() |
|
|
const TArray... |
GetCompressedTrackToSkeletonMapTable() |
|
|
float |
GetCurrentTimeFromMarkers ( |
Advancing based on markers. |
|
GetDDCCacheKeySuffix ( |
||
|
GetRawDataGuid() |
Return this animations guid for the raw data. |
|
|
const TArray... |
GetResampledTrackData() |
|
|
GetSkeletonIndexFromCompressedDataTrackIndex ( |
Get Skeleton Bone Index from Track Index for compressed data |
|
|
GetUncompressedRawSize() |
||
|
IsCompressedDataValid() |
||
|
IsCurveCompressedDataValid() |
||
|
MoveAttributesToModel() |
||
|
OnlyUseRawData() |
Should we be always using our raw data (i.e is our compressed data stale) |
|
|
RecompressAnimationData() |
||
|
RefreshSyncMarkerDataFromAuthored() |
Refresh sync marker data |
|
|
RequestAnimCompression ( |
||
|
RequestAsyncAnimRecompression ( |
||
|
RequestSyncAnimRecompression ( |
||
|
ResampleAnimationTrackData() |
||
|
ResetAnimation() |
Resets Bone Animation, Curve data and Notify tracks |
|
|
SetUseRawDataOnly ( |
||
|
ShouldPerformStripping |
Get compressed data for this UAnimSequence. May be built directly or pulled from DDC. |
|
|
SortSyncMarkers() |
Sort the sync markers array by time, earliest first. |
|
|
SynchronousAnimatedBoneAttributesCompression() |
||
|
TestEvalauteAnimation() |
Performs multiple evaluations of the animation as a test of compressed data validatity. |
|
|
UpdateDependentStreamingAnimations() |
Helper function to allow us to update streaming animations that depend on us with our data when we are updated. |
|
|
UseRawDataForPoseExtraction ( |
||
|
ValidateCurrentPosition ( |
Take a set of marker positions and validates them against a requested start position, updating them as desired |
|
|
WaitOnExistingCompression ( |
Name | Description | ||
---|---|---|---|
|
AdvanceMarkerPhaseAsFollower ( |
||
|
AdvanceMarkerPhaseAsLeader ( |
||
|
EnableRootMotionSettingFromMontage ( |
To support anim sequence base to all montages |
|
|
EvaluateCurveData ( |
Evaluate curve data to Instance at the time of CurrentTime |
|
|
float |
EvaluateCurveData ( |
Evaluate curve data to Instance at the time of CurrentTime |
|
EAdditiveAni... |
GetAdditiveAnimType() |
Default implementation, no additive |
|
UAnimSequenc... |
GetAdditiveBasePose() |
Ideally this would be animsequcnebase, but we might have some issue with that. For now, just allow AnimSequence |
|
GetAnimationPose ( |
Begin Transform related functions. |
|
|
float |
GetFirstMatchingPosFromMarkerSyncPos ( |
|
|
GetMarkerIndicesForPosition ( |
||
|
GetMarkerIndicesForTime ( |
||
|
FMarkerSyncA... |
GetMarkerSyncPositionFromMarkerIndicies ( |
|
|
float |
GetNextMatchingPosFromMarkerSyncPos ( |
|
|
GetNumberOfSampledKeys() |
Return the total number of keys sampled for this animation, including the T0 key |
|
|
float |
GetPrevMatchingPosFromMarkerSyncPos ( |
|
|
const FFrame... |
GetSamplingFrameRate() |
Return rate at which the animation is sampled |
|
HandleAssetPlayerTickedInternal ( |
||
|
HasCurveData ( |
||
|
HasRootMotion() |
||
|
IsValidToPlay() |
Add validation check to see if it's being ready to play or not |
|
|
OnModelModified ( |
Callback registered to UAnimDatModel::GetModifiedEvent for the embedded object |
|
|
PopulateModel() |
Populates the UAnimDataModel object according to any pre-existing data. |
|
|
RefreshCacheData() |
Update cache data (notify tracks, sync markers) |
Name | Description | ||
---|---|---|---|
|
GetAllAnimationSequencesReferred ( |
Retrieve all animations that are used by this asset |
|
|
GetMarkerUpdateCounter() |
||
|
GetUniqueMarkerNames() |
Return a list of unique marker names for blending compatibility |
|
|
IsValidAdditive() |
Return true if this is valid additive animation false otherwise |
|
|
ReplaceReferredAnimations ( |
Replace this assets references to other animations based on ReplacementMap |
Name | Description | ||
---|---|---|---|
|
BeginDestroy() |
Called before destroying the object. |
|
|
GetAssetRegistryTags ( |
Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects |
|
|
GetPreloadDependencies |
Called during cooking. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
PreSave ( |
Presave function. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name | Description | ||
---|---|---|---|
|
AnimationTrackNames |
Animation track names has been deprecated see FBoneAnimationTrack::Name |
|
|
bNeedsRebake |
bNeedsRebake has been deprecated, transform curves are now baked during compression |
|
|
NumberOfKeys |
NumberOfKeys is deprecated see UAnimDataModel::GetNumberOfKeys for the number of source data keys, or GetNumberOfSampledKeys for the target keys |
|
|
NumFrames |
NumFrames is deprecated see UAnimDataModel::GetNumberOfFrames for the number of source data frames, or GetNumberOfSampledKeys for the target keys |
|
|
TArray< struct ... |
RawAnimationData |
RawAnimationData has been deprecated see FBoneAnimationTrack::InternalTrackData |
|
SamplingFrameRate |
SamplingFrameRate is deprecated see UAnimDataModel::GetFrameRate for the source frame rate, or GetSamplingFrameRate for the target frame rate instead |
|
|
SourceFilePath_DEPRECATED |
Path to the resource used to construct this skeletal mesh |
|
|
SourceFileTimestamp_DEPRECATED |
Date/Time-stamp of the file from the last import |
|
|
TArray< struct ... |
SourceRawAnimationData_DEPRECATED |
Source RawAnimationData. |
|
TArray< struct ... |
TrackToSkeletonMapTable |
TrackToSkeletonMapTable has been deprecated see FBoneAnimationTrack::BoneTreeIndex |
Name | Description | ||
---|---|---|---|
|
AddBoneFloatCustomAttribute |
AddBoneCustomAttribute has been deprecated see UAnimDataController::AddAttribute |
|
|
AddBoneIntegerCustomAttribute |
AddBoneCustomAttribute has been deprecated see UAnimDataController::AddAttribute |
|
|
AddBoneStringCustomAttribute |
AddBoneStringCustomAttribute has been deprecated see UAnimDataController::AddAttribute |
|
|
AddLoopingInterpolation() |
AddLoopingInterpolation has been deprecated see FAnimSequenceHelpers::AnimationData::AddLoopingInterpolation |
|
|
AddNewRawTrack ( |
AddNewRawTrack has been deprecated see UAnimDataController::AddBoneTrack and UAnimDataController::SetBoneTrackKeys |
|
|
BakeTrackCurvesToRawAnimation() |
BakeTrackCurvesToRawAnimation has been deprecated, transform curves are now baked during compression |
|
|
CleanAnimSequenceForImport() |
CleanAnimSequenceForImport has been deprecated see UAnimDataController:ResetModel |
|
|
ClearBakedTransformData() |
ClearBakedTransformData has been deprecated, transform curves are now baked during compression |
|
|
ClearCompressedBoneData() |
ClearCompressedBoneData will be marked protected |
|
|
ClearCompressedCurveData() |
ClearCompressedCurveData will be marked protected |
|
|
CompressRawAnimData ( |
CompressRawAnimData has been deprecated, reduction of Raw Animation data now happens during compression instead |
|
|
CompressRawAnimData() |
CompressRawAnimData has been deprecated, reduction of Raw Animation data now happens during compression instead |
|
|
CopyNotifies ( |
CopyNotifies has been moved, see UAnimSequenceHelpers::CopyNotifies |
|
|
CropRawAnimData ( |
InsertFramesToRawAnimData has been deprecated see FAnimSequenceHelpers::AnimationData::Trim |
|
|
DoesContainTransformCurves() |
DoesContainTransformCurves has been deprecated see UAnimDataModel::GetNumberOfTransformCurves |
|
|
DoesNeedRebake() |
DoesNeedRebake has been deprecated, transform curves are now baked during compression |
|
|
ExtractBoneTransform ( |
ExtractBoneTransform has been deprecated see FAnimationUtils::ExtractTransformFromTrack |
|
|
ExtractBoneTransform ( |
ExtractBoneTransform has been deprecated see FAnimationUtils::ExtractTransformFromTrack |
|
|
ExtractBoneTransform ( |
ExtractBoneTransform has been deprecated see FAnimSequenceHelpers::ExtractBoneTransform |
|
|
FlipRotationWForNonRoot ( |
FlipRotationWForNonRoot has been deprecated, use UAnimDataModel::GetBoneAnimationTracks and UAnimDataController::SetBoneTrackKeys instead |
|
|
GetAdditiveBasePose ( |
Use other GetAdditiveBasePose signature |
|
|
GetAdditiveBasePose ( |
Use other GetAdditiveBasePose signature |
|
|
const TArray... |
GetAnimationTrackNames() |
GetAnimationTrackNames has been deprecated see FBoneAnimationTrack::Name |
|
GetBonePose ( |
Use other GetBonePose signature |
|
|
GetBonePose_Additive ( |
Use other GetBonePose_Additive signature |
|
|
GetBonePose_Additive ( |
Use other GetBonePose_Additive signature |
|
|
GetCustomAttributes ( |
GetCustomAttributesForBone has been deprecated use EvaluateAttribute instead |
|
|
GetCustomAttributesForBone ( |
GetCustomAttributesForBone has been deprecated see UAnimDataModel::GetAttributesForBone |
|
|
float |
GetFrameRate() |
GetFrameRate is deprecated see UAnimDataModel::GetFrameRate for the source frame rate, or GetSamplingFrameRate for the target frame rate instead |
|
FMarkerSyncA... |
GetMarkerSyncPositionfromMarkerIndicies |
Use other GetMarkerSyncPositionfromMarkerIndicies signature |
|
const TArray... |
GetRawAnimationData() |
GetRawAnimationTrack has been deprecated see UAnimDataModel::GetBoneAnimationTracks |
|
FRawAnimSequ... |
GetRawAnimationTrack ( |
GetRawAnimationTrack, and non-const access to Raw Animation Data has been deprecated see UAnimDataModel::GetBoneTrackByIndex |
|
const FRawAn... |
GetRawAnimationTrack ( |
GetRawAnimationTrack has been deprecated see UAnimDataModel::GetBoneTrackByIndex |
|
GetRawNumberOfFrames() |
GetRawNumberOfFrames is deprecated see UAnimDataModel::GetNumberOfKeys for the source keys, or GetNumberOfSampledKeys for resampled keys |
|
|
const TArray... |
GetRawTrackToSkeletonMapTable() |
GetRawTrackToSkeletonMapTable has been deprecated see FBoneAnimationTrack::BoneTreeIndex |
|
GetSkeletonIndexFromRawDataTrackIndex ( |
DoesContainTransformCurves has been deprecated see FBoneAnimationTrack::BoneTreeIndex |
|
|
HasBakedTransformCurves() |
HasBakedTransformCurves has been deprecated, transform curves are now baked during compression |
|
|
HasSourceRawData() |
SourceRawAnimationData has been deprecated |
|
|
InsertFramesToRawAnimData |
InsertFramesToRawAnimData has been deprecated see FAnimSequenceHelpers::AnimationData::DuplicateKeys |
|
|
MarkRawDataAsModified ( |
MarkRawDataAsModified has been deprecated, any (Raw Data) modification should be applied using the UAnimDataController API instead. This will handle updating the GUID instead. |
|
|
OnRawDataChanged() |
OnRawDataChanged has been deprecated, any Raw Animation Data modifications should go through UAnimDataController |
|
|
PostProcessSequence ( |
PostProcessSequence has been deprecated, any Raw Animation Data modifications should go through UAnimDataController |
|
|
PreSave ( |
Use version that takes FObjectPreSaveContext instead. |
|
|
RecycleAnimSequence() |
RecycleAnimSequence has been deprecated use ResetAnimation instead |
|
|
RemoveAllCustomAttributes() |
RemoveAllCustomAttributes has been deprecated see UAnimDataController::RemoveAllAttributes |
|
|
RemoveAllCustomAttributesForBone ( |
RemoveAllCustomAttributesForBone has been deprecated see UAnimDataController::RemoveAllAttributesForBone |
|
|
RemoveAllTracks() |
RemoveAllTracks has been deprecated see UAnimDataController::RemoveAllBoneTracks |
|
|
RemoveCustomAttribute |
RemoveCustomAttribute has been deprecated see UAnimDataController::RemoveAttribute |
|
|
ResizeSequence |
ResizeSequence has been deprecated see UAnimDataController::Resize |
|
|
RestoreSourceData() |
RestoreSourceData has been deprecated, transform curves are now baked during compression |
|
|
SerializeCompressedData |
SerializeCompressedData will be marked protected |
|
|
SetNumberOfSampledKeys ( |
SetNumberOfSampledKeys has been deprecated see UAnimDataController::SetFrameRate |
|
|
SetRawNumberOfFrame ( |
SetRawNumberOfFrame has been deprecated see UAnimDataController::SetFrameRate |
|
|
UpdateCompressedCurveName ( |
UpdateCompressedCurveName will be marked protected, updating compressed curve names is now handled by EAnimDataModelNotifyType::CurveRenamed |