1. Epic GamesDeveloper
  3. UMeshPaintingSubsystem

UMeshPaintingSubsystem

API > API/Plugins > API/Plugins/MeshPaintingToolset

   
Name UMeshPaintingSubsystem
Type class
Header File /Engine/Plugins/MeshPainting/Source/MeshPaintingToolset/Public/MeshPaintHelpers.h
Include Path #include "MeshPaintHelpers.h"

Syntax

UCLASS (MinimalAPI)  
class UMeshPaintingSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMeshPaintingSubsystem()

   MeshPaintHelpers.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bNeedsRecache bool   MeshPaintHelpers.h  
LastPaintedComponent TObjectPtr< UMeshComponent >   MeshPaintHelpers.h
  • Transient

Protected

Name Type Remarks Include Path Unreal Specifiers
bSelectionContainsPerLODColors bool   MeshPaintHelpers.h  
bSelectionSupportsTextureAssetPaint bool   MeshPaintHelpers.h  
bSelectionSupportsTextureColorPaint bool   MeshPaintHelpers.h  
bSelectionSupportsVertexPaint bool   MeshPaintHelpers.h  
ComponentToAdapterMap TMap< FString, TSharedPtr< IMeshPaintComponentAdapter > > Map of geometry adapters for each selected mesh component MeshPaintHelpers.h  
CopiedColorsByComponent TArray< FPerComponentVertexColorData > Contains copied vertex color data MeshPaintHelpers.h  
CopiedTextureData FImage Contains copied texture data MeshPaintHelpers.h  
PaintableComponents TArray< TWeakObjectPtr< UMeshComponent > > Mesh components within the current selection which are eligible for painting MeshPaintHelpers.h  
SelectedMeshComponents TArray< TWeakObjectPtr< UMeshComponent > > Currently selected mesh components as provided by the mode class MeshPaintHelpers.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddPaintableMeshComponent ( UMeshComponent* InComponent
)

   MeshPaintHelpers.h  

void AddSelectedMeshComponents ( const TArray< UMeshComponent* >& InComponents
)

   MeshPaintHelpers.h  

void AddToComponentToAdapterMap ( const UMeshComponent* InComponent,
const TSharedPtr< IMeshPaintComponentAdapter > InAdapter
)

   MeshPaintHelpers.h  

void ApplyBrushToVertex ( const FVector& VertexPosition,
const FMatrix& InverseBrushMatrix,
const float BrushRadius,
const float BrushFalloffAmount,
const float BrushStrength,
const T& PaintValue,
T& InOutValue
)

   MeshPaintHelpers.h  

void ApplyFillWithMask ( FColor& InOutColor,
const FColor& MaskColor,
const FColor& FillColor
)

   MeshPaintHelpers.h  

bool ApplyPerTrianglePaintAction ( IMeshPaintComponentAdapter* Adapter,
const FVector& CameraPosition,
const FVector& HitPosition,
const UBrushBaseProperties* Settings,
FPerTrianglePaintAction Action,
bool bOnlyFrontFacingTriangles
)

 Given the adapter, settings and view-information retrieves influences triangles and applies Action to them MeshPaintHelpers.h  

bool ApplyPerVertexPaintAction ( FPerVertexPaintActionArgs& InArgs,
FPerVertexPaintAction Action
)

 Given arguments for an action, and an action - retrieves influences vertices and applies Action to them MeshPaintHelpers.h  

void ApplyVertexColorPaint ( const FMeshPaintParameters& InParams,
const FLinearColor& OldColor,
FLinearColor& NewColor,
const float PaintAmount
)

 Applies Vertex Color Painting according to the given parameters MeshPaintHelpers.h  

void ApplyVertexColorsToAllLODs ( IMeshPaintComponentAdapter& GeometryInfo,
USkeletalMeshComponent* SkeletalMeshComponent
)

 Applies the vertex colors found in LOD level 0 to all contained LOD levels in the SkeletalMeshComponent MeshPaintHelpers.h  

void ApplyVertexColorsToAllLODs ( IMeshPaintComponentAdapter& GeometryInfo,
UStaticMeshComponent* StaticMeshComponent
)

 Applies the vertex colors found in LOD level 0 to all contained LOD levels in the StaticMeshComponent MeshPaintHelpers.h  

void ApplyVertexColorsToAllLODs ( IMeshPaintComponentAdapter& GeometryInfo,
UMeshComponent* InMeshComponent
)

 Applies vertex color painting found on LOD 0 to all lower LODs. MeshPaintHelpers.h  

void ApplyVertexWeightPaint ( const FMeshPaintParameters& InParams,
const FLinearColor& OldColor,
FLinearColor& NewColor,
const float PaintAmount
)

 Applies Vertex Blend Weight Painting according to the given parameters MeshPaintHelpers.h  

void CacheSelectionData ( const int32 PaintLODIndex,
const int32 UVChannel
)

   MeshPaintHelpers.h  

void ClearMeshTextureOverrides ( const IMeshPaintComponentAdapter& GeometryInfo,
UMeshComponent* InMeshComponent
)

   MeshPaintHelpers.h  

void ClearPaintableMeshComponents()

   MeshPaintHelpers.h  

void ClearSelectedMeshComponents()

   MeshPaintHelpers.h  

void ClearSelectionLODColors()

   MeshPaintHelpers.h  

float ComputePaintMultiplier ( float SquaredDistanceToVertex2D,
float BrushStrength,
float BrushInnerRadius,
float BrushRadialFalloff,
float BrushInnerDepth,
float BrushDepthFallof,
float VertexDepthToBrush
)

 Computes the Paint power multiplier value MeshPaintHelpers.h  

void CreateComponentMeshPaintTexture ( UStaticMeshComponent* StaticMeshComponent
)

 Creates mesh paint texture associated with the mesh component MeshPaintHelpers.h  

void CreateComponentMeshPaintTexture ( UStaticMeshComponent* StaticMeshComponent,
FImageView const& InImage
)

   MeshPaintHelpers.h  

UTexture * CreateMeshPaintTexture ( UObject* Outer,
uint32 TextureSize
)

 Creates and returns a mesh paint texture that isn't attached to a mesh component MeshPaintHelpers.h  

bool DoesMeshComponentContainPerLODColors ( const UMeshComponent* MeshComponent
)

 Checks whether or not the mesh components contains per lod colors (for all LODs) MeshPaintHelpers.h  

void FillSkeletalMeshVertexColors ( USkeletalMeshComponent* MeshComponent,
int32 LODIndex,
const FColor FillColor,
const FColor MaskColor
)

   MeshPaintHelpers.h  

void FillStaticMeshVertexColors ( UStaticMeshComponent* MeshComponent,
int32 LODIndex,
const FColor FillColor,
const FColor MaskColor
)

 Fills all vertex colors for all LODs found in the given mesh component with Fill Color MeshPaintHelpers.h  

bool FindHitResult ( const FRay Ray,
FHitResult& BestTraceResult
)

   MeshPaintHelpers.h  

void ForceRenderMeshLOD ( UMeshComponent* Component,
int32 LODIndex
)

 Forces the component to render LOD level at LODIndex instead of the view-based LOD level ( X = 0 means do not force the LOD, X > 0 means force the lod to X - 1 ) MeshPaintHelpers.h  

FLinearColor GenerateColorForTextureWeight ( const int32 NumWeights,
const int32 WeightIndex
)

 Generate texture weight color for given number of weights and the to-paint index MeshPaintHelpers.h  

TSharedPtr< IMeshPaintComponentAdapter > GetAdapterForComponent ( const UMeshComponent* InComponent
) const

 Map of geometry adapters for each selected mesh component MeshPaintHelpers.h  

TArray< FColor > GetColorDataForLOD ( const UStaticMesh* StaticMesh,
int32 LODIndex
)

 Retrieves the vertex colors from the given LOD level in the Mesh MeshPaintHelpers.h  

TArray< FPerComponentVertexColorData > GetCopiedColorsByComponent()

   MeshPaintHelpers.h  

FImage const & GetCopiedTexture()

   MeshPaintHelpers.h  

TArray< FColor > GetInstanceColorDataForLOD ( const UStaticMeshComponent* MeshComponent,
int32 LODIndex
)

 Retrieves the per-instance vertex colors from the given LOD level in the StaticMeshComponent MeshPaintHelpers.h  

void GetInstanceColorDataInfo ( const UStaticMeshComponent* StaticMeshComponent,
int32 LODIndex,
int32& OutTotalInstanceVertexColorBytes
)

 Retrieves the number of bytes used to store the per-instance LOD vertex color data from the mesh component MeshPaintHelpers.h  

uint32 GetMeshPaintTextureResourceSize ( UMeshComponent* MeshComponent
)

 Retrieves the resource size for the mesh paint texture on the component MeshPaintHelpers.h  

FIntPoint GetMinMaxUVChannelsToPaint()

   MeshPaintHelpers.h  

int32 GetNumberOfLODs ( const UMeshComponent* MeshComponent
)

 Returns the number of Mesh LODs for the given MeshComponent MeshPaintHelpers.h  

int32 GetNumberOfUVs ( const UMeshComponent* MeshComponent,
int32 LODIndex
) const

 Returns the number of Texture Coordinates for the given MeshComponent MeshPaintHelpers.h  

TArray< UMeshComponent * > GetPaintableMeshComponents()

   MeshPaintHelpers.h  

bool GetPerVertexPaintInfluencedVertices ( FPerVertexPaintActionArgs& InArgs,
TSet< int32 >& InfluencedVertices
)

   MeshPaintHelpers.h  

TArray< UMeshComponent * > GetSelectedMeshComponents()

   MeshPaintHelpers.h  

bool GetSelectionSupportsTextureAssetPaint()

   MeshPaintHelpers.h  

bool GetSelectionSupportsTextureColorPaint()

   MeshPaintHelpers.h  

bool GetSelectionSupportsVertexPaint()

   MeshPaintHelpers.h  

uint32 GetVertexColorBufferSize ( UMeshComponent* MeshComponent,
int32 LODIndex,
bool bInstance
)

 Retrieves the Vertex Color buffer size for the given LOD level in the Mesh MeshPaintHelpers.h  

TArray< FVector > GetVerticesForLOD ( const UStaticMesh* StaticMesh,
int32 LODIndex
)

 Retrieves the vertex positions from the given LOD level in the Mesh MeshPaintHelpers.h  

bool HasPaintableMesh ( UActorComponent* Component
)

   MeshPaintHelpers.h  

bool IsPointInfluencedByBrush ( const FVector& InPosition,
const FMeshPaintParameters& InParams,
float& OutSquaredDistanceToVertex2D,
float& OutVertexDepthToBrush
)

 Checks whether or not a point is influenced by the painting brush according to the given parameters MeshPaintHelpers.h  

bool IsPointInfluencedByBrush ( const FVector2D& BrushSpacePosition,
const float BrushRadiusSquared,
float& OutInRangeValue
)

   MeshPaintHelpers.h  

bool PaintVertex ( const FVector& InVertexPosition,
const FMeshPaintParameters& InParams,
FColor& InOutVertexColor
)

 Applies vertex painting to InOutvertexColor according to the given parameters MeshPaintHelpers.h  

FColor PickVertexColorFromTextureData ( const uint8* MipData,
const FVector2D& UVCoordinate,
const UTexture2D* Texture,
const FColor ColorMask
)

 Helper function to retrieve vertex color from a UTexture given a UVCoordinate MeshPaintHelpers.h  

bool PropagateColorsToRawMesh ( UStaticMesh* StaticMesh,
int32 LODIndex,
FStaticMeshComponentLODInfo& ComponentLODInfo
)

 Propagates per-instance vertex colors to the underlying Mesh for the given LOD Index MeshPaintHelpers.h  

void Refresh()

   MeshPaintHelpers.h  

void RemoveComponentInstanceVertexColors ( UStaticMeshComponent* StaticMeshComponent
)

 Removes vertex colors associated with the mesh component MeshPaintHelpers.h  

void RemoveComponentMeshPaintTexture ( UStaticMeshComponent* StaticMeshComponent
)

 Removes mesh paint texture associated with the mesh component MeshPaintHelpers.h  

void RemoveInstanceVertexColors ( UObject* Obj
)

 Removes vertex colors associated with the object MeshPaintHelpers.h  

void ResetState()

   MeshPaintHelpers.h  

bool SelectionContainsPerLODColors()

   MeshPaintHelpers.h  

void SetColorDataForLOD ( USkeletalMesh* SkeletalMesh,
int32 LODIndex,
const FColor FillColor,
const FColor MaskColor
)

 Sets all vertex colors for a specific LOD level in the SkeletalMesh to FillColor MeshPaintHelpers.h  

void SetCopiedColorsByComponent ( TArray< FPerComponentVertexColorData >& InCopiedColors
)

   MeshPaintHelpers.h  

void SetCopiedTexture ( UTexture* InTexture
)

   MeshPaintHelpers.h  

void SetInstanceColorDataForLOD ( UStaticMeshComponent* MeshComponent,
int32 LODIndex,
const TArray< FColor >& Colors
)

 Sets the specific (LOD Index) per-instance vertex colors for the given StaticMeshComponent to the supplied Color array MeshPaintHelpers.h  

void SetInstanceColorDataForLOD ( UStaticMeshComponent* MeshComponent,
int32 LODIndex,
const FColor FillColor,
const FColor MaskColor
)

 Sets the specific (LOD Index) per-instance vertex colors for the given StaticMeshComponent to a single Color value MeshPaintHelpers.h  

bool TryGetNumberOfLODs ( const UMeshComponent* MeshComponent,
int32& OutNumLODs
)

 OutNumLODs is set to number of Mesh LODs for the given MeshComponent and returns true, or returns false of given mesh component has no valid LODs MeshPaintHelpers.h  

void UpdatePaintSupportState()

   MeshPaintHelpers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page