unreal.MetaHumanIdentityPromotedFrame

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

Bases: Object

UMetaHumanIdentityPromotedFrame

C++ Source:

  • Plugin: MetaHuman

  • Module: MetaHumanIdentity

  • File: MetaHumanIdentityPromotedFrames.h

Editor Properties: (see get_editor_property/set_editor_property)

  • contour_data (MetaHumanContourData): [Read-Write] Contour data class that holds all the data for curves and control vertices

  • contour_tracker (MetaHumanFaceContourTrackerAsset): [Read-Write] The tracker that can be used to track landmarks on the data represented by this Promoted Frame

  • depth_map_diagnostics (DepthMapDiagnosticsResult): [Read-Only] The depth-map diagnostics result for the frame

  • frame_name (Text): [Read-Write] The name of frame as given by the user

  • head_alignment (Transform): [Read-Only] The alignment of the conformal mesh associated with this promoted frame

  • is_front_view (bool): [Read-Write] Whether this promoted frame is front view

  • is_head_alignment_set (bool): [Read-Only] Do we have a valid alignment of the conformal mesh associated with this promoted frame

  • is_navigation_locked (bool): [Read-Write] Whether or not the navigation is locked for this Promoted frame

  • use_to_solve (bool): [Read-Write] Whether or not the markers (landmarks) of this Promoted Frame are active

can_track() bool

Returns true if this Promoted Frame has all the required information to track

Return type:

bool

diagnostics_indicates_processing_issue(minimum_depth_map_face_coverage, minimum_depth_map_face_width) Text or None
Returns true if the diagnostics associated with the promoted frame indicate a potential issue, and returns a warning message if so. Note that the thresholds

supplied for checking whether an issue exists are properties of UMetaHumanIdentityFace and can be obtained from there

Parameters:
  • minimum_depth_map_face_coverage (float)

  • minimum_depth_map_face_width (float)

Returns:

out_diagnostics_warning_message (Text):

Return type:

Text or None

frame_contours_contain_active_data() bool

Returns true if ContourData in ShapeAnnotation contains any curves that are active

Return type:

bool

property is_front_view: bool

[Read-Write] Whether this promoted frame is front view

Type:

(bool)

is_navigation_locked() bool

Is Navigation Locked

Return type:

bool

is_tracking_manually() bool

Is Tracking Manually

Return type:

bool

is_tracking_on_change() bool

Is Tracking on Change

Return type:

bool

set_navigation_locked(is_locked) None

Set Navigation Locked

Parameters:

is_locked (bool)

toggle_navigation_locked() None

Toggle Navigation Locked