UMirrorDataTable

Data table for mirroring bones, notifies, and curves.

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public variable

TMap< FName, FN...

 

AnimNotifyToMirrorAnimNotifyMap

Map from animation notify to mirrored animation notify.

Public variable

TCustomBoneInde...

 

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

TArray< SmartNa...

 

CurveMirrorSourceUIDArray

Array with entries the source UIDs of curves that should be mirrored.

Public variable

TArray< SmartNa...

 

CurveMirrorTargetUIDArray

Array with the target UIDs of curves that should be mirrored.

Public variable

TEnumAsByte< EA...

 

MirrorAxis

Public variable

TArray< FMirror...

 

MirrorFindReplaceExpressions

Public variable

TObjectPtr< USk...

 

Skeleton

Public variable

TMap< FName, FN...

 

SyncToMirrorSyncMap

Map from sync marker to mirrored sync marker.

Constructors

Name Description

Public function

UMirrorDataTable

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

void

 

FillCompactPoseMirrorBones

(
    const FBoneContainer& BoneContaine...,
    const TCustomBoneIndexArray< FSkele...,
    TCustomBoneIndexArray< FCompactPose...
)

Create Mirror Bone Indices for the provided BoneContainer.

Protected function

void

 

FillMirrorArrays()

Fill BoneToMirrorBoneIndex, CurveMirrorSourceUIDArray, CurveMirrorTargetUIDArray and NotifyToMirrorNotifyIndex based on the Skeleton and Table Contents.

Public function Const

void

 

FillMirrorBoneIndexes

(
    const FReferenceSkeleton& Referenc...,
    TCustomBoneIndexArray< FSkeletonPos...
)

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

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

 

FindReplaceMirroredNames()

Populates the table by running the MirrorFindReplaceExpressions on bone names in the Skeleton.

Public function Static

FName

 

GetMirrorName

(
    FName InName,
    const TArray< FMirrorFindReplaceExp...
)

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

 

GetSettingsMirrorName

(
    FName InName
)

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

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PreEditChange

(
    FProperty* PropertyAboutToChan...
)

This is called when a property is about to be modified externally