Module |
|
Header |
/Engine/Source/Editor/MeshPaint/Public/IMeshPainter.h |
Include |
#include "IMeshPainter.h" |
class IMeshPainter
Base class for creating a mesh painter, has basic functionality combined with IMeshPaintMode and requires painting/situation-specific information to do actual painting
Name | Description | ||
---|---|---|---|
|
bArePainting |
Flag for whether or not we are currently painting |
|
|
CurrentViewportInteractor |
When painting in VR, this is viewport interactor we are using |
|
|
HoverVertexPointColor |
||
|
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 |
|
|
VertexPointColor |
||
|
WidgetLineColor |
||
|
float |
WidgetLineThickness |
Name | Description | |
---|---|---|
|
IMeshPainter() |
Name | Description | |
---|---|---|
|
~IMeshPainter() |
Name | Description | ||
---|---|---|---|
|
ActorDeselected ( |
Is called by the owning EdMode when an actor is selected in the viewport |
|
|
ActorSelected ( |
Is called by the owning EdMode when an actor is de-selected in the viewport |
|
|
AddReferencedObjects ( |
Functionality to collect painter referenced objects to prevent GC |
|
|
BeginTransaction ( |
Begins and keeps track of an Editor transaction with the given Description |
|
|
EndTransaction() |
Ends the current transaction |
|
|
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 |
Returns a HitResult structure given a origin and direction to trace a ray for |
|
TSharedPtr< ... |
GetMeshAdapterForComponent ( |
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 |
|
InputKey ( |
Allows painter to act on specific key actions |
|
|
IsPainting() |
Returns whether or not painting (of any sorts) is in progress |
|
|
Paint |
'Normal' painting functionality, called when the user tries to paint on a mesh using the mouse |
|
|
Paint |
'Normal' painting functionality, called when the user tries to paint on a mesh using the mouse |
|
|
PaintInternal ( |
Internal painting functionality, is called from Paint and PaintVR and implemented in the derived painters |
|
|
PaintVR ( |
VR painting functionality, called when the user tries to paint on a mesh using a VR controller |
|
|
Refresh() |
Refreshes the underlying data |
|
|
RegisterCommands ( |
Registers a base set of commands for altering UBrushSettings |
|
|
Render ( |
Renders ray widgets for the active viewport interactors |
|
|
RenderInteractors ( |
Renders viewport interactor widget |
|
|
RenderInteractorWidget ( |
Functionality for rendering the interactor widget given its positional information and paint action |
|
|
Reset() |
Resets the state of the painter |
|
|
Tick ( |
Base ticking functionality, keeps track of time and caches VR interactors |
|
|
UnregisterCommands ( |
Unregisters a base set of commands |