1. Epic GamesDeveloper
  3. UMeshGroupPaintTool

UMeshGroupPaintTool

Mesh Element Paint Tool Class

API > API/Plugins > API/Plugins/MeshModelingTools

Mesh Element Paint Tool Class

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

Syntax

UCLASS (MinimalAPI)  
class UMeshGroupPaintTool : public UMeshSculptToolBase

Inheritance Hierarchy

Implements Interfaces

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
FilterProperties TObjectPtr< UGroupPaintBrushFilterProperties > Filters on paint brush MeshGroupPaintTool.h  
FreezeActions TObjectPtr< UMeshGroupPaintToolFreezeActions >   MeshGroupPaintTool.h  
PolygroupLayerProperties TObjectPtr< UPolygroupLayersProperties >   MeshGroupPaintTool.h  
PolyLassoMechanic TObjectPtr< UPolyLassoMarqueeMechanic > Marquee Support MeshGroupPaintTool.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
EraseBrushOpProperties TObjectPtr< UGroupEraseBrushOpProps >   MeshGroupPaintTool.h  
PaintBrushOpProperties TObjectPtr< UGroupPaintBrushOpProps > This will be of type UGroupPaintBrushOpProps, we keep a ref so we can change active group ID on pick. MeshGroupPaintTool.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AllocateNewGroupAndSetAsCurrentAction()

   MeshGroupPaintTool.h  

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

   MeshGroupPaintTool.h  

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

   MeshGroupPaintTool.h  

void ClearAllGroupsAction()

   MeshGroupPaintTool.h  

void ClearCurrentGroupAction()

   MeshGroupPaintTool.h  

void FloodFillCurrentGroupAction()

   MeshGroupPaintTool.h  

void GrowCurrentGroupAction()

   MeshGroupPaintTool.h  

bool HaveVisibilityFilter()

   MeshGroupPaintTool.h  

bool IsInBrushSubMode()

   MeshGroupPaintTool.h  

virtual void RequestAction ( EMeshGroupPaintToolActions ActionType
)

 Action support MeshGroupPaintTool.h  

void SetTrianglesToGroupID ( const TSet< int32 >& Triangles,
int32 ToGroupID,
bool bIsErase
)

   MeshGroupPaintTool.h  

void ShrinkCurrentGroupAction()

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

virtual void DecreaseBrushRadiusAction()

   MeshGroupPaintTool.h  

virtual void DecreaseBrushRadiusSmallStepAction()

   MeshGroupPaintTool.h  

virtual void IncreaseBrushRadiusAction()

 We override these so we can update the separate BrushSize property added for this tool MeshGroupPaintTool.h  

virtual void IncreaseBrushRadiusSmallStepAction()

   MeshGroupPaintTool.h  

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual bool CanAccept()

   MeshGroupPaintTool.h  

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

   MeshGroupPaintTool.h  

virtual bool HasAccept()

   MeshGroupPaintTool.h  

virtual bool HasCancel()

   MeshGroupPaintTool.h  

virtual void OnTick ( float DeltaTime
)

   MeshGroupPaintTool.h  

virtual void RegisterActions ( FInteractiveToolActionSet& ActionSet
)

   MeshGroupPaintTool.h  

virtual void Setup()

   MeshGroupPaintTool.h  

virtual void Shutdown ( EToolShutdownType ShutdownType
)

   MeshGroupPaintTool.h  

Overridden from IHoverBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual bool OnUpdateHover ( const FInputDeviceRay& DevicePos
)

   MeshGroupPaintTool.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ApplyAction ( EMeshGroupPaintToolActions ActionType
)

   MeshGroupPaintTool.h  

bool ApplyStamp()

   MeshGroupPaintTool.h  

void BeginChange()

   MeshGroupPaintTool.h  

void ClearAllFrozenGroups()

   MeshGroupPaintTool.h  

void EmitFrozenGroupsChange ( const TArray< int32 >& FromGroups,
const TArray< int32 >& ToGroups,
const FText& ChangeText
)

   MeshGroupPaintTool.h  

void EndChange()

   MeshGroupPaintTool.h  

void FreezeOtherGroups ( int32 GroupID
)

   MeshGroupPaintTool.h  

FColor GetColorForGroup ( int32 GroupID
)

   MeshGroupPaintTool.h  

bool GetInEraseStroke()

   MeshGroupPaintTool.h  

void OnDynamicMeshComponentChanged()

 Realtime visualization MeshGroupPaintTool.h  

void OnPolyLassoFinished ( const FCameraPolyLasso& Lasso,
bool bCanceled
)

   MeshGroupPaintTool.h  

void OnSelectedGroupLayerChanged()

   MeshGroupPaintTool.h  

void PrecomputeFilterData()

   MeshGroupPaintTool.h  

bool SyncMeshWithGroupBuffer ( FDynamicMesh3* Mesh
)

   MeshGroupPaintTool.h  

void ToggleFrozenGroup ( int32 GroupID
)

   MeshGroupPaintTool.h  

void UpdateActiveGroupLayer()

   MeshGroupPaintTool.h  

bool UpdateBrushPosition ( const FRay& WorldRay
)

   MeshGroupPaintTool.h  

void UpdateBrushType ( EMeshGroupPaintBrushType BrushType
)

   MeshGroupPaintTool.h  

void UpdateROI ( const FSculptBrushStamp& CurrentStamp
)

   MeshGroupPaintTool.h  

bool UpdateStampPosition ( const FRay& WorldRay
)

   MeshGroupPaintTool.h  

void UpdateSubToolType ( EMeshGroupPaintInteractionType NewType
)

   MeshGroupPaintTool.h  

void WaitForPendingUndoRedoUpdate()

   MeshGroupPaintTool.h  

Overridden from UMeshSculptToolBase

Name Remarks Include Path Unreal Specifiers

virtual int32 FindHitSculptMeshTriangleConst ( const FRay3d& LocalRay
) const

   MeshGroupPaintTool.h  

virtual int32 FindHitTargetMeshTriangleConst ( const FRay3d& LocalRay
) const

   MeshGroupPaintTool.h  

virtual TUniquePtr< FMeshSculptBrushOp > & GetActiveBrushOp()

   MeshGroupPaintTool.h  

virtual FDynamicMesh3 * GetBaseMesh ()

   MeshGroupPaintTool.h  

virtual const FDynamicMesh3 * GetBaseMesh ()

   MeshGroupPaintTool.h  

virtual UBaseDynamicMeshComponent * GetSculptMeshComponent()

 UMeshSculptToolBase API. MeshGroupPaintTool.h  

virtual void OnBeginStroke ( const FRay& WorldRay
)

   MeshGroupPaintTool.h  

virtual void OnCancelStroke()

   MeshGroupPaintTool.h  

virtual void OnEndStroke()

   MeshGroupPaintTool.h  

virtual bool SharesBrushPropertiesChanges()

 For any subclass where this returns false, BrushProperties will not be automatically saved/restored, so the class won't use BrushProperties changes made in other tools. MeshGroupPaintTool.h  

virtual bool ShowWorkPlane()

   MeshGroupPaintTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page