FSkeletalMeshMerge Class Reference

#include <SkeletalMeshMerge.h>

Public Member Functions
ENGINE_API	FSkeletalMeshMerge (USkeletalMesh *InMergeMesh, const TArray< USkeletalMesh * > &InSrcMeshList, const TArray< FSkelMeshMergeSectionMapping > &InForceSectionMapping, int32 StripTopLODs, EMeshBufferAccess MeshBufferAccess=EMeshBufferAccess::Default, const FSkelMeshMergeUVTransformMapping *InSectionUVTransforms=nullptr)
ENGINE_API	FSkeletalMeshMerge (USkeletalMesh *InMergeMesh, const TArray< USkeletalMesh * > &InSrcMeshList, const TArray< FSkelMeshMergeSectionMapping > &InForceSectionMapping, int32 StripTopLODs, EMeshBufferAccess MeshBufferAccess, PRAGMA_DISABLE_DEPRECATION_WARNINGS FSkelMeshMergeUVTransforms *InSectionUVTransforms PRAGMA_ENABLE_DEPRECATION_WARNINGS)
PRAGMA_DISABLE_DEPRECATION_WARNINGS	FSkeletalMeshMerge (const FSkeletalMeshMerge &)=default
ENGINE_API PRAGMA_ENABLE_DEPRECATION_WARNINGS bool	DoMerge (TArray< FRefPoseOverride > *RefPoseOverrides=nullptr)
ENGINE_API void	MergeSkeleton (const TArray< FRefPoseOverride > *RefPoseOverrides=nullptr)
ENGINE_API bool	FinalizeMesh ()

Detailed Description

Utility for merging a list of skeletal meshes into a single mesh.

Constructor & Destructor Documentation

FSkeletalMeshMerge() [1/3]

FSkeletalMeshMerge::FSkeletalMeshMerge	(	USkeletalMesh *	InMergeMesh,
		const TArray< USkeletalMesh * > &	InSrcMeshList,
		const TArray< FSkelMeshMergeSectionMapping > &	InForceSectionMapping,
		int32	InStripTopLODs,
		EMeshBufferAccess	InMeshBufferAccess = EMeshBufferAccess::Default,
		const FSkelMeshMergeUVTransformMapping *	InSectionUVTransforms = nullptr
	)

Constructor

Parameters

InMergeMesh	- destination mesh to merge to
InSrcMeshList	- array of source meshes to merge
InForceSectionMapping	- optional array to map sections from the source meshes to merged section entries
StripTopLODs	- number of high LODs to remove from input meshes
bMeshNeedsCPUAccess	- (optional) if the resulting mesh needs to be accessed by the CPU for any reason (e.g. for spawning particle effects).
UVTransforms	- optional array to transform the UVs in each mesh

Constructor

Parameters

InMergeMesh	- destination mesh to merge to
InSrcMeshList	- array of source meshes to merge
InForceSectionMapping	- optional array to map sections from the source meshes to merged section entries

FSkeletalMeshMerge() [2/3]

ENGINE_API FSkeletalMeshMerge::FSkeletalMeshMerge	(	USkeletalMesh *	InMergeMesh,
		const TArray< USkeletalMesh * > &	InSrcMeshList,
		const TArray< FSkelMeshMergeSectionMapping > &	InForceSectionMapping,
		int32	StripTopLODs,
		EMeshBufferAccess	MeshBufferAccess,
		PRAGMA_DISABLE_DEPRECATION_WARNINGS FSkelMeshMergeUVTransforms *InSectionUVTransforms	PRAGMA_ENABLE_DEPRECATION_WARNINGS
	)

FSkeletalMeshMerge() [3/3]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FSkeletalMeshMerge::FSkeletalMeshMerge ( const FSkeletalMeshMerge &  )

default

Member Function Documentation

DoMerge()

ENGINE_API PRAGMA_ENABLE_DEPRECATION_WARNINGS bool FSkeletalMeshMerge::DoMerge

(

TArray< FRefPoseOverride > *

RefPoseOverrides = nullptr

)

Merge/Composite skeleton and meshes together from the list of source meshes.

Parameters

RefPoseOverrides

- An optional override for the merged skeleton's reference pose.

Returns

true if succeeded

FinalizeMesh()

bool FSkeletalMeshMerge::FinalizeMesh

(

)

Creates the merged mesh from the 'SrcMeshList' (note, this should only be called after MergeSkeleton()). Use when the reference skeleton is needed prior to finalizing the merged meshes (do not use with DoMerge()).

Returns

'true' if successful; 'false' otherwise.

MergeSkeleton()

void FSkeletalMeshMerge::MergeSkeleton

(

const TArray< FRefPoseOverride > *

RefPoseOverrides = nullptr

)

Create the 'MergedMesh' reference skeleton from the skeletons in the 'SrcMeshList'. Use when the reference skeleton is needed prior to finalizing the merged meshes (do not use with DoMerge()).

Parameters

RefPoseOverrides

- An optional override for the merged skeleton's reference pose.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/SkeletalMeshMerge.h
• Engine/Source/Runtime/Engine/Private/SkeletalMeshMerge.cpp