UMeshPartitionDefinition

Asset holding shared properties and settings for all components in a MegaMesh.

API > API/Plugins > API/Plugins/MeshPartition

Asset holding shared properties and settings for all components in a MegaMesh.

MegaMeshClassVersion is used to track changes in the behavior of this class with respect to building sections. It is used, along with GatherDependencies, when determining whether existing sections are up to date, or need to be rebuilt.

It should be bumped whenever code behavior changes in a way that affects how existing sections would be built. NOTE: Changing the MegaMeshClassVersion here invalidates ALL compiled sections (they all use this class).

   
Name UMeshPartitionDefinition
Type class
Header File /Engine/Plugins/Experimental/MeshPartition/Source/MeshPartition/Public/MeshPartitionDefinition.h
Include Path #include "MeshPartitionDefinition.h"

Syntax

UCLASS (MinimalAPI, Meta=(MegaMeshClassVersion="1"))  
class UMeshPartitionDefinition :  
    public UDataAsset,  
    public IMaterialEnumerationProvider

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UMeshPartitionDefinition()

   MeshPartitionDefinition.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UMeshPartitionDefinition()

   MeshPartitionDefinition.h  

Typedefs

Name Type Remarks Include Path
FOnDefinitionModified TMulticastDelegate_TwoParams< void, const FName &, const FName & >   MeshPartitionDefinition.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ChannelMap MeshPartition::FChannelMap   MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Material"
  • Meta=(ShowOnlyInnerProperties)
ChannelTexelSize float Channel Texel Size controls the resolution of rasterization of the textures capturing the channel signal. MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Material"
  • Meta=(ClampMin="0.05")
ChannelUVLayoutMethod EChannelCollectionUVLayoutMethod Algorithm used to unwrap section UVs when rasterizing channel textures. MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Material"
  • Meta=(DisplayName="Channel UV Layout Method")
CompiledSectionBuildVariants TArray< MeshPartition::FCompiledSectionBuildVariant >   MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Build"
  • Meta=(TitleProperty="Name")
DefaultPhysicalMaterial TObjectPtr< UPhysicalMaterial >   MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Material|Physics"
Material TObjectPtr< UMaterialInterface >   MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Material"
MaterialCacheTexelSize float   MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Material"
  • Meta=(ClampMin="0.05")
meta   Target sample count per square meter of section surface area. MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Material|Experimental VEUV Controls"
  • Meta=(EditCondition="ChannelUVLayoutMethod == EChannelCollectionUVLayoutMethod::VolumeEncoded", EditConditionHides, ClampMin="0.001", DisplayName="VEUV Samples Per Square Meter")
ModifierTypePriorities TArray< FName >   MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Modifiers"
  • Meta=(DisplayName="Modifier Layer Priorities")
OnDefinitionModified FOnDefinitionModified   MeshPartitionDefinition.h  
PerPlatformRuntimeSettings MeshPartition::FPerPlatformRuntimeSettings   MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Build|Platforms"
PhysicalMaterialChannels TArray< FPhysicalMaterialChannel >   MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Material|Physics"
PreviewSectionBuildVariant MeshPartition::FCommonBuildVariant   MeshPartitionDefinition.h
  • EditAnywhere
  • Category="Preview"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void GatherDependencies ( MeshPartition::IDependencyInterface& InDependencies,
FName InBuildVariantName
) const

 Return a hash of all the settings that affect the compiled section results - FILTERED to only those used by the BuildVariant MeshPartitionDefinition.h  

TArray< FName > GetAllCompiledSectionBuildVariantNames()

   MeshPartitionDefinition.h  
  MeshPartitionDefinition.h  
  MeshPartitionDefinition.h  

TArray< FName > GetChannelNames()

   MeshPartitionDefinition.h
  • CallInEditor

FVector GetChannelPlaneProjectionFixedNormal()

   MeshPartitionDefinition.h  

EPlaneProjectionNormalSource GetChannelPlaneProjectionNormalSource()

   MeshPartitionDefinition.h  

float GetChannelTexelSize()

   MeshPartitionDefinition.h  

EChannelCollectionUVLayoutMethod GetChannelUVLayoutMethod()

   MeshPartitionDefinition.h  

float GetChannelVEUVSamplesPerSquareMeter()

   MeshPartitionDefinition.h  

FIntVector GetChannelVEUVVoxelCount()

   MeshPartitionDefinition.h  

const MeshPartition::FCompiledSectionBuildVariant & GetCompiledSectionBuildVariantByName ( const FName& BuildVariantName
) const

   MeshPartitionDefinition.h  

TArray< FName > GetCompiledSectionBuildVariantNamesForCurrentEditorPreview ( const FName& InPreviewPlatformName,
ITargetPlatform* PreviewPlatform
) const

 Get the set of build variants to use in PIE for the specified preview platform. If no preview platform is specified, returns the build variant for the current platform. MeshPartitionDefinition.h  

TArray< FName > GetCompiledSectionBuildVariantNamesForPlatform ( const ITargetPlatform* TargetPlatform
) const

   MeshPartitionDefinition.h  

TArray< FName > GetCompiledSectionBuildVariantNamesForPlatform ( const FName& InPlatformName,
const FName& InIniPlatformName
) const

 Note that the platform name includes build type like "WindowsClient", while the IniPlatformName is just the platform "Windows". It looks for PlatformName match first, then if not found it looks for IniPlatformName. MeshPartitionDefinition.h  

TArray< FName > GetCompiledSectionBuildVariantNamesForPlatforms ( TArray< ITargetPlatform* > TargetPlatforms
) const

 Get the set of build variants needed for the specified target platforms. MeshPartitionDefinition.h  

TConstArrayView< MeshPartition::FCompiledSectionBuildVariant > GetCompiledSectionBuildVariants()

   MeshPartitionDefinition.h  

UPhysicalMaterial * GetDefaultPhysicalMaterial()

   MeshPartitionDefinition.h  

UMaterialInterface * GetMaterial()

   MeshPartitionDefinition.h  

float GetMaterialCacheTexelSize()

   MeshPartitionDefinition.h  

const TArray< FName > & GetModifierTypePriorities()

   MeshPartitionDefinition.h
  • BlueprintCallable
  • Category="Modifiers"

FOnDefinitionModified & GetOnDefinitionModified()

   MeshPartitionDefinition.h  

const TArray< FPhysicalMaterialChannel > & GetPhysicalMaterialChannels()

   MeshPartitionDefinition.h  

const MeshPartition::FCommonBuildVariant & GetPreviewSectionBuildVariant()

   MeshPartitionDefinition.h  

void SetPreviewSectionBuildVariant ( const MeshPartition::FCommonBuildVariant& InNewPreviewBuildVairant
)

   MeshPartitionDefinition.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void ForEachEntry ( TFunctionRef< void(FName Name, int32Value)> Iterator
) const

   MeshPartitionDefinition.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

   MeshPartitionDefinition.h  

virtual void PostLoad()

   MeshPartitionDefinition.h  

virtual bool ResolveValue ( FName EntryName,
int32& OutValue,
int32 DefaultValue
) const

   MeshPartitionDefinition.h  

virtual void Serialize ( FArchive& Ar
)

 UObject Implementation. MeshPartitionDefinition.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool DoesPropertyNameRequireRebuild ( const FName& InMemberName,
const FName& InName
)

   MeshPartitionDefinition.h  

static const UMeshPartitionDefinition * GetDefaultMegaMeshDefinition()

   MeshPartitionDefinition.h  

static bool IsMaterialPropertyName ( const FName& InName
)

   MeshPartitionDefinition.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page