IMeshDescriptionProvider Class Reference

#include <MeshDescriptionProvider.h>

Public Member Functions
virtual const FMeshDescription *	GetMeshDescription (const FGetMeshParameters &GetMeshParams=FGetMeshParameters())=0
virtual FMeshDescription	GetEmptyMeshDescription ()=0
virtual FMeshDescription	GetMeshDescriptionCopy (const FGetMeshParameters &GetMeshParams)
virtual TArray< EMeshLODIdentifier >	GetAvailableLODs (bool bSkipAutoGenerated=true) const
virtual EMeshLODIdentifier	GetMeshDescriptionLOD () const
virtual bool	SupportsLODs () const
virtual TArray< int32 >	GetPolygonGroupToMaterialIndexMap () const

Member Function Documentation

GetAvailableLODs()

virtual TArray< EMeshLODIdentifier > IMeshDescriptionProvider::GetAvailableLODs ( bool  bSkipAutoGenerated = true ) const

inlinevirtual

For providers that have LODs (i.e. if SupportsLODs returns true), returns an array of all available LODs. Otherwise, returns an array with just the Default LOD.

Parameters

bSkipAutoGenerated

Skip auto-generated LODs, which have no associated source Mesh Description

GetEmptyMeshDescription()

virtual FMeshDescription IMeshDescriptionProvider::GetEmptyMeshDescription ( )

pure virtual

Returns an empty mesh description appropriate for the provider, i.e. configured with appropriate mesh attributes but otherwise devoid of topology or element data.

Note: Some of our code expects at least FStaticMeshAttributes to be registered with the provided mesh description, and will break if some of the attributes that FStaticMeshAttributes uses are not present. The only reason we don't provide a default implementation here that is identical to the one used in StaticMeshToolTarget.cpp is to avoid a dependency on the static mesh description module in ITF.

GetMeshDescription()

virtual const FMeshDescription * IMeshDescriptionProvider::GetMeshDescription ( const FGetMeshParameters &  GetMeshParams = FGetMeshParameters() )

pure virtual

Access the MeshDescription available through this Provider. Note that this MeshDescription may or may not be owned by the provider and should not be modified directly. Use IMeshDescriptionCommitter for writes.

Returns

pointer to MeshDescription

GetMeshDescriptionCopy()

virtual FMeshDescription IMeshDescriptionProvider::GetMeshDescriptionCopy ( const FGetMeshParameters &  GetMeshParams )

inlinevirtual

Get a copy of the MeshDescription available through this Provider.

GetMeshDescriptionLOD()

virtual EMeshLODIdentifier IMeshDescriptionProvider::GetMeshDescriptionLOD ( ) const

inlinevirtual

For providers that have LODs (i.e. if SupportsLODs returns true), returns the LOD that GetMeshDescription/etc will return. Otherwise, returns Default LOD.

GetPolygonGroupToMaterialIndexMap()

virtual TArray< int32 > IMeshDescriptionProvider::GetPolygonGroupToMaterialIndexMap ( ) const

inlinevirtual

Returns

a mapping from section ID to material ID. If empty, an identity mapping is assumed.

SupportsLODs()

virtual bool IMeshDescriptionProvider::SupportsLODs ( ) const

inlinevirtual

Returns

true if the provider is able to provide different Mesh Descriptions for different requested LODs. If so, GetAvailableLODs() will return the available LODs.

---

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

• Engine/Source/Runtime/InteractiveToolsFramework/Public/TargetInterfaces/MeshDescriptionProvider.h