1. Epic GamesDeveloper
  3. MeshPaintHelpers

MeshPaintHelpers

API > API/Editor > API/Editor/MeshPaint

References

   
Module MeshPaint
Header /Engine/Source/Editor/MeshPaint/Public/MeshPaintHelpers.h
Include #include "MeshPaintHelpers.h"

Syntax

class MeshPaintHelpers

Functions

  Type Name Description
Public function Static void

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

  
Public function Static void

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

  
Public function Static bool

ApplyPerTrianglePaintAction ( IMeshPaintGeometryAdapter* Adapter,
const FVector& CameraPosition,
const FVector& HitPosition,
const UPaintBrushSettings* Settings,
FPerTrianglePaintAction Action
)

 Given the adapter, settings and view-information retrieves influences triangles and applies Action to them
Public function Static bool Given arguments for an action, and an action - retrieves influences vertices and applies Action to them
Public function Static void

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

 Applies Vertex Color Painting according to the given parameters
Public function Static void

ApplyVertexColorsToAllLODs ( IMeshPaintGeometryAdapter& GeometryInfo,
USkeletalMeshComponent* SkeletalMeshComponent
)

 Applies the vertex colors found in LOD level 0 to all contained LOD levels in the SkeletalMeshComponent
Public function Static void

ApplyVertexColorsToAllLODs ( IMeshPaintGeometryAdapter& GeometryInfo,
UStaticMeshComponent* StaticMeshComponent
)

 Applies the vertex colors found in LOD level 0 to all contained LOD levels in the StaticMeshComponent
Public function Static void

ApplyVertexColorsToAllLODs ( IMeshPaintGeometryAdapter& GeometryInfo,
UMeshComponent* InMeshComponent
)

 Applies vertex color painting found on LOD 0 to all lower LODs.
Public function Static void

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

 Applies Vertex Blend Weight Painting according to the given parameters
Public function Static void

ClearMeshTextureOverrides ( const IMeshPaintGeometryAdapter& GeometryInfo,
UMeshComponent* InMeshComponent
)

 Clears all texture overrides for this component.
Public function Static float

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

 Computes the Paint power multiplier value
Public function Static bool

DoesMeshComponentContainPerLODColors ( const UMeshComponent* MeshComponent
)

 Checks whether or not the mesh components contains per lod colors (for all LODs)
Public function Static void

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

  
Public function Static 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
Public function Static 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 )
Public function Static FLinearColor

GenerateColorForTextureWeight ( const int32 NumWeights,
const int32 WeightIndex
)

 Generate texture weight color for given number of weights and the to-paint index
Public function Static TArray< FColor >

GetColorDataForLOD ( const UStaticMesh* StaticMesh,
int32 LODIndex
)

 Retrieves the vertex colors from the given LOD level in the Static Mesh
Public function Static TArray< FColor >

GetInstanceColorDataForLOD ( const UStaticMeshComponent* MeshComponent,
int32 LODIndex
)

 Retrieves the per-instance vertex colors from the given LOD level in the StaticMeshComponent
Public function Static 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 static mesh component
Public function Static int32

GetNumberOfLODs ( const UMeshComponent* MeshComponent
)

 Returns the number of Mesh LODs for the given MeshComponent
Public function Static int32

GetNumberOfUVs ( const UMeshComponent* MeshComponent,
int32 LODIndex
)

 Returns the number of Texture Coordinates for the given MeshComponent
Public function Static bool

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

  
Public function Static uint32

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

 Retrieves the Vertex Color buffer size for the given LOD level in the Static Mesh
Public function Static TArray< FVector >

GetVerticesForLOD ( const UStaticMesh* StaticMesh,
int32 LODIndex
)

 Retrieves the vertex positions from the given LOD level in the Static Mesh
Public function Static void

ImportVertexColorsFromTexture ( UMeshComponent* MeshComponent
)

 Helper function to import Vertex Colors from a Texture to the specified MeshComponent (makes use of SImportVertexColorsOptions Widget)
Protected function Static void

ImportVertexColorsToSkeletalMesh ( USkeletalMesh* SkeletalMesh,
const UVertexColorImportOptions* Options,
UTexture2D* Texture
)

 Imports vertex colors from a Texture to the specified Skeletal Mesh according to user-set options
Protected function Static void

ImportVertexColorsToStaticMesh ( UStaticMesh* StaticMesh,
const UVertexColorImportOptions* Options,
UTexture2D* Texture
)

 Imports vertex colors from a Texture to the specified Static Mesh according to user-set options
Protected function Static void

ImportVertexColorsToStaticMeshComponent ( UStaticMeshComponent* StaticMeshComponent,
const UVertexColorImportOptions* Options,
UTexture2D* Texture
)

 Imports vertex colors from a Texture to the specified Static Mesh Component according to user-set options
Public function Static bool

IsInVRMode ( const FEditorViewportClient* ViewportClient
)

 Checks whether or not the given Viewport Client is a VR editor viewport client
Public function Static 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
Public function Static bool

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

  
Public function Static bool

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

 Applies vertex painting to InOutvertexColor according to the given parameters
Protected function Static 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
Public function Static bool

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

 Propagates per-instance vertex colors to the underlying Static Mesh for the given LOD Index
Public function Static void

RemoveComponentInstanceVertexColors ( UStaticMeshComponent* StaticMeshComponent
)

 Removes vertex colors associated with the static mesh component
Public function Static void

RemoveInstanceVertexColors ( UObject* Obj
)

 Removes vertex colors associated with the object
Public function Static bool

RetrieveViewportPaintRays ( const FSceneView* View,
FViewport* Viewport,
FPrimitiveDrawInterface* PDI,
TArray< FPaintRay >& OutPaintRays
)

  
Public function Static 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
Public function Static 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
Public function Static 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
Public function Static void

SetRealtimeViewport ( bool bRealtime
)

 Sets whether or not the level viewport should be real time rendered move or viewport as parameter?
Public function Static void

SetViewportColorMode ( EMeshPaintColorViewMode ColorViewMode,
FEditorViewportClient* ViewportClient
)

 Forces the Viewport Client to render using the given Viewport Color ViewMode
Public function Static 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

Classes

  Type Name Description
Public struct FPaintRay    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page