1. Epic GamesDeveloper
  3. UMirrorDataTable

UMirrorDataTable

Data table for mirroring bones, notifies, and curves.

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

Inheritance Hierarchy

References

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

Syntax

class UMirrorDataTable : public UDataTable

Remarks

Data table for mirroring bones, notifies, and curves. The mirroring table allows self mirroring with entries where the name and mirrored name are identical

Variables

  Type Name Description
Public variable TMap< FName, FName > AnimNotifyToMirrorAnimNotifyMap Map from animation notify to mirrored animation notify.
Public variable TCustomBoneIndexArray< FSkeletonPoseBoneIndex, FSkeletonPoseBoneIndex > BoneToMirrorBoneIndex Index of the mirror bone for a given bone index in the reference skeleton, or INDEX_NONE if the bone is not mirrored.
Public variable TMap< FName, FName > CurveToMirrorCurveMap Map from animation curve to mirrored animation curve.
Public variable TEnumAsByte< EAxis::Type > MirrorAxis  
Public variable TArray< FMirrorFindReplaceExpression > MirrorFindReplaceExpressions  
Public variable TObjectPtr< USkeleton > Skeleton  
Public variable TMap< FName, FName > SyncToMirrorSyncMap Map from sync marker to mirrored sync marker.

Constructors

  Type Name Description
Public function  

UMirrorDataTable ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const void

FillCompactPoseAndComponentRefRotations ( const FBoneContainer& BoneContainer,
TCustomBoneIndexArray< FCompactPoseBoneIndex, FCompactPoseBoneIndex >& OutCompactPoseMirrorBones,
TCustomBoneIndexArray< FQuat, FCompactPoseBoneIndex >& OutComponentSpaceRefRotations
)

 Populates two arrays with a mapping of compact pose mirror bones and reference rotations
Public function Static void

FillCompactPoseMirrorBones ( const FBoneContainer& BoneContainer,
const TCustomBoneIndexArray< FSkeletonPoseBoneIndex, FSkeletonPoseBoneIndex >& MirrorBoneIndexes,
TCustomBoneIndexArray< FCompactPoseBoneIndex, FCompactPoseBoneIndex >& OutCompactPoseMirrorBones
)

 Create Mirror Bone Indices for the provided BoneContainer.
Protected function void Fill BoneToMirrorBoneIndex, CurveMirrorSourceUIDArray, CurveMirrorTargetUIDArray and NotifyToMirrorNotifyIndex based on the Skeleton and Table Contents.
Public function Const void

FillMirrorBoneIndexes ( const USkeleton* Skeleton,
TCustomBoneIndexArray< FSkeletonPoseBoneIndex, FSkeletonPoseBoneIndex >& OutMirrorBoneIndexes
)

 Converts the mirror data table Name -> MirrorName map into an index map for the given ReferenceSkeleton
Public function Static FName

FindBestMirroredBone ( const FName InBoneName,
const FReferenceSkeleton& InRefSkeleton,
EAxis::Type InMirrorAxis,
const float SearchThreshold
)

 Finds the "best matching" mirrored bone across the specified axis.
Public function Const FName

FindReplace ( FName InName
)

 Evaluate the MirrorFindReplaceExpressions on InName and return the replaced value of the first entry that matches
Public function void Populates the table by running the MirrorFindReplaceExpressions on bone names in the Skeleton.
Public function Static FName

GetMirrorName ( FName InName,
const TArray< FMirrorFindReplaceExpression >& MirrorFindReplaceExpressions
)

 Apply the provided find and replace strings against the given name, returning the mirrored name or NAME_None if none of the find strings are found in the name.
Public function Static FName Apply the animation settings mirroring find and replace strings against the given name, returning the mirrored name or NAME_None if none of the find strings are found in the name.

Overridden from UObject

  Type Name Description
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.

Deprecated Variables

  Type Name Description
Public variable TArray< SmartName::UID_Type > CurveMirrorSourceUIDArray UID-based mirroring has been remove, please use CurveToMirrorCurveMap.
Public variable TArray< SmartName::UID_Type > CurveMirrorTargetUIDArray UID-based mirroring has been remove, please use CurveToMirrorCurveMap.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page