1. Epic GamesDeveloper
  3. UVREditorInteractor

UVREditorInteractor

VREditor default interactor

API > API/Editor > API/Editor/VREditor

Inheritance Hierarchy

References

   
Module VREditor
Header /Engine/Source/Editor/VREditor/Public/VREditorInteractor.h
Include #include "VREditorInteractor.h"

Syntax

class UVREditorInteractor : public UViewportInteractor

Remarks

VREditor default interactor

Variables

  Type Name Description
Protected variable bool bFlickActionExecuted Whether a flick action was executed
Protected variable bool bForceShowLaser Forcing to show laser
Protected variable bool bHasTriggerBeenReleasedSinceLastPress True if trigger has been fully released since the last press
Protected variable bool bIsScrubbingSequence Whether or not this controller is being used to scrub sequencer
Protected variable bool[2] bIsTrackpadPositionValid True if we have a valid trackpad position (for each axis)
Protected variable bool bIsTriggerFullyPressed Trigger axis stateTrue if trigger is fully pressed right now (or within some small threshold)
Protected variable bool bIsTriggerPressed True if the trigger is currently pulled far enough that we consider it in a "half pressed" state
Protected variable bool bIsUndoRedoSwipeEnabled Whether swiping left/right on touchpad/joystick triggers undo/redo
Protected variable bool bWantHelpLabels True if we want help labels to be visible right now, otherwise false
Protected variable FName ControllerMotionSource HelpRight or left hand
Protected variable TOptional< FLinearColor > ForceLaserColor The color that will be used for one frame
Protected variable FVector3d HandMeshBaseScale  
Protected variable TObjectPtr< class UStaticMeshComponent > HandMeshComponent GraphicsAccess to the current handmesh.
Protected variable FTransform HandMeshGripTransform  
Protected variable TMap< FKey, class AFloatingText * > HelpLabels Help labels for buttons on the motion controllers
Protected variable FTimespan HelpLabelShowOrHideStartTime Time that we either started showing or hiding help labels (for fade transitions)
Protected variable FVector2D InitialTouchPosition SwipeInitial position when starting to touch the trackpad
Protected variable TObjectPtr< class UMotionControllerComponent > LaserMotionControllerComponent Separate motion controller component set to the "aim" pose motion source, used for the laser pointer.
Protected variable FTimespan LastActiveTrackpadUpdateTime Real time that the last trackpad position was over the dead zone threshold.
Protected variable ETouchSwipeDirection LastSwipe Latest swipe direction on the trackpad
Protected variable FVector2D LastTrackpadPosition Last position of the touched trackpad
Protected variable FTimespan LastTrackpadPositionUpdateTime Real time that the last trackpad position was last updated. Used to filter out stale previous data.
Protected variable TObjectPtr< class UMotionControllerComponent > MotionControllerComponent Motion controller component which handles late-frame transform updates of all parented sub-components
Protected variable FVector2D TrackpadPosition Position of the touched trackpad
Protected variable TObjectPtr< class UVREditorMode > VRMode The mode that owns this interactor

Constructors

  Type Name Description
Public function   Default constructor

Functions

  Type Name Description
Public function Const FName Sets the EControllerHand for this motioncontroller
Public function Const EControllerHand Get the side of the controller
Public function Const EControllerType Returns what controller type this is for asymmetric control schemes
Public function Const FName  
Public function Const const TMap< FKey, FViewportActionKeyInput > & Gets the key-to-action map (const)
Public function Virtual Const TMap< FViewportActionKeyInput, TArray< FKey > >

GetKnownActionMappings ( EControllerHand InHand,
FName InHMDDeviceType
)

  
Public function Const const FVector &  
Public function Const const FVector & Getters and setters
Public function FTimespan & Get when the last time the trackpad position was updated
Public function Const UWidgetComponent * Gets the current hovered widget component if any
Public function Const FVector2D Get the last position of the trackpad or analog stick
Public function FTimespan & Get when the last time the trackpad position was updated
Public function Const double Gets last time the interactor pressed on UI
Public function Const UMotionControllerComponent * Get the motioncontroller component of this interactor
Public function Const float Gets the trigger value
Public function Const float Returns the slide delta for pushing and pulling objects.
Public function AVREditorTeleporter *  
Public function Const FVector2D Get the current position of the trackpad or analog stick
Public function Const float

GetTrackpadSlideDelta ( const bool Axis
)

 Trackpad Gets the trackpad delta of the axis passed.
Public function Const float Gets the UI scroll velocity
Public function UVREditorMode & Gets the owner of this system
Public function Const const UVREditorMode & Gets the owner of this system (const)
Public function Const bool Check if the quick menu is on this interactor
Public function void

Init ( UVREditorMode* InVRMode
)

 Initialize default values
Public function Const bool

IsActionKeyPressed ( FName ActionName
)

  
Public function Const bool Tells us if thie interator is carrying a "carryable" actor, like a camera, which matches the interactor motions instead of using manipulators.
Public function Const bool Gets if the interactor is clicking on any UI
Public function Const bool Gets if this interactor is hovering over UI
Public function Const bool Gets if the interactor is right clicking on UI
Public function Const bool Returns whether or not this controller is being used to scrub sequencer
Public function Const bool Check if the touchpad is currently touched
Public function Const bool

IsTrackpadPositionValid ( const int32 AxisIndex
)

 If the trackpad values are valid
Public function void

ReplaceHandMeshComponent ( UStaticMesh* NewMesh,
FVector MeshScale
)

 Replace the default VR controller mesh with a custom one.
Public function void Resets all the trackpad related values to default.
Public function void

SetControllerHandSide ( const FName InControllerHandSide
)

 Sets the EControllerHand for this motioncontroller
Public function void

SetControllerType ( const EControllerType InControllerType
)

 Set what controller type this is for asymmetric control schemes
Public function void

SetForceLaserColor ( const FLinearColor& InColor
)

 Next frame this will be used as color for the laser
Public function void

SetForceShowLaser ( const bool bInForceShow
)

 Set if we want to force to show the laser
Public function void

SetHasUIOnForearm ( const bool bInHasUIOnForearm
)

 Sets if the quick menu is on this interactor
Public function void

SetIsClickingOnUI ( const bool bInIsClickingOnUI
)

 Sets if the interactor is clicking on any UI
Public function void

SetIsHoveringOverUI ( const bool bInIsHoveringOverUI
)

 Sets if the interactor is hovering over any UI
Public function void

SetIsRightClickingOnUI ( const bool bInIsRightClickingOnUI
)

 Sets if the interactor is right hover over any UI
Public function void

SetLastHoveredWidgetComponent ( UWidgetComponent* NewHoveringOverWidgetComponent
)

 Sets the current hovered widget component
Public function void

SetLastUIPressTime ( const double InLastUIPressTime
)

 Sets the time the interactor last pressed on UI
Public function void

SetUIScrollVelocity ( const float InUIScrollVelocity
)

 Sets the UI scroll velocity
Public function void

SetupComponent ( AActor* OwningActor
)

 Sets up all components
Public function Virtual void  
Public function Virtual void

Tick_Implementation ( const float DeltaTime
)

  
Public function void Toggles whether or not this controller is being used to scrub sequencer
Public function bool

TryOverrideControllerType ( const EControllerType InControllerType
)

 Temporary set what controller type this is for asymmetric control schemes.
Protected function void  

Overridden from UViewportInteractor

  Type Name Description
Public function 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
Public function 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
Public function Virtual Const bool ViewportInteractor overrides, checks if the laser is blocked by UI
Public function Virtual Const bool

GetTransformAndForwardVector ( FTransform& OutHandTransform,
FVector& OutForwardVector
)

 Creates a hand transform and forward vector for a laser pointer for a given hand
Public function 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
Public function 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
Public function Virtual Const bool  
Public function Virtual void

PlayHapticEffect ( const float Strength
)

 Starts haptic feedback for physical motion controller
Protected function Virtual void Polls input for the motion controllers transforms
Public function 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
Public function Virtual void Reset the values before checking the hover actions

Constants

Name Description
MotionController_Left_FullyPressedTriggerAxis  
MotionController_Left_PressedTriggerAxis  
MotionController_Right_FullyPressedTriggerAxis  
MotionController_Right_PressedTriggerAxis  
TrackpadPositionX Special key action names for motion controllers.
TrackpadPositionY  
TriggerAxis  

Deprecated Variables

  Type Name Description
Protected variable bool bIsPressingTrackpad Use IsActionKeyPressed(VRActionTypes::ConfirmRadialSelection) instead.
Protected variable bool bIsTouchingTrackpad Use IsActionKeyPressed(VRActionTypes::Touch) instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page