Navigation
API > API/Plugins > API/Plugins/MeshPaintingToolset
Inheritance Hierarchy
- UObject
- IInputBehaviorSource
- UInteractiveTool
- USingleSelectionTool
- UMeshSurfacePointTool
- UBaseBrushTool
- UMeshTexturePaintingTool
- UMeshTextureAssetPaintingTool
- UMeshTextureColorPaintingTool
References
| Module | MeshPaintingToolset |
| Header | /Engine/Plugins/MeshPainting/Source/MeshPaintingToolset/Public/MeshTexturePaintingTool.h |
| Include | #include "MeshTexturePaintingTool.h" |
Syntax
UCLASS (Abstract)
class UMeshTexturePaintingTool :
public UBaseBrushTool ,
public IMeshPaintSelectionInterface
Remarks
Base class for mesh texture painting tool.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TArray< FPaintableTexture > | PaintableTextures | Textures eligible for painting retrieved from the current selection |
   |
TMap< TObjectPtr< UTexture2D >, FPaintTexture2DData > | PaintTargetData | Stores data associated with our paint target textures |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FPaintTexture2DData * | AddPaintTargetData
(
UTexture2D* InTexture |
|
  |
void | ||
   |
bool | CanPaintTextureToComponent
(
UTexture* InTexture, |
|
 |
void | ||
 |
void | ||
   |
void | GetModifiedTexturesToSave
(
TArray< UObject* >& OutTexturesToSave |
|
 |
FPaintTexture2DData * | GetPaintTargetData
(
const UTexture2D* InTexture |
|
   |
UTexture2D * | GetSelectedPaintTexture
(
UMeshComponent const* InMeshComponent |
|
   |
int32 | GetSelectedUVChannel
(
UMeshComponent const* InMeshComponent |
|
 |
FOnPaintingFinishedDelegate & | ||
 |
void |
Overridden from UBaseBrushTool
| Type | Name | Description | |
|---|---|---|---|
  |
double | Subclasses should implement this to give an estimate of target dimension for brush size scaling |
Overridden from UMeshSurfacePointTool
| Type | Name | Description | |
|---|---|---|---|
  |
bool | HitTest
(
const FRay& Ray, |
|
  |
void | OnBeginDrag
(
const FRay& Ray |
UMeshSurfacePointTool implementation. |
  |
void | This function is called when the user releases the button driving a click-drag-release interaction | |
  |
void | OnUpdateDrag
(
const FRay& Ray |
This function is called each frame that the user is in a click-drag-release interaction |
Overridden from UInteractiveTool
| Type | Name | Description | |
|---|---|---|---|
   |
bool | CanAccept () |
|
   |
bool | HasAccept () |
|
   |
bool | HasCancel () |
|
  |
void | OnPropertyModified
(
UObject* PropertySet, |
Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes |
  |
void | OnTick
(
float DeltaTime |
Allow the Tool to do any necessary processing on Tick |
  |
void | Render
(
IToolsContextRenderAPI* RenderAPI |
Allow the Tool to do any custom drawing (ie via PDI/RHI) |
  |
void | Setup () |
UInteractiveTool. |
  |
void | Shutdown
(
EToolShutdownType ShutdownType |
Called by ToolManager to shut down the Tool |
Overridden from IClickDragBehaviorTarget
| Type | Name | Description | |
|---|---|---|---|
  |
FInputRayHit | CanBeginClickDragSequence
(
const FInputDeviceRay& PressPos |
IClickDragBehaviorTarget implementation. |
Overridden from IModifierToggleBehaviorTarget
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnUpdateModifierState
(
int ModifierID, |
Notify target of current modifier state |
Typedefs
| Name | Description |
|---|---|
| FOnPaintingFinishedDelegate |