1. Epic GamesDeveloper
  3. MeshPaintHelpers

MeshPaintHelpers

API > API/Editor > API/Editor/MeshPaint

   
Name MeshPaintHelpers
Type class
Header File /Engine/Source/Editor/MeshPaint/Public/MeshPaintHelpers.h
Include Path #include "MeshPaintHelpers.h"

Syntax

class MeshPaintHelpers

Structs

Name Remarks
FPaintRay  

Functions

Static

Name Remarks Include Path Unreal Specifiers

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

   MeshPaintHelpers.h  

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

   MeshPaintHelpers.h  

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 MeshPaintHelpers.h  

static bool ApplyPerVertexPaintAction ( FPerVertexPaintActionArgs& InArgs,
FPerVertexPaintAction Action
)

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

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

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

static void ApplyVertexColorsToAllLODs ( IMeshPaintGeometryAdapter& GeometryInfo,
USkeletalMeshComponent* SkeletalMeshComponent
)

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

static void ApplyVertexColorsToAllLODs ( IMeshPaintGeometryAdapter& GeometryInfo,
UStaticMeshComponent* StaticMeshComponent
)

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

static void ApplyVertexColorsToAllLODs ( IMeshPaintGeometryAdapter& GeometryInfo,
UMeshComponent* InMeshComponent
)

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

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

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

static void ClearMeshTextureOverrides ( const IMeshPaintGeometryAdapter& GeometryInfo,
UMeshComponent* InMeshComponent
)

 Clears all texture overrides for this component. MeshPaintHelpers.h  

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

 Computes the Paint power multiplier value MeshPaintHelpers.h  

static bool DoesMeshComponentContainPerLODColors ( const UMeshComponent* MeshComponent
)

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

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

   MeshPaintHelpers.h  

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 MeshPaintHelpers.h  

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 ) MeshPaintHelpers.h  

static FLinearColor GenerateColorForTextureWeight ( const int32 NumWeights,
const int32 WeightIndex
)

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

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

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

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

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

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 MeshPaintHelpers.h  

static int32 GetNumberOfLODs ( const UMeshComponent* MeshComponent
)

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

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

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

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

   MeshPaintHelpers.h  

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

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

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

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

static void ImportVertexColorsFromTexture ( UMeshComponent* MeshComponent
)

 Helper function to import Vertex Colors from a Texture to the specified MeshComponent (makes use of SImportVertexColorsOptions Widget) MeshPaintHelpers.h  

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 MeshPaintHelpers.h  

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 MeshPaintHelpers.h  

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 MeshPaintHelpers.h  

static bool IsInVRMode ( const FEditorViewportClient* ViewportClient
)

 Checks whether or not the given Viewport Client is a VR editor viewport client MeshPaintHelpers.h  

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 MeshPaintHelpers.h  

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

   MeshPaintHelpers.h  

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

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

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 MeshPaintHelpers.h  

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

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

static void RemoveComponentInstanceVertexColors ( UStaticMeshComponent* StaticMeshComponent
)

 Removes vertex colors associated with the static mesh component MeshPaintHelpers.h  

static void RemoveInstanceVertexColors ( UObject* Obj
)

 Removes vertex colors associated with the object MeshPaintHelpers.h  

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

   MeshPaintHelpers.h  

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 MeshPaintHelpers.h  

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 MeshPaintHelpers.h  

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 MeshPaintHelpers.h  

static void SetRealtimeViewport ( bool bRealtime
)

 Sets whether or not the level viewport should be real time rendered move or viewport as parameter? MeshPaintHelpers.h  

static void SetViewportColorMode ( EMeshPaintColorViewMode ColorViewMode,
FEditorViewportClient* ViewportClient
)

 Forces the Viewport Client to render using the given Viewport Color ViewMode MeshPaintHelpers.h  

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 MeshPaintHelpers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page