unreal.MetaHumanIdentity

class unreal.MetaHumanIdentity(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

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.

C++ Source:

  • Plugin: MetaHuman

  • Module: MetaHumanIdentity

  • File: MetaHumanIdentity.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_auto_rig_service_finished_dynamic_delegate (OnAutoRigServiceFinishedDynamicDelegate): [Read-Write] Dynamic delegate called when the pipeline finishes running

  • parts (Array[MetaHumanIdentityPart]): [Read-Write] The list of Parts the make this Identity. See UMetaHumanIdentityPart

  • thumbnail_info (ThumbnailInfo): [Read-Only] Information for thumbnail rendering

  • viewport_settings (MetaHumanIdentityViewportSettings): [Read-Write] Stores the viewport settings for this MetaHuman Identity

can_add_part_of_class(part_class) → bool

Returns true if the given Part class can be added to the MetaHuman Identity being edited

Parameters:

part_class (type(Class))

Return type:

bool

can_add_pose_of_class(pose_class, pose_type) → bool

Returns true if the given Pose class can be added to the MetaHuman Identity being edited

Parameters:
Return type:

bool

create_dna_for_identity(log_only) → None

Create DNAFor Identity

Parameters:

log_only (bool)

diagnostics_indicates_processing_issue() → Text or None

Diagnostics Indicates Processing Issue

Returns:

out_diagnostics_warning_message (Text):

Return type:

Text or None

export_dna_data_to_files(dna_path_with_name, brows_path_with_name) → bool

Export DNA and brows data to files at selected location

Parameters:

  • dna_path_with_name (str)

  • brows_path_with_name (str)

Return type:

bool

find_part_of_class(part_class) → MetaHumanIdentityPart

Looks for a Part of the given class in the array of parts. Returns nullptr if no Part was found

Parameters:

part_class (type(Class))

Return type:

MetaHumanIdentityPart

get_or_create_part_of_class(part_class) → MetaHumanIdentityPart

Looks for a Part of the given class in the array of parts. Creates and return a new one if not found

Parameters:

part_class (type(Class))

Return type:

MetaHumanIdentityPart

classmethod handle_error(error_code, log_only=False) → bool

Deals with error produced by the MetaHuman Identity process - logs message and optionally show user dialog

Parameters:
Return type:

bool

import_dna_file(dna_file_path, dna_data_layer, brows_file_path) → IdentityErrorCode

Initialize the MetaHuman Identity from a DNA file. The MetaHuman Identity must already have a face for this to succeeded

Parameters:
Return type:

IdentityErrorCode

is_auto_rigging_in_progress() → bool

Is Auto Rigging in Progress

Return type:

bool

is_frame_tracking_pipeline_processing() → bool

Is Frame Tracking Pipeline Processing

Return type:

bool

is_logged_in_to_service() → bool

This function checks if there’s a session stored. There is NO request sent to check if the token is actually valid

Return type:

bool

log_in_to_auto_rig_service() → None

Log in to Auto Rig Service

property on_auto_rig_service_finished_dynamic_delegate: OnAutoRigServiceFinishedDynamicDelegate

[Read-Write] Dynamic delegate called when the pipeline finishes running

Type:

(OnAutoRigServiceFinishedDynamicDelegate)

property parts: None

[Read-Only] The list of Parts the make this Identity. See UMetaHumanIdentityPart

Type:

(Array[MetaHumanIdentityPart])

set_blocking_processing(blocking_processing) → None

Set Blocking Processing

Parameters:

blocking_processing (bool)

start_frame_tracking_pipeline(image_data, width, height, depth_frame_path, pose, promoted_frame, show_progress) → None

Start Frame Tracking Pipeline

Parameters:
property viewport_settings: MetaHumanIdentityViewportSettings

[Read-Write] Stores the viewport settings for this MetaHuman Identity

Type:

(MetaHumanIdentityViewportSettings)