Navigation
API > API/Plugins > API/Plugins/MetaHumanIdentity
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.
| Name | UMetaHumanIdentityPose |
| Type | class |
| Header File | /Engine/Plugins/MetaHuman/MetaHumanAnimator/Source/MetaHumanIdentity/Public/MetaHumanIdentityPose.h |
| Include Path | #include "MetaHumanIdentityPose.h" |
Syntax
UCLASS (BlueprintType, HideCategories=("Preview"))
class UMetaHumanIdentityPose : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMetaHumanIdentityPose
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMetaHumanIdentityPose() |
MetaHumanIdentityPose.h |
Enums
Public
| Name | Remarks |
|---|---|
| ECurrentFrameValid | Determine if specified frame is valid, ie has RGB and depth data, not excluded etc |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFitEyes | bool | Whether or not to use the data driven approach to fit the eyes in the template mesh | MetaHumanIdentityPose.h |
|
| Camera | FString | Name of camera (view) in the footage capture data to use for display and processing | MetaHumanIdentityPose.h |
|
| CameraNames | TArray< TSharedPtr< FString > > | List of all RGB cameras (views) in the footage capture data | MetaHumanIdentityPose.h | |
| CaptureDataSceneComponent | TObjectPtr< class USceneComponent > | The scene component that represents the capture data for this pose | MetaHumanIdentityPose.h |
|
| ClampMax | MetaHumanIdentityPose.h |
|
||
| ClampMin | MetaHumanIdentityPose.h |
|
||
| DefaultTracker | TObjectPtr< class UMetaHumanFaceContourTrackerAsset > | The default tracker that should be used for tracking a Promoted Frame of this pose. | MetaHumanIdentityPose.h |
|
| PoseName | FText | The display name of the pose. This can be edited for custom poses | MetaHumanIdentityPose.h |
|
| PoseTransform | FTransform | The transform for the pose if changed in the viewport | MetaHumanIdentityPose.h |
|
| PoseType | EIdentityPoseType | The type this pose represents | MetaHumanIdentityPose.h |
|
| PromotedFrameClass | TSubclassOf< class UMetaHumanIdentityPromotedFrame > | The class the defines the Promoted Frame type for this pose | MetaHumanIdentityPose.h |
|
| PromotedFrames | TArray< TObjectPtr< class UMetaHumanIdentityPromotedFrame > > | The array of Promoted Frames for this pose | MetaHumanIdentityPose.h |
|
| TimecodeAlignment | ETimecodeAlignment | Controls alignment of media tracks via their timecode | MetaHumanIdentityPose.h |
|
| ToolTip | Additional offset depth translation for the teeth | MetaHumanIdentityPose.h |
|
|
| UIMax | MetaHumanIdentityPose.h |
|
||
| UIMin | MetaHumanIdentityPose.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsCaptureDataValid | bool | A cached check on if capture data is valid | MetaHumanIdentityPose.h | |
| CaptureData | TObjectPtr< class UCaptureData > | Source data for this pose, this could be a mesh or footage | MetaHumanIdentityPose.h |
|
| CaptureDataConfig | FString | Display name of the config to use with the capture data | MetaHumanIdentityPose.h |
|
| OnCaptureDataChangedDelegate | FOnCaptureDataChanged | Delegated called when the capture data associated with the Pose changes | MetaHumanIdentityPose.h | |
| PreviousCamera | FString | The value of camera used previously (used to detect when camera changes) | MetaHumanIdentityPose.h | |
| PreviousTimecodeAlignment | ETimecodeAlignment | The value of timecode alignment used previously (used to detect when timecode alignment changes between particular modes) | MetaHumanIdentityPose.h | |
| RateMatchingDropFrameRanges | TArray< FFrameRange > | MetaHumanIdentityPose.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMetaHumanIdentityPromotedFrame * AddNewPromotedFrame
(
int32& OutPromotedFrameIndex |
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. | MetaHumanIdentityPose.h |
|
TArray< class UMetaHumanIdentityPromotedFrame * > GetAllPromotedFramesWithValidContourData() |
Returns all Promoted Frames that contain contour data | MetaHumanIdentityPose.h | |
UCaptureData * GetCaptureData() |
MetaHumanIdentityPose.h |
|
|
UMetaHumanIdentityPromotedFrame * GetFrontalViewPromotedFrame() |
Returns the promoted frame tagged as front view | MetaHumanIdentityPose.h | |
const FTransform & GetHeadAlignment
(
int32 InFrameIndex |
Returns the head alignment transform for a given promoted frame | MetaHumanIdentityPose.h | |
ECurrentFrameValid GetIsFrameValid
(
int32 InFrameNumber |
MetaHumanIdentityPose.h | ||
ECurrentFrameValid GetIsFrameValid
(
int32 InFrameNumber, |
MetaHumanIdentityPose.h | ||
FSlateIcon GetPoseIcon() |
Returns an icon that represents this pose | MetaHumanIdentityPose.h | |
FText GetPoseTooltip() |
Returns an tooltip for this pose | MetaHumanIdentityPose.h | |
TArray< FFrameRange > GetRateMatchingExcludedFrameRanges() |
MetaHumanIdentityPose.h | ||
TArray< class UMetaHumanIdentityPromotedFrame * > GetValidContourDataFramesFrontFirst() |
If front view is set, returns promoted frames with valid contours with front view as first entry | MetaHumanIdentityPose.h | |
bool IsCaptureDataValid() |
Returns true if the capture is initialized | MetaHumanIdentityPose.h |
|
bool IsDefaultTrackerValid() |
Returns true iff the default tracker is a valid object that is ready to track | MetaHumanIdentityPose.h | |
void LoadDefaultTracker() |
Sets the default tracker based on the PoseType. Only changes it DefaultTracker is not currently set | MetaHumanIdentityPose.h |
|
FOnCaptureDataChanged & OnCaptureDataChanged() |
MetaHumanIdentityPose.h | ||
void RemovePromotedFrame
(
UMetaHumanIdentityPromotedFrame* InPromotedFrame |
Removes the given promoted frame from this pose | MetaHumanIdentityPose.h |
|
void SetCaptureData
(
UCaptureData* InCaptureData |
MetaHumanIdentityPose.h |
|
|
void SetHeadAlignment
(
const FTransform& InTransform, |
Sets the head alignment transform for a promoted frame. | MetaHumanIdentityPose.h | |
void UpdateCaptureDataConfigName() |
Update the capture data config name | MetaHumanIdentityPose.h | |
void UpdateCaptureDataSceneComponent() |
Adds or destroys the capture data scene component depending if it has valid capture data | MetaHumanIdentityPose.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& InPropertyChangedEvent |
MetaHumanIdentityPose.h | ||
virtual void PostInitProperties() |
MetaHumanIdentityPose.h | ||
virtual void PostLoad() |
MetaHumanIdentityPose.h | ||
virtual void PostTransacted
(
const FTransactionObjectEvent& InTransactionEvent |
MetaHumanIdentityPose.h | ||
virtual void PreEditChange
(
FEditPropertyChain& InPropertyAboutToChange |
MetaHumanIdentityPose.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FString PoseTypeAsString
(
EIdentityPoseType InPoseType |
Utility function to convert the EIdentityPoseType to a FString | MetaHumanIdentityPose.h |