UPhysicalMaterialMask | Unreal Engine 5.7 Documentation

Physical material masks are used to map multiple physical materials to a single rendering material


Name	UPhysicalMaterialMask
Type	class
Header File	/Engine/Source/Runtime/Engine/Classes/PhysicalMaterials/PhysicalMaterialMask.h
Include Path	#include "PhysicalMaterials/PhysicalMaterialMask.h"

Syntax

UCLASS (BlueprintType, Blueprintable, CollapseCategories, HideCategories=Object, MinimalAPI)  
class UPhysicalMaterialMask : public UObject

Name	Remarks	Include Path	Unreal Specifiers
UPhysicalMaterialMask ( const FObjectInitializer& ObjectInitializer )		PhysicalMaterials/PhysicalMaterialMask.h
UPhysicalMaterialMask ( FVTableHelper& Helper )		PhysicalMaterials/PhysicalMaterialMask.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~UPhysicalMaterialMask()		PhysicalMaterials/PhysicalMaterialMask.h

Name	Type	Remarks	Include Path
INVALID_MASK_INDEX	uint32		PhysicalMaterials/PhysicalMaterialMask.h

Name	Type	Remarks	Include Path	Unreal Specifiers
AddressX	TEnumAsByte< enum TextureAddress >	The addressing mode to use for the X axis.	PhysicalMaterials/PhysicalMaterialMask.h	EditAnywhere BlueprintReadWrite Meta=(DisplayName="X-axis Tiling Method") Category=TextureSource
AddressY	TEnumAsByte< enum TextureAddress >	The addressing mode to use for the Y axis.	PhysicalMaterials/PhysicalMaterialMask.h	EditAnywhere BlueprintReadWrite Meta=(DisplayName="Y-axis Tiling Method") Category=TextureSource
AssetImportData	TObjectPtr< class UAssetImportData >	Object properties.	PhysicalMaterials/PhysicalMaterialMask.h	VisibleAnywhere Instanced Category=ImportSettings
MaskTexture	TObjectPtr< UTexture >	Mask input texture, square aspect ratio recommended.	PhysicalMaterials/PhysicalMaterialMask.h	VisibleAnywhere BlueprintReadOnly Category=TextureSource
MaterialMaskHandle	TUniquePtr< FPhysicsMaterialMaskHandle >		PhysicalMaterials/PhysicalMaterialMask.h
UVChannelIndex	int32	StaticMesh UV channel index to use when performing lookups with this mask.	PhysicalMaterials/PhysicalMaterialMask.h	EditAnywhere BlueprintReadWrite Category=TextureSource

Name	Remarks	Include Path
void DumpMaskData()	Dump mask data to log display.	PhysicalMaterials/PhysicalMaterialMask.h
void GenerateMaskData ( TArray< uint32 >& OutMaskData, int32& OutSizeX, int32& OutSizeY ) const	Helper method to generate mask data used at runtime based on mask texture.	PhysicalMaterials/PhysicalMaterialMask.h
FPhysicsMaterialMaskHandle & GetPhysicsMaterialMask()	Get the physics-interface derived version of this material	PhysicalMaterials/PhysicalMaterialMask.h
void SetMaskTexture ( UTexture* InMaskTexture, const FString& InTextureFilename )	Helper method to set mask texture.	PhysicalMaterials/PhysicalMaterialMask.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void FinishDestroy()		PhysicalMaterials/PhysicalMaterialMask.h
virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )		PhysicalMaterials/PhysicalMaterialMask.h
virtual void PostInitProperties()		PhysicalMaterials/PhysicalMaterialMask.h
virtual void PostLoad()		PhysicalMaterials/PhysicalMaterialMask.h

Name	Remarks	Include Path	Unreal Specifiers
static uint32 GetPhysMatIndex ( const TArray< uint32 >& MaskData, int32 SizeX, int32 SizeY, int32 AddressX, int32 AddressY, float U, float V )	Helper method to query phys mat index at a given UV position in mask data.	PhysicalMaterials/PhysicalMaterialMask.h