1. Epic GamesDeveloper
  3. UMeshVertexPaintTool

UMeshVertexPaintTool

Mesh Vertex Color Painting TOol

API > API/Plugins > API/Plugins/MeshModelingTools

Mesh Vertex Color Painting TOol

   
Name UMeshVertexPaintTool
Type class
Header File /Engine/Plugins/Runtime/MeshModelingToolset/Source/MeshModelingTools/Public/MeshVertexPaintTool.h
Include Path #include "MeshVertexPaintTool.h"

Syntax

UCLASS (MinimalAPI)  
class UMeshVertexPaintTool :  
    public UMeshSculptToolBase ,  
    public IInteractiveToolManageGeometrySelectionAPI

Inheritance Hierarchy

Implements Interfaces

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BasicProperties TObjectPtr< UVertexPaintBasicProperties >   MeshVertexPaintTool.h  
FilterProperties TObjectPtr< UVertexPaintBrushFilterProperties > Filters on paint brush MeshVertexPaintTool.h  
PolygroupLayerProperties TObjectPtr< UPolygroupLayersProperties >   MeshVertexPaintTool.h  
PolyLassoMechanic TObjectPtr< UPolyLassoMarqueeMechanic > Marquee Support MeshVertexPaintTool.h  
QuickActions TObjectPtr< UMeshVertexPaintToolQuickActions >   MeshVertexPaintTool.h  
SymmetryProperties TObjectPtr< UMeshSymmetryProperties >   MeshVertexPaintTool.h  
UtilityActions TObjectPtr< UMeshVertexPaintToolUtilityActions >   MeshVertexPaintTool.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bApplySymmetry bool   MeshVertexPaintTool.h  
bMeshSymmetryIsValid bool   MeshVertexPaintTool.h  
EraseBrushOpProperties TObjectPtr< UVertexColorPaintBrushOpProps > This will be of type UVertexPaintBrushOpProps, we keep a ref so we can change active color on pick. MeshVertexPaintTool.h  
GeometrySelection TOptional< UE::Geometry::FGeometrySelection >   MeshVertexPaintTool.h  
PaintBrushOpProperties TObjectPtr< UVertexColorPaintBrushOpProps > This will be of type UVertexPaintBrushOpProps, we keep a ref so we can change active color on pick. MeshVertexPaintTool.h  
SelectionTids TSet< int32 >   MeshVertexPaintTool.h  
SymmetricROITriangleBuffer TArray< int32 >   MeshVertexPaintTool.h  
SymmetricTriangleROI TSet< int >   MeshVertexPaintTool.h  
SymmetricVertexROI TArray< int >   MeshVertexPaintTool.h  
Symmetry TPimplPtr< UE::Geometry::FMeshPlanarSymmetry >   MeshVertexPaintTool.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyCurrentUtilityAction()

   MeshVertexPaintTool.h  

void ApplyVisibilityFilter ( TSet< int32 >& Triangles,
TArray< int32 >& ROIBuffer,
TArray< int32 >& OutputBuffer
)

   MeshVertexPaintTool.h  

void ApplyVisibilityFilter ( const TArray< int32 >& Triangles,
TArray< int32 >& VisibleTriangles
)

   MeshVertexPaintTool.h  

void BlendAllSeams()

   MeshVertexPaintTool.h  

void CopyChannelToChannel()

   MeshVertexPaintTool.h  

void CopyFromWeightMap()

   MeshVertexPaintTool.h  

void CopyToOtherLODs()

   MeshVertexPaintTool.h  

void CopyToSpecificLOD()

   MeshVertexPaintTool.h  

void FillChannels()

   MeshVertexPaintTool.h  

void FloodFillColorAction ( FLinearColor Color
)

   MeshVertexPaintTool.h  

bool HaveVisibilityFilter()

   MeshVertexPaintTool.h  

void InvertChannels()

   MeshVertexPaintTool.h  

bool IsInBrushSubMode()

   MeshVertexPaintTool.h  

virtual void RequestAction ( EMeshVertexPaintToolActions ActionType
)

 Action support MeshVertexPaintTool.h  

void SetGeometrySelection ( const UE::Geometry::FGeometrySelection& SelectionIn
)

   MeshVertexPaintTool.h  

void SetTrianglesToVertexColor ( const TArray< int32 >& Triangles,
const FLinearColor& ToColor
)

   MeshVertexPaintTool.h  

void SetTrianglesToVertexColor ( const TSet< int32 >& Triangles,
const FLinearColor& ToColor
)

   MeshVertexPaintTool.h  

void SwapChannels()

   MeshVertexPaintTool.h  

Overridden from UMeshSculptToolBase

Name Remarks Include Path Unreal Specifiers

virtual void CommitResult ( UBaseDynamicMeshComponent* Component,
bool bModifiedTopology
)

 Subclass can override this to change what results are written. MeshVertexPaintTool.h  

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual bool CanAccept()

   MeshVertexPaintTool.h  

virtual void DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

   MeshVertexPaintTool.h  

virtual bool HasAccept()

   MeshVertexPaintTool.h  

virtual bool HasCancel()

   MeshVertexPaintTool.h  

virtual void OnPropertyModified ( UObject* PropertySet,
FProperty* Property
)

   MeshVertexPaintTool.h  

virtual void OnTick ( float DeltaTime
)

   MeshVertexPaintTool.h  

virtual void RegisterActions ( FInteractiveToolActionSet& ActionSet
)

   MeshVertexPaintTool.h  

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

   MeshVertexPaintTool.h  

virtual void Setup()

   MeshVertexPaintTool.h  

virtual void Shutdown ( EToolShutdownType ShutdownType
)

   MeshVertexPaintTool.h  

Overridden from IHoverBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual bool OnUpdateHover ( const FInputDeviceRay& DevicePos
)

   MeshVertexPaintTool.h  

Overridden from IInteractiveToolManageGeometrySelectionAPI

Name Remarks Include Path Unreal Specifiers

virtual bool IsInputSelectionValidOnOutput()

 IInteractiveToolManageGeometrySelectionAPI this tool won't update external geometry selection or change selection-relevant mesh IDs. MeshVertexPaintTool.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ApplyAction ( EMeshVertexPaintToolActions ActionType
)

   MeshVertexPaintTool.h  

void ApplyChannelFilter ( const FVector4f& CurColor,
FVector4f& NewColor
)

   MeshVertexPaintTool.h  

bool ApplyStamp()

   MeshVertexPaintTool.h  

void BeginChange()

   MeshVertexPaintTool.h  

void EndChange()

   MeshVertexPaintTool.h  

void ExternalUpdateValues ( const TArray< int32 >& ElementIDs,
const TArray< FVector4f >& NewValues
)

   MeshVertexPaintTool.h  

UE::Geometry::FDynamicMeshColorOverlay * GetActiveColorOverlay()

   MeshVertexPaintTool.h  

FColor GetColorForGroup ( int32 GroupID
)

   MeshVertexPaintTool.h  

bool GetInEraseStroke()

   MeshVertexPaintTool.h  

virtual FString GetPropertyCacheIdentifier()

   MeshVertexPaintTool.h  

void InitializeElementROIFromTriangleROI ( const TArray< int32 >& TriangleROI,
bool bInitializeFlatBuffers
)

   MeshVertexPaintTool.h  

void OnChannelFilterModified()

   MeshVertexPaintTool.h  

void OnDynamicMeshComponentChanged()

 Realtime visualization MeshVertexPaintTool.h  

void OnPolyLassoFinished ( const FCameraPolyLasso& Lasso,
bool bCanceled
)

   MeshVertexPaintTool.h  

void OnSelectedGroupLayerChanged()

   MeshVertexPaintTool.h  

void PrecomputeFilterData()

   MeshVertexPaintTool.h  

bool SyncMeshWithColorBuffer ( FDynamicMesh3* Mesh
)

   MeshVertexPaintTool.h  

void UpdateActiveGroupLayer()

   MeshVertexPaintTool.h  

bool UpdateBrushPosition ( const FRay& WorldRay
)

   MeshVertexPaintTool.h  

void UpdateBrushType ( EMeshVertexPaintBrushType BrushType
)

   MeshVertexPaintTool.h  

void UpdateROI ( const FSculptBrushStamp& CurrentStamp
)

   MeshVertexPaintTool.h  

void UpdateSecondaryBrushType ( EMeshVertexPaintSecondaryActionType NewType
)

   MeshVertexPaintTool.h  

bool UpdateStampPosition ( const FRay& WorldRay
)

   MeshVertexPaintTool.h  

void UpdateSubToolType ( EMeshVertexPaintInteractionType NewType
)

   MeshVertexPaintTool.h  

void UpdateVertexPaintMaterialMode()

   MeshVertexPaintTool.h  

void WaitForPendingUndoRedoUpdate()

   MeshVertexPaintTool.h  

Overridden from UMeshSculptToolBase

Name Remarks Include Path Unreal Specifiers

virtual int32 FindHitSculptMeshTriangleConst ( const FRay3d& LocalRay
) const

   MeshVertexPaintTool.h  

virtual int32 FindHitTargetMeshTriangleConst ( const FRay3d& LocalRay
) const

   MeshVertexPaintTool.h  

virtual TUniquePtr< FMeshSculptBrushOp > & GetActiveBrushOp()

   MeshVertexPaintTool.h  

virtual FDynamicMesh3 * GetBaseMesh ()

   MeshVertexPaintTool.h  

virtual const FDynamicMesh3 * GetBaseMesh ()

   MeshVertexPaintTool.h  

virtual UBaseDynamicMeshComponent * GetSculptMeshComponent()

 UMeshSculptToolBase API. MeshVertexPaintTool.h  

virtual float GetStampTemporalFlowRate()

 Currently using flow rate as 'brush strength', so disable temporal stamp spacing. MeshVertexPaintTool.h  

virtual void OnBeginStroke ( const FRay& WorldRay
)

   MeshVertexPaintTool.h  

virtual void OnCancelStroke()

   MeshVertexPaintTool.h  

virtual void OnEndStroke()

   MeshVertexPaintTool.h  

virtual bool ShowWorkPlane()

   MeshVertexPaintTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page