Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Users of the Tools Framework can use UToolsContextCursorAPI to access to setting and retrieving cursor overrides for tool activities.
| Name | UToolsContextCursorAPI |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/ToolContextInterfaces.h |
| Include Path | #include "ToolContextInterfaces.h" |
Syntax
UCLASS (MinimalAPI)
class UToolsContextCursorAPI : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UToolsContextCursorAPI
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UToolsContextCursorAPI() |
ToolContextInterfaces.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UToolsContextCursorAPI() |
ToolContextInterfaces.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsCursorOverridden | bool | ToolContextInterfaces.h | ||
| CursorOverrideShape | EMouseCursor::Type | ToolContextInterfaces.h | ||
| CursorOverrideWidget | TSharedPtr< SWidget > | ToolContextInterfaces.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ClearCursorOverride() |
Clears the custom widget, if any, resets the shape to Default and resets the overridden flag. | ToolContextInterfaces.h | |
virtual EMouseCursor::Type GetCurrentCursorOverride() |
ToolContextInterfaces.h | ||
virtual TSharedPtr< SWidget > GetCurrentCursorOverrideWidget() |
ToolContextInterfaces.h | ||
virtual bool IsCursorOverridden() |
ToolContextInterfaces.h | ||
virtual void SetCursorOverride
(
EMouseCursor::Type CursorOverride |
ToolContextInterfaces.h | ||
virtual void SetCursorOverrideWidget
(
const TSharedRef< SWidget >& InCursorOverrideWidget |
ToolContextInterfaces.h |