Navigation
API > API/Plugins > API/Plugins/AvalancheInteractiveTools
| Name | UAvaInteractiveToolsToolBase |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheInteractiveTools/Public/Tools/AvaInteractiveToolsToolBase.h |
| Include Path | #include "Tools/AvaInteractiveToolsToolBase.h" |
Syntax
UCLASS (Abstract)
class UAvaInteractiveToolsToolBase :
public UInteractiveTool,
public IAvaSingleClickAndDragBehaviorTarget ,
public IClickBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → UAvaInteractiveToolsToolBase
Implements Interfaces
- IAvaSingleClickAndDragBehaviorTarget
- IModifierToggleBehaviorTarget
- IInputBehaviorSource
- IClickBehaviorTarget
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UAvaInteractiveToolsToolBase() |
Tools/AvaInteractiveToolsToolBase.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BID_Cancel | int32 | Cancel Behavior ID | Tools/AvaInteractiveToolsToolBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DrawHUD
(
FCanvas* InCanvas, |
Tools/AvaInteractiveToolsToolBase.h | ||
FString GetActiveToolIdentifier() |
Tools/AvaInteractiveToolsToolBase.h | ||
const FAvaInteractiveToolsToolParameters * GetActiveToolParameters() |
Tools/AvaInteractiveToolsToolBase.h | ||
AActor * GetSpawnedActor() |
Tools/AvaInteractiveToolsToolBase.h | ||
FViewport * GetViewport
(
EAvaViewportStatus InViewportStatus |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual FInputRayHit IsHitByClick
(
const FInputDeviceRay& InClickPos |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void OnActorSpawned
(
AActor* InActor |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void OnClicked
(
const FInputDeviceRay& InClickPos |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void OnRegisterTool
(
IAvalancheInteractiveToolsModule* InAITModule |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void OnTick
(
float InDeltaTime |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void OnUpdateModifierState
(
int InModifierID, |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void OnViewportPlannerComplete() |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void OnViewportPlannerUpdate() |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void Render
(
IToolsContextRenderAPI* InRenderAPI |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void Setup() |
Tools/AvaInteractiveToolsToolBase.h | ||
bool ShouldAutoRegister() |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void Shutdown
(
EToolShutdownType ShutdownType |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual bool SupportsDefaultAction() |
Returns true if this supports a default action. | Tools/AvaInteractiveToolsToolBase.h | |
bool ViewportPositionToWorldPositionAndOrientation
(
EAvaViewportStatus InViewportStatus, |
Calls the below function with the default camera distance. | Tools/AvaInteractiveToolsToolBase.h | |
bool ViewportPositionToWorldPositionAndOrientation
(
EAvaViewportStatus InViewportStatus, |
Converts viewport position to camera plane transform at given distance. | Tools/AvaInteractiveToolsToolBase.h |
Overridden from IAvaSingleClickAndDragBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit CanBeginSingleClickAndDragSequence
(
const FInputDeviceRay& InPressPos |
Test if target can begin click-drag interaction at this point | Tools/AvaInteractiveToolsToolBase.h | |
virtual void OnClickDrag
(
const FInputDeviceRay& InDragPos |
Notify Target that input position has changed | Tools/AvaInteractiveToolsToolBase.h | |
virtual void OnClickPress
(
const FInputDeviceRay& InPressPos |
Notify Target that click press ocurred | Tools/AvaInteractiveToolsToolBase.h | |
virtual void OnClickRelease
(
const FInputDeviceRay& InReleasePos, |
Notify Target that click release occurred | Tools/AvaInteractiveToolsToolBase.h | |
virtual void OnDragStart
(
const FInputDeviceRay& InDragPos |
Notify Target that the drag process has started | Tools/AvaInteractiveToolsToolBase.h | |
virtual void OnTerminateSingleClickAndDragSequence() |
Notify Target that click-drag sequence has been explicitly terminated (eg by escape key) | Tools/AvaInteractiveToolsToolBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Activate
(
const FString& InToolIdentifier, |
Tools/AvaInteractiveToolsToolBase.h | ||
void BeginTransaction() |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual bool CanActivate
(
const FString& InToolIdentifier, |
Tools/AvaInteractiveToolsToolBase.h | ||
void CancelTransaction() |
Tools/AvaInteractiveToolsToolBase.h | ||
bool ConditionalIdentityRotation() |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void DefaultAction() |
Creates a default actor in the world, without user input. | Tools/AvaInteractiveToolsToolBase.h | |
void DestroyPreviewActor() |
Tools/AvaInteractiveToolsToolBase.h | ||
void EndTransaction() |
Tools/AvaInteractiveToolsToolBase.h | ||
bool IsMotionDesignViewport() |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual void OnActivate() |
Called when the tool is selected in the InteractiveTools tab. | Tools/AvaInteractiveToolsToolBase.h | |
virtual bool OnBegin() |
Returns false if tool fails to initialise. | Tools/AvaInteractiveToolsToolBase.h | |
virtual void OnCancel() |
Cancels the tool and shuts it down. | Tools/AvaInteractiveToolsToolBase.h | |
virtual void OnComplete() |
Completes the tool and shuts it down. | Tools/AvaInteractiveToolsToolBase.h | |
virtual void OnPostBegin() |
Called if Begin() is successful. | Tools/AvaInteractiveToolsToolBase.h | |
void OnPreviewActorDestroyed
(
AActor* InDestroyedActor |
Tools/AvaInteractiveToolsToolBase.h | ||
void RequestShutdown
(
EToolShutdownType InShutdownType |
Tools/AvaInteractiveToolsToolBase.h | ||
void SetToolkitSettingsObject
(
UObject* InObject |
Tools/AvaInteractiveToolsToolBase.h | ||
virtual bool ShouldForceDefaultAction() |
Tools/AvaInteractiveToolsToolBase.h | ||
AActor * SpawnActor
(
TSubclassOf< AActor > InActorClass, |
Calls the other spawn actor with the centre of the last active viewport as the position. | Tools/AvaInteractiveToolsToolBase.h | |
virtual AActor * SpawnActor
(
TSubclassOf< AActor > InActorClass, |
Spawns an actor of the given class at the correct distance from the camera in the given viewport position. | Tools/AvaInteractiveToolsToolBase.h | |
virtual bool UseIdentityLocation() |
Returns true if actors should be spawned at {0, 0, 0}. | Tools/AvaInteractiveToolsToolBase.h | |
virtual bool UseIdentityRotation() |
Returns true if actors should be spawned oriented to {0, 0, 0}. | Tools/AvaInteractiveToolsToolBase.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static InActorFactoryClass * CreateActorFactory() |
Helper to create an Actor Factory of a given class | Tools/AvaInteractiveToolsToolBase.h | |
| Checks the given actor and its components against UAvaInteractiveToolsModeDetailsObject and UAvaInteractiveToolsModeDetailsObjectProvider. | Tools/AvaInteractiveToolsToolBase.h |