UMeshAttributePaintTool

[UMeshAttributePaintTool](API\Plugins\MeshModelingTools\UMeshAttributePaintTool) paints single-channel float attributes on a MeshDescription or DynamicMesh Note: a new experimental version of this tool is UMeshAttributePaintToolV2

API > API/Plugins > API/Plugins/MeshModelingTools

UMeshAttributePaintTool paints single-channel float attributes on a MeshDescription or DynamicMesh Note: a new experimental version of this tool is UMeshAttributePaintToolV2

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

Syntax

UCLASS (MinimalAPI)  
class UMeshAttributePaintTool :  
    public UDynamicMeshBrushTool ,  
    public IInteractiveToolManageGeometrySelectionAPI

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Structs

Name Remarks
FAttributeData  
FBrushActionData  
FStampActionData  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
GeometrySelection TOptional< UE::Geometry::FGeometrySelection >   MeshAttributePaintTool.h  
SelectionTids TSet< int32 >   MeshAttributePaintTool.h  
SelectionVids TSet< int32 >   MeshAttributePaintTool.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UE::Geometry::TDynamicVerticesOctree3< FDynamicMesh3 > & GetVerticesOctree()

   MeshAttributePaintTool.h  

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

   MeshAttributePaintTool.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void RequestAction ( EMeshAttributePaintToolActions ActionType
)

   MeshAttributePaintTool.h  

virtual void SetColorMap ( TUniquePtr< FFloatAttributeColorMapper > ColorMap
)

   MeshAttributePaintTool.h  

virtual void SetWorld ( UWorld* World
)

   MeshAttributePaintTool.h  

Overridden from UMeshSurfacePointTool

Name Remarks Include Path Unreal Specifiers

virtual bool HitTest ( const FRay& Ray,
FHitResult& OutHit
)

 UMeshSurfacePointTool. MeshAttributePaintTool.h  

virtual void OnBeginDrag ( const FRay& Ray
)

   MeshAttributePaintTool.h  

virtual void OnEndDrag ( const FRay& Ray
)

   MeshAttributePaintTool.h  

virtual void OnUpdateDrag ( const FRay& Ray
)

   MeshAttributePaintTool.h  

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual bool HasAccept()

   MeshAttributePaintTool.h  

virtual bool HasCancel()

   MeshAttributePaintTool.h  

virtual void OnTick ( float DeltaTime
)

   MeshAttributePaintTool.h  

virtual void RegisterActions ( FInteractiveToolActionSet& ActionSet
)

   MeshAttributePaintTool.h  

virtual void Setup()

   MeshAttributePaintTool.h  

Overridden from IHoverBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual bool OnUpdateHover ( const FInputDeviceRay& DevicePos
)

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

Protected

Name Remarks Include Path Unreal Specifiers

void BeginChange()

   MeshAttributePaintTool.h  

double CalculateBrushFalloff ( double Distance
)

   MeshAttributePaintTool.h  

void CalculateVertexROI ( const FBrushStampData& Stamp,
TArray< int >& VertexROI
)

   MeshAttributePaintTool.h  
  MeshAttributePaintTool.h  

void StoreCurrentAttribute()

   MeshAttributePaintTool.h  

void UpdateSelectedAttribute ( int32 NewSelectedIndex
)

   MeshAttributePaintTool.h  

void UpdateVisibleAttribute()

   MeshAttributePaintTool.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual void ApplyAction ( EMeshAttributePaintToolActions ActionType
)

   MeshAttributePaintTool.h  

virtual void ApplyStamp ( const FBrushStampData& Stamp
)

   MeshAttributePaintTool.h  

virtual void ApplyStamp_FloodFill ( const FBrushStampData& Stamp,
FStampActionData& ActionData
)

   MeshAttributePaintTool.h  

virtual void ApplyStamp_Paint ( const FBrushStampData& Stamp,
FStampActionData& ActionData
)

   MeshAttributePaintTool.h  

virtual void ExternalUpdateValues ( int32 AttribIndex,
const TArray< int32 >& VertexIndices,
const TArray< float >& NewValues
)

   MeshAttributePaintTool.h  

virtual FString GetPropertyCacheIdentifier()

 Should be overriden by subclasses so that settings are not shared across this tool and subclasses. MeshAttributePaintTool.h  

virtual void InitializeAttributes()

   MeshAttributePaintTool.h  

Overridden from UDynamicMeshBrushTool

Name Remarks Include Path Unreal Specifiers

virtual void OnShutdown ( EToolShutdownType ShutdownType
)

 Subclasses can override these to customize behavior MeshAttributePaintTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page