1. Epic GamesDeveloper
  3. UMetaHumanCharacterInstance

UMetaHumanCharacterInstance

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 UMetaHumanCharacterInstance
Type class
Header File /Engine/Plugins/MetaHuman/MetaHumanCharacter/Source/MetaHumanCharacterPalette/Public/MetaHumanCharacterInstance.h
Include Path #include "MetaHumanCharacterInstance.h"

Syntax

UCLASS (BlueprintType)  
class UMetaHumanCharacterInstance : public UObject

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnInstanceUpdatedNative FMetaHumanCharacterInstanceUpdatedNative This delegate is mutable so that code that has a const pointer can't change the parameters, but can register for updates MetaHumanCharacterInstance.h  
OverridePipelineInstance TObjectPtr< UMetaHumanCollectionPipeline > If non-null, this overrides the runtime pipeline on the Collection MetaHumanCharacterInstance.h
  • EditAnywhere
  • Category=CharacterInstance

Protected

Name Type Remarks Include Path Unreal Specifiers
AssemblyAssetMetadata TArray< FMetaHumanGeneratedAssetMetadata >   MetaHumanCharacterInstance.h
  • Transient
AssemblyInstanceParameterContext TMap< FMetaHumanPaletteItemPath, FInstancedStruct > Opaque data about the instance parameters that only has meaning to the pipeline. MetaHumanCharacterInstance.h
  • Transient
AssemblyInstanceParameters TMap< FMetaHumanPaletteItemPath, FInstancedPropertyBag >   MetaHumanCharacterInstance.h
  • Transient
AssemblyOutput FInstancedStruct A structure produced by the Character Pipeline that contains the assets belonging to this instance, such as meshes and materials. MetaHumanCharacterInstance.h
  • Transient
Collection TObjectPtr< UMetaHumanCollection >   MetaHumanCharacterInstance.h  
OnInstanceUpdated FMetaHumanCharacterInstanceUpdated   MetaHumanCharacterInstance.h
  • Transient
  • BlueprintAssignable
  • Category=CharacterInstance
OnPaletteBuiltHandle FDelegateHandle   MetaHumanCharacterInstance.h  
OverriddenInstanceParameters TMap< FMetaHumanPaletteItemPath, FInstancedPropertyBag >   MetaHumanCharacterInstance.h  
SlotSelections TArray< FMetaHumanPipelineSlotSelectionData > The selected items for slots on the Pipeline. MetaHumanCharacterInstance.h
  • VisibleAnywhere
  • Category=CharacterInstance

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   MetaHumanCharacterInstance.h  

void Assemble ( EMetaHumanCharacterPaletteBuildQuality Quality,
const FMetaHumanCharacterAssembledNative& OnAssembledNative
)

   MetaHumanCharacterInstance.h
  • BlueprintCallable
  • Category=CharacterInstance
Runs the associated Character Pipeline's assembly function to populate the AssemblyOutput. MetaHumanCharacterInstance.h
  • BlueprintCallable
  • Category=CharacterInstance

void ClearAllOverriddenInstanceParameters()

 Functions to clear overridden Instance Parameters MetaHumanCharacterInstance.h  
Clear the result of the last assembly. MetaHumanCharacterInstance.h
  • BlueprintCallable
  • Category=CharacterInstance

void ClearOverriddenInstanceParameters ( const FMetaHumanPaletteItemPath& ItemPath
)

   MetaHumanCharacterInstance.h  

bool ContainsSlotSelection ( const FMetaHumanPipelineSlotSelection& Selection
) const

   MetaHumanCharacterInstance.h  
Returns the Instance Parameters produced by the last assembly and their original values. MetaHumanCharacterInstance.h  

const FInstancedStruct & GetAssemblyOutput()

 Fetch the result of the last assembly, if any MetaHumanCharacterInstance.h
  • BlueprintCallable
  • Category=CharacterInstance
Returns the Instance Parameters produced by the last assembly and their effective values. MetaHumanCharacterInstance.h  
Return the MetaHuman Collection that this instance will assemble from. MetaHumanCharacterInstance.h
  • BlueprintCallable
  • Category=CharacterInstance
Returns the Instance Parameters stored in this instance as overrides. MetaHumanCharacterInstance.h  

const TArray< FMetaHumanPipelineSlotSelectionData > & GetSlotSelectionData()

   MetaHumanCharacterInstance.h  

void OverrideInstanceParameters ( const FMetaHumanPaletteItemPath& ItemPath,
const FInstancedPropertyBag& NewInstanceParameterValues
)

 Set the overridden Instance Parameter values for a given item, or the Collection itself if an empty item path is specified. MetaHumanCharacterInstance.h  

void RegisterOnInstanceUpdated ( const FMetaHumanCharacterInstanceUpdated_Unicast& Delegate
)

 TODO: The OnInstanceUpdated interface is WIP and will change. MetaHumanCharacterInstance.h
  • BlueprintCallable
  • Category=CharacterInstance
Set the MetaHuman Collection that this instance will assemble from. MetaHumanCharacterInstance.h
  • BlueprintCallable
  • Category=CharacterInstance

void SetSingleSlotSelection ( FName SlotName,
const FMetaHumanPaletteItemKey& ItemKey
)

 Remove any existing selections for this slot and select only the given item. MetaHumanCharacterInstance.h  

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

   MetaHumanCharacterInstance.h  

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. MetaHumanCharacterInstance.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. MetaHumanCharacterInstance.h  

bool TryGetAnySlotSelection ( FName SlotName,
FMetaHumanPaletteItemKey& OutItemKey
) const

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

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

   MetaHumanCharacterInstance.h  

bool TryRemoveSlotSelection ( const FMetaHumanPipelineSlotSelection& Selection
)

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

bool TryUnpack ( const FString& TargetFolder
)

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

void UnregisterOnInstanceUpdated ( UObject* Object
)

   MetaHumanCharacterInstance.h
  • BlueprintCallable
  • Category=CharacterInstance

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   MetaHumanCharacterInstance.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   MetaHumanCharacterInstance.h  

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

   MetaHumanCharacterInstance.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page