UMetaHumanInstance

Used to assemble a renderable character from a MetaHuman Collection.

API > API/Plugins > API/Plugins/MetaHumanCharacterPalette

Used to assemble a renderable character from a MetaHuman Collection.

Can be either an asset used in the editor or a transient object generated at runtime.

   
Name UMetaHumanInstance
Type class
Header File /Engine/Plugins/MetaHuman/MetaHumanCharacter/Source/MetaHumanCharacterPalette/Public/MetaHumanInstance.h
Include Path #include "MetaHumanInstance.h"

Syntax

UCLASS (BlueprintType)  
class UMetaHumanInstance : public UObject

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnInstanceUpdatedNative FMetaHumanInstanceUpdatedNative   MetaHumanInstance.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsAssemblyOutputCooked bool True if this Instance was loaded from a cooked package and has a valid baked RuntimeAssemblyOutput. MetaHumanInstance.h
  • Transient
  • DuplicateTransient
Collection TObjectPtr< UMetaHumanCollection >   MetaHumanInstance.h  
CurrentOverriddenAssemblyParameters FMetaHumanInstanceParameterCollection Used by the assembly that's currently in progress MetaHumanInstance.h
  • Transient
  • DuplicateTransient
EditorAssemblyOutput FMetaHumanProcessedAssemblyOutput The assembly output and associated data for this Instance while it's being edited in the editor. MetaHumanInstance.h
  • Transient
  • DuplicateTransient
OverriddenCollectionInstanceParameters FInstancedPropertyBag OverriddenInstanceParameters for the Collection pipeline itself, so that we can detect when a key in OverriddenInstanceParameters has been reset to the empty path due to a missing asset. MetaHumanInstance.h  
OverriddenInstanceParameters TMap< FMetaHumanPaletteItemPath, FInstancedPropertyBag >   MetaHumanInstance.h  
RuntimeAssemblyOutput FMetaHumanProcessedAssemblyOutput The assembly output and associated data for this Instance in cooked builds. MetaHumanInstance.h
  • DuplicateTransient
ShouldCookAsAssembled EMetaHumanInstanceCookBehavior Determines whether this Instance should be assembled at cook time and have its assembly output baked into the cooked package. MetaHumanInstance.h
  • EditAnywhere
  • Category=Instance
SlotSelections TArray< FMetaHumanPipelineSlotSelectionData > The selected items for slots on the Pipeline. MetaHumanInstance.h  
WillCookAsAssembled EMetaHumanInstanceCookBehavior The effective resolved value of ShouldCookAsAssembled. MetaHumanInstance.h
  • VisibleAnywhere
  • Transient
  • Category=Instance

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Assemble ( const FMetaHumanCharacterAssembled& OnAssembled,
const FMetaHumanCharacterAssembledNative& OnAssembledNative
)

   MetaHumanInstance.h  
  MetaHumanInstance.h  

void Assemble ( EMetaHumanCharacterPaletteBuildQuality Quality,
const FMetaHumanCharacterAssembledNative& OnAssembledNative
)

   MetaHumanInstance.h  

void Assemble ( EMetaHumanCharacterPaletteBuildQuality Quality,
const FMetaHumanCharacterAssembled& OnAssembled,
const FMetaHumanCharacterAssembledNative& OnAssembledNative
)

   MetaHumanInstance.h  

void Assemble ( const FMetaHumanCharacterAssembled& OnAssembled
)

 Runs the associated Character Pipeline's assembly function to populate the AssemblyOutput. MetaHumanInstance.h
  • BlueprintCallable
  • Category="MetaHuman|Instance"

void Assemble ( const FMetaHumanCharacterAssembledNative& OnAssembledNative
)

   MetaHumanInstance.h
  • BlueprintCallable
  • Category="MetaHuman|Instance"

void ClearAllOverriddenInstanceParameters()

 Functions to clear overridden Instance Parameters MetaHumanInstance.h  
Clear the result of the last assembly. MetaHumanInstance.h
  • BlueprintCallable
  • Category="MetaHuman|Instance"

void ClearOverriddenInstanceParameters ( const FMetaHumanPaletteItemPath& ItemPath
)

   MetaHumanInstance.h  

bool ContainsSlotSelection ( const FMetaHumanPipelineSlotSelection& Selection
) const

   MetaHumanInstance.h  

void CopyContentsFrom ( TNotNull< const UMetaHumanInstance* > Other
)

 Copies the contents of the Other Instance into this Instance, discarding this Instance's existing contents and leaving it in an unassembled state. MetaHumanInstance.h  
The term Instance Parameters now refers to both Assembly and Post-Assembly Parameters. MetaHumanInstance.h  
  MetaHumanInstance.h  
Assemble if necessary and return the assembly output MetaHumanInstance.h
  • BlueprintPure
  • Category="MetaHuman|Instance"
Returns the Assembly Parameters produced by the last build and their original values. MetaHumanInstance.h  
Returns the Instance Parameters produced by the last assembly and their effective values. MetaHumanInstance.h  
GetAssemblyOutput should be used instead of this function in most cases. MetaHumanInstance.h
  • BlueprintCallable
  • Category="MetaHuman|Instance"
Return the MetaHuman Collection that this instance will assemble from. MetaHumanInstance.h
  • BlueprintCallable
  • Category="MetaHuman|Instance"
Returns the Instance Parameters stored in this instance as overrides. MetaHumanInstance.h  
Returns the Post-Assembly Parameters produced by the last assembly and their original values. MetaHumanInstance.h  

const TArray< FMetaHumanPipelineSlotSelectionData > & GetSlotSelectionData()

   MetaHumanInstance.h
  • BlueprintCallable
  • Category="Slots"

bool IsAssembled()

 Returns true if the Instance is assembled and up to date MetaHumanInstance.h
  • BlueprintCallable
  • Category="MetaHuman|Instance"
Notify users of this Instance that they should call GetAssemblyOutput again and update themselves. MetaHumanInstance.h  
Set the overridden Instance Parameter values for a given item, or the Collection itself if an empty item path is specified. MetaHumanInstance.h  
Set the MetaHuman Collection that this instance will assemble from. MetaHumanInstance.h
  • BlueprintCallable
  • Category="MetaHuman|Instance"

void SetSingleSlotSelection ( FName SlotName,
const FMetaHumanPaletteItemKey& ItemKey
)

 Remove any existing selections for this slot and select only the given item. MetaHumanInstance.h
  • BlueprintCallable
  • Category="Slots"

void SetSingleSlotSelection ( const FMetaHumanPaletteItemPath& ParentItemPath,
FName SlotName,
const FMetaHumanPaletteItemKey& ItemKey
)

   MetaHumanInstance.h
  • BlueprintCallable
  • Category="Slots"

TArray< FMetaHumanPinnedSlotSelection > ToPinnedSlotSelections ( EMetaHumanUnusedSlotBehavior UnusedSlotBehavior
) const

 Formats the slot selections and overridden instance parameters stored in this instance to be passed into a Collection build as pinned selections. MetaHumanInstance.h  

bool TryAddSlotSelection ( const FMetaHumanPipelineSlotSelection& Selection
)

 Adds the provided slot selection if valid, e.g. won't allow duplicate selections or multiple selections for slots that don't allow it. MetaHumanInstance.h
  • BlueprintCallable
  • Category=Instance

bool TryGetAnySlotSelection ( FName SlotName,
FMetaHumanPaletteItemKey& OutItemKey
) const

 Get a single item selection for this slot, if there is at least one. MetaHumanInstance.h  

bool TryGetAnySlotSelection ( const FMetaHumanPaletteItemPath& ParentItemPath,
FName SlotName,
FMetaHumanPaletteItemKey& OutItemKey
) const

   MetaHumanInstance.h  

bool TryRemoveSlotSelection ( const FMetaHumanPipelineSlotSelection& Selection
)

 Returns true if the selection existed and was removed, false if it didn't exist. MetaHumanInstance.h  

bool TryUnpack ( const FString& TargetFolder
)

 Unpacks only the assets contained in this Instance. MetaHumanInstance.h  

Public Virtual

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   MetaHumanInstance.h  

virtual void PostLoad()

   MetaHumanInstance.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   MetaHumanInstance.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool TryGetAnySlotSelection ( TConstArrayView< FMetaHumanPipelineSlotSelectionData > SlotSelections,
const FMetaHumanPaletteItemPath& ParentItemPath,
FName SlotName,
FMetaHumanPaletteItemKey& OutItemKey
)

   MetaHumanInstance.h  

static bool TryGetAnySlotSelection ( TConstArrayView< FMetaHumanPipelineSlotSelectionData > SlotSelections,
FName SlotName,
FMetaHumanPaletteItemKey& OutItemKey
)

   MetaHumanInstance.h  

static bool TryGetAnySlotSelection ( TConstArrayView< FMetaHumanPipelineSlotSelection > SlotSelections,
FName SlotName,
FMetaHumanPaletteItemKey& OutItemKey
)

   MetaHumanInstance.h  

static bool TryGetAnySlotSelection ( TConstArrayView< FMetaHumanPipelineSlotSelection > SlotSelections,
const FMetaHumanPaletteItemPath& ParentItemPath,
FName SlotName,
FMetaHumanPaletteItemKey& OutItemKey
)

   MetaHumanInstance.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page