UMetaHumanCollectionEditorPipeline

The editor-only component of a [UMetaHumanCollectionPipeline](API\Plugins\MetaHumanCharacterPalette\UMetaHumanCollectionPipeline).

API > API/Plugins > API/Plugins/MetaHumanCharacterPalette

The editor-only component of a UMetaHumanCollectionPipeline.

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

Syntax

UCLASS (Abstract, MinimalAPI)  
class UMetaHumanCollectionEditorPipeline : public UMetaHumanCharacterEditorPipeline

Inheritance Hierarchy

Derived Classes

Structs

Name Remarks
FBuildCollectionParams Build the Collection
FWriteBlueprintSettings  

Typedefs

Name Type Remarks Include Path
FOnBuildComplete TBaseDelegate_TwoParams< void, EMetaHumanBuildStatus, TSharedPtr< FMetaHumanCollectionBuiltData > >   MetaHumanCollectionEditorPipeline.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BuildCollection ( TNotNull< const UMetaHumanCollection* > Collection,
TNotNull< UObject* > OuterForGeneratedAssets,
const TArray< FMetaHumanPinnedSlotSelection >& SortedPinnedSlotSelections,
const TArray< FMetaHumanPaletteItemPath >& SortedItemsToExclude,
const FInstancedStruct& BuildInput,
EMetaHumanCharacterPaletteBuildQuality Quality,
ITargetPlatform* TargetPlatform,
const FOnBuildComplete& OnComplete
) const

   MetaHumanCollectionEditorPipeline.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual bool BeginCharacterEditorAssemble ( TNotNull< UMetaHumanCollection* > InCollection,
const FString& InCharacterName
)

 NOTE MetaHumanCollectionEditorPipeline.h  

virtual void BuildCollection ( const FBuildCollectionParams& Params,
const FOnBuildComplete& OnComplete
) const

   MetaHumanCollectionEditorPipeline.h  

virtual bool CanBuild()

 Utility to check if the pipeline has valid properties to build and unpack a collection Gives the opportunity for backwards compatibility checks and user prompts before even attempting to unpack MetaHumanCollectionEditorPipeline.h  

virtual void EndCharacterEditorAssemble ( TNotNull< UMetaHumanCollection* > InCollection
)

   MetaHumanCollectionEditorPipeline.h  
Returns an actor class that supports Instances targeting this pipeline. MetaHumanCollectionEditorPipeline.h  

virtual TNotNull< const UMetaHumanCollectionPipeline * > GetRuntimePipeline()

 Returns the runtime pipeline instance corresponding to this editor pipeline instance. MetaHumanCollectionEditorPipeline.h  

virtual bool ShouldCookInstanceAsAssembled ( TNotNull< const UMetaHumanInstance* > Instance
) const

 Returns true if the given MetaHuman Instance should have its assembly output baked into the cooked package by default. MetaHumanCollectionEditorPipeline.h  

virtual bool TryCreateItemForImport ( TNotNull< UMetaHumanCollection* > Collection,
FName SlotName,
TNotNull< const UMetaHumanWardrobeItem* > SourceWardrobeItem,
FMetaHumanCharacterPaletteItem& OutItem
)

 Creates a FMetaHumanCharacterPaletteItem for a Wardrobe Item whose pipeline is not directly compatible with the target slot. MetaHumanCollectionEditorPipeline.h  

virtual bool TryUnpackInstanceAssets ( TNotNull< UMetaHumanInstance* > Instance,
FInstancedStruct& AssemblyOutput,
TArray< FMetaHumanGeneratedAssetMetadata >& AssemblyAssetMetadata,
const FString& TargetFolder
) const

 IMPORTANT: Don't call this directly. MetaHumanCollectionEditorPipeline.h  

virtual void UnpackCollectionAssets ( TNotNull< const UMetaHumanCollection* > Collection,
FMetaHumanCollectionBuiltData& CollectionBuiltData,
const FOnUnpackComplete& OnComplete
) const

 IMPORTANT: Don't call this directly. MetaHumanCollectionEditorPipeline.h  

virtual bool UpdateActorBlueprint ( const UMetaHumanInstance* InCharacterInstance,
UBlueprint* InBlueprint
) const

 Updates the given blueprint asset with the given instance. MetaHumanCollectionEditorPipeline.h  

virtual bool ValidateCollection ( TNotNull< UMetaHumanCollection* > Collection
)

 Returns true if the Collection is in a valid state to be built. MetaHumanCollectionEditorPipeline.h  

virtual UBlueprint * WriteActorBlueprint ( const FString& InBlueprintPath
) const

 Generates a blueprint actor asset on the given path and quality level. MetaHumanCollectionEditorPipeline.h  

virtual UBlueprint * WriteActorBlueprint ( const FWriteBlueprintSettings& InWriteBlueprintSettings
) const

   MetaHumanCollectionEditorPipeline.h  

Overridden from UMetaHumanCharacterEditorPipeline

Name Remarks Include Path Unreal Specifiers

virtual TNotNull< const UMetaHumanCharacterPipeline * > GetRuntimeCharacterPipeline()

 Calls GetRuntimePipeline. No need for subclasses to implement this. MetaHumanCollectionEditorPipeline.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page