unreal.MetaHumanIdentityPose

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

Bases: Object

A Pose describes the appearance of the MetaHuman Identity in some way. It could be a mesh or footage showing the Identity’s teeth or its neutral expression.

C++ Source:

  • Plugin: MetaHuman

  • Module: MetaHumanIdentity

  • File: MetaHumanIdentityPose.h

Editor Properties: (see get_editor_property/set_editor_property)

  • camera (str): [Read-Write] Name of camera (view) in the footage capture data to use for display and processing

  • capture_data (CaptureData): [Read-Write] Source data for this pose, this could be a mesh or footage

  • capture_data_config (str): [Read-Only] Display name of the config to use with the capture data

  • capture_data_scene_component (SceneComponent): [Read-Only] The scene component that represents the capture data for this pose

  • default_tracker (MetaHumanFaceContourTrackerAsset): [Read-Write] The default tracker that should be used for tracking a Promoted Frame of this pose. This can still be customized in a per-frame basis

  • fit_eyes (bool): [Read-Write] Whether or not to use the data driven approach to fit the eyes in the template mesh

  • manual_teeth_depth_offset (float): [Read-Write] Unit: cm

  • pose_name (Text): [Read-Write] The display name of the pose. This can be edited for custom poses

  • pose_transform (Transform): [Read-Write] The transform for the pose if changed in the viewport

  • pose_type (IdentityPoseType): [Read-Write] The type this pose represents

  • promoted_frame_class (type(Class)): [Read-Only] The class the defines the Promoted Frame type for this pose

  • promoted_frames (Array[MetaHumanIdentityPromotedFrame]): [Read-Only] The array of Promoted Frames for this pose

  • timecode_alignment (TimecodeAlignment): [Read-Write] Controls alignment of media tracks via their timecode

add_new_promoted_frame() -> (MetaHumanIdentityPromotedFrame, out_promoted_frame_index=int32)

brief: Creates a new promoted frame suitable for this pose. The type of the promoted frame will be based on PromotedFrameClass. It also sets the default tracker for the frame to be the same as DefaultTracker.

Returns:

A new UMetaHumanIdentityPromotedFrame based on PromotedFrameClass

out_promoted_frame_index (int32): The index of the newly created promoted frame in the internal array

Return type:

int32

property fit_eyes: bool

[Read-Write] Whether or not to use the data driven approach to fit the eyes in the template mesh

Type:

(bool)

get_capture_data() → CaptureData

Get Capture Data

Return type:

CaptureData

is_capture_data_valid() → bool

Returns true if the capture is initialized

Return type:

bool

load_default_tracker() → None

Sets the default tracker based on the PoseType. Only changes it DefaultTracker is not currently set

property pose_type: IdentityPoseType

[Read-Write] The type this pose represents

Type:

(IdentityPoseType)

property promoted_frame_class: Class

[Read-Only] The class the defines the Promoted Frame type for this pose

Type:

(type(Class))

property promoted_frames: None

[Read-Only] The array of Promoted Frames for this pose

Type:

(Array[MetaHumanIdentityPromotedFrame])

remove_promoted_frame(promoted_frame) → None

Removes the given promoted frame from this pose

Parameters:

promoted_frame (MetaHumanIdentityPromotedFrame)

set_capture_data(capture_data) → None

Set Capture Data

Parameters:

capture_data (CaptureData)

property timecode_alignment: TimecodeAlignment

[Read-Write] Controls alignment of media tracks via their timecode

Type:

(TimecodeAlignment)