Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > VREditor > UVREditorInteractor

Light Theme

Dark Theme

UVREditorInteractor

VREditor default interactor

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UViewportInteractor

UVREditorInteractor

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

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

Constructors

	Name	Description
	UVREditorInteractor()	Default constructor

Functions

	Name	Description
FName	GetControllerHandSide()	Sets the EControllerHand for this motioncontroller
EControllerH...	GetControllerSide()	Get the side of the controller
EControllerT...	GetControllerType()	Returns what controller type this is for asymmetric control schemes
FName	GetHMDDeviceType()
const TMap< ...	GetKeyToActionMap()	Gets the key-to-action map (const)
const FVecto...	GetLaserEnd()
const FVecto...	GetLaserStart()	Getters and setters
FTimespan &	GetLastActiveTrackpadUpdateTime()	Get when the last time the trackpad position was updated
UWidgetCompo...	GetLastHoveredWidgetComponent()	Gets the current hovered widget component if any
FVector2D	GetLastTrackpadPosition()	Get the last position of the trackpad or analog stick
FTimespan &	GetLastTrackpadPositionUpdateTime()	Get when the last time the trackpad position was updated
double	GetLastUIPressTime()	Gets last time the interactor pressed on UI
UMotionContr...	GetMotionControllerComponent()	Get the motioncontroller component of this interactor
float	GetSelectAndMoveTriggerValue()	Gets the trigger value
float	GetSlideDelta()	Returns the slide delta for pushing and pulling objects.
AVREditorTel...	GetTeleportActor()
FVector2D	GetTrackpadPosition()	Get the current position of the trackpad or analog stick
float	GetTrackpadSlideDelta ( const bool Axis )	Trackpad Gets the trackpad delta of the axis passed.
float	GetUIScrollVelocity()	Gets the UI scroll velocity
UVREditorMod...	GetVRMode()	Gets the owner of this system
const UVREdi...	GetVRMode()	Gets the owner of this system (const)
bool	HasUIOnForearm()	Check if the quick menu is on this interactor
void	Init ( UVREditorMode* InVRMode )	Initialize default values
bool	IsCarrying()	Tells us if thie interator is carrying a "carryable" actor, like a camera, which matches the interactor motions instead of using manipulators.
bool	IsClickingOnUI()	Gets if the interactor is clicking on any UI
bool	IsHoveringOverUI()	Gets if this interactor is hovering over UI
bool	IsRightClickingOnUI()	Gets if the interactor is right clicking on UI
bool	IsScrubbingSequencer()	Returns whether or not this controller is being used to scrub sequencer
bool	IsTouchingTrackpad()	Check if the touchpad is currently touched
bool	IsTrackpadPositionValid ( const int32 AxisIndex )	If the trackpad values are valid
void	ReplaceHandMeshComponent ( UStaticMesh* NewMesh )	Replace the default VR controller mesh with a custom one.
void	ResetTrackpad()	Resets all the trackpad related values to default.
void	SetControllerHandSide ( const FName InControllerHandSide )	Sets the EControllerHand for this motioncontroller
void	SetControllerType ( const EControllerType InControllerT... )	Set what controller type this is for asymmetric control schemes
void	SetForceLaserColor ( const FLinearColor& InColor )	Next frame this will be used as color for the laser
void	SetForceShowLaser ( const bool bInForceShow )	Set if we want to force to show the laser
void	SetHasUIOnForearm ( const bool bInHasUIOnForearm )	Sets if the quick menu is on this interactor
void	SetIsClickingOnUI ( const bool bInIsClickingOnUI )	Sets if the interactor is clicking on any UI
void	SetIsHoveringOverUI ( const bool bInIsHoveringOverUI )	Sets if the interactor is hovering over any UI
void	SetIsRightClickingOnUI ( const bool bInIsRightClickingOnUI )	Sets if the interactor is right hover over any UI
void	SetLastHoveredWidgetComponent ( UWidgetComponent* NewHoveringO... )	Sets the current hovered widget component
void	SetLastUIPressTime ( const double InLastUIPressTime )	Sets the time the interactor last pressed on UI
void	SetUIScrollVelocity ( const float InUIScrollVelocity )	Sets the UI scroll velocity
void	SetupComponent ( AActor* OwningActor )	Sets up all components
void	Shutdown_Implementation()
void	Tick_Implementation ( const float DeltaTime )
void	ToggleSequencerScrubbingMode()	Toggles whether or not this controller is being used to scrub sequencer
bool	TryOverrideControllerType ( const EControllerType InControllerT... )	Temporary set what controller type this is for asymmetric control schemes.

Overridden from UViewportInteractor

	Name	Description
void	CalculateDragRay ( float& InOutDragRayLength, float& InOutDragRayVelocity )	Needs to be implemented by the base to calculate drag ray length and the velocity for the ray
FHitResult	GetHitResultFromLaserPointer ( TArray< AActor* >* Option..., const EHitResultGizmoFilterMode Giz..., TArray< UClass* >* Object..., const bool bEvenIfBlocked, const float LaserLengthOverride )	Traces along the laser pointer vector and returns what it first hits in the world
bool	GetIsLaserBlocked()	ViewportInteractor overrides, checks if the laser is blocked by UI
bool	GetTransformAndForwardVector ( FTransform& OutHandTransform, FVector& OutForwardVector )	Creates a hand transform and forward vector for a laser pointer for a given hand
void	HandleInputAxis ( FEditorViewportClient& ViewportCli..., 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
void	HandleInputKey ( FEditorViewportClient& ViewportCli..., FViewportActionKeyInput& Action, const FKey Key, const EInputEvent Event, bool& bOutWasHandled )	To be overridden. Called by HandleInputKey before delegates and default input implementation
bool	IsModifierPressed()
void	PlayHapticEffect ( const float Strength )	Starts haptic feedback for physical motion controller
void	PollInput()	Polls input for the motion controllers transforms
void	PreviewInputKey ( FEditorViewportClient& ViewportCli..., FViewportActionKeyInput& Action, const FKey Key, const EInputEvent Event, bool& bOutWasHandled )	To be overridden. Called by HandleInputKey before delegates and default input implementation
void	ResetHoverState()	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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss