Navigation
API > API/Plugins > API/Plugins/MetaHumanIdentity
MetaHuman Identity Asset
Provides the tools to auto-generate a fully rigged Skeletal Mesh of a human face from Capture Data (Mesh or Footage) by tracking the facial features, fitting a Template Mesh having MetaHuman topology to the tracked curves, and sending the resulting mesh to MetaHuman Service, which returns an auto-rigged SkeletalMesh resembling the person from the Capture Data.
The obtained Skeletal Mesh can be used by MetaHuman Performance asset to generate an Animation Sequence from video footage.
MetaHuman Identity Asset Toolkit can also create a full MetaHuman in MetaHuman Creator, downloadable through Quixel Bridge.
| Name | UMetaHumanIdentity |
| Type | class |
| Header File | /Engine/Plugins/MetaHuman/MetaHumanAnimator/Source/MetaHumanIdentity/Public/MetaHumanIdentity.h |
| Include Path | #include "MetaHumanIdentity.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UMetaHumanIdentity : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMetaHumanIdentity
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMetaHumanIdentity() |
MetaHumanIdentity.h |
Classes
| Name | Remarks |
|---|---|
| FOnAutoRigServiceFinishedDynamicDelegate |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnAutoRigServiceFinishedDelegate | TMulticastDelegate_OneParam< void, bool > | MetaHumanIdentity.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AutoRigServiceTitleError | const FText | MetaHumanIdentity.h | |
| AutoRigServiceTitleSuccess | const FText | MetaHumanIdentity.h | |
| IdentityTransactionContext | const TCHAR * | The transaction context identifier for transactions done in the MetaHuman Identity being edited | MetaHumanIdentity.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InvalidationState | EIdentityInvalidationState | MetaHumanIdentity.h | ||
| OnAutoRigServiceFinishedDelegate | FOnAutoRigServiceFinishedDelegate | Delegate called when the pipeline finishes running (used by toolkit) | MetaHumanIdentity.h | |
| OnAutoRigServiceFinishedDynamicDelegate | FOnAutoRigServiceFinishedDynamicDelegate | Dynamic delegate called when the pipeline finishes running. | MetaHumanIdentity.h |
|
| Parts | TArray< TObjectPtr< class UMetaHumanIdentityPart > > | The list of Parts the make this Identity. | MetaHumanIdentity.h |
|
| ThumbnailInfo | TObjectPtr< class UThumbnailInfo > | Information for thumbnail rendering | MetaHumanIdentity.h |
|
| ViewportSettings | TObjectPtr< class UMetaHumanIdentityViewportSettings > | Stores the viewport settings for this MetaHuman Identity | MetaHumanIdentity.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AutoRigProgressNotification | TWeakPtr< class SNotificationItem > | A reference to the notification dialog that shows the autorigging progress | MetaHumanIdentity.h | |
| bBlockingProcessing | bool | MetaHumanIdentity.h | ||
| bIsAutorigging | bool | True if the auto rigging service has been called | MetaHumanIdentity.h | |
| bMetaHumanAuthoringObjectsPresent | bool | MetaHumanIdentity.h | ||
| TrackPipeline | UE::MetaHuman::Pipeline::FPipeline | Pipeline for tracking Promoted Frames | MetaHumanIdentity.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanAddPartOfClass
(
TSubclassOf< class UMetaHumanIdentityPart > InPartClass |
Returns true if the given Part class can be added to the MetaHuman Identity being edited | MetaHumanIdentity.h |
|
bool CanAddPoseOfClass
(
TSubclassOf< class UMetaHumanIdentityPose > InPoseClass, |
Returns true if the given Pose class can be added to the MetaHuman Identity being edited | MetaHumanIdentity.h |
|
void CreateDNAForIdentity
(
bool bInLogOnly |
MetaHumanIdentity.h |
|
|
bool DiagnosticsIndicatesProcessingIssue
(
FText& OutDiagnosticsWarningMessage |
MetaHumanIdentity.h |
|
|
| Export DNA and brows data to files at selected location | MetaHumanIdentity.h |
|
|
SearchType * FindPartOfClass () |
Searches for a Part of the given class in the array of parts. | MetaHumanIdentity.h | |
UMetaHumanIdentityPart * FindPartOfClass
(
TSubclassOf< class UMetaHumanIdentityPart > InPartClass |
Looks for a Part of the given class in the array of parts. Returns nullptr if no Part was found | MetaHumanIdentity.h |
|
FString GetHashedIdentityAssetID() |
Returns a hashed PrimaryAssetType/PrimaryAssetName identifier. Used for telemetry | MetaHumanIdentity.h | |
bool GetMetaHumanAuthoringObjectsPresent() |
MetaHumanIdentity.h | ||
UMetaHumanIdentityPart * GetOrCreatePartOfClass
(
TSubclassOf< class UMetaHumanIdentityPart > InPartClass |
Looks for a Part of the given class in the array of parts. | MetaHumanIdentity.h |
|
UCaptureData * GetPoseCaptureData
(
EIdentityPoseType InPoseType |
MetaHumanIdentity.h | ||
EIdentityErrorCode ImportDNA
(
TSharedPtr< class IDNAReader > InDNAReader, |
Initialize the MetaHuman Identity from a DNA. | MetaHumanIdentity.h | |
EIdentityErrorCode ImportDNAFile
(
const FString& InDNAFilePath, |
Initialize the MetaHuman Identity from a DNA file. | MetaHumanIdentity.h |
|
bool IsAutoRiggingInProgress() |
MetaHumanIdentity.h |
|
|
bool IsFrameTrackingPipelineProcessing() |
MetaHumanIdentity.h |
|
|
bool IsLoggedInToService () |
This function checks if there's a session stored. | MetaHumanIdentity.h |
|
void LogInToAutoRigService() |
MetaHumanIdentity.h |
|
|
void SetBlockingProcessing
(
bool bInBlockingProcessing |
MetaHumanIdentity.h |
|
|
void StartFrameTrackingPipeline
(
const TArray< FColor >& InImageData, |
MetaHumanIdentity.h |
|
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPrimaryAssetId GetPrimaryAssetId() |
MetaHumanIdentity.h | ||
virtual void PostLoad() |
MetaHumanIdentity.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool HandleError
(
EIdentityErrorCode InErrorCode, |
Deals with error produced by the MetaHuman Identity process - logs message and optionally show user dialog | MetaHumanIdentity.h |
|