1. Epic GamesDeveloper
  3. UBlendSpace

UBlendSpace

Allows multiple animations to be blended between based on input parameters

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Animation

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Animation/BlendSpace.h
Include #include "Animation/BlendSpace.h"

Syntax

class UBlendSpace :  
    public UAnimationAsset,  
    public IInterpolationIndexProvider

Remarks

Allows multiple animations to be blended between based on input parameters

Variables

  Type Name Description
Public variable TObjectPtr< UAnalysisProperties >[3] AnalysisProperties Analysis properties for each axis.
Public variable float AnimLength This is the maximum length of any sample in the blendspace.
Protected variable TEnumAsByte< EBlendSpaceAxis > AxisToScaleAnimation If you have input smoothing, this specifies the axis on which to scale the animation playback speed.
Public variable bool bAllowMeshSpaceBlending If set then blending is performed in mesh space if there are per-bone sample smoothing overrides.
Public variable bool bContainsRotationOffsetMeshSpaceSamples Indicates whether any samples have the flag to apply rotation offsets in mesh space
Public variable bool bInterpolateUsingGrid If true then interpolation is done via a grid at runtime.
Protected variable FBlendParameter[3] BlendParameters Blend Parameters for each axis.
Protected variable FBlendSpaceData BlendSpaceData Container for the runtime data, which could be line segments, triangulation or tetrahedrons
Public variable bool bLoop The default looping behavior of this blend space. Asset players can override this
Public variable bool bTargetWeightInterpolationEaseInOut If set then this eases in/out the sample weight adjustments, using the speed to determine how much smoothing to apply.
Public variable TObjectPtr< UCachedAnalysisProperties >[3] CachedAnalysisProperties Cached properties used to initialize properties when newly created.
Protected variable TArray< int32 > DimensionIndices The order in which to use the dimensions in the data - e.g. [1, 2] means a 2D blend using Y and Z
Protected variable TArray< struct FEditorElement > GridSamples Grid samples, indexing scheme imposed by subclass
Public variable FInterpolationParameter[3] InterpolationParam Input Smoothing parameters for each input axis
Protected variable TArray< FPerBoneInterpolation > ManualPerBoneOverrides Per bone sample smoothing settings, which affect the specified bone and all its descendants in the skeleton.
Public variable TEnumAsByte< ENotifyTriggerMode::Type > NotifyTriggerMode The current mode used by the BlendSpace to decide which animation notifies to fire.
Protected variable EBlendSpacePerBoneBlendMode PerBoneBlendMode There are two ways to use per pone sample smoothing: Blend profiles and manually maintaining the per bone overrides.
Protected variable FBlendSpaceBlendProfile PerBoneBlendProfile Reference to a blend profile of the corresponding skeleton to be used for per bone smoothing in case the per bone blend mode is set to use a blend profile.
Protected variable TArray< FPerBoneInterpolation > PerBoneBlendValues Stores the actual bone references and their smoothing interpolation speeds used by the blend space.
Public variable EPreferredTriangulationDirection PreferredTriangulationDirection Preferred edge direction when the triangulation has to make an arbitrary choice
Public variable TObjectPtr< UAnimSequence > PreviewBasePose Preview Base pose for additive BlendSpace
Protected variable FVector[3] PreviousAxisMinMaxValues  
Protected variable float[3] PreviousGridSpacings  
Protected variable TArray< struct FBlendSample > SampleData Sample animation data
Protected variable int32 SampleIndexWithMarkers Track index to get marker data from.
Public variable float TargetWeightInterpolationSpeedPerSec If greater than zero, this is the speed at which the sample weights are allowed to change.

Constructors

  Type Name Description
Public function  

UBlendSpace ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function int32

AddSample ( const FVector& SampleValue
)

 Add samples
Public function int32

AddSample ( UAnimSequence* AnimationSequence,
const FVector& SampleValue
)

 Add samples
Protected function Const bool

ContainsMatchingSamples ( EAdditiveAnimationType AdditiveType
)

 Returns whether or not all animation set on the blend space samples match the given additive type
Protected function Const bool  
Protected function Const FVector

ConvertBlendInputToGridSpace ( const FVector& BlendInput
)

 Translates BlendInput to grid space
Public function bool

DeleteSample ( const int32 BlendSampleIndex
)

 Delete samples
Public function Const bool

DoesAnimationMatchExistingSamples ( const UAnimSequence* AnimationSequence
)

 Check if the blend spaces contains samples whos additive type match that of the animation sequence
Public function bool

EditSampleValue ( const int32 BlendSampleIndex,
const FVector& NewValue
)

 Edit samples
Public function void

ExpandRangeForSample ( const FVector& SampleValue
)

  
Public function Const FVector

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

 Interpolate BlendInput based on Filter data
Public function Const void

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

 Allows the user to iterate through all the data samples available in the blend space.
Public function Const float Utility function to calculate animation length from sample data list
Public function Const void

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

  
Public function Const void

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

  
Protected function Virtual Const EBlendSpaceAxis Returns the axis which can be used to scale animation speed.
Public function Const const FBlendParameter &

GetBlendParameter ( const int32 Index
)

 Accessor for blend parameter
Public function Const const FBlendSample &

GetBlendSample ( const int32 SampleIndex
)

 Returns the Blend Sample at the given index, will assert on invalid indices
Public function Const const TArray< struct FBlendSample > & Get this blend spaces sample data
Public function Const const FBlendSpaceData & Returns the runtime triangulation etc data
Public function Const FVector

GetClampedAndWrappedBlendInput ( const FVector& BlendInput
)

 Returns the blend input after clamping and/or wrapping
Protected function Const FVector

GetClampedBlendInput ( const FVector& BlendInput
)

 Returns the blend input clamped to the valid range, unless that axis has been set to wrap in which case no clamping is done
Public function Const FVector

GetGridPosition ( int32 GridIndex
)

 Returns the sample position associated with the elements returned by GetGridSamples
Public function Const FVector

GetGridPosition ( int32 GridX,
int32 GridY
)

 Returns the sample position associated with the coordinates
Protected function Const const FEditorElement *

GetGridSampleInternal ( int32 Index
)

 Returns the grid element at Index or NULL if Index is not valid
Public function Const const TArray< FEditorElement > & Return GridSamples from this BlendSpace
Protected function Const FVector

GetNormalizedBlendInput ( const FVector& BlendInput
)

 Translates BlendInput to grid space
Public function Const int32 Get the number of sample points for this blend space
Protected function Const void

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

 Get Grid Samples from BlendInput, From Input, it will populate OutGridSamples with the closest grid points.
Public function Const bool

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

 Get Grid Samples from BlendInput It will return all samples that has weight > KINDA_SMALL_NUMBER
Public function Const void

InitializeFilter ( FBlendFilter* Filter,
int NumDimensions
)

 Initialize BlendSpace filtering for runtime.
Protected function void Initialize Per Bone Blend
Protected function Const bool

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

 Utility function to interpolate weight of samples from OldSampleDataList to NewSampleDataList and copy back the interpolated result to FinalSampleDataList
Public function Const bool

IsAnimationCompatible ( const UAnimSequence* AnimationSequence
)

 Check if the animation sequence additive type is compatible with this blend space
Public function Const bool

IsAnimationCompatibleWithSkeleton ( const UAnimSequence* AnimationSequence
)

 Check if the animation sequence's skeleton is compatible with this blendspace
Protected function Const bool

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

 Checks if the given samples points overlap
Public function Const bool

IsSampleWithinBounds ( const FVector& SampleValue
)

  
Public function Const bool

IsTooCloseToExistingSamplePoint ( const FVector& SampleValue,
int32 OriginalIndex
)

 Check if given sample value isn't too close to existing sample point
Public function Virtual Const bool

IsValidAdditiveType ( EAdditiveAnimationType AdditiveType
)

 Returns whether or not the given additive animation type is compatible with the blendspace type
Public function Const bool

IsValidBlendSampleIndex ( const int32 SampleIndex
)

 Check whether or not the sample index is valid in combination with the stored sample data
Public function bool

ReplaceSampleAnimation ( const int32 BlendSampleIndex,
UAnimSequence* AnimationSequence
)

 Update animation on grid sample
Public function void Runs triangulation/segmentation to update our grid and BlendSpaceData structures
Protected function Const void Reset to reference pose. It does apply different refpose based on additive or not
Public function void  
Public function void Sets up BlendSpaceData based on Line elements
Public function Const bool Check if the the blendspace contains additive samples only
Protected function Virtual void If around border, snap to the border to avoid empty hole of data that is not valid
Protected function Const void

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

 Ticks the samples in SampleDataList apart from the HighestWeightIndex one.
Public function Const bool

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

 Updates a cached set of blend samples according to internal parameters, blendspace position and a delta time.
Public function Static void Validates sample data for blendspaces using the given animation sequence
Public function Const void Update BlendSpace filtering parameters - values that don't require a full initialization
Protected function void  
Public function Const bool

ValidateAnimationSequence ( const UAnimSequence* AnimationSequence
)

 Validate that the given animation sequence and contained blendspace data
Public function void Validates the contained data
Public function Const bool

ValidateSampleValue ( const FVector& SampleValue,
int32 OriginalIndex
)

 Validates supplied blend sample against current contents of blendspace

Overridden from UAnimationAsset

  Type Name Description
Public function Virtual bool

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

 Retrieve all animations that are used by this asset
Public function Virtual Const int32  
Public function Virtual Const float This is used in editor only when used for transition getter this doesn't mean max time.
Public function Virtual TArray< FName > * Return a list of unique marker names for blending compatibility
Public function Virtual Const bool Return true if this is valid additive animation false otherwise
Public function Virtual void Replace this assets references to other animations based on ReplacementMap
Public function Virtual Const void Advances the asset player instance

Overridden from UObject

  Type Name Description
Public function Virtual 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).
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterpolationIndexProvider

  Type Name Description
Public function Virtual Const TSharedPtr< IInterpolationIndexProvider::FPerBoneInterpolationData > Sorts the PerBoneBlend data into a form that can be repeatedly used in GetPerBoneInterpolationIndex
Public function Virtual Const int32 Get PerBoneInterpolationIndex for the input BoneIndex If nothing found, return INDEX_NONE

Deprecated Variables

  Type Name Description
Public variable bool bRotationBlendInMeshSpace_DEPRECATED This property is deprecated. Please use/see bContainsRotationOffsetMeshSpaceSamples instead

Deprecated Functions

  Type Name Description
Public function Const void

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

 Use GetAnimationPose with extraction context signature
Public function Const void

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

 Use GetAnimationPose with other signature
Public function Const void

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

 Use GetAnimationPose with extraction context signature
Public function bool

UpdateSampleAnimation ( UAnimSequence* AnimationSequence,
const FVector& SampleValue
)

 Please use ReplaceSampleAnimation instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page