1. Epic GamesDeveloper
  3. UMetaHumanCollection

UMetaHumanCollection

A collection of character parts (e.g. MetaHuman Characters, clothing, hairstyles) that target slots on a Character Pipeline.

API > API/Plugins > API/Plugins/MetaHumanCharacterPalette

A collection of character parts (e.g. MetaHuman Characters, clothing, hairstyles) that target slots on a Character Pipeline.

Create a Character Instance from a Collection to assemble a renderable character from the parts contained in the Collection.

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

Syntax

UCLASS (BlueprintType)  
class UMetaHumanCollection : public UMetaHumanCharacterPalette

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMetaHumanCollection()

   MetaHumanCollection.h  

Typedefs

Name Type Remarks Include Path
FOnBuildComplete TBaseDelegate_OneParam< void, EMetaHumanBuildStatus > Collections should not be created or modified outside the editor. MetaHumanCollection.h
FOnPaletteBuilt TMulticastDelegate_OneParam< void, EMetaHumanCharacterPaletteBuildQuality >   MetaHumanCollection.h
FOnPipelineChanged TMulticastDelegate_NoParams< void >   MetaHumanCollection.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnPaletteBuilt FOnPaletteBuilt Delegate fired when the Collection has finished building, if it succeeded MetaHumanCollection.h  
OnPipelineChanged FOnPipelineChanged Delegate fired when a new Pipeline has been set on this Collection. MetaHumanCollection.h  
UnpackFolderPath FString The folder path that assets will be unpacked to. Interpreted according to UnpackPathMode. MetaHumanCollection.h
  • EditAnywhere
  • Category="Targets"
  • DisplayName="Root Path"
  • Meta=(EditCondition="UnpackPathMode != EMetaHumanCharacterUnpackPathMode::SubfolderNamedForPalette", EditConditionHides, ToolTip="Project directory to place the generated assets")
UnpackPathMode EMetaHumanCharacterUnpackPathMode The mode for determining which folder to unpack the Collection's assets to MetaHumanCollection.h
  • EditAnywhere
  • Category="Targets"
  • DisplayName="Root Relative"
  • Meta=(ToolTip="The mode for determining whether the Root path is relative to the character asset path")

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsUnpacked bool True if the assets in this Collection have been unpacked and are in their own packages. MetaHumanCollection.h  
DefaultInstance TObjectPtr< UMetaHumanCharacterInstance >   MetaHumanCollection.h
  • BlueprintReadOnly
  • Category="Character"
  • Meta=(AllowPrivateAccess)
ItemBuildCache TMap< FMetaHumanPaletteItemPath, FMetaHumanPaletteBuildCacheEntry > A per-item cache that persists between builds. MetaHumanCollection.h  
PaletteBuildCache FMetaHumanPaletteBuildCacheEntry   MetaHumanCollection.h  
Pipeline TObjectPtr< UMetaHumanCollectionPipeline > The MetaHuman Collection Pipeline used to build this collection MetaHumanCollection.h
  • EditAnywhere
  • Instanced
  • Category="Character"
PreviewBuiltData FMetaHumanCollectionBuiltData Built data from Preview quality builds. MetaHumanCollection.h
  • Transient
  • DuplicateTransient
ProductionBuiltData FMetaHumanCollectionBuiltData   MetaHumanCollection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Build ( const FInstancedStruct& BuildInput,
EMetaHumanCharacterPaletteBuildQuality Quality,
ITargetPlatform* TargetPlatform,
const FOnBuildComplete& OnComplete,
const TArray< FMetaHumanPinnedSlotSelection >& PinnedSlotSelections,
const TArray< FMetaHumanPaletteItemPath >& ItemsToExclude
)

 Builds the collection so that Character Instances can assemble characters from it MetaHumanCollection.h  
Note that the returned data is not guaranteed to be valid. Call IsValid on the result to check. MetaHumanCollection.h  

TNotNull< const UMetaHumanCharacterInstance * > GetDefaultInstance()

   MetaHumanCollection.h  

const UMetaHumanCollectionEditorPipeline * GetEditorPipeline()

 Convenience function to access the editor pipeline MetaHumanCollection.h  
The Collection contains a default instance that is used for preview. MetaHumanCollection.h  

UMetaHumanCollectionPipeline * GetMutablePipeline()

 The Pipeline targeted by this Collection.May be null if the user hasn't set a pipeline yet. MetaHumanCollection.h  

const UMetaHumanCollectionPipeline * GetPipeline()

 The Pipeline targeted by this Collection.May be null if the user hasn't set a pipeline yet. MetaHumanCollection.h  

FString GetUnpackFolder()

 Returns the folder path where the assets will be unpacked, depending on the UnpackPathMode MetaHumanCollection.h  
Resolves virtual slots in the given array of selections. MetaHumanCollection.h  
  MetaHumanCollection.h  
Sets the default Pipeline from the project settings. MetaHumanCollection.h  

void SetPipeline ( TNotNull< UMetaHumanCollectionPipeline* > InPipeline
)

 Set the Pipeline for this Collection to use. MetaHumanCollection.h  

void SetPipelineFromClass ( TSubclassOf< UMetaHumanCollectionPipeline > InPipelineClass
)

 Sets the Pipeline to be an instance of the given class MetaHumanCollection.h  

void UnpackAssets ( const FOnMetaHumanCharacterAssetsUnpacked& OnComplete
)

 Moves any built assets stored within this Collection to their own asset packages, making them standalone assets that can be referenced from other objects. MetaHumanCollection.h  

Overridden from UMetaHumanCharacterPalette

Name Remarks Include Path Unreal Specifiers

virtual const UMetaHumanCharacterEditorPipeline * GetPaletteEditorPipeline()

   MetaHumanCollection.h  

virtual const UMetaHumanCharacterPipeline * GetPalettePipeline()

   MetaHumanCollection.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   MetaHumanCollection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page