1. Epic GamesDeveloper
  3. UAnimStreamable

UAnimStreamable

API > API/Runtime > API/Runtime/Engine

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

Syntax

UCLASS (Config=Engine, HideCategories=UObject, MinimalAPI, BlueprintType)  
class UAnimStreamable : public UAnimSequenceBase

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimStreamable ( const FObjectInitializer& ObjectInitializer
)

   Animation/AnimStreamable.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnimationTrackNames TArray< FName > This is name of RawAnimationData tracks for editoronly - if we lose skeleton, we'll need relink them Animation/AnimStreamable.h  
bEnableRootMotion bool If this is on, it will allow extracting of root motion Animation/AnimStreamable.h
  • EditAnywhere
  • AssetRegistrySearchable
  • Category=RootMotion
  • Meta=(DisplayName="EnableRootMotion")
bForceRootLock bool Force Root Bone Lock even if Root Motion is not enabled Animation/AnimStreamable.h
  • EditAnywhere
  • Category=RootMotion
BoneCompressionSettings TObjectPtr< class UAnimBoneCompressionSettings > The bone compression settings used to compress bones in this sequence. Animation/AnimStreamable.h
  • Category=Compression
  • EditAnywhere
bUseNormalizedRootMotionScale bool If this is on, it will use a normalized scale value for the root motion extracted: FVector(1.0, 1.0, 1.0) Animation/AnimStreamable.h
  • EditAnywhere
  • AssetRegistrySearchable
  • Category=RootMotion
  • Meta=(DisplayName="Use Normalized Root Motion Scale")
CurveCompressionSettings TObjectPtr< class UAnimCurveCompressionSettings > The curve compression settings used to compress curves in this sequence. Animation/AnimStreamable.h
  • Category=Compression
  • EditAnywhere
Interpolation EAnimInterpolationType This defines how values between keys are calculated Animation/AnimStreamable.h
  • EditAnywhere
  • AssetRegistrySearchable
  • Category=Animation
NumberOfKeys int32 The number of keys expected within the individual animation tracks. Animation/AnimStreamable.h
  • AssetRegistrySearchable
NumFrames int32 Number of raw frames in this sequence (not used by engine - just for informational purposes). Animation/AnimStreamable.h  
RawAnimationData TArray< struct FRawAnimSequenceTrack > Raw uncompressed keyframe data. Animation/AnimStreamable.h  
RawDataGuid FGuid   Animation/AnimStreamable.h  
RetargetSource FName Base pose to use when retargeting Animation/AnimStreamable.h
  • EditAnywhere
  • AssetRegistrySearchable
  • Category=Animation
RootMotionRootLock TEnumAsByte< ERootMotionRootLock::Type > Root Bone will be locked to that position when extracting root motion. Animation/AnimStreamable.h
  • EditAnywhere
  • Category=RootMotion
RunningAnimPlatformData FStreamableAnimPlatformData *   Animation/AnimStreamable.h  
SamplingFrameRate FFrameRate   Animation/AnimStreamable.h  
SourceSequence TObjectPtr< const UAnimSequence > Sequence the streamable was created from (used for reflecting changes to the source in editor) Animation/AnimStreamable.h  
StreamableAnimPlatformData TMap< const ITargetPlatform *, FStreamableAnimPlatformData * > Editor can have multiple platforms loaded at once. Animation/AnimStreamable.h  
TrackToSkeletonMapTable TArray< struct FTrackToSkeletonMap > 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). Animation/AnimStreamable.h  
VariableFrameStrippingSettings TObjectPtr< class UVariableFrameStrippingSettings > The settings used to control whether or not to use variable frame stripping and its amount Animation/AnimStreamable.h
  • Category=Compression
  • EditAnywhere

Protected

Name Type Remarks Include Path Unreal Specifiers
bUseRawDataOnly bool   Animation/AnimStreamable.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetChunkSizeSeconds ( const ITargetPlatform* Platform
) const

   Animation/AnimStreamable.h  
  Animation/AnimStreamable.h  
  Animation/AnimStreamable.h  

FStreamableAnimPlatformData & GetStreamingAnimPlatformData ( const ITargetPlatform* Platform
)

   Animation/AnimStreamable.h  

bool HasRunningPlatformData()

   Animation/AnimStreamable.h  

void InitFrom ( const UAnimSequence* InSourceSequence
)

   Animation/AnimStreamable.h  

Overridden from UAnimSequenceBase

Name Remarks Include Path Unreal Specifiers

virtual void GetAnimationPose ( FAnimationPoseData& OutPoseData,
const FAnimExtractContext& ExtractionContext
) const

 Get Bone Transform of the Time given, relative to Parent for all RequiredBones This returns different transform based on additive or not. Animation/AnimStreamable.h  

virtual int32 GetNumberOfSampledKeys()

 Return the total number of keys sampled for this animation, including the T0 key Animation/AnimStreamable.h  

virtual void HandleAssetPlayerTickedInternal ( FAnimAssetTickContext& Context,
const float PreviousTime,
const float MoveDelta,
const FAnimTickRecord& Instance,
FAnimNotifyQueue& NotifyQueue
) const

   Animation/AnimStreamable.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void FinishDestroy()

   Animation/AnimStreamable.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   Animation/AnimStreamable.h  

virtual void PostLoad()

   Animation/AnimStreamable.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   Animation/AnimStreamable.h  

virtual void Serialize ( FArchive& Ar
)

   Animation/AnimStreamable.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page