Navigation
API > API/Plugins > API/Plugins/MeshPaintingToolset
USingleClickTool is perhaps the simplest possible interactive tool. It simply reacts to default primary button clicks for the active device (eg left-mouse clicks).
The function IsHitByClick() determines what is clickable by this Tool. The default is to return true, which means the click will activate anywhere (the Tool itself has no notion of Actors, Components, etc). You can override this function to, for example, filter out clicks that don't hit a target object, etc.
The function OnClicked() implements the action that will occur when a click happens. You must override this to implement any kind of useful behavior.
| Name | UMeshClickTool |
| Type | class |
| Header File | /Engine/Plugins/MeshPainting/Source/MeshPaintingToolset/Public/MeshSelect.h |
| Include Path | #include "MeshSelect.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UMeshClickTool :
public USingleClickTool ,
public IMeshPaintSelectionInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → USingleClickTool → UMeshClickTool
Implements Interfaces
- IClickBehaviorTarget
- IModifierToggleBehaviorTarget
- IInputBehaviorSource
- IMeshPaintSelectionInterface
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMeshClickTool() |
MeshSelect.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AdditiveSelectionModifier | const int | Flags used to identify modifier keys/buttons | MeshSelect.h |
Functions
Public
Overridden from UInteractiveTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Setup() |
MeshSelect.h |
Overridden from IClickBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit IsHitByClick
(
const FInputDeviceRay& ClickPos |
MeshSelect.h | ||
virtual void OnClicked
(
const FInputDeviceRay& ClickPos |
MeshSelect.h |
Overridden from IModifierToggleBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnUpdateModifierState
(
int ModifierID, |
MeshSelect.h |
Overridden from IMeshPaintSelectionInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AllowsMultiselect() |
MeshSelect.h | ||
virtual bool IsMeshAdapterSupported
(
TSharedPtr< IMeshPaintComponentAdapter > MeshAdapter |
MeshSelect.h |