UMetaHumanCharacterEditorSubsystem

Subsystem used to interface with the [UMetaHumanCharacter](API\Plugins\MetaHumanCharacter\UMetaHumanCharacter) asset.

API > API/Plugins > API/Plugins/MetaHumanCharacterEditor

Subsystem used to interface with the UMetaHumanCharacter asset. Any edits to a MetaHumanCharacter that may need to be exposed as an API should be done as part of this class, as UFUNCTIONs declared here are automatically exposed

   
Name UMetaHumanCharacterEditorSubsystem
Type class
Header File /Engine/Plugins/MetaHuman/MetaHumanCharacter/Source/MetaHumanCharacterEditor/Public/MetaHumanCharacterEditorSubsystem.h
Include Path #include "MetaHumanCharacterEditorSubsystem.h"

Syntax

UCLASS (BlueprintType)  
class UMetaHumanCharacterEditorSubsystem :  
    public UEditorSubsystem ,  
    public FTickableEditorObject

Inheritance Hierarchy

Structs

Name Remarks
FMetaHumanCharacterIdentityModels  

Enums

Public

Name Remarks
EBodyMeshUpdateMode Body Editing

Typedefs

Name Type Remarks Include Path
FMetaHumanOnDownloadingTexturesStateChanged TMulticastDelegate_OneParam< void, TNotNull< const UMetaHumanCharacter * > > Callback when downloading textures state changes in editor MetaHumanCharacterEditorSubsystem.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnDownloadingTexturesStateChanged FMetaHumanOnDownloadingTexturesStateChanged   MetaHumanCharacterEditorSubsystem.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsAddingObjectToEdit bool True if TryAddObjectToEdit is running. MetaHumanCharacterEditorSubsystem.h  
CharacterCloudRequests TMap< TObjectKey< UMetaHumanCharacter >, FMetaHumanCharacterEditorCloudRequests > Map all the live cloud requests for a given MetaHuman Character. MetaHumanCharacterEditorSubsystem.h  
CharacterDataMap TMap< TObjectKey< UMetaHumanCharacter >, TSharedRef< FMetaHumanCharacterEditorData > > Map a MetaHuman Character to the data it needs while being edited. MetaHumanCharacterEditorSubsystem.h  
CharacterIdentities TSortedMap< EMetaHumanCharacterTemplateType, FMetaHumanCharacterIdentityModels > Map with loaded Character Identity Models. MetaHumanCharacterEditorSubsystem.h  
CharacterInstanceUpdatedDelegateHandle FDelegateHandle Delegate handle for instance update. MetaHumanCharacterEditorSubsystem.h  
CharacterMeshImportContexts TMap< TObjectKey< UMetaHumanCharacter >, FMetaHumanCharacterEditorMeshImportContext > Map async mesh import contexts for each MetaHuman Character. MetaHumanCharacterEditorSubsystem.h  
FaceTextureSynthesizer FMetaHumanFaceTextureSynthesizer Face Synthesizer to be shared between all editable objects. MetaHumanCharacterEditorSubsystem.h  
MetaHumanBodyArchetypeMesh TObjectPtr< USkeletalMesh >   MetaHumanCharacterEditorSubsystem.h  
MetaHumanFaceArchetypeMesh TObjectPtr< USkeletalMesh > Cached archetype meshes imported from DNA. MetaHumanCharacterEditorSubsystem.h  
SkinToneTexture TWeakObjectPtr< class UTexture2D > Skin Tone Texture created from FaceTextureSynthesizer used in UI skin tone picker. MetaHumanCharacterEditorSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddFaceLandmark ( TNotNull< const UMetaHumanCharacter* > InCharacter,
int32 InMeshVertexIndex
)

 Adds additional custom landmark manipulator on a given mesh surface point. MetaHumanCharacterEditorSubsystem.h  

TSharedPtr< IDNAReader > AlignFaceDNAWithBody ( TNotNull< UMetaHumanCharacter* > InCharacter,
TSharedPtr< IDNAReader > InFaceDNAReader,
bool bUpdateDescendentFaceJoints
)

 Adapts the given face DNA to fit the character's current body, returning the corrected DNA. MetaHumanCharacterEditorSubsystem.h  

bool AlignToTargetMeshes ( UMetaHumanCharacter* InMetaHumanCharacter,
const FMetaHumanCharacterTargetMeshKey& InTargetMeshKey,
const FConformTargetParams& InConformTargetParams
)

 Synchronously aligns tthe body and head meshes to target meshes Python/Blueprint-friendly wrapper that calls AlignToTargetMeshesAsync in blocking mode. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

bool AlignToTargetMeshesAsync ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
const FMetaHumanCharacterTargetMeshKey& InTargetMeshKey,
const FConformTargetParams& InConformTargetParams,
bool bBlocking
)

 Rigidly aligns the character state to the target meshes MetaHumanCharacterEditorSubsystem.h  

TSharedPtr< IDNAReader > ApplyBodyDNA ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedRef< IDNAReader > InBodyDNAReader,
bool bImportMesh
)

 Updates the body editing state with the given DNA. MetaHumanCharacterEditorSubsystem.h  

void ApplyBodyState ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedRef< const FMetaHumanCharacterBodyIdentity::FState > InState,
EBodyMeshUpdateMode InUpdateMode
)

 Applies the given custom body state to MetaHuman Character Actors registered against the character. MetaHumanCharacterEditorSubsystem.h  

void ApplyEyesSettings ( TNotNull< UMetaHumanCharacter* > InCharacter,
const FMetaHumanCharacterEyesSettings& InEyesSettings
) const

 Eyes editing Updates the editing state of the Character with the given eyes settings MetaHumanCharacterEditorSubsystem.h  

TSharedPtr< IDNAReader > ApplyFaceDNA ( TNotNull< UMetaHumanCharacter* > InCharacter,
TSharedPtr< IDNAReader > InFaceDNAReader,
bool& bOutUpdatedFaceMesh,
ELodUpdateOption InLodUpdateOption
)

   MetaHumanCharacterEditorSubsystem.h  

bool ApplyFaceDNA ( TNotNull< UMetaHumanCharacter* > InCharacter,
TSharedRef< IDNAReader > InFaceDNAReader,
ELodUpdateOption InLodUpdateOption
)

 Updates the face editing state and SkelMesh from the given DNA. Does NOT modify the DNA. MetaHumanCharacterEditorSubsystem.h  

TSharedPtr< IDNAReader > ApplyFaceDNA ( TNotNull< UMetaHumanCharacter* > InCharacter,
TSharedPtr< IDNAReader > InFaceDNAReader,
ELodUpdateOption InLodUpdateOption
)

   MetaHumanCharacterEditorSubsystem.h  

void ApplyFaceEvaluationSettings ( TNotNull< UMetaHumanCharacter* > InCharacter,
const FMetaHumanCharacterFaceEvaluationSettings& InFaceEvaluationSettings
) const

 Updates the face evaluation settings (vertex deltas and vertex geometry delta) of all the actors associated with the given character. MetaHumanCharacterEditorSubsystem.h  

void ApplyFaceState ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedRef< const FMetaHumanCharacterIdentity::FState > InState
)

 Face sculpting and editing Applies the given state in the MetaHuman Character Actors registered against the character. MetaHumanCharacterEditorSubsystem.h  

void ApplyHeadModelSettings ( TNotNull< UMetaHumanCharacter* > InCharacter,
const FMetaHumanCharacterHeadModelSettings& InHeadModelSettings,
bool bIgnoreGrooms
)

 Updates the Head Model (Eyelashes) of all the actors associated with the given character. MetaHumanCharacterEditorSubsystem.h  

void ApplyMakeupSettings ( TNotNull< UMetaHumanCharacter* > InCharacter,
const FMetaHumanCharacterMakeupSettings& InMakeupSettings
) const

 Makeup editing Updates the editing state of the Character with the given makeup settings MetaHumanCharacterEditorSubsystem.h  

void ApplySkinSettings ( TNotNull< UMetaHumanCharacter* > InCharacter,
const FMetaHumanCharacterSkinSettings& InSkinSettings
) const

 Updates the Skin material of all the actors associated with the given character. MetaHumanCharacterEditorSubsystem.h  

void AutoRigFace ( TNotNull< UMetaHumanCharacter* > InCharacter,
const UE::MetaHuman::ERigType InRigType
)

 Method which handles calls to AutoRigService. MetaHumanCharacterEditorSubsystem.h  

TArray< FVector3f > BlendBodyRegion ( TNotNull< const UMetaHumanCharacter* > InCharacter,
int32 InRegionIndex,
EBodyBlendOptions InBodyBlendOptions,
const TSharedPtr< const FMetaHumanCharacterBodyIdentity::FState >& InStartState,
const TArray< TSharedPtr< const FMetaHumanCharacterBodyIdentity::FState > >& InPresetStates,
TConstArrayView< float > InPresetWeights
)

 Blends Face region though preset states. MetaHumanCharacterEditorSubsystem.h  

TArray< FVector3f > BlendFaceRegion ( TNotNull< const UMetaHumanCharacter* > InCharacter,
int32 InRegionIndex,
const TSharedPtr< const FMetaHumanCharacterIdentity::FState >& InStartState,
const TArray< TSharedPtr< const FMetaHumanCharacterIdentity::FState > >& InPresetStates,
TConstArrayView< float > InPresetWeights,
EBlendOptions InBlendOptions,
bool bInBlendSymmetrically
)

 Blends Face region though preset states. MetaHumanCharacterEditorSubsystem.h  
Assemble a MetaHuman Character. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Assembly"

bool CanBuildMetaHuman ( TNotNull< const UMetaHumanCharacter* > InCharacter,
FText& OutErrorMessage
)

 Checks if MetaHuman character is ready for building. MetaHumanCharacterEditorSubsystem.h  

bool CanBuildMetaHuman ( const UMetaHumanCharacter* InCharacter,
bool bInLogError
)

 Checks if MetaHuman character is ready for assembly. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Assembly"

void CancelMeshAsyncProcess ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter
)

 Cancels any async mesh import process MetaHumanCharacterEditorSubsystem.h  

void CommitBodyDNA ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
TSharedRef< class IDNAReader > InBodyDNAReader,
bool bFixedBodyType
)

 Commits the Body DNA into the Character asset in order to be serialized when the asset is saved, Sets the Character as having a fixed body type with bFixedBodyType. MetaHumanCharacterEditorSubsystem.h  

void CommitBodyState ( UMetaHumanCharacter* InCharacter
)

 Commits the Body State of the given Character to be serialized. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Sculpting"

void CommitBodyState ( TNotNull< UMetaHumanCharacter* > InCharacter,
TSharedRef< const FMetaHumanCharacterBodyIdentity::FState > InState,
EBodyMeshUpdateMode InUpdateMode
)

 Commits the Body State into the Character asset in order to be serialized when the asset is saved. MetaHumanCharacterEditorSubsystem.h  

void CommitEyesSettings ( UMetaHumanCharacter* InCharacter,
const FMetaHumanCharacterEyesSettings& InEyesSettings
) const

 Commits the eyes settings to the character and updates the associated actors. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Eyes"

void CommitFaceDNA ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
TSharedRef< class IDNAReader > InFaceDNAReader
)

 Commits the Face DNA into the Character asset in order to be serialized when the asset is saved. MetaHumanCharacterEditorSubsystem.h  

void CommitFaceEvaluationSettings ( TNotNull< UMetaHumanCharacter* > InCharacter,
const FMetaHumanCharacterFaceEvaluationSettings& InFaceEvaluationSettings
)

 Set all the face evaluation settings to the character and apply the changes to all the registered actors. MetaHumanCharacterEditorSubsystem.h  

void CommitFaceState ( UMetaHumanCharacter* InCharacter
)

 Commits the Face State of the given Character to be serialized. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Sculpting"

void CommitFaceState ( TNotNull< UMetaHumanCharacter* > InCharacter,
TSharedRef< const FMetaHumanCharacterIdentity::FState > InState
)

 Commits the Face State into the Character asset in order to be serialized when the asset is saved. MetaHumanCharacterEditorSubsystem.h  

void CommitHeadModelSettings ( UMetaHumanCharacter* InMetaHumanCharacter,
const FMetaHumanCharacterHeadModelSettings& InHeadModelSettings
)

 Set all the Head Model settings to the character and apply the changes to all the registered actors. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Model"

void CommitMakeupSettings ( UMetaHumanCharacter* InCharacter,
const FMetaHumanCharacterMakeupSettings& InMakeupSettings
) const

 Commits the makeup settings to the character and updates the associated actors. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Makeup"

void CommitPosedStateAsAPose ( UMetaHumanCharacter* InMetaHumanCharacter,
const FMetaHumanCharacterTargetMeshKey& InTargetMeshKey
)

 After conforming body state in pose, finalizes body and face states by evaluating solved body state in MetaHuman A Pose, and updating face state from it. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

void CommitSkinSettings ( UMetaHumanCharacter* InCharacter,
const FMetaHumanCharacterSkinSettings& InSkinSettings
)

 Set all the skin settings to the character and apply the changes to all registered actors. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Texture Synthesis"

void CommitTargetMeshKeypoints ( UMetaHumanCharacter* InMetaHumanCharacter,
const FMetaHumanCharacterTargetMeshKey& InTargetMeshKey,
const FMetaHumanCharacterTargetKeyPoints& InTargetMeshKeyPoints,
const TMap< FName, EKeyPointType >& InKeyPointTypes
)

 Commit the target mesh keypoints to the character (filters out preset keypoints, only commits Custom) MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

void CommitTargetMeshTrackingResults ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
const FMetaHumanCharacterTargetMeshKey& InTargetMeshKey,
const FMetaHumanCharacterTargetTrackingResults& InTrackingResults
)

 Commit the target mesh tracking results to the character MetaHumanCharacterEditorSubsystem.h  

bool CompareBodyState ( const UMetaHumanCharacter* InCharacter1,
const UMetaHumanCharacter* InCharacter2,
float InTolerance
) const

 Evaluate the body state for each of the supplied characters, and compare the vertices and vertex normals Requires the characters to have been added for edit using TryAddObjectToEdit Returns true if all corresponding vertices and vertex normals are within InTolerance of each other in terms of vector norm MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Testing"

bool CompareFaceState ( const UMetaHumanCharacter* InCharacter1,
const UMetaHumanCharacter* InCharacter2,
float InTolerance
) const

 Evaluate the face state for each of the supplied characters, and compare the vertices and vertex normals Requires the characters to have been added for edit using TryAddObjectToEdit Returns true if all corresponding vertices and vertex normals are within InTolerance of each other in terms of vector norm MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Testing"

bool ConformBody ( UMetaHumanCharacter* InMetaHumanCharacter,
const TArray< FVector >& InVertices,
const TArray< FVector >& InJointRotations,
bool bRepose,
bool bEstimateJointsFromMesh
)

 Blueprint exposed version of the ConformBody functions. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use ConformBodyToTarget instead.")

bool ConformBody ( UMetaHumanCharacter* InMetaHumanCharacter,
const TArray< FVector3f >& InVertices,
const TArray< FVector3f >& InJointRotations,
bool bTargetIsInAPose,
bool bEstimateJointsFromMesh
)

 Conforms the body mesh to target parameters MetaHumanCharacterEditorSubsystem.h  

bool ConformBodyToTarget ( UMetaHumanCharacter* InMetaHumanCharacter,
const TArray< FVector3f >& InVertices,
const TArray< FVector3f >& InJointRotations,
bool bTargetIsInAPose,
bool bEstimateJointsFromMesh
)

   MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

bool ConformTargetMeshesAsync ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
const FMetaHumanCharacterTargetMeshKey& InTargetMeshKey,
const FConformTargetParams& InConformTargetParams,
bool bBlocking
)

 Conforms the body and head meshes to target meshes MetaHumanCharacterEditorSubsystem.h  

bool ConformToTargetMeshes ( UMetaHumanCharacter* InMetaHumanCharacter,
const FMetaHumanCharacterTargetMeshKey& InTargetMeshKey,
const FConformTargetParams& InConformTargetParams
)

 Synchronously conforms the body and head meshes to target parameters. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"
Creates a copy of the current body editing state. MetaHumanCharacterEditorSubsystem.h  
Creates a copy of the current face editing state. MetaHumanCharacterEditorSubsystem.h  

USkeletalMesh * CreateCombinedFaceAndBodyMesh ( TNotNull< const UMetaHumanCharacter* > InCharacter,
const FString& InAssetPathAndName,
const bool bOverwriteExisting
)

 Returns combined face and body mesh for the given character. MetaHumanCharacterEditorSubsystem.h  

TScriptInterface< IMetaHumanCharacterEditorActorInterface > CreateMetaHumanCharacterEditorActor ( TNotNull< UMetaHumanCharacter* > InCharacter,
TNotNull< class UWorld* > InWorld
)

 Spawns and initializes an actor implementing IMetaHumanCharacterEditorActorInterface in the given world. MetaHumanCharacterEditorSubsystem.h  

void CreateMetaHumanInvisibleDrivingActor ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TScriptInterface< IMetaHumanCharacterEditorActorInterface > InEditorActorInterface,
TNotNull< class UWorld* > InWorld
)

 Create invisible driving actor. MetaHumanCharacterEditorSubsystem.h  

TNotNull< const USkeletalMesh * > Debug_GetBodyEditMesh ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

   MetaHumanCharacterEditorSubsystem.h  

TNotNull< const USkeletalMesh * > Debug_GetFaceEditMesh ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

   MetaHumanCharacterEditorSubsystem.h  

void DestroyMetaHumanCharacterEditorActor ( TScriptInterface< class IMetaHumanCharacterEditorActorInterface > InCharacterActor
)

 Destroys an editor actor previously created via CreateMetaHumanCharacterEditorActor and unregisters it from the character's actor list. MetaHumanCharacterEditorSubsystem.h  

void DisableAnimation ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Disable animation. This will disconnect the preview character from the invisible driving actor. MetaHumanCharacterEditorSubsystem.h  

void DisableSkeletalPostProcessing ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Disable skeletal post-processing. This will enable running the face and body rig and correctives. MetaHumanCharacterEditorSubsystem.h  

void EnableAnimation ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Enable animation. This will connect the preview character to the invisible driving actor. MetaHumanCharacterEditorSubsystem.h  

void EnableSkeletalPostProcessing ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Enable skeletal post-processing. This will enable running the face and body rig and correctives. MetaHumanCharacterEditorSubsystem.h  

FVector2f EstimateSkinTone ( const FLinearColor& InSkinTone,
const int HFIndex
) const

 Estimates the skin tone UI values from an sRGB colour. MetaHumanCharacterEditorSubsystem.h  

bool FitFaceStateFromBodyWithEyesTeethDNA ( UMetaHumanCharacter* InMetaHumanCharacter,
const FString& InFaceDnaFilePath
)

 Updates the face state to fit the current body state, then re-fits teeth and eyes using vertex positions read from a face DNA file. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

bool FitFaceStateFromBodyWithEyesTeethDNA ( UMetaHumanCharacter* InMetaHumanCharacter,
TSharedRef< class IDNAReader > InFaceDna
)

 Updates the face state to fit the current body state, then re-fits teeth and eyes using vertex positions read directly from a face DNA reader. MetaHumanCharacterEditorSubsystem.h  

bool FitFaceStateFromBodyWithEyesTeethTemplate ( UMetaHumanCharacter* InMetaHumanCharacter,
UObject* InTeethMesh,
UObject* InLeftEyeMesh,
UObject* InRightEyeMesh,
bool bInMatchVerticesByUVs
)

 Updates the face state to fit the current body state, and optionally re-fits teeth and/or eyes using vertices extracted from the supplied template mesh objects. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"
Fit the character to the supplied vertices. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

bool FitStateToTargetVertices ( TNotNull< UMetaHumanCharacter* > InCharacter,
const TMap< EHeadFitToTargetMeshes, TArray< FVector3f > >& InTargetVertices,
const FFitToTargetOptions& InFitToTargetOptions
)

 Fit the state to the supplied target vertices, which will use whatever part(s) the user has supplied to fit the model EHeadFitToTargetMeshes::Head vertices must always be supplied in the InTargetVertices, using the supplied fitting options. MetaHumanCharacterEditorSubsystem.h  

bool FitToBodyDna ( TNotNull< UMetaHumanCharacter* > InCharacter,
TSharedRef< class IDNAReader > InBodyDna,
EMetaHumanCharacterBodyFitOptions InBodyFitOptions
)

 Fit the state to the supplied body DNA. Returns true if successful, false otherwise MetaHumanCharacterEditorSubsystem.h  

bool FitToFaceDna ( TNotNull< UMetaHumanCharacter* > InCharacter,
TSharedRef< class IDNAReader > InFaceDna,
const FFitToTargetOptions& InFitToTargetOptions
)

 Fit the state to the supplied face DNA, using the supplied fitting options. MetaHumanCharacterEditorSubsystem.h  

void ForEachCharacterActor ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TFunction< void(TScriptInterface< class IMetaHumanCharacterEditorActorInterface >)> InFunc
)

 Utility function that invokes a callback for each valid MetaHuman Character Editor Actor registered against the given MetaHuman Character MetaHumanCharacterEditorSubsystem.h  

TArray< FMetaHumanCharacterBodyConstraint > GetBodyConstraints ( const UMetaHumanCharacter* InCharacter,
bool bScaleMeasurementRangesWithHeight
) const

 Gets the list of body constrains from the underlying parametric body model. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Sculpting"

TNotNull< const USkeletalMesh * > GetBodyEditMesh ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Returns the body editing mesh for the character. MetaHumanCharacterEditorSubsystem.h  

TArray< FVector3f > GetBodyGizmos ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Returns the list of body region gizmo positions from the character's state MetaHumanCharacterEditorSubsystem.h  

float GetBodyGlobalDeltaScale ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Gets the body vertex and joint global delta scale MetaHumanCharacterEditorSubsystem.h  

TSharedRef< const FMetaHumanCharacterBodyIdentity::FState > GetBodyState ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Provides read-only access to the current body editing state. MetaHumanCharacterEditorSubsystem.h  

EMetaHumanClothingVisibilityState GetClothingVisibilityState ( TNotNull< UMetaHumanCharacter* > InCharacter
)

 Gets the clothing visibility state on any character actor MetaHumanCharacterEditorSubsystem.h  

TSharedRef< const FDNAToSkelMeshMap > GetFaceDnaToSkelMeshMap ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Provides read-only access to the FDNAToSkelMeshMap for the current face editing state. MetaHumanCharacterEditorSubsystem.h  

TNotNull< const USkeletalMesh * > GetFaceEditMesh ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Returns the face editing mesh for the character. MetaHumanCharacterEditorSubsystem.h  

TArray< FVector3f > GetFaceGizmos ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Returns the list of Face Gizmo positions from the Character's state MetaHumanCharacterEditorSubsystem.h  

TArray< FVector3f > GetFaceLandmarks ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Returns the list of Face Landmark positions from the Character's state MetaHumanCharacterEditorSubsystem.h  

void GetFaceLandmarks ( const UMetaHumanCharacter* InCharacter,
TArray< FVector >& OutFaceLandmarks
) const

 Gets the positions of the face landmarks for a given character. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category="MetaHuman|Sculpting"

void GetFaceModelCoefficients ( const UMetaHumanCharacter* InCharacter,
TArray< float >& OutCoefficients
) const

 Gets the coefficients of the underlying face model for the given character. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category="MetaHuman|Sculpting"

TSharedRef< const FMetaHumanCharacterIdentity::FState > GetFaceState ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Provides read-only access to the current face editing state. MetaHumanCharacterEditorSubsystem.h  

const FMetaHumanFaceTextureAttributeMap & GetFaceTextureAttributeMap()

 Gets the texture attribute map associated with the face texture synthesizer. MetaHumanCharacterEditorSubsystem.h  

TObjectPtr< class AMetaHumanInvisibleDrivingActor > GetInvisibleDrivingActor ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Get the invisible driving actor given the character. MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode GetJointsForBodyConforming ( TSharedRef< IDNAReader > BodyDNA,
TArray< FVector3f >& OutJointWorldTranslations,
TArray< FVector3f >& OutJointRotations
)

 Get the joints for performing import from body template MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode GetJointsForBodyConforming ( USkeletalMesh* InTemplateMesh,
TArray< FVector >& OutJointWorldTranslations,
TArray< FVector >& OutJointRotations
)

 Blueprint exposed version of the GetJointsForBodyConforming function. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use GetJointsForBodyConformingFromTemplate instead.")

EImportErrorCode GetJointsForBodyConforming ( USkeletalMesh* InTemplateMesh,
TArray< FVector3f >& OutJointWorldTranslations,
TArray< FVector3f >& OutJointRotations
)

 Get the joints for performing import from body template MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode GetJointsForBodyConformingFromDNA ( const FString& InBodyDnaFilePath,
TArray< FVector3f >& OutJointWorldTranslations,
TArray< FVector3f >& OutJointRotations
)

 Get the body joint data for conforming, from a DNA file path. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

EImportErrorCode GetJointsForBodyConformingFromTemplate ( USkeletalMesh* InTemplateMesh,
TArray< FVector3f >& OutJointWorldTranslations,
TArray< FVector3f >& OutJointRotations
)

   MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

int32 GetMaxHighFrequencyIndex()

 Get the maximum value for the HF index the model supports MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode GetMeshForBodyConforming ( UMetaHumanCharacter* InMetaHumanCharacter,
TSharedRef< IDNAReader > BodyDNA,
TSharedPtr< IDNAReader > HeadDNA,
TArray< FVector3f >& OutVertices
)

 Get the mesh for performing import from body template MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode GetMeshForBodyConforming ( UMetaHumanCharacter* InMetaHumanCharacter,
UObject* InBodyTemplateMesh,
UObject* InHeadTemplateMesh,
bool bInMatchVerticesByUVs,
TArray< FVector >& OutVertices
)

 Blueprint exposed version of the GetMeshForBodyConforming function. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use GetMeshForBodyConformingFromTemplate instead.")

EImportErrorCode GetMeshForBodyConforming ( UMetaHumanCharacter* InMetaHumanCharacter,
UObject* InBodyTemplateMesh,
UObject* InHeadTemplateMesh,
bool bInMatchVerticesByUVs,
TArray< FVector3f >& OutVertices
)

 Get the mesh for performing import from body template MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode GetMeshForBodyConformingFromDNA ( UMetaHumanCharacter* InMetaHumanCharacter,
const FString& InBodyDnaFilePath,
const FString& InHeadDnaFilePath,
TArray< FVector3f >& OutVertices
)

 Get the body mesh vertices for conforming, from DNA file paths. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

EImportErrorCode GetMeshForBodyConformingFromTemplate ( UMetaHumanCharacter* InMetaHumanCharacter,
UObject* InBodyTemplateMesh,
UObject* InHeadTemplateMesh,
bool bInMatchVerticesByUVs,
TArray< FVector3f >& OutVertices
)

   MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

const TSharedRef< FMetaHumanCharacterEditorData > * GetMetaHumanCharacterEditorData ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Gets a readonly view on the character editor data MetaHumanCharacterEditorSubsystem.h  

TWeakObjectPtr< class UTexture2D > GetOrCreateSkinToneTexture()

 Get or create the skin tone texture suitable to be used in the skin tone picker UI The caller is responsible for keeping a reference to the returned texture or it may be GC'ed MetaHumanCharacterEditorSubsystem.h  

TMap< FName, int32 > GetPresetBodyKeyPoints ( const UMetaHumanCharacter* InCharacter
) const

 Get preset keypoints from MetaHumanCreator API (body or head) without committing them MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"
Returns the Collection used to build the Character's preview. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Pipeline"

EMetaHumanCharacterRigState GetRiggingState ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Get the rigging state for the supplied character MetaHumanCharacterEditorSubsystem.h  

FLinearColor GetSkinTone ( const FVector2f& UV
) const

 Gets the skin tone texture color as rgb value MetaHumanCharacterEditorSubsystem.h  

UMaterialInterface * GetTranslucentClothingMaterial()

 Returns the material to apply to clothing when it should be translucent MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode ImportBodyWholeRig ( UMetaHumanCharacter* InMetaHumanCharacter,
const FString& InBodyDnaFilePath,
const FString& InHeadDnaFilePath
)

 Import body as a fully rigged Character from DNA file paths, sets character to a fixed body type MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

EImportErrorCode ImportBodyWholeRig ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
TSharedRef< class IDNAReader > InBodyDna,
TSharedPtr< IDNAReader > InHeadDna
)

 Import body as a fully rigged Character from DNA, sets character to a fixed body type MetaHumanCharacterEditorSubsystem.h  

void ImportFaceDNA ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedPtr< IDNAReader > InFaceDNAReader
)

 Create a face skeletal mesh from the imported DNA. MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode ImportFromBodyDna ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
TSharedRef< class IDNAReader > InBodyDna,
const FImportBodyFromDNAParams& InImportOptions
)

 Either fits the Character body state to the input body DNA, or imports the DNA as-is, depending on options MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode ImportFromBodyTemplate ( UMetaHumanCharacter* InMetaHumanCharacter,
UObject* InTemplateMesh,
EMetaHumanCharacterBodyFitOptions InBodyFitOptions
)

 Fits the Character body state to the conformed mesh of the input asset, which must be a SkelMesh or Static Mesh which has the correct number of vertices. MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode ImportFromFaceDna ( UMetaHumanCharacter* InCharacter,
const FString& InDNAFilePath,
const FImportFromDNAParams& InImportParams
)

 Either fits the Character face state to the input face DNA, or imports the DNA as-is, depending on options. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

EImportErrorCode ImportFromFaceDna ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
TSharedRef< class IDNAReader > InFaceDna,
const FImportFromDNAParams& InImportParams
)

 Either fits the Character face state to the input face DNA, or imports the DNA as-is, depending on options MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode ImportFromIdentity ( UMetaHumanCharacter* InMetaHumanCharacter,
const UMetaHumanIdentity* InMetaHumanIdentity,
const FImportFromIdentityParams& InImportParams
)

 Fits the Character face state to the conformed mesh of the input Identity asset. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

EImportErrorCode ImportFromIdentity ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
TNotNull< const class UMetaHumanIdentity* > InMetaHumanIdentity,
const FImportFromIdentityParams& InImportParams
)

 Fits the Character face state to the conformed mesh of the input Identity asset MetaHumanCharacterEditorSubsystem.h  

EImportErrorCode ImportFromTemplate ( UMetaHumanCharacter* InCharacter,
UObject* InTemplateMesh,
UObject* InTemplateLeftEyeMesh,
UObject* InTemplateRightEyeMesh,
UObject* InTemplateTeethMesh,
const FImportFromTemplateParams& InImportParams
)

 Fits the Character face state to the conformed mesh of the input asset, which must be a SkelMesh or Static Mesh which has the correct number of vertices. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

void InitializeFromPreset ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
TNotNull< const UMetaHumanCharacter* > InPresetCharacter
)

 Initializes metahuman character using selected preset character. MetaHumanCharacterEditorSubsystem.h  

void InitializeMetaHumanCharacter ( TNotNull< UMetaHumanCharacter* > InCharacter
)

 Character and Actor Initialization Initializes all properties from the given MetaHumanCharacter that require loading data from various sources MetaHumanCharacterEditorSubsystem.h  

bool IsAsyncConformPending ( TNotNull< const UMetaHumanCharacter* > InMetaHumanCharacter
) const

 Returns if Async Conform process is pending MetaHumanCharacterEditorSubsystem.h  

bool IsAutoRiggingFace ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Returns true if there is an active request to auto rig the face of the given character MetaHumanCharacterEditorSubsystem.h  

bool IsBodyStateMatchingTargetPosedState ( UMetaHumanCharacter* InMetaHumanCharacter,
const FMetaHumanCharacterTargetMeshKey& InTargetMeshKey
) const

 Returns if the body state is currently matching the target posed state for the given target mesh key MetaHumanCharacterEditorSubsystem.h  

bool IsCharacterOutfitSelected ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Returns true when the input Character has an outfit applied in the currently active edit sesssion MetaHumanCharacterEditorSubsystem.h  

bool IsFixedBodyType ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Is the body a fixed body type, either imported from dna as a whole rig, or a fixed compatibility body MetaHumanCharacterEditorSubsystem.h  

bool IsObjectAddedForEditing ( const UMetaHumanCharacter* InCharacter
) const

 Returns true if the object is registered for editing MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category="MetaHuman|Initialization"

bool IsRequestingHighResolutionTextures ( TNotNull< const UMetaHumanCharacter* > InCharacter
) const

 Returns true if there is pending request for high resolution textures MetaHumanCharacterEditorSubsystem.h  

bool IsTextureSynthesisEnabled()

 Skin Material Editing Returns if the subsystem is able synthesize textures MetaHumanCharacterEditorSubsystem.h  

void NotifyLightingEnvironmentChanged ( TNotNull< UMetaHumanCharacter* > InCharacter
) const

 Used for lighting scenario levels updates, including custom levels and post process levels, signals an update to editor toolkit MetaHumanCharacterEditorSubsystem.h  

void NotifyViewportToolbarRenderingQualityProfileChange ( TNotNull< UMetaHumanCharacter* > InCharacter,
const int32 InIndex
) const

 Used for rendering quality profile update from viewport toolbar, signals an update to editor toolkit MetaHumanCharacterEditorSubsystem.h  

FOnAsyncMeshConformCompleted & OnAsyncMeshConformCompleted ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Returns a reference to a delegate that fires whenever the conform async is completed. MetaHumanCharacterEditorSubsystem.h  

FOnAsyncMeshConformIteration & OnAsyncMeshConformIteration ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Returns a reference to a delegate that fires on each conform async iteration MetaHumanCharacterEditorSubsystem.h  

FOnStudioBackgroundColorChanged & OnBackgroundColorChanged ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

   MetaHumanCharacterEditorSubsystem.h  

FSimpleMulticastDelegate & OnBodyStateChanged ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Returns a reference to a delegate that fires whenever the body editing state of the given character is modified. MetaHumanCharacterEditorSubsystem.h  

FOnCameraFocusRequested & OnCameraFocusRequested ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

   MetaHumanCharacterEditorSubsystem.h  

void OnEditPreviewCollection ( UMetaHumanCharacter* InCharacter
)

 Any code that modifies the preview collection for a Character must call this function afterwards, in order to propagate the edits back to the Character asset. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Pipeline"

FSimpleMulticastDelegate & OnFaceStateChanged ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Returns a reference to a delegate that fires whenever the face editing state of the given character is modified. MetaHumanCharacterEditorSubsystem.h  

FOnNotifyLightingEnvironmentChanged & OnLightEnvironmentChanged ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

   MetaHumanCharacterEditorSubsystem.h  

FOnStudioLightRotationChanged & OnLightRotationChanged ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

   MetaHumanCharacterEditorSubsystem.h  

FOnNotifyLightingEnvironmentChanged & OnLightTonemapperChanged ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Editing environment changes from toolbar options MetaHumanCharacterEditorSubsystem.h  

FOnNotifyLightingEnvironmentChanged & OnNotifyLightingEnvironmentChanged ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

   MetaHumanCharacterEditorSubsystem.h  

FSimpleMulticastDelegate & OnPreviewMaterialChanged ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

   MetaHumanCharacterEditorSubsystem.h  

FSimpleMulticastDelegate & OnTargetMeshKeyPointsChanged ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Returns a reference to a delegate that fires whenever the target-mesh keypoints collection on the given character is modified including undo/redo of keypoint changes. MetaHumanCharacterEditorSubsystem.h  

FOnViewportToolbarRenderingQualityProfileChange & OnViewportToolbarRenderingQualityProfileChange ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

   MetaHumanCharacterEditorSubsystem.h  

bool ParametricFitToCompatibilityBody ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter
)

 Fits the Character body state to the current fixed compatibility body MetaHumanCharacterEditorSubsystem.h  

bool ParametricFitToDnaBody ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter
)

 Fits the Character body state to the fixed body DNA MetaHumanCharacterEditorSubsystem.h  

bool RefineVerticesToTargeAsync ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
const FMetaHumanCharacterTargetMeshKey& InTargetMeshKey,
const FRefinementTargetParams& InRefinementTargetParams
)

 Refines vertices to the target mesh MetaHumanCharacterEditorSubsystem.h  

void RemoveBodyRig ( TNotNull< UMetaHumanCharacter* > InCharacter
)

 Remove the body rig from InCharacter MetaHumanCharacterEditorSubsystem.h  

void RemoveFaceLandmark ( TNotNull< const UMetaHumanCharacter* > InCharacter,
int32 InLandmarkIndex
)

 Removes selected landmark manipulator. MetaHumanCharacterEditorSubsystem.h  

void RemoveFaceRig ( UMetaHumanCharacter* InCharacter
)

 Remove the face rig from InCharacter, reverting the face mesh back to the archetype DNA and unregistering any morph targets. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Auto-Rigging"

void RemoveObjectToEdit ( const UMetaHumanCharacter* InCharacter
)

 Tells the subsystem that a character is no longer being edited. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Initialization"

bool RemoveTexturesAndRigs ( TNotNull< UMetaHumanCharacter* > InCharacter
)

 Removes all data that is not needed to be in the character to make it a preset. MetaHumanCharacterEditorSubsystem.h  
Make a request to auto-rig a character. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Auto-Rigging"

void RequestHighResolutionTextures ( TNotNull< UMetaHumanCharacter* > InCharacter,
ERequestTextureResolution InResolution
)

   MetaHumanCharacterEditorSubsystem.h  
Request high resolution textures for the given character. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Texture Synthesis"

void ResetCharacterFace ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Reset character face. MetaHumanCharacterEditorSubsystem.h  

void ResetParametricBody ( TNotNull< const UMetaHumanCharacter* > InCharacter
)

 Reset the parametric body MetaHumanCharacterEditorSubsystem.h  

void ResetTextureSynthesis()

 Clears all internal model data for Texture Synthesis and re-loads the model using the path in the settings MetaHumanCharacterEditorSubsystem.h  
Runs the editor pipeline (Preview quality) for the given character. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Pipeline"
  • Meta=(ScriptName="AssembleForPreview")

int32 SelectBodyVertex ( TNotNull< const UMetaHumanCharacter* > InCharacter,
const FRay& InRay,
FVector& OutHitVertex,
FVector& OutHitNormal
) const

 Selects a vertex on the body by intersecting the ray with the current body mesh. MetaHumanCharacterEditorSubsystem.h  

int32 SelectFaceVertex ( TNotNull< const UMetaHumanCharacter* > InCharacter,
const FRay& InRay,
FVector& OutHitVertex,
FVector& OutHitNormal
)

 Selects a vertex on the face by intersecting the ray with the current face mesh. MetaHumanCharacterEditorSubsystem.h  

void SetBodyConstraints ( const UMetaHumanCharacter* InCharacter,
const TArray< FMetaHumanCharacterBodyConstraint >& InBodyConstraints
)

 Set body constraints and evaluate the parametric body. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Sculpting"

void SetBodyGlobalDeltaScale ( TNotNull< UMetaHumanCharacter* > InCharacter,
float InBodyGlobalDelta
) const

 Sets the body vertex and joint global delta scale MetaHumanCharacterEditorSubsystem.h  

bool SetBodyJoints ( UMetaHumanCharacter* InMetaHumanCharacter,
const TArray< FVector3f >& InComponentJointTranslations,
const TArray< FVector3f >& InJointRotations,
bool bImportHelperJoints
)

 Set custom body joints MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

bool SetBodyMesh ( UMetaHumanCharacter* InMetaHumanCharacter,
const TArray< FVector3f >& InVertices,
bool bRepositionHelperJoints
)

 Set custom body neutral mesh MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

void SetClothingVisibilityState ( TNotNull< UMetaHumanCharacter* > InCharacter,
EMetaHumanClothingVisibilityState InState,
bool bUpdateMaterialHiddenFaces
)

 Sets the clothing visibility state on any character actor and optionally updates the body material with character data hidden face map MetaHumanCharacterEditorSubsystem.h  

void SetEvaluateBodyPose ( UMetaHumanCharacter* InMetaHumanCharacter,
bool bEvaluateBodyPose
)

 Sets to evaluate a pose other than MetaHuman A pose from the state MetaHumanCharacterEditorSubsystem.h  

TArray< FVector3f > SetFaceGizmoPosition ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedRef< const FMetaHumanCharacterIdentity::FState > InState,
int32 InGizmoIndex,
const FVector3f& InPosition,
bool bInSymmetric,
bool bInEnforceBounds
)

 Sets the face gizmo to an exact position. MetaHumanCharacterEditorSubsystem.h  

TArray< FVector3f > SetFaceGizmoRotation ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedRef< const FMetaHumanCharacterIdentity::FState > InState,
int32 InGizmoIndex,
const FVector3f& InRotation,
bool bInSymmetric,
bool bInEnforceBounds
)

 Sets the face gizmo to an exact rotation. MetaHumanCharacterEditorSubsystem.h  

TArray< FVector3f > SetFaceGizmoScale ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedRef< const FMetaHumanCharacterIdentity::FState > InState,
int32 InGizmoIndex,
float InScale,
bool bInSymmetric,
bool bInEnforceBounds
)

 Scales the given gizmo. MetaHumanCharacterEditorSubsystem.h  

void SetFaceModelCoefficients ( const UMetaHumanCharacter* InCharacter,
const TArray< float >& InCoefficients
)

 Sets the coefficients of the underlying face model for the given character. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Sculpting"

void SetGuideTexturesOnActor ( TNotNull< UMetaHumanCharacter* > InCharacter,
bool bShowGuides
)

 Set guide textures on matcap material used in Import Tool, this won't work if character doesn't have matcap material applied MetaHumanCharacterEditorSubsystem.h  

void SetMetaHumanBodyType ( TNotNull< const UMetaHumanCharacter* > InCharacter,
EMetaHumanBodyType InBodyType,
EBodyMeshUpdateMode InUpdateMode
)

 Sets the MetaHuman body on the body editing state MetaHumanCharacterEditorSubsystem.h  

bool SetToTargetPosedState ( TNotNull< UMetaHumanCharacter* > InCharacter,
const FMetaHumanCharacterTargetMeshKey& InTargetMeshKey
)

 Sets the character state to the character's posed state MetaHumanCharacterEditorSubsystem.h  

AActor * SpawnMetaHumanActor ( UMetaHumanCharacter* InCharacter,
bool bKeepTransient
)

 Spawns a MetaHuman Editor Actor in the main editor level. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Actor"

void ToggleEyelashesGrooms ( TNotNull< UMetaHumanCharacter* > InMetaHumanCharacter,
const FMetaHumanCharacterEyelashesProperties& InEyelashesProperties
)

 Applies or removes eyelashes grooms according to properties. MetaHumanCharacterEditorSubsystem.h  

bool TrackFaceLandmarksFromImage ( const TArray< FColor >& InImageData,
int32 InWidth,
int32 InHeight,
TMap< FString, FTrackingPoints >& OutCurveTrackingPoints
)

 Run face landmark detection on an image and return tracking contour curves. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

TArray< FVector3f > TranslateFaceLandmark ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedRef< const FMetaHumanCharacterIdentity::FState > InState,
int32 InLandmarkIndex,
const FVector3f& InDelta,
bool bInTranslateSymmetrically
)

 Translates the given landmark by a delta. MetaHumanCharacterEditorSubsystem.h  

void TranslateFaceLandmarks ( const UMetaHumanCharacter* InCharacter,
const TArray< int32 >& InLandmarkIndices,
const TArray< FVector >& InDeltas
)

 Translates the face landmarks by the given deltas. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Sculpting"

bool TryAddObjectToEdit ( UMetaHumanCharacter* InCharacter
)

 Registers an object to be edited. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Initialization"

bool TryGenerateCharacterAssets ( TNotNull< const UMetaHumanCharacter* > InCharacter,
UObject* InOuterForGeneratedAssets,
const FMetaHumanCharacterGeneratedAssetOptions& InOptions,
FMetaHumanCharacterGeneratedAssets& OutGeneratedAssets
)

   MetaHumanCharacterEditorSubsystem.h  

bool TryGenerateCharacterAssets ( TNotNull< const UMetaHumanCharacter* > InCharacter,
UObject* InOuterForGeneratedAssets,
FMetaHumanCharacterGeneratedAssets& OutGeneratedAssets
)

 Build and Export Generates assets, such as meshes and textures, so that other code systems can render the Character. MetaHumanCharacterEditorSubsystem.h  

bool TryGetCharacterPreviewAssets ( TNotNull< const UMetaHumanCharacter* > InCharacter,
const FMetaHumanCharacterPreviewAssetOptions& InOptions,
FMetaHumanCharacterPreviewAssets& OutPreviewAssets
)

   MetaHumanCharacterEditorSubsystem.h  

bool TryGetCharacterPreviewAssets ( TNotNull< const UMetaHumanCharacter* > InCharacter,
FMetaHumanCharacterPreviewAssets& OutPreviewAssets
)

 Fetches editor-owned assets needed for the preview build, such as the meshes being actively edited by the Character asset editor. MetaHumanCharacterEditorSubsystem.h  

bool TryGetMetaHumanCharacterEditorActorClass ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSubclassOf< AActor >& OutActorClass,
FText& OutFailureReason
) const

 Gets the class of actor that will be spawned by CreateMetaHumanCharacterEditorActor if there are no errors. MetaHumanCharacterEditorSubsystem.h  

void UpdateAlwaysUseHairCardsOption ( TNotNull< UMetaHumanCharacter* > InCharacter,
bool bInAlwaysUseHairCards
)

 Updates character actor groom components to always use cards instead of strands. MetaHumanCharacterEditorSubsystem.h  

void UpdateBackgroundColor ( TNotNull< UMetaHumanCharacter* > InCharacter,
const FLinearColor& InBackgroundColor
) const

 Updates the background color of the lighting environment MetaHumanCharacterEditorSubsystem.h  

void UpdateCharacterLOD ( TNotNull< UMetaHumanCharacter* > InCharacter,
const EMetaHumanCharacterLOD NewLODValue
) const

 Updates the Character Level of detail shown in Editor. MetaHumanCharacterEditorSubsystem.h  

void UpdateCharacterPreviewMaterial ( TNotNull< UMetaHumanCharacter* > InCharacter,
EMetaHumanCharacterSkinPreviewMaterial InPreviewMaterial,
bool bWritePersistentState
) const

 Update the currently active preview material for the character. MetaHumanCharacterEditorSubsystem.h  

void UpdateEyelashesVariantFromProperties ( TSharedRef< FMetaHumanCharacterIdentity::FState > InOutFaceState,
const FMetaHumanCharacterEyelashesProperties& InEyelashesProperties
) const

 Utility function that sets the eyelashes variant to the input state based on the eyelashes type property MetaHumanCharacterEditorSubsystem.h  

void UpdateHFVariantFromSkinProperties ( TSharedRef< FMetaHumanCharacterIdentity::FState > InOutFaceState,
const FMetaHumanCharacterSkinProperties& InSkinProperties
) const

 Utility function that sets the high frequency variant to the input state based on the skin texture property MetaHumanCharacterEditorSubsystem.h  

void UpdateLightingEnvironment ( TNotNull< UMetaHumanCharacter* > InCharacter,
EMetaHumanCharacterEnvironment InLightingEnvironment
) const

 !!!!DEPRECATED!!!! USE NotifyLightingEnvironmentChanged Updates the Environment Lighting studio. MetaHumanCharacterEditorSubsystem.h  

void UpdateLightRotation ( TNotNull< UMetaHumanCharacter* > InCharacter,
float InRotation
) const

   MetaHumanCharacterEditorSubsystem.h  

void UpdateMatcapMaterialColorOnActor ( TNotNull< UMetaHumanCharacter* > InCharacter,
FLinearColor InColor
)

 Update color on matcap material used in Import Tool, this won't work if character doesn't have matcap material applied MetaHumanCharacterEditorSubsystem.h  

void UpdateTeethVariantFromProperties ( TSharedRef< FMetaHumanCharacterIdentity::FState > InOutFaceState,
const FMetaHumanCharacterTeethProperties& InTeethProperties,
bool bInUseExpressions
) const

 Utility function that sets the teeth variant to the input state based on the teeth type property Also allows the user to turn off the (teeth) expressions at the end of using the tool MetaHumanCharacterEditorSubsystem.h  

void UpdateTonemapperOption ( TNotNull< UMetaHumanCharacter* > InCharacter,
bool bInToneMapperEnabled
) const

 !!!!DEPRECATED!!!! USE NotifyLightingEnvironmentChanged Updates the Environment Lighting studio. MetaHumanCharacterEditorSubsystem.h  

void UpdateTranslucencyOnActor ( TNotNull< UMetaHumanCharacter* > InCharacter,
float InTranslucency
)

 Update translucency on matcap material used in Import Tool, this won't work if character doesn't have matcap material applied MetaHumanCharacterEditorSubsystem.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

 Subsystem Initialization MetaHumanCharacterEditorSubsystem.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   MetaHumanCharacterEditorSubsystem.h  

virtual bool IsTickable()

   MetaHumanCharacterEditorSubsystem.h  

virtual void Tick ( float InDeltaTime
)

   MetaHumanCharacterEditorSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   MetaHumanCharacterEditorSubsystem.h  
  MetaHumanCharacterEditorSubsystem.h  

static void ApplyEyesSettings ( TSharedRef< FMetaHumanCharacterEditorData > InCharacterData,
const FMetaHumanCharacterEyesSettings& InEyesSettings
)

 Utility function to apply the eyes settings in the character data and update the eyes material with the eyes settings MetaHumanCharacterEditorSubsystem.h  
Sets the given face state on the Character Data. MetaHumanCharacterEditorSubsystem.h  

static void ApplyMakeupSettings ( TSharedRef< FMetaHumanCharacterEditorData > InCharacterData,
const FMetaHumanCharacterMakeupSettings& InMakeupSettings
)

 Utility function to apply the makeup settings in the character data and update the face material with the makeup settings. MetaHumanCharacterEditorSubsystem.h  

static bool CompareFaceTextures ( const UMetaHumanCharacter* InCharacter1,
const UMetaHumanCharacter* InCharacter2,
int32 InPixelTolerance
)

 Compare the face textures for the two supplied characters Does NOT require the characters to have been added for edit Returns true if face textures are identical to within the specified tolerance for each channel of each pixel, false otherwise MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Testing"

static TObjectPtr< UPhysicsAsset > CreatePhysicsAssetForCharacter ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TNotNull< UObject* > InOuter,
TSharedRef< const FMetaHumanCharacterBodyIdentity::FState > InBodyState
)

 Creates the physics asset using body state MetaHumanCharacterEditorSubsystem.h  

static void ForEachCharacterActor ( TSharedRef< FMetaHumanCharacterEditorData > InCharacterData,
TFunction< void(TScriptInterface< class IMetaHumanCharacterEditorActorInterface >)> InFunc
)

 Utility function that invokes a callback for each valid MetaHuman Character Editor Actor registered against the given MetaHuman Character MetaHumanCharacterEditorSubsystem.h  
Utility for obtaining a pointer to the global instance of this subsystem in the editor. MetaHumanCharacterEditorSubsystem.h  

static USkeletalMesh * GetBodyArchetypeMesh ( EMetaHumanCharacterTemplateType InTemplateType,
UObject* OuterForGeneratedAssets
)

 Returns the Body Archetype Mesh for the given template type MetaHumanCharacterEditorSubsystem.h  

static FString GetBodyIdentityModelPath()

 Returns the path to where the body model is stored MetaHumanCharacterEditorSubsystem.h  

static void GetFaceAndBodySkeletalMeshes ( TNotNull< const UMetaHumanCharacter* > InCharacter,
const FEditorDataForCharacterCreationParams& InParams,
USkeletalMesh*& OutFaceMesh,
USkeletalMesh*& OutBodyMesh
)

 Creates Face and Body mesh either by duplicating content browser assets or Interchange system from stored or loaded DNA data MetaHumanCharacterEditorSubsystem.h  

static USkeletalMesh * GetFaceArchetypeMesh ( EMetaHumanCharacterTemplateType InTemplateType,
UObject* OuterForGeneratedAssets
)

 Returns the Face Archetype Mesh for the given template type MetaHumanCharacterEditorSubsystem.h  

static FString GetFaceIdentityTemplateModelPath ( EMetaHumanCharacterTemplateType InTemplateType
)

 Returns the path to where the face models for the given template type are stored MetaHumanCharacterEditorSubsystem.h  

static FString GetLegacyBodiesPath()

 Returns the path to where the legacy bodies are stored MetaHumanCharacterEditorSubsystem.h  

static bool GetMeshDataForConforming ( UObject* InMesh,
TArray< FVector3f >& OutVertices,
TArray< int32 >& OutTriangleIndices
)

 Extract topology vertices and triangle indices from a static or skeletal mesh. MetaHumanCharacterEditorSubsystem.h
  • BlueprintCallable
  • Category="MetaHuman|Conforming"

static ELodUpdateOption GetUpdateOptionForEditing()

   MetaHumanCharacterEditorSubsystem.h  

static void UpdateActorsSkinPreviewMaterial ( TSharedRef< FMetaHumanCharacterEditorData > InCharacterData,
EMetaHumanCharacterSkinPreviewMaterial InPreviewMaterialType,
const FMetaHumanCharacterSkinSettings* InSkinSettings
)

 Update the preview material for the actors corresponding to the character data MetaHumanCharacterEditorSubsystem.h  

static void UpdateBodyMeshInternal ( TSharedRef< FMetaHumanCharacterEditorData > InCharacterData,
const FMetaHumanRigEvaluatedState& InVerticesAndNormals,
ELodUpdateOption InUpdateOption,
bool bInUpdateDnaState
)

   MetaHumanCharacterEditorSubsystem.h  

static void UpdateCharacterBodyMeshFromDNA ( TNotNull< UObject* > InGeneratedAssetsOuter,
const TSharedPtr< IDNAReader >& InDNAReader,
TSharedRef< FMetaHumanCharacterEditorData >& OutCharacterData
)

 Creates body SkeletalMesh from DNA through DNA Interchange system and attaches it to CharacterData->BodyMesh. MetaHumanCharacterEditorSubsystem.h  

static bool UpdateCharacterFaceMeshFromDNA ( TNotNull< UObject* > InGeneratedAssetsOuter,
const TSharedPtr< IDNAReader >& InDNAReader,
TSharedRef< FMetaHumanCharacterEditorData >& OutCharacterData
)

 Updates character face by creating facial SkeletalMesh from DNA through DNA Interchange system and attaches it to CharacterData->FaceMesh. MetaHumanCharacterEditorSubsystem.h  

static void UpdateDebugBoneTransformsFromState ( const TSharedRef< FMetaHumanCharacterEditorData >& InCharacterData
)

 Updates override debug bone transforms used to display body bones during conform MetaHumanCharacterEditorSubsystem.h  

static void UpdateFaceFromBodyInternal ( TSharedRef< FMetaHumanCharacterEditorData > InCharacterData,
ELodUpdateOption InUpdateOption,
bool bInUpdateNeutral
)

   MetaHumanCharacterEditorSubsystem.h  

static void UpdateFaceMeshInternal ( TSharedRef< FMetaHumanCharacterEditorData > InCharacterData,
const FMetaHumanRigEvaluatedState& InVerticesAndNormals,
ELodUpdateOption InUpdateOption
)

 Updates the Face Mesh of the Character using state stored in the actor and the given vertices and vertex normals This function does not evaluate the model and purely updates the skeletal mesh. MetaHumanCharacterEditorSubsystem.h  

static void UpdatePendingHighResBodyTextures ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedRef< FMetaHumanCharacterEditorData > InCharacterData,
TMap< EBodyTextureType, TObjectPtr< UTexture2D > >& OutBodyTextures
)

   MetaHumanCharacterEditorSubsystem.h  

static void UpdatePendingSynthesizedTextures ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedRef< FMetaHumanCharacterEditorData > InCharacterData,
TMap< EFaceTextureType, TObjectPtr< UTexture2D > >& OutSynthesizedFaceTextures
)

 Fills in textures with image data for any pending textures that are ready. MetaHumanCharacterEditorSubsystem.h  

static void UpdatePhysicsAssetFromBodyState ( TNotNull< UPhysicsAsset* > InPhysicsAsset,
TSharedRef< const FMetaHumanCharacterBodyIdentity::FState > InBodyState
)

 Updates a physics asset using body state MetaHumanCharacterEditorSubsystem.h  

static void WaitForSynthesizedTextures ( TNotNull< const UMetaHumanCharacter* > InCharacter,
TSharedRef< FMetaHumanCharacterEditorData > InCharacterData,
TMap< EFaceTextureType, TObjectPtr< UTexture2D > >& OutSynthesizedFaceTextures,
TMap< EBodyTextureType, TObjectPtr< UTexture2D > >& OutBodyTextures
)

 Block until all textures are filled with image data MetaHumanCharacterEditorSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page