1. Epic GamesDeveloper
  3. UAvaInteractiveToolsToolBase

UAvaInteractiveToolsToolBase

API > API/Plugins > API/Plugins/AvalancheInteractiveTools > API/Plugins/AvalancheInteractiveTools/Tools

Inheritance Hierarchy

References

   
Module AvalancheInteractiveTools
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheInteractiveTools/Public/Tools/AvaInteractiveToolsToolBase.h
Include #include "Tools/AvaInteractiveToolsToolBase.h"

Syntax

UCLASS (Abstract)  
class UAvaInteractiveToolsToolBase : public UInteractiveTool

Variables

  Type Name Description
Protected variable bool bPerformingDefaultAction  
Protected variable UProperty USingleKeyCaptureBehavior * EscapeKeyBehavior  
Protected variable UProperty UAvaSingleClickAndDragBehavior * LeftClickBehavior  
Protected variable UProperty AActor * PreviewActor  
Protected variable UProperty UAvaInteractiveToolsRightClickBehavior * RightClickBehavior  
Protected variable UProperty AActor * SpawnedActor  
Protected variable UProperty UAvaInteractiveToolsToolViewportPlanner * ViewportPlanner  
Protected variable UProperty TSubclassOf< UAvaInteractiveToolsToolViewportPlanner > ViewportPlannerClass  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Virtual void

Activate ( bool bInReactivate
)

  
Protected function void  
Protected function Virtual Const bool

CanActivate ( bool bInReactivate
)

  
Public function Virtual FInputRayHit  
Protected function void  
Protected function Const bool  
Protected function Static InActorFactoryClass * Helper to create an Actor Factory of a given class
Protected function Virtual void Creates a default actor in the world, without user input.
Protected function void  
Public function Virtual FName Designed to be called on the CDO.
Public function Static UObject * Checks the given actor and its components against UAvaInteractiveToolsModeDetailsObject and UAvaInteractiveToolsModeDetailsObjectProvider.
Public function Const AActor *  
Public function Virtual Const FAvaInteractiveToolsToolParameters Designed to be called on the CDO.
Public function Const FViewport *

GetViewport ( EAvaViewportStatus InViewportStatus
)

  
Public function Virtual FInputRayHit

IsHitByClick ( const FInputDeviceRay& InClickPos
)

  
Protected function Const bool  
Protected function Virtual void Called when the tool is selected in the InteractiveTools tab.
Protected function Virtual bool

OnBegin ()

 Returns false if tool fails to initialise.
Protected function Virtual void Cancels the tool and shuts it down.
Public function Virtual void

OnClickDrag ( const FInputDeviceRay& InDragPos
)

  
Public function Virtual void

OnClicked ( const FInputDeviceRay& InClickPos
)

  
Public function Virtual void

OnClickPress ( const FInputDeviceRay& InPressPos
)

  
Public function Virtual void

OnClickRelease ( const FInputDeviceRay& InReleasePos,
bool bInIsDragOperation
)

  
Protected function Virtual void Completes the tool and shuts it down.
Public function Virtual void

OnDragStart ( const FInputDeviceRay& InDragPos
)

  
Protected function Virtual void Called if Begin() is successful.
Protected function Static void  
Public function Virtual void  
Public function Virtual void

OnUpdateModifierState ( int InModifierID,
bool bInIsOn
)

  
Public function Virtual void  
Public function Virtual void  
Protected function Static void  
Protected function void

RequestShutdown ( EToolShutdownType InShutdownType
)

  
Protected function Const void  
Protected function Const bool  
Protected function Const bool  
Protected function void  
Protected function Const AActor *

SpawnActor ( TSubclassOf< AActor > InActorClass,
bool bInPreview,
FString* InActorLabelOverride
)

 Calls the other spawn actor with the centre of the last active viewport as the position.
Protected function Virtual Const AActor *

SpawnActor ( TSubclassOf< AActor > InActorClass,
EAvaViewportStatus InViewportStatus,
const FVector2f& InViewportPosition,
bool bInPreview,
FString* InActorLabelOverride
)

 Spawns an actor of the given class at the correct distance from the camera in the given viewport position.
Public function Virtual Const bool Returns true if this supports a default action.
Protected function Virtual Const bool Returns true if actors should be spawned at {0, 0, 0}.
Protected function Virtual Const bool Returns true if actors should be spawned oriented to {0, 0, 0}.
Public function Const bool

ViewportPositionToWorldPositionAndOrientation ( EAvaViewportStatus InViewportStatus,
const FVector2f& InViewportPosition,
UWorld*& OutWorld,
FVector& OutPosition,
FRotator& OutRotation
)

 Calls the below function with the default camera distance.
Public function Const bool

ViewportPositionToWorldPositionAndOrientation ( EAvaViewportStatus InViewportStatus,
const FVector2f& InViewportPosition,
float InDistance,
UWorld*& OutWorld,
FVector& OutPosition,
FRotator& OutRotation
)

 Converts viewport position to camera plane transform at given distance.

Overridden from UInteractiveTool

  Type Name Description
Public function Virtual void

DrawHUD ( FCanvas* InCanvas,
IToolsContextRenderAPI* InRenderAPI
)

 Allow the Tool to do any custom screen space drawing
Public function Virtual void

OnTick ( float InDeltaTime
)

 Allow the Tool to do any necessary processing on Tick
Public function Virtual void

Render ( IToolsContextRenderAPI* InRenderAPI
)

 Allow the Tool to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ()

 Called by ToolManager to initialize the Tool after ToolBuilder::BuildTool() has been called
Public function Virtual void

Shutdown ( EToolShutdownType ShutdownType
)

 Called by ToolManager to shut down the Tool

Constants

Name Description
BID_Cancel Cancel Behavior ID

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page