UE::Anim Namespace Reference

Namespaces
namespace	Compression
namespace	Conversion
namespace	DataModel
namespace	DeadBlending
namespace	Decompression
namespace	Inertialization
namespace	Private
namespace	RetargetHelpers
namespace	Retargeting
namespace	RichCurve

Classes
struct	Attributes
struct	AttributeTypes
struct	CBlendableAttribute
struct	CNormalizedAttribute
class	FActiveStateMachineScope
struct	FAnimationEvaluationCache
struct	FAnimationEvaluationTask
struct	FAnimationEvaluator
class	FAnimBlendDebugScope
class	FAnimInertializationSyncScope
class	FAnimNotifyEndDataContext
class	FAnimNotifyMirrorContext
class	FAnimNotifyMontageInstanceContext
class	FAnimNotifyStateMachineContext
struct	FAnimPoseDecompressionData
struct	FAnimSync
struct	FAnimSyncDebugInfo
class	FAnimSyncGroupScope
struct	FAnimSyncParams
struct	FAttributeBlendData
struct	FAttributeId
struct	FAttributes
struct	FAttributeTypeRegistrar
struct	FBaseBlendedCurve_DEPRECATED
struct	FBuildRawPoseScratchArea
struct	FBulkCurveFlags
struct	FBulkCurves
struct	FCachedPoseScope
class	FCachedPoseSkippedUpdateHandler
struct	FCachedPoseThreadContext
struct	FCurveElement
struct	FCurveElementFlags
struct	FCurveElementIndexed
struct	FCurveFilter
struct	FCurveFilterElement
struct	FCurveFilterSettings
struct	FCurveUtils
class	FDeadBlendingRequester
struct	FEvaluationForCachingScope
struct	FHeapAttributeContainer
struct	FHeapAttributeContainerAccessor
class	FInertializationRequester
struct	FMeshAttributeContainer
struct	FMessageStack
class	FMirrorSyncScope
struct	FNamedIndexElement
struct	FNamedValueArrayUtils
struct	FNodeDataId
struct	FNodeFunctionCaller
class	FNonBlendableAttributeBlendOperator
struct	FScopedGraphMessage
struct	FScopedGraphTag
class	FSkeletonRemappingRegistry
struct	FSkeletonRemappingRegistryPrivate
struct	FStackAttributeContainer
struct	FStackAttributeContainerAccessor
class	IAnimEventsFilterContext
class	IAnimNotifyEventContextDataInterface
class	IAnimRootMotionProvider
class	IAttributeBlendOperator
class	IGraphMessage
class	IInertializationRequester
class	IPoseSearchProvider
class	TAttributeBlendOperator
struct	TAttributeContainer
struct	TAttributeContainerAccessor
struct	TAttributeTypeTraits
struct	TAttributeTypeTraits< FIntegerAnimationAttribute >
struct	TAttributeTypeTraits< FNonBlendableFloatAnimationAttribute >
struct	TAttributeTypeTraits< FNonBlendableIntegerAnimationAttribute >
struct	TAttributeTypeTraits< FNonBlendableQuaternionAnimationAttribute >
struct	TAttributeTypeTraits< FNonBlendableTransformAnimationAttribute >
struct	TAttributeTypeTraits< FNonBlendableVectorAnimationAttribute >
struct	TAttributeTypeTraits< FQuaternionAnimationAttribute >
struct	TAttributeTypeTraits< FStringAnimationAttribute >
struct	TAttributeTypeTraits< FTransformAnimationAttribute >
struct	TAttributeTypeTraitsBase
struct	TNamedValueArray
struct	TOptionalScopedGraphMessage
struct	TScopedGraphMessage
class	TTypedIndexRange
struct	TWrappedAttribute

Typedefs
using	FSlotInertializationRequest = TPair< float, const UBlendProfile * >
template<typename IndexType , typename ... TArrayArgs>
using	TTypedIndexArray = TTypedIndexRange< IndexType, TArray< TArrayArgs... > >
template<typename IndexType , typename ... TArrayViewArgs>
using	TTypedIndexArrayView = TTypedIndexRange< IndexType, TArrayView< TArrayViewArgs... > >

Enumerations
enum class	ECurveElementFlags : uint8 { None = 0 , Material = 0x01 , MorphTarget = 0x02 }
enum class	ECurveFilterFlags : uint8 { None = 0 , Disallowed = 0x01 , Filtered = 0x02 }
enum class	ECurveFilterMode : uint8 { None , DisallowAll , AllowOnlyFiltered , DisallowFiltered }
enum class	ENamedValueUnionFlags : uint8 { None = 0 , ValidArg0 = 0x01 , ValidArg1 = 0x02 , BothArgsValid = ValidArg0 | ValidArg1 }

Functions
ENGINE_API void	ExtractBoneTransform (const struct FRawAnimSequenceTrack &RawTrack, FTransform &OutTransform, int32 KeyIndex)
ENGINE_API FTransform	MirrorTransform (const FTransform &Transform, const UMirrorDataTable &MirrorDataTable)
ENGINE_API FTransform	ExtractRootMotionFromAnimationAsset (const UAnimationAsset *Animation, const UMirrorDataTable *MirrorDataTable, float StartTime, float DeltaTime, bool bAllowLooping)
ENGINE_API FTransform	ExtractRootMotionFromAnimationAsset (const UAnimationAsset *Animation, const UMirrorDataTable *MirrorDataTable, float StartPosition, float EndPosition)
ENGINE_API FTransform	ExtractRootTransformFromAnimationAsset (const UAnimationAsset *Animation, float Position)
	IMPLEMENT_ANIMGRAPH_MESSAGE (FActiveStateMachineScope)
void	ExtractBoneTransform (const FRawAnimSequenceTrack &RawTrack, FTransform &OutTransform, int32 KeyIndex)
bool	IsMirrorSyncIdentical (const UMirrorDataTable *MirrorTableA, const UMirrorDataTable *MirrorTableB)
	ENUM_CLASS_FLAGS (ECurveElementFlags)
	ENUM_CLASS_FLAGS (ECurveFilterFlags)
FString	GetComponentName (const USceneComponent *InSceneComponent)
bool	IsCaching ()
void	MarkComponentForEvaluation (const USceneComponent *InSceneComponent)
const FAnimationEvaluator &	EvaluateComponent (USceneComponent *InSceneComponent)

Variables
FSkeletonRemappingRegistry *	GSkeletonRemappingRegistry = nullptr
FSkeletonRemapping	DefaultMapping

Typedef Documentation

FSlotInertializationRequest

typedef TPair< float, const UBlendProfile * > UE::Anim::FSlotInertializationRequest

TTypedIndexArray

template<typename IndexType , typename ... TArrayArgs>

using UE::Anim::TTypedIndexArray = typedef TTypedIndexRange<IndexType, TArray<TArrayArgs...> >

TTypedIndexArrayView

template<typename IndexType , typename ... TArrayViewArgs>

using UE::Anim::TTypedIndexArrayView = typedef TTypedIndexRange<IndexType, TArrayView<TArrayViewArgs...> >

Enumeration Type Documentation

ECurveElementFlags

enum class UE::Anim::ECurveElementFlags : uint8

strong

Enumerator
None
Material
MorphTarget

ECurveFilterFlags

enum class UE::Anim::ECurveFilterFlags : uint8

strong

Enumerator
None
Disallowed
Filtered

ECurveFilterMode

enum class UE::Anim::ECurveFilterMode : uint8

strong

Enumerator
None
DisallowAll
AllowOnlyFiltered
DisallowFiltered

ENamedValueUnionFlags

enum class UE::Anim::ENamedValueUnionFlags : uint8

strong

Enumerator
None
ValidArg0
ValidArg1
BothArgsValid

Function Documentation

ENUM_CLASS_FLAGS() [1/2]

UE::Anim::ENUM_CLASS_FLAGS

(

ECurveElementFlags

)

ENUM_CLASS_FLAGS() [2/2]

UE::Anim::ENUM_CLASS_FLAGS

(

ECurveFilterFlags

)

EvaluateComponent()

const FAnimationEvaluator & UE::Anim::EvaluateComponent

(

USceneComponent *

InSceneComponent

)

ExtractBoneTransform() [1/2]

void UE::Anim::ExtractBoneTransform	(	const FRawAnimSequenceTrack &	RawTrack,
		FTransform &	OutTransform,
		int32	KeyIndex
	)

ExtractBoneTransform() [2/2]

ENGINE_API void UE::Anim::ExtractBoneTransform	(	const struct FRawAnimSequenceTrack &	RawTrack,
		FTransform &	OutTransform,
		int32	KeyIndex
	)

Extract Bone Transform of the Time given, from the provided FRawAnimSequenceTrack

Parameters

RawTrack	RawAnimationTrack it extracts bone transform from
OutAtom	[out] Output bone transform.
KeyIndex	Key index to retrieve from the track.

ExtractRootMotionFromAnimationAsset() [1/2]

FTransform UE::Anim::ExtractRootMotionFromAnimationAsset	(	const UAnimationAsset *	Animation,
		const UMirrorDataTable *	MirrorDataTable,
		float	StartPosition,
		float	EndPosition
	)

Extract relative root motion between start and end position of the animation asset.

Parameters

Animation	Animation asset to extract the root motion from.
MirrorDataTable	[optional] Animation data mirroring data table.
StartPosition	Start Position of the animation.
EndPosition	End Position of the animation.

ExtractRootMotionFromAnimationAsset() [2/2]

FTransform UE::Anim::ExtractRootMotionFromAnimationAsset	(	const UAnimationAsset *	Animation,
		const UMirrorDataTable *	MirrorDataTable,
		float	StartTime,
		float	DeltaTime,
		bool	bAllowLooping
	)

Extract relative root motion between start and end position of the animation asset. With optional looping if applicable. NOTE WELL: Our second time param is a delta time, not an end like like other variations of this API.

Parameters

Animation	Animation asset to extract the root motion from.
MirrorDataTable	[optional] Animation data mirroring data table.
StartTime	Start Position of the animation.
DeltaTime	Delta time to Advance, can be negative.
bAllowLooping	True if we should accumulate and loop.

ExtractRootTransformFromAnimationAsset()

FTransform UE::Anim::ExtractRootTransformFromAnimationAsset	(	const UAnimationAsset *	Animation,
		float	Position
	)

Extract absolute root transform at specific position in time from the animation asset. Note: this function applies skeleton reference pose the transform (similar to ExtractRootMotionFromAnimationAsset, but unlike UAnimSequence::ExtractRootTrackTransform()).

Parameters

Animation	Animation asset to extract the root motion from.
Position	Start Position of the animation.

GetComponentName()

FString UE::Anim::GetComponentName

(

const USceneComponent *

InSceneComponent

)

IMPLEMENT_ANIMGRAPH_MESSAGE()

UE::Anim::IMPLEMENT_ANIMGRAPH_MESSAGE

(

FActiveStateMachineScope

)

IsCaching()

CONSTRAINTS_API bool UE::Anim::IsCaching

(

)

IsMirrorSyncIdentical()

bool UE::Anim::IsMirrorSyncIdentical	(	const UMirrorDataTable *	MirrorTableA,
		const UMirrorDataTable *	MirrorTableB
	)

MarkComponentForEvaluation()

void UE::Anim::MarkComponentForEvaluation

(

const USceneComponent *

InSceneComponent

)

MirrorTransform()

FTransform UE::Anim::MirrorTransform	(	const FTransform &	Transform,
		const UMirrorDataTable &	MirrorDataTable
	)

Mirrors transform based on the specified mirror table.

Parameters

Transform	Transform to mirror
MirrorDataTable	Animation data mirroring data table.

Returns

Transform mirrored based on the mirror data table.

Variable Documentation

DefaultMapping

FSkeletonRemapping UE::Anim::DefaultMapping

GSkeletonRemappingRegistry

FSkeletonRemappingRegistry* UE::Anim::GSkeletonRemappingRegistry = nullptr