1. Epic GamesDeveloper
  3. UBlendSpace

UBlendSpace

Allows multiple animations to be blended between based on input parameters

API > API/Runtime > API/Runtime/Engine

Allows multiple animations to be blended between based on input parameters

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

Syntax

UCLASS (Config=Engine, HideCategories=Object, MinimalAPI, BlueprintType)  
class UBlendSpace :  
    public UAnimationAsset ,  
    public IInterpolationIndexProvider

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UBlendSpace ( const FObjectInitializer& ObjectInitializer
)

   Animation/BlendSpace.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnalysisProperties TObjectPtr< UAnalysisProperties > Analysis properties for each axis. Animation/BlendSpace.h
  • EditAnywhere
  • Category=AnalysisProperties
AnimLength float This is the maximum length of any sample in the blendspace. Animation/BlendSpace.h  
bAllowMarkerBasedSync bool Whether to allow marker based sync between the samples (it won't force sync if the markers don't exist) Animation/BlendSpace.h
  • EditAnywhere
  • Category=Animation
bAllowMeshSpaceBlending bool If set then blending is performed in mesh space if there are per-bone sample smoothing overrides. Animation/BlendSpace.h
  • EditAnywhere
  • Category=SampleSmoothing
bContainsRotationOffsetMeshSpaceSamples bool Indicates whether any samples have the flag to apply rotation offsets in mesh space Animation/BlendSpace.h  
bInterpolateUsingGrid bool If true then interpolation is done via a grid at runtime. Animation/BlendSpace.h
  • EditAnywhere
  • Category=InputInterpolation
  • Meta=(DisplayName="Use Grid")
bLoop bool The default looping behavior of this blend space. Asset players can override this Animation/BlendSpace.h
  • EditAnywhere
  • Category=Animation
bShouldMatchSyncPhases bool If true, all follower samples will pass the same amount of markers the leader sample has passed to match its sync phase. Animation/BlendSpace.h
  • EditAnywhere
  • Category=Animation
bTargetWeightInterpolationEaseInOut bool If set then this eases in/out the sample weight adjustments, using the speed to determine how much smoothing to apply. Animation/BlendSpace.h
  • EditAnywhere
  • Category=SampleSmoothing
  • Meta=(DisplayName="Smoothing")
CachedAnalysisProperties TObjectPtr< UCachedAnalysisProperties > Cached properties used to initialize properties when newly created. Animation/BlendSpace.h  
InterpolationParam FInterpolationParameter Input Smoothing parameters for each input axis Animation/BlendSpace.h
  • EditAnywhere
  • Category=InputInterpolation
NotifyTriggerMode TEnumAsByte< ENotifyTriggerMode::Type > The current mode used by the BlendSpace to decide which animation notifies to fire. Animation/BlendSpace.h
  • EditAnywhere
  • Category=AnimationNotifies
PreferredTriangulationDirection EPreferredTriangulationDirection Preferred edge direction when the triangulation has to make an arbitrary choice Animation/BlendSpace.h
  • EditAnywhere
  • Category=InputInterpolation
PreviewBasePose TObjectPtr< UAnimSequence > Preview Base pose for additive BlendSpace Animation/BlendSpace.h
  • EditAnywhere
  • Category=AdditiveSettings
TargetWeightInterpolationSpeedPerSec float If greater than zero, this is the speed at which the sample weights are allowed to change. Animation/BlendSpace.h
  • EditAnywhere
  • Category=SampleSmoothing
  • Meta=(DisplayName="Weight Speed", ClampMin="0")

Protected

Name Type Remarks Include Path Unreal Specifiers
MarkerDataUpdateCounter int32 Track whether we have updated markers so cached data can be updated. Animation/BlendSpace.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddSample ( const FVector& SampleValue
)

 Add samples Animation/BlendSpace.h  

int32 AddSample ( UAnimSequence* AnimationSequence,
const FVector& SampleValue
)

   Animation/BlendSpace.h  

float ComputeAxisScaleFactor ( const FVector& BlendSpacePosition,
const FVector& FilteredBlendInput
) const

 Computes the axis scale factor. See AxisToScaleAnimation. Animation/BlendSpace.h  

bool DeleteSample ( const int32 BlendSampleIndex
)

 Delete samples Animation/BlendSpace.h  

bool DoesAnimationMatchExistingSamples ( const UAnimSequence* AnimationSequence
) const

 Check if the blend spaces contains samples whos additive type match that of the animation sequence Animation/BlendSpace.h  

bool EditSampleValue ( const int32 BlendSampleIndex,
const FVector& NewValue
)

 Edit samples Animation/BlendSpace.h  

void ExpandRangeForSample ( const FVector& SampleValue
)

   Animation/BlendSpace.h  

FVector FilterInput ( FBlendFilter* Filter,
const FVector& BlendInput,
float DeltaTime
) const

 Interpolate BlendInput based on Filter data Animation/BlendSpace.h  

void ForEachImmutableSample ( const TFunctionRef< void(const FBlendSample&)> Func
) const

 Allows the user to iterate through all the data samples available in the blend space. Animation/BlendSpace.h  

float GetAnimationLengthFromSampleData ( const TArray< FBlendSampleData >& SampleDataList
) const

 Utility function to calculate animation length from sample data list Animation/BlendSpace.h  

void GetAnimationPose ( TArray< FBlendSampleData >& BlendSampleDataCache,
TArrayView< FPoseLink > InPoseLinks,
const FAnimExtractContext& ExtractionContext,
FPoseContext& Output
) const

   Animation/BlendSpace.h  

void GetAnimationPose ( TArray< FBlendSampleData >& BlendSampleDataCache,
const FAnimExtractContext& ExtractionContext,
FAnimationPoseData& OutAnimationPoseData
) const

   Animation/BlendSpace.h  

void GetAnimationPose ( TArray< FBlendSampleData >& BlendSampleDataCache,
TArrayView< FPoseLink > InPoseLinks,
FPoseContext& Output
) const

   Animation/BlendSpace.h  

void GetAnimationPose ( TArray< FBlendSampleData >& BlendSampleDataCache,
FCompactPose& OutPose,
FBlendedCurve& OutCurve
) const

 BlendSpace Get Animation Pose function Animation/BlendSpace.h  

void GetAnimationPose ( TArray< FBlendSampleData >& BlendSampleDataCache,
FAnimationPoseData& OutAnimationPoseData
) const

   Animation/BlendSpace.h  

const FBlendParameter & GetBlendParameter ( const int32 Index
) const

 Accessor for blend parameter Animation/BlendSpace.h  

const FBlendSample & GetBlendSample ( const int32 SampleIndex
) const

 Returns the Blend Sample at the given index, will assert on invalid indices Animation/BlendSpace.h  

const TArray< struct FBlendSample > & GetBlendSamples()

 Get this blend spaces sample data Animation/BlendSpace.h  

const FBlendSpaceData & GetBlendSpaceData()

 Returns the runtime triangulation etc data Animation/BlendSpace.h  

FVector GetClampedAndWrappedBlendInput ( const FVector& BlendInput
) const

 Returns the blend input after clamping and/or wrapping Animation/BlendSpace.h  

FVector GetGridPosition ( int32 GridIndex
) const

 Returns the sample position associated with the elements returned by GetGridSamples Animation/BlendSpace.h  

FVector GetGridPosition ( int32 GridX,
int32 GridY
) const

 Returns the sample position associated with the coordinates Animation/BlendSpace.h  

const TArray< FEditorElement > & GetGridSamples()

 Return GridSamples from this BlendSpace Animation/BlendSpace.h  

int32 GetNumberOfBlendSamples()

 Get the number of sample points for this blend space Animation/BlendSpace.h  

bool GetSamplesFromBlendInput ( const FVector& BlendInput,
TArray< FBlendSampleData >& OutSampleDataList,
int32& InOutCachedTriangulationIndex,
bool bCombineAnimations
) const

 Get Grid Samples from BlendInput It will return all samples that has weight > KINDA_SMALL_NUMBER Animation/BlendSpace.h  

void InitializeFilter ( FBlendFilter* Filter,
int NumDimensions
) const

 Initialize BlendSpace filtering for runtime. Animation/BlendSpace.h  

bool IsAnimationCompatible ( const UAnimSequence* AnimationSequence
) const

 Check if the animation sequence additive type is compatible with this blend space Animation/BlendSpace.h  

bool IsAnimationCompatibleWithSkeleton ( const UAnimSequence* AnimationSequence
) const

 Check if the animation sequence's skeleton is compatible with this blendspace Animation/BlendSpace.h  

bool IsSampleWithinBounds ( const FVector& SampleValue
) const

   Animation/BlendSpace.h  

bool IsTooCloseToExistingSamplePoint ( const FVector& SampleValue,
int32 OriginalIndex
) const

 Check if given sample value isn't too close to existing sample point Animation/BlendSpace.h  

virtual bool IsValidAdditiveType ( EAdditiveAnimationType AdditiveType
) const

 Returns whether or not the given additive animation type is compatible with the blendspace type Animation/BlendSpace.h  

bool IsValidBlendSampleIndex ( const int32 SampleIndex
) const

 Check whether or not the sample index is valid in combination with the stored sample data Animation/BlendSpace.h  

bool ReplaceSampleAnimation ( const int32 BlendSampleIndex,
UAnimSequence* AnimationSequence
)

 Update animation on grid sample Animation/BlendSpace.h  

void ResampleData()

 Runs triangulation/segmentation to update our grid and BlendSpaceData structures Animation/BlendSpace.h  

void ResetBlendSamples ( TArray< FBlendSampleData >& InOutSampleDataCache,
float InNormalizedCurrentTime,
bool bLooping,
bool bMatchSyncPhases
) const

 Resets a cached set of blend samples to match a given input time. Animation/BlendSpace.h  

void RuntimeValidateMarkerData()

   Animation/BlendSpace.h  

void SetBlendSpaceData ( const TArray< FBlendSpaceSegment >& Segments
)

 Sets up BlendSpaceData based on Line elements Animation/BlendSpace.h  

bool ShouldAnimationBeAdditive()

 Check if the the blendspace contains additive samples only Animation/BlendSpace.h  

bool UpdateBlendSamples ( const FVector& InBlendSpacePosition,
float InDeltaTime,
TArray< FBlendSampleData >& InOutSampleDataCache,
int32& InOutCachedTriangulationIndex
) const

 Updates a cached set of blend samples according to internal parameters, blendspace position and a delta time. Animation/BlendSpace.h  

void UpdateFilterParams ( FBlendFilter* Filter
) const

 Update BlendSpace filtering parameters - values that don't require a full initialization Animation/BlendSpace.h  

bool UpdateSampleAnimation ( UAnimSequence* AnimationSequence,
const FVector& SampleValue
)

   Animation/BlendSpace.h  

bool ValidateAnimationSequence ( const UAnimSequence* AnimationSequence
) const

 Validate that the given animation sequence and contained blendspace data Animation/BlendSpace.h  

void ValidateSampleData()

 Validates the contained data Animation/BlendSpace.h  

bool ValidateSampleValue ( const FVector& SampleValue,
int32 OriginalIndex
) const

 Validates supplied blend sample against current contents of blendspace Animation/BlendSpace.h  

Overridden from UAnimationAsset

Name Remarks Include Path Unreal Specifiers

virtual bool GetAllAnimationSequencesReferred ( TArray< UAnimationAsset* >& AnimationSequences,
bool bRecursive
)

 Retrieve all animations that are used by this asset Animation/BlendSpace.h  

virtual int32 GetMarkerUpdateCounter()

   Animation/BlendSpace.h  

virtual float GetPlayLength ()

 This is used in editor only when used for transition getter this doesn't mean max time. Animation/BlendSpace.h  

virtual TArray< FName > * GetUniqueMarkerNames()

 Return a list of unique marker names for blending compatibility Animation/BlendSpace.h  

virtual bool IsValidAdditive()

 Return true if this is valid additive animation false otherwise Animation/BlendSpace.h  

virtual void ReplaceReferredAnimations ( const TMap< UAnimationAsset*, UAnimationAsset* >& ReplacementMap
)

 Replace this assets references to other animations based on ReplacementMap Animation/BlendSpace.h  

virtual void TickAssetPlayer ( FAnimTickRecord& Instance,
FAnimNotifyQueue& NotifyQueue,
FAnimAssetTickContext& Context
) const

 Advances the asset player instance Animation/BlendSpace.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   Animation/BlendSpace.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Animation/BlendSpace.h  

virtual void PostLoad()

   Animation/BlendSpace.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Animation/BlendSpace.h  

virtual void Serialize ( FArchive& Ar
)

   Animation/BlendSpace.h  

Overridden from IInterpolationIndexProvider

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< IInterpolationIndexProvider::FPerBoneInterpolationData > GetPerBoneInterpolationData ( const USkeleton* Skeleton
) const

 Sorts the PerBoneBlend data into a form that can be repeatedly used in GetPerBoneInterpolationIndex Animation/BlendSpace.h  

virtual int32 GetPerBoneInterpolationIndex ( const FSkeletonPoseBoneIndex InSkeletonBoneIndex,
const USkeleton* TargetSkeleton,
const IInterpolationIndexProvider::FPerBoneInterpolationData* Data
) const

 Get PerBoneInterpolationIndex for the input BoneIndex If nothing found, return INDEX_NONE Animation/BlendSpace.h  

virtual int32 GetPerBoneInterpolationIndex ( const FCompactPoseBoneIndex& InCompactPoseBoneIndex,
const FBoneContainer& RequiredBones,
const IInterpolationIndexProvider::FPerBoneInterpolationData* Data
) const

 Get PerBoneInterpolationIndex for the input BoneIndex If nothing found, return INDEX_NONE Animation/BlendSpace.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool ContainsMatchingSamples ( EAdditiveAnimationType AdditiveType
) const

 Returns whether or not all animation set on the blend space samples match the given additive type Animation/BlendSpace.h  

bool ContainsNonAdditiveSamples()

   Animation/BlendSpace.h  

FVector ConvertBlendInputToGridSpace ( const FVector& BlendInput
) const

 Translates BlendInput to grid space Animation/BlendSpace.h  

virtual EBlendSpaceAxis GetAxisToScale()

 Returns the axis which can be used to scale animation speed. Animation/BlendSpace.h  

FVector GetClampedBlendInput ( const FVector& BlendInput
) const

 Returns the blend input clamped to the valid range, unless that axis has been set to wrap in which case no clamping is done Animation/BlendSpace.h  

const FEditorElement * GetGridSampleInternal ( int32 Index
) const

 Returns the grid element at Index or NULL if Index is not valid Animation/BlendSpace.h  

FVector GetNormalizedBlendInput ( const FVector& BlendInput
) const

 Translates BlendInput to grid space Animation/BlendSpace.h  

void GetRawSamplesFromBlendInput ( const FVector& BlendInput,
TArray< FGridBlendSample, TInlineAllocator< 4 > >& OutBlendSamples
) const

 Get Grid Samples from BlendInput, From Input, it will populate OutGridSamples with the closest grid points. Animation/BlendSpace.h  

void InitializePerBoneBlend()

 Initialize Per Bone Blend Animation/BlendSpace.h  

bool InterpolateWeightOfSampleData ( float DeltaTime,
const TArray< FBlendSampleData >& OldSampleDataList,
const TArray< FBlendSampleData >& NewSampleDataList,
TArray< FBlendSampleData >& FinalSampleDataList
) const

 Utility function to interpolate weight of samples from OldSampleDataList to NewSampleDataList and copy back the interpolated result to FinalSampleDataList Animation/BlendSpace.h  

bool IsSameSamplePoint ( const FVector& SamplePointA,
const FVector& SamplePointB
) const

 Checks if the given samples points overlap Animation/BlendSpace.h  

void ResetToRefPose ( FCompactPose& OutPose
) const

 Reset to reference pose. It does apply different refpose based on additive or not Animation/BlendSpace.h  

virtual void SnapSamplesToClosestGridPoint()

 If around border, snap to the border to avoid empty hole of data that is not valid Animation/BlendSpace.h  

void TickFollowerSamples ( TArray< FBlendSampleData >& SampleDataList,
const int32 HighestWeightIndex,
FAnimAssetTickContext& Context,
bool bResetMarkerDataOnFollowers,
bool bLooping,
const UMirrorDataTable* MirrorDataTable
) const

 Ticks the samples in SampleDataList apart from the HighestWeightIndex one. Animation/BlendSpace.h  

void UpdatePreviewBasePose()

   Animation/BlendSpace.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsSingleFrameBlendingIndexInBounds ( const FBlendSample& BlendSample
)

   Animation/BlendSpace.h  

static void UpdateBlendSpacesUsingAnimSequence ( UAnimSequenceBase* Sequence
)

 Validates sample data for blendspaces using the given animation sequence Animation/BlendSpace.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bRotationBlendInMeshSpace_DEPRECATED bool   Animation/BlendSpace.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page