Navigation
API > API/Plugins > API/Plugins/MeshPaintingToolset
Base class for mesh texture painting tool.
| Name | UMeshTexturePaintingTool |
| Type | class |
| Header File | /Engine/Plugins/MeshPainting/Source/MeshPaintingToolset/Public/MeshTexturePaintingTool.h |
| Include Path | #include "MeshTexturePaintingTool.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UMeshTexturePaintingTool :
public UBaseBrushTool ,
public IMeshPaintSelectionInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → USingleSelectionTool → UMeshSurfacePointTool → UBaseBrushTool → UMeshTexturePaintingTool
Implements Interfaces
- IClickDragBehaviorTarget
- IModifierToggleBehaviorTarget
- IHoverBehaviorTarget
- IInputBehaviorSource
- IInteractiveToolCameraFocusAPI
- IMeshPaintSelectionInterface
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMeshTexturePaintingTool() |
MeshTexturePaintingTool.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnPaintingFinishedDelegate | TBaseDelegate_OneParam< void, UMeshComponent * > | MeshTexturePaintingTool.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bArePainting | bool | MeshTexturePaintingTool.h | ||
| bCachedClickRay | bool | MeshTexturePaintingTool.h | ||
| bInDrag | bool | MeshTexturePaintingTool.h | ||
| bRequestPaintBucketFill | bool | MeshTexturePaintingTool.h | ||
| bRequiresRuntimeVirtualTextureUpdates | bool | MeshTexturePaintingTool.h | ||
| bResultValid | bool | MeshTexturePaintingTool.h | ||
| bStampPending | bool | MeshTexturePaintingTool.h | ||
| InitialMeshArea | double | MeshTexturePaintingTool.h | ||
| LastBestHitResult | FHitResult | MeshTexturePaintingTool.h | ||
| LastPaintRayResults | TArray< FPaintRayResults > | MeshTexturePaintingTool.h | ||
| OnPaintingFinishedDelegate | FOnPaintingFinishedDelegate | MeshTexturePaintingTool.h | ||
| PaintingTexture2D | TObjectPtr< UTexture2D > | The original texture that we're painting | MeshTexturePaintingTool.h |
|
| PaintingTransaction | TUniquePtr< FScopedTransaction > | Hold the transaction while we are painting | MeshTexturePaintingTool.h | |
| PendingClickRay | FRay | MeshTexturePaintingTool.h | ||
| PendingClickScreenPosition | FVector2D | MeshTexturePaintingTool.h | ||
| PendingStampRay | FRay | MeshTexturePaintingTool.h | ||
| SelectionMechanic | TObjectPtr< UMeshPaintSelectionMechanic > | MeshTexturePaintingTool.h |
|
|
| TextureProperties | TObjectPtr< UMeshTexturePaintingToolProperties > | MeshTexturePaintingTool.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void FloodCurrentPaintTexture() |
MeshTexturePaintingTool.h | ||
| MeshTexturePaintingTool.h | |||
virtual int32 GetSelectedUVChannel
(
UMeshComponent const* InMeshComponent |
MeshTexturePaintingTool.h | ||
FOnPaintingFinishedDelegate & OnPaintingFinished() |
MeshTexturePaintingTool.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPaintTexture2DData * AddPaintTargetData
(
UTexture2D* InTexture |
MeshTexturePaintingTool.h | ||
virtual void CacheTexturePaintData() |
MeshTexturePaintingTool.h | ||
virtual bool CanPaintTextureToComponent
(
UTexture* InTexture, |
MeshTexturePaintingTool.h | ||
void ClearAllTextureOverrides() |
MeshTexturePaintingTool.h | ||
FPaintTexture2DData * GetPaintTargetData
(
const UTexture2D* InTexture |
MeshTexturePaintingTool.h | ||
virtual UTexture2D * GetSelectedPaintTexture
(
UMeshComponent const* InMeshComponent |
MeshTexturePaintingTool.h | ||
void SetAllTextureOverrides() |
MeshTexturePaintingTool.h |
Overridden from UBaseBrushTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual double EstimateMaximumTargetDimension() |
MeshTexturePaintingTool.h |
Overridden from UMeshSurfacePointTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool HitTest
(
const FRay& Ray, |
MeshTexturePaintingTool.h | ||
virtual void OnBeginDrag
(
const FRay& Ray |
MeshTexturePaintingTool.h | ||
virtual void OnEndDrag
(
const FRay& Ray |
MeshTexturePaintingTool.h | ||
virtual void OnUpdateDrag
(
const FRay& Ray |
MeshTexturePaintingTool.h |
Overridden from UInteractiveTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanAccept() |
MeshTexturePaintingTool.h | ||
virtual bool HasAccept() |
MeshTexturePaintingTool.h | ||
virtual bool HasCancel() |
MeshTexturePaintingTool.h | ||
| MeshTexturePaintingTool.h | |||
virtual void OnTick
(
float DeltaTime |
MeshTexturePaintingTool.h | ||
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
MeshTexturePaintingTool.h | ||
virtual void Setup() |
MeshTexturePaintingTool.h | ||
virtual void Shutdown
(
EToolShutdownType ShutdownType |
MeshTexturePaintingTool.h |
Overridden from IClickDragBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit CanBeginClickDragSequence
(
const FInputDeviceRay& PressPos |
MeshTexturePaintingTool.h |
Overridden from IModifierToggleBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnUpdateModifierState
(
int ModifierID, |
MeshTexturePaintingTool.h |