1. Epic GamesDeveloper
  3. IMeshPainter

IMeshPainter

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

API > API/Editor > API/Editor/MeshPaint

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

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

Syntax

class IMeshPainter

Constructors

Name Remarks Include Path Unreal Specifiers

IMeshPainter()

   IMeshPainter.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IMeshPainter()

   IMeshPainter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ActorDeselected ( AActor* Actor
)

 Is called by the owning EdMode when an actor is selected in the viewport IMeshPainter.h  

void ActorSelected ( AActor* Actor
)

 Is called by the owning EdMode when an actor is de-selected in the viewport IMeshPainter.h  

void AddReferencedObjects ( FReferenceCollector& Collector
)

 Functionality to collect painter referenced objects to prevent GC IMeshPainter.h  

virtual void FinishPainting()

 If painting is in progress will propagate changes and cleanup the painting state IMeshPainter.h  

UPaintBrushSettings * GetBrushSettings()

 Returns an instance of UPaintBrushSettings (base or derived) which contains the basic settings used for painting IMeshPainter.h  

const FHitResult GetHitResult ( const FVector& Origin,
const FVector& Direction
)

 Returns a HitResult structure given a origin and direction to trace a ray for IMeshPainter.h  

TSharedPtr< IMeshPaintGeometryAdapter > GetMeshAdapterForComponent ( const UMeshComponent* Component
)

 Tries to retrieves a valid mesh adapter for the given component (derived painters can cache these hence no base implementation) IMeshPainter.h  

UMeshPaintSettings * GetPainterSettings()

 Returns an instance of UMeshPainterSettings used for specific types of painting IMeshPainter.h  

TSharedPtr< class SWidget > GetWidget()

 Returns a SWidget which represents the painters state and allows for changes / extra functionality IMeshPainter.h  

virtual bool InputKey ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
FKey InKey,
EInputEvent InEvent
)

 Allows painter to act on specific key actions IMeshPainter.h  

virtual bool IsPainting()

 Returns whether or not painting (of any sorts) is in progress IMeshPainter.h  

virtual bool Paint ( FViewport* Viewport,
const FVector& InCameraOrigin,
const TArrayView< TPair< FVector, FVector > >& Rays
)

 'Normal' painting functionality, called when the user tries to paint on a mesh using the mouse IMeshPainter.h  

virtual 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 IMeshPainter.h  

void Refresh()

 Refreshes the underlying data IMeshPainter.h  

virtual void RegisterCommands ( TSharedRef< FUICommandList > CommandList
)

 Registers a base set of commands for altering UBrushSettings IMeshPainter.h  

void Render ( const FSceneView* View,
FViewport* Viewport,
FPrimitiveDrawInterface* PDI
)

 Renders ray widgets for the active viewport interactors IMeshPainter.h  

void Reset()

 Resets the state of the painter IMeshPainter.h  

virtual void Tick ( FEditorViewportClient* ViewportClient,
float DeltaTime
)

 Base ticking functionality, keeps track of time and caches VR interactors IMeshPainter.h  

virtual void UnregisterCommands ( TSharedRef< FUICommandList > CommandList
)

 Unregisters a base set of commands IMeshPainter.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BeginTransaction ( const FText Description
)

 Begins and keeps track of an Editor transaction with the given Description IMeshPainter.h  

void EndTransaction()

 Ends the current transaction IMeshPainter.h  

bool PaintInternal ( const FVector& InCameraOrigin,
const TArrayView< TPair< FVector, FVector > >& Rays,
EMeshPaintAction PaintAction,
float PaintStrength
)

 Internal painting functionality, is called from Paint and PaintVR and implemented in the derived painters IMeshPainter.h  

void RenderInteractors ( const FSceneView* View,
FViewport* Viewport,
FPrimitiveDrawInterface* PDI,
bool bRenderVertices,
ESceneDepthPriorityGroup DepthGroup
)

 Renders viewport interactor widget IMeshPainter.h  

virtual 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 IMeshPainter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page