Navigation
API > API/Plugins > API/Plugins/UVEditorTools
The brush select tool allows for brush selection of triangles on the unwrap or the live preview.
| Name | UUVEditorBrushSelectTool |
| Type | class |
| Header File | /Engine/Plugins/Editor/UVEditor/Source/UVEditorTools/Public/UVEditorBrushSelectTool.h |
| Include Path | #include "UVEditorBrushSelectTool.h" |
Syntax
UCLASS (MinimalAPI)
class UUVEditorBrushSelectTool :
public UInteractiveTool ,
public IInteractiveToolNestedAcceptCancelAPI ,
public IUVToolSupportsSelection ,
public IUVEditorGenericBuildableTool
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → UUVEditorBrushSelectTool
Implements Interfaces
- IInputBehaviorSource
- IInteractiveToolNestedAcceptCancelAPI
- IUVEditorGenericBuildableTool
- IUVToolSupportsSelection
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCtrlToggle | bool | UVEditorBrushSelectTool.h | ||
| bCurrentStrokeIsSubtracting | bool | UVEditorBrushSelectTool.h | ||
| bDraggingLivePreview | bool | UVEditorBrushSelectTool.h | ||
| bDraggingUnwrap | bool | UVEditorBrushSelectTool.h | ||
| bHaveInteracted | bool | Currently used just so that the Esc key exits out of the tool instead of clearing the selection if we haven't yet done anything. | UVEditorBrushSelectTool.h | |
| bHavePendingLivePreviewHit | bool | UVEditorBrushSelectTool.h | ||
| bHavePendingUnwrapHit | bool | UVEditorBrushSelectTool.h | ||
| bHoveringLivePreview | bool | UVEditorBrushSelectTool.h | ||
| bHoveringUnwrap | bool | UVEditorBrushSelectTool.h | ||
| bShiftToggle | bool | UVEditorBrushSelectTool.h | ||
| CtrlModifierID | int32 | UVEditorBrushSelectTool.h | ||
| EmitChangeAPI | TObjectPtr< UUVToolEmitChangeAPI > | UVEditorBrushSelectTool.h | ||
| LivePreviewAPI | TObjectPtr< UUVToolLivePreviewAPI > | UVEditorBrushSelectTool.h | ||
| LivePreviewBehaviorSet | TObjectPtr< UInputBehaviorSet > | UVEditorBrushSelectTool.h | ||
| LivePreviewBehaviorSource | TObjectPtr< ULocalInputBehaviorSource > | UVEditorBrushSelectTool.h | ||
| LivePreviewBrushIndicator | TObjectPtr< UBrushStampIndicator > | UVEditorBrushSelectTool.h | ||
| LivePreviewInputRouter | TWeakObjectPtr< UInputRouter > | UVEditorBrushSelectTool.h | ||
| PendingLivePreviewHits | TArray< UUVEditorMeshSelectionMechanic::FRaycastResult > | UVEditorBrushSelectTool.h | ||
| PendingUnwrapHits | TArray< FVector2d > | For unwrap, we don't necessarily need to hit the mesh to be able to select things with the brush- we just need the locations of all the hits. | UVEditorBrushSelectTool.h | |
| SelectionAPI | TObjectPtr< UUVToolSelectionAPI > | UVEditorBrushSelectTool.h | ||
| SelectionMechanic | TWeakObjectPtr< const UUVEditorMeshSelectionMechanic > | UVEditorBrushSelectTool.h | ||
| Settings | TObjectPtr< UUVEditorBrushSelectToolProperties > | UVEditorBrushSelectTool.h | ||
| ShiftModifierID | int32 | UVEditorBrushSelectTool.h | ||
| Targets | TArray< TObjectPtr< UUVEditorToolMeshInput > > | UVEditorBrushSelectTool.h | ||
| TempROIBuffer | TArray< int32 > | TODO: It would be nice to have Ctrl+Shift brush inverting, so that a user could brush an inverted selection. | UVEditorBrushSelectTool.h | |
| UnwrapBrushIndicator | TObjectPtr< UBrushStampIndicator > | UVEditorBrushSelectTool.h |
Functions
Public
Overridden from UInteractiveTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool HasAccept() |
UVEditorBrushSelectTool.h | ||
virtual bool HasCancel() |
UVEditorBrushSelectTool.h | ||
virtual void OnTick
(
float DeltaTime |
UVEditorBrushSelectTool.h | ||
virtual void RegisterActions
(
FInteractiveToolActionSet& ActionSet |
UVEditorBrushSelectTool.h | ||
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
UVEditorBrushSelectTool.h | ||
virtual void Setup() |
UInteractiveTool. | UVEditorBrushSelectTool.h | |
virtual void Shutdown
(
EToolShutdownType ShutdownType |
UVEditorBrushSelectTool.h |
Overridden from IInteractiveToolNestedAcceptCancelAPI
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanCurrentlyNestedCancel() |
UVEditorBrushSelectTool.h | ||
virtual bool ExecuteNestedCancelCommand() |
UVEditorBrushSelectTool.h | ||
virtual bool SupportsNestedCancelCommand() |
IInteractiveToolNestedAcceptCancelAPI. | UVEditorBrushSelectTool.h |
Overridden from IUVToolSupportsSelection
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool SupportsUnsetElementAppliedMeshSelections () |
A tool that returns false here will have the unset element selections (ie selections of triangles that don't have associated UV's) cleared before its invocation. | UVEditorBrushSelectTool.h |
Overridden from IUVEditorGenericBuildableTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void SetTargets
(
const TArray< TObjectPtr< UUVEditorToolMeshInput > >& TargetsIn |
IUVEditorGenericBuildableTool. | UVEditorBrushSelectTool.h |