Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Animation
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UAnimationAsset
- UAnimSequenceBase
- UAnimStreamable
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Animation/AnimStreamable.h |
| Include | #include "Animation/AnimStreamable.h" |
Syntax
class UAnimStreamable : public UAnimSequenceBase
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< FName > | AnimationTrackNames | This is name of RawAnimationData tracks for editoronly - if we lose skeleton, we'll need relink them | |
| bool | bEnableRootMotion | If this is on, it will allow extracting of root motion | |
| bool | bForceRootLock | Force Root Bone Lock even if Root Motion is not enabled | |
| TObjectPtr< class UAnimBoneCompressionSettings > | BoneCompressionSettings | The bone compression settings used to compress bones in this sequence. | |
| bool | bUseNormalizedRootMotionScale | If this is on, it will use a normalized scale value for the root motion extracted: FVector(1.0, 1.0, 1.0) | |
| TObjectPtr< class UAnimCurveCompressionSettings > | CurveCompressionSettings | The curve compression settings used to compress curves in this sequence. | |
| EAnimInterpolationType | Interpolation | This defines how values between keys are calculated | |
| int32 | NumberOfKeys | The number of keys expected within the individual animation tracks. | |
| TArray< struct FRawAnimSequenceTrack > | RawAnimationData | Raw uncompressed keyframe data. | |
| FGuid | RawDataGuid | ||
| FName | RetargetSource | Base pose to use when retargeting | |
| TEnumAsByte< ERootMotionRootLock::Type > | RootMotionRootLock | Root Bone will be locked to that position when extracting root motion. | |
| FStreamableAnimPlatformData * | RunningAnimPlatformData | ||
| FFrameRate | SamplingFrameRate | ||
| TObjectPtr< const UAnimSequence > | SourceSequence | Sequence the streamable was created from (used for reflecting changes to the source in editor) | |
| TMap< const ITargetPlatform *, FStreamableAnimPlatformData * > | StreamableAnimPlatformData | Editor can have multiple platforms loaded at once. | |
| TArray< struct FTrackToSkeletonMap > | TrackToSkeletonMapTable | In the future, maybe keeping RawAnimSequenceTrack + TrackMap as one would be good idea to avoid inconsistent array size TrackToSkeletonMapTable(i) should contains track mapping data for RawAnimationData(i). | |
| TObjectPtr< class UVariableFrameStrippingSettings > | VariableFrameStrippingSettings | The settings used to control whether or not to use variable frame stripping and its amount |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UAnimStreamable
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| float | GetChunkSizeSeconds
(
const ITargetPlatform* Platform |
||
| FStreamableAnimPlatformData & | |||
| const FStreamableAnimPlatformData & | |||
| FStreamableAnimPlatformData & | GetStreamingAnimPlatformData
(
const ITargetPlatform* Platform |
||
| bool | |||
| void | InitFrom
(
const UAnimSequence* InSourceSequence |
Overridden from UAnimSequenceBase
| Type | Name | Description | |
|---|---|---|---|
| void | GetAnimationPose
(
FAnimationPoseData& OutAnimationPoseData, |
||
| int32 | Return the total number of keys sampled for this animation, including the T0 key | ||
| void | HandleAssetPlayerTickedInternal
(
FAnimAssetTickContext& Context, |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | Called to finish destroying the object. | ||
| void | GetResourceSizeEx
(
FResourceSizeEx& CumulativeResourceSize |
Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific). | |
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. | |
| void | PreSave
(
FObjectPreSaveContext SaveContext |
Presave function. | |
| void | Handles reading, writing, and reference collecting using FArchive. |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
| int32 | NumFrames | Num Frames is deprecated use NumberOfKeys instead |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid | PreSave
(
const ITargetPlatform* TargetPlatform |
Use version that takes FObjectPreSaveContext instead. |