Navigation
Unreal Engine C++ API Reference > Runtime > Engine > PhysicalMaterials
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UPhysicalMaterialMask
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/PhysicalMaterials/PhysicalMaterialMask.h |
| Include | #include "PhysicalMaterials/PhysicalMaterialMask.h" |
Syntax
class UPhysicalMaterialMask : public UObject
Remarks
Physical material masks are used to map multiple physical materials to a single rendering material
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TEnumAsByte< enum TextureAddress > | AddressX | The addressing mode to use for the X axis. |
 |
TEnumAsByte< enum TextureAddress > | AddressY | The addressing mode to use for the Y axis. |
 |
TObjectPtr< class UAssetImportData > | AssetImportData | Object properties. |
 |
TObjectPtr< UTexture > | MaskTexture | Mask input texture, square aspect ratio recommended. |
 |
TUniquePtr< FPhysicsMaterialMaskHandle > | MaterialMaskHandle | |
 |
int32 | UVChannelIndex | StaticMesh UV channel index to use when performing lookups with this mask. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UPhysicalMaterialMask
(
const FObjectInitializer& ObjectInitializer |
||
 |
UPhysicalMaterialMask
(
FVTableHelper& Helper |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | DumpMaskData () |
Dump mask data to log display. |
  |
void | GenerateMaskData
(
TArray< uint32 >& OutMaskData, |
Helper method to generate mask data used at runtime based on mask texture. |
 |
FPhysicsMaterialMaskHandle & | Get the physics-interface derived version of this material | |
  |
uint32 | GetPhysMatIndex
(
const TArray< uint32 >& MaskData, |
Helper method to query phys mat index at a given UV position in mask data. |
 |
void | SetMaskTexture
(
UTexture* InMaskTexture, |
Helper method to set mask texture. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | Called to finish destroying the object. | |
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. | |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
Constants
| Name | Description |
|---|---|
| INVALID_MASK_INDEX |