1. Epic GamesDeveloper
  3. UViewportInteractor

UViewportInteractor

Represents the interactor in the world

API > API/Editor > API/Editor/ViewportInteraction

Represents the interactor in the world

   
Name UViewportInteractor
Type class
Header File /Engine/Source/Editor/ViewportInteraction/Public/ViewportInteractor.h
Include Path #include "ViewportInteractor.h"

Syntax

UCLASS (Abstract, Blueprintable, BlueprintType)  
class UViewportInteractor : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UViewportInteractor()

 Default constructor ViewportInteractor.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentHitResultGizmoFilterMode EHitResultGizmoFilterMode   ViewportInteractor.h  
SmoothingOneEuroFilter ViewportInteractionUtils::FOneEuroFilter Smoothing filter for laser ViewportInteractor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddKeyAction ( const FKey& Key,
const FViewportActionKeyInput& Action
)

 Adds a new action to the KeyToActionMap ViewportInteractor.h  

virtual void CalculateDragRay ( float& InOutDragRayLength,
float& InOutDragRayVelocity
)

   ViewportInteractor.h  

virtual void CalculateDragRay ( double& InOutDragRayLength,
double& InOutDragRayVelocity
)

 Needs to be implemented by the base to calculate drag ray length and the velocity for the ray ViewportInteractor.h  

bool CanCarry()

 Gets if the interactor can carry an object ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

FViewportActionKeyInput * GetActionWithName ( const FName InActionName
)

 Gets a certain action by iterating through the map looking for the same ActionType ViewportInteractor.h  
Gets the current interactor data dragging mode ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

float GetDragHapticFeedbackStrength()

 Gets the drag haptic feedback strength console variable ViewportInteractor.h  

FVector GetDragTranslationVelocity()

 Gets the interactor data drag velocity ViewportInteractor.h  

bool GetGrabberSphere ( FSphere& OutGrabberSphere,
const bool bEvenIfBlocked
)

 Gets a sphere on this interactor that can be used to interact with objects in close proximity ViewportInteractor.h  

virtual FHitResult GetHitResultFromLaserPointer ( TArray< AActor* >* OptionalListOfIgnoredActors,
const EHitResultGizmoFilterMode GizmoFilterMode,
TArray< UClass* >* ObjectsInFrontOfGizmo,
const bool bEvenIfBlocked,
const float LaserLengthOverride
)

 Traces along the laser pointer vector and returns what it first hits in the world ViewportInteractor.h  

virtual FHitResult GetHitResultFromLaserPointer ( TArray< AActor* >* OptionalListOfIgnoredActors,
const bool bIgnoreGizmos,
TArray< UClass* >* ObjectsInFrontOfGizmo,
const bool bEvenIfBlocked,
const float LaserLengthOverride
)

 Traces along the laser pointer vector and returns what it first hits in the world ViewportInteractor.h  

EHitResultGizmoFilterMode GetHitResultGizmoFilterMode()

 Gets current gizmo filter mode used for Interaction ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

FVector GetHoverLocation()

 Gets the interactor laser hover location ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"
Gets the private data for this interactor (const) ViewportInteractor.h  
Gets the private data for this interactor ViewportInteractor.h  

virtual bool GetIsLaserBlocked ()

 To be overridden by base class. ViewportInteractor.h  

bool GetLaserPointer ( FVector& LaserPointerStart,
FVector& LaserPointerEnd,
const bool bEvenIfBlocked,
const float LaserLengthOverride
)

 Gets the start and end point of the laser pointer for the specified hand ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

float GetLaserPointerMaxLength()

 Gets the maximum length of a laser pointer ViewportInteractor.h  

EViewportInteractionDraggingMode GetLastDraggingMode()

 Gets the interactor data previous dragging mode ViewportInteractor.h  

virtual UActorComponent * GetLastHoverComponent()

 Gets the last component hovered on by the interactor laser. ViewportInteractor.h  

FTransform GetLastRoomSpaceTransform()

 Gets the last hand transform of the interactor, in the local tracking space ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

FTransform GetLastTransform()

 Gets the last world transform of this interactor ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

UViewportInteractor * GetOtherInteractor()

 Gets the paired interactor assigned by the world interaction, can return null when there is no other interactor ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

FTransform GetRoomSpaceTransform()

 Gets the hand transform of the interactor, in the local tracking space ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

FTransform GetTransform()

 Gets the world transform of this interactor ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

virtual bool GetTransformAndForwardVector ( FTransform& OutHandTransform,
FVector& OutForwardVector
) const

 Creates a hand transform and forward vector for a laser pointer for a given hand ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

UViewportWorldInteraction * GetWorldInteraction()

 Gets the world interaction ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

bool HandleInputAxis ( FEditorViewportClient& ViewportClient,
const FKey Key,
const float Delta,
const float DeltaTime
)

 Handles axis input and translates it to actions C++ Child classes are expected to to call there super versions of this. ViewportInteractor.h  

bool HandleInputKey ( FEditorViewportClient& ViewportClient,
const FKey Key,
const EInputEvent Event
)

 Handles key input and translates it actions C++ Child classes are expected to to call there super versions of this. ViewportInteractor.h  

bool IsHovering()

 If the interactor laser is currently hovering ViewportInteractor.h  

bool IsHoveringOverGizmo()

 If the interactor laser is currently hovering over a gizmo handle ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

bool IsHoveringOverPriorityType()

 If this interactor is hovering over a type that has priority from GetHitResultFromLaserPointer ViewportInteractor.h  

bool IsHoveringOverSelectedActor()

 Returns true if currently hovering over selected actor ViewportInteractor.h  

virtual bool IsModifierPressed()

   ViewportInteractor.h  

virtual void OnStartDragging ( const FVector& HitLocation,
const bool bIsPlacingNewObjects
)

 Called by StartDragging in world interaction to give the interactor a chance of acting upon starting a drag operation ViewportInteractor.h  

virtual void PlayHapticEffect ( const float Strength
)

 Triggers a force feedback effect on device if possible ViewportInteractor.h  

virtual void PollInput()

 Base classes need to implement getting the input for the input devices for that interactor ViewportInteractor.h  

void RemoveKeyAction ( const FKey& Key
)

 Removes an action from the KeyToActionMap ViewportInteractor.h  

void RemoveOtherInteractor()

 Removes the other interactor reference for this interactor ViewportInteractor.h  

virtual void ResetHoverState()

 Reset the values before checking the hover actions ViewportInteractor.h  

void ResetLaserEnd()

 Reset the stored laser end location at the end of tick ViewportInteractor.h  

void SetCanCarry ( const bool bInCanCarry
)

 Sets if the interactor can carry an object ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

void SetDraggingMode ( const EViewportInteractionDraggingMode NewDraggingMode
)

 Sets the current dragging mode for this interactor ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

void SetHitResultGizmoFilterMode ( EHitResultGizmoFilterMode newFilter
)

 Sets the current gizmo filter mode used for Interaction ViewportInteractor.h
  • BlueprintCallable
  • Category="Interactor"

void SetHoverLocation ( const FVector& InHoverLocation
)

 Sets the hover location ViewportInteractor.h  

void SetOtherInteractor ( UViewportInteractor* InOtherInteractor
)

 Sets the other interactor ViewportInteractor.h  

void SetWorldInteraction ( UViewportWorldInteraction* InWorldInteraction
)

 Sets the world interaction ViewportInteractor.h  

void Shutdown()

 Whenever the ViewportWorldInteraction is shut down, the interacts will shut down as well ViewportInteractor.h
  • BlueprintNativeEvent
  • CallInEditor
  • Category="Interactor"

void Tick ( const float DeltaTime
)

 Update for this interactor called by the ViewportWorldInteraction ViewportInteractor.h
  • BlueprintNativeEvent
  • CallInEditor
  • Category="Interactor"

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool AllowLaserSmoothing()

 If this interactors allows to smooth the laser. Default is true. ViewportInteractor.h  

virtual void HandleInputAxis ( FEditorViewportClient& ViewportClient,
FViewportActionKeyInput& Action,
const FKey Key,
const float Delta,
const float DeltaTime,
bool& bOutWasHandled
)

 To be overridden. Called by HandleInputAxis before delegates and default input implementation ViewportInteractor.h  

void HandleInputAxis_BP ( const FViewportActionKeyInput& Action,
const FKey Key,
const float Delta,
const float DeltaTime,
bool& bOutWasHandled
)

 To be overridden. Called by HandleInputAxis before delegates and default input implementation ViewportInteractor.h
  • BlueprintImplementableEvent
  • CallInEditor
  • Meta=(DisplayName="HandleInputAxis")
  • Category="Interactor"

virtual void HandleInputKey ( FEditorViewportClient& ViewportClient,
FViewportActionKeyInput& Action,
const FKey Key,
const EInputEvent Event,
bool& bOutWasHandled
)

 To be overridden. Called by HandleInputKey before delegates and default input implementation ViewportInteractor.h  

void HandleInputKey_BP ( const FViewportActionKeyInput& Action,
const FKey Key,
const EInputEvent Event,
bool& bOutWasHandled
)

 To be overridden. Called by HandleInputKey before delegates and default input implementation ViewportInteractor.h
  • BlueprintImplementableEvent
  • CallInEditor
  • Meta=(DisplayName="HandleInputKey")
  • Category="Interactor"

virtual void PreviewInputAxis ( FEditorViewportClient& ViewportClient,
FViewportActionKeyInput& Action,
const FKey Key,
const float Delta,
const float DeltaTime,
bool& bOutWasHandled
)

 To be overridden. Called by HandleInputAxis before delegates and default input implementation ViewportInteractor.h  

virtual void PreviewInputKey ( FEditorViewportClient& ViewportClient,
FViewportActionKeyInput& Action,
const FKey Key,
const EInputEvent Event,
bool& bOutWasHandled
)

 To be overridden. Called by HandleInputKey before delegates and default input implementation ViewportInteractor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page