IMeshPainter

Base class for creating a mesh painter, has basic functionality combined with IMeshPaintMode and requires painting/situation-specific information to do actual painting

Unreal Engine C++ API Reference > Editor > MeshPaint

References

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

Syntax

class IMeshPainter  

Remarks

Base class for creating a mesh painter, has basic functionality combined with IMeshPaintMode and requires painting/situation-specific information to do actual painting

Variables

Type Name Description
bool bArePainting Flag for whether or not we are currently painting
FLinearColor HoverVertexPointColor  
FScopedTransact... PaintTransaction Painting transaction instance which is currently active
float Time Overall time value kept for drawing effects
float TimeSinceStartedPainting Time kept since the user has started painting
TSharedPtr< FUI... UICommandList  
FLinearColor VertexPointColor  
FLinearColor WidgetLineColor  
float WidgetLineThickness  

Constructors

Type Name Description
  IMeshPainter ()  

Destructors

Type Name Description
  ~IMeshPainter ()  

Functions

Type Name Description
void ActorDeselected ( AActor* Actor ) Is called by the owning EdMode when an actor is selected in the viewport
void ActorSelected ( AActor* Actor ) Is called by the owning EdMode when an actor is de-selected in the viewport
void AddReferencedObjects ( FReferenceCollector& Collector ) Functionality to collect painter referenced objects to prevent GC
void BeginTransaction ( const FText Description ) Begins and keeps track of an Editor transaction with the given Description
void EndTransaction () Ends the current transaction
void FinishPainting () If painting is in progress will propagate changes and cleanup the painting state
UPaintBrushS... GetBrushSettings () Returns an instance of UPaintBrushSettings (base or derived) which contains the basic settings used for painting
const FHitRe... GetHitResult ( const FVector& Origin, const FVector& Direction ) Returns a HitResult structure given a origin and direction to trace a ray for
TSharedPtr< ... GetMeshAdapterForComponent ( const UMeshComponent* Componen... ) Tries to retrieves a valid mesh adapter for the given component (derived painters can cache these hence no base implementation)
UMeshPaintSe... GetPainterSettings () Returns an instance of UMeshPainterSettings used for specific types of painting
TSharedPtr< ... GetWidget () Returns a SWidget which represents the painters state and allows for changes / extra functionality
bool InputKey ( FEditorViewportClient* InViewp..., FViewport* InViewport, FKey InKey, EInputEvent InEvent ) Allows painter to act on specific key actions
bool IsPainting () Returns whether or not painting (of any sorts) is in progress
bool Paint ( FViewport* Viewport, const FVector& InCameraOrigin, const TArrayView< TPair< FVector, F... ) 'Normal' painting functionality, called when the user tries to paint on a mesh using the mouse
bool Paint ( FViewport* Viewport, const FVector& InCameraOrigin, const FVector& InRayOrigin, const FVector& InRayDirection ) 'Normal' painting functionality, called when the user tries to paint on a mesh using the mouse
bool PaintInternal ( const FVector& InCameraOrigin, const TArrayView< TPair< FVector, F..., EMeshPaintAction PaintAction, float PaintStrength ) Internal painting functionality, is called from Paint and PaintVR and implemented in the derived painters
void Refresh () Refreshes the underlying data
void RegisterCommands ( TSharedRef< FUICommandList > Comman... ) Registers a base set of commands for altering UBrushSettings
void Render ( const FSceneView* View, FViewport* Viewport, FPrimitiveDrawInterface* PDI ) Renders ray widgets for the active viewport interactors
void RenderInteractors ( const FSceneView* View, FViewport* Viewport, FPrimitiveDrawInterface* PDI, bool bRenderVertices, ESceneDepthPriorityGroup DepthGroup ) Renders viewport interactor widget
void RenderInteractorWidget ( const FVector& InCameraOrigin, const FVector& InRayOrigin, const FVector& InRayDirection, FPrimitiveDrawInterface* PDI, EMeshPaintAction PaintAction, bool bRenderVertices, ESceneDepthPriorityGroup DepthGroup ) Functionality for rendering the interactor widget given its positional information and paint action
void Reset () Resets the state of the painter
void Tick ( FEditorViewportClient* Viewpor..., float DeltaTime ) Base ticking functionality, keeps track of time and caches VR interactors
void UnregisterCommands ( TSharedRef< FUICommandList > Comman... ) Unregisters a base set of commands

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library