FSkeletonRemapping Struct Reference

#include <SkeletonRemapping.h>

Public Member Functions
	FSkeletonRemapping ()=default
ENGINE_API	FSkeletonRemapping (const USkeleton *InSourceSkeleton, const USkeleton *InTargetSkeleton)
const TWeakObjectPtr< const USkeleton > &	GetSourceSkeleton () const
const TWeakObjectPtr< const USkeleton > &	GetTargetSkeleton () const
ENGINE_API void	ComposeWith (const FSkeletonRemapping &OtherSkeletonRemapping)
int32	GetTargetSkeletonBoneIndex (int32 SourceSkeletonBoneIndex) const
int32	GetSourceSkeletonBoneIndex (int32 TargetSkeletonBoneIndex) const
FTransform	RetargetBoneTransformToTargetSkeleton (int32 TargetSkeletonBoneIndex, const FTransform &SourceTransform) const
FVector	RetargetBoneTranslationToTargetSkeleton (int32 TargetSkeletonBoneIndex, const FVector &SourceTranslation) const
FQuat	RetargetBoneRotationToTargetSkeleton (int32 TargetSkeletonBoneIndex, const FQuat &SourceRotation) const
FTransform	RetargetAdditiveTransformToTargetSkeleton (int32 TargetSkeletonBoneIndex, const FTransform &SourceTransform) const
FVector	RetargetAdditiveTranslationToTargetSkeleton (int32 TargetSkeletonBoneIndex, const FVector &SourceTranslation) const
FQuat	RetargetAdditiveRotationToTargetSkeleton (int32 TargetSkeletonBoneIndex, const FQuat &SourceRotation) const
ENGINE_API const TArray< SmartName::UID_Type > &	GetSourceToTargetCurveMapping () const
ENGINE_API void	RegenerateMapping ()
void	GenerateCurveMapping ()
bool	RequiresReferencePoseRetarget () const
bool	IsValid () const

Constructor & Destructor Documentation

FSkeletonRemapping() [1/2]

FSkeletonRemapping::FSkeletonRemapping ( )

default

FSkeletonRemapping() [2/2]

FSkeletonRemapping::FSkeletonRemapping	(	const USkeleton *	InSourceSkeleton,
		const USkeleton *	InTargetSkeleton
	)

Member Function Documentation

ComposeWith()

void FSkeletonRemapping::ComposeWith

(

const FSkeletonRemapping &

OtherSkeletonRemapping

)

Compose this remapping with another remapping in place. The other remapping's source skeleton must match this remapping's target skeleton. The result will map from this remapping's source skeleton to the other remapping's target skeleton

Parameters

OtherSkeletonRemapping

Skeleton remapping to compose into this remapping

GenerateCurveMapping()

void FSkeletonRemapping::GenerateCurveMapping ( )

inline

GetSourceSkeleton()

const TWeakObjectPtr< const USkeleton > & FSkeletonRemapping::GetSourceSkeleton ( ) const

inline

GetSourceSkeletonBoneIndex()

int32 FSkeletonRemapping::GetSourceSkeletonBoneIndex ( int32  TargetSkeletonBoneIndex ) const

inline

Get the source skeleton bone index that corresponds to the specified bone on the target skeleton

Parameters

TargetSkeletonBoneIndex

Skeleton bone index on the target skeleton

Returns

Skeleton bone index on the source skeleton (or INDEX_NONE)

GetSourceToTargetCurveMapping()

const TArray< SmartName::UID_Type > & FSkeletonRemapping::GetSourceToTargetCurveMapping

(

)

const

GetTargetSkeleton()

const TWeakObjectPtr< const USkeleton > & FSkeletonRemapping::GetTargetSkeleton ( ) const

inline

GetTargetSkeletonBoneIndex()

int32 FSkeletonRemapping::GetTargetSkeletonBoneIndex ( int32  SourceSkeletonBoneIndex ) const

inline

Get the target skeleton bone index that corresponds to the specified bone on the source skeleton

Parameters

SourceSkeletonBoneIndex

Skeleton bone index on the source skeleton

Returns

Skeleton bone index on the target skeleton (or INDEX_NONE)

IsValid()

bool FSkeletonRemapping::IsValid ( ) const

inline

Check whether this mapping is valid - whether the source and target hierarchies still exist

RegenerateMapping()

void FSkeletonRemapping::RegenerateMapping

(

)

Refreshes the mapping. Empties mapping arrays and regenerates them against the stored skeletons.

RequiresReferencePoseRetarget()

bool FSkeletonRemapping::RequiresReferencePoseRetarget ( ) const

inline

Check to see if a reference pose retarget is required between the source & target hierarchies

RetargetAdditiveRotationToTargetSkeleton()

FQuat FSkeletonRemapping::RetargetAdditiveRotationToTargetSkeleton ( int32  TargetSkeletonBoneIndex, const FQuat &  SourceRotation  ) const

inline

Get the specified additive rotation retargeted from the source skeleton onto the target skeleton, corrected for differences between source and target rest poses

Parameters

TargetSkeletonBoneIndex	Skeleton bone index on the target skeleton
SourceRotation	Bone rotation from the corresponding bone on the source skeleton

Returns

Rotation mapped onto the target skeleton

RetargetAdditiveTransformToTargetSkeleton()

FTransform FSkeletonRemapping::RetargetAdditiveTransformToTargetSkeleton ( int32  TargetSkeletonBoneIndex, const FTransform &  SourceTransform  ) const

inline

Get the specified additive transform retargeted from the source skeleton onto the target skeleton, corrected for differences between source and target rest poses

Parameters

TargetSkeletonBoneIndex	Skeleton bone index on the target skeleton
SourceTransform	Bone transform from the corresponding bone on the source skeleton

Returns

Transform mapped onto the target skeleton

RetargetAdditiveTranslationToTargetSkeleton()

FVector FSkeletonRemapping::RetargetAdditiveTranslationToTargetSkeleton ( int32  TargetSkeletonBoneIndex, const FVector &  SourceTranslation  ) const

inline

Get the specified additive translation retargeted from the source skeleton onto the target skeleton, corrected for differences between source and target rest poses

Parameters

TargetSkeletonBoneIndex	Skeleton bone index on the target skeleton
SourceTranslation	Bone translation from the corresponding bone on the source skeleton

Returns

Translation mapped onto the target skeleton

RetargetBoneRotationToTargetSkeleton()

FQuat FSkeletonRemapping::RetargetBoneRotationToTargetSkeleton ( int32  TargetSkeletonBoneIndex, const FQuat &  SourceRotation  ) const

inline

Get the specified bone rotation retargeted from the source skeleton onto the target skeleton, corrected for differences between source and target rest poses

Parameters

TargetSkeletonBoneIndex	Skeleton bone index on the target skeleton
SourceRotation	Bone rotation from the corresponding bone on the source skeleton

Returns

Rotation mapped onto the target skeleton

RetargetBoneTransformToTargetSkeleton()

FTransform FSkeletonRemapping::RetargetBoneTransformToTargetSkeleton ( int32  TargetSkeletonBoneIndex, const FTransform &  SourceTransform  ) const

inline

Get the specified bone transform retargeted from the source skeleton onto the target skeleton, corrected for differences between source and target rest poses

Parameters

TargetSkeletonBoneIndex	Skeleton bone index on the target skeleton
SourceTransform	Bone transform from the corresponding bone on the source skeleton

Returns

Transform mapped onto the target skeleton

RetargetBoneTranslationToTargetSkeleton()

FVector FSkeletonRemapping::RetargetBoneTranslationToTargetSkeleton ( int32  TargetSkeletonBoneIndex, const FVector &  SourceTranslation  ) const

inline

Get the specified bone translation retargeted from the source skeleton onto the target skeleton, corrected for differences between source and target rest poses

Parameters

TargetSkeletonBoneIndex	Skeleton bone index on the target skeleton
SourceTranslation	Bone translation from the corresponding bone on the source skeleton

Returns

Translation mapped onto the target skeleton

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Engine/Public/Animation/SkeletonRemapping.h
• Engine/Source/Runtime/Engine/Private/Animation/SkeletonRemapping.cpp