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 > UVREditorMode

Light Theme

Dark Theme

UVREditorMode

VR Editor Mode. Extends editor viewports with functionality for VR controls and object manipulation

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UEditorWorldExtension

UVREditorMode

References

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

Syntax

class UVREditorMode : public UEditorWorldExtension

Remarks

VR Editor Mode. Extends editor viewports with functionality for VR controls and object manipulation

Variables

	Name	Description
FTimespan	AppTimeModeEntered	App time that we entered this mode
UVREditorAutoSc...	AutoScalerSystem	Automatic scale system
AVREditorAvatar...	AvatarActor	Avatar visualsActor with components to represent the VR avatar in the world, including motion controller meshes
bool	bActuallyUsingVR	True if we're in using an actual HMD in this mode, or false if we're "faking" VR mode for testing
bool	bIsFlashlightOn	If there is currently a flashlight in the scene
bool	bIsFullyInitialized	True if VR mode is fully initialized and ready to render
bool	bWantsToExitMode	True if we currently want to exit VR mode.
EGizmoHandleTyp...	CurrentGizmoType	The current Gizmo type that is used for the TransformGizmo Actor
USpotLightCompo...	FlashlightComponent	FlashlightSpotlight for the flashlight
TArray< UVREdit...	Interactors	Interactors
int32	MotionControllerID	InputThe Unreal controller ID for the motion controllers we're using
FOnPlaceDragged...	OnPlaceDraggedMaterialEvent	Event broadcast when a material is placed
FOnPlacePreview...	OnPlacePreviewActorEvent	Event broadcast when a preview actor is placed
FOnVREditingMod...	OnVREditingModeExit_Handler	Used to override dockable area restoration behavior
UVREditorPlacem...	PlacementSystem
FSavedEditorSta...	SavedEditorState	Saved information about the editor and viewport we possessed, so we can restore it after exiting VR mode
AVREditorTelepo...	TeleportActor	Teleporter system
FOnVRTickHandle	TickHandle	Subsystems registered
UVREditorUISyst...	UISystem	SubsystemsVR UI system
TWeakPtr< class...	VREditorLevelViewportWeakPtr	The VR level viewport, if we're in VR mode
TWeakPtr< class...	VREditorWindowWeakPtr	Startup/ShutdownThe VR editor window, if it's open right now
UViewportWorldI...	WorldInteraction	World interactionWorld interaction manager

Constructors

	Name	Description
	UVREditorMode()	Default constructor

Functions

	Name	Description
void	AllocateInteractors()
UStaticMeshC...	CreateMesh ( AActor* OwningActor, UStaticMesh* Mesh, USceneComponent* AttachmentToC... )	Helper functions to create a static mesh
UStaticMeshC...	CreateMesh ( AActor* OwningActor, const FString& MeshName, USceneComponent* AttachmentToC... )	Helper functions to create a static mesh
UStaticMeshC...	CreateMotionControllerMesh ( AActor* OwningActor, USceneComponent* AttachmentToC..., UStaticMesh* OptionalControlle... )	Create a static motion controller mesh for the current HMD platform
void	CycleTransformGizmoHandleType()	Will update the TransformGizmo Actor with the next Gizmo type
void	Enter()	When the user actually enters the VR Editor mode
void	Exit ( const bool bShouldDisableStereo )	When the user leaves the VR Editor mode
const UVREdi...	GetAssetContainer()	Gets the container for all the assets of VREditor.
FLinearColor	GetColor ( const EColors Color )	Gets the color.
EGizmoHandle...	GetCurrentGizmoType()	Gets the current Gizmo handle type
ISequencer &...	GetCurrentSequencer()	Returns the currently active sequencer
float	GetDefaultVRNearClipPlane()	Get the default near clipping plane for VR editing.
UVREditorInt...	GetHandInteractor ( const EControllerHand ControllerHan... )	Gets the hand interactor
FTransform	GetHeadTransform()	Gets the world space transform of the HMD (head)
FName	GetHMDDeviceType()
const SLevel...	GetLevelViewportPossessedForVR()	Gets the viewport that VR Mode is activated in.
SLevelViewpo...	GetLevelViewportPossessedForVR()	Mutable version of above.
int32	GetMotionControllerID()	Returns the Unreal controller ID for the motion controllers we're using
UVREditorPla...	GetPlacementSystem()	Gets access to VREditorWorldInteraction
FTransform	GetRoomSpaceHeadTransform()	Gets the transform of the user's HMD in room space
FTransform	GetRoomTransform()	Gets the world space transform of the calibrated VR room origin.
const FSaved...	GetSavedEditorState()	Gets the saved editor state from entering the mode
bool	GetStartedPlayFromVREditor()	Returns true if we started the play in editor session from this VR Editor
AVREditorTel...	GetTeleportActor()	Get Teleporter
FTimespan	GetTimeSinceModeEntered()	Returns the time since the VR Editor mode was last entered
UVREditorUIS...	GetUISystem()	Gets access to the VR UI system
const UVREdi...	GetUISystem()	Gets access to the VR UI system (const)
const TArray...	GetVRInteractors()
const UViewp...	GetWorldInteraction()	Gets access to the world interaction system (const)
UViewportWor...	GetWorldInteraction()	Gets access to the world interaction system
float	GetWorldScaleFactor()	Gets the world scale factor, which can be multiplied by a scale vector to convert to room space
bool	IsActuallyUsingVR()	Returns true if we're actually using VR, or false if we're faking it
bool	IsAimingTeleport()	Return true if currently aiming to teleport.
bool	IsDebugModeEnabled()	Returns if the VR Mode is in debug mode.
bool	IsFlashlightOn()	Returns whether or not the flashlight is visible
bool	IsFullyInitialized()	If the mode was completely initialized
bool	IsHandAimingTowardsCapsule ( UViewportInteractor* Interacto..., const FTransform& CapsuleTransform, const FVector CapsuleStart, const FVector CapsuleEnd, const float CapsuleRadius, const float MinDistanceToCapsule, const FVector CapsuleFrontDirection, const float MinDotForAimingAtCapsul... )
bool	IsShowingRadialMenu ( const UVREditorInteractor* Int... )	Lets other modules know if the radial menu is visible on a given interactor so input should be handled differently
bool	IsTeleporting()
UVREditorAss...	LoadAssetContainer()	Loads and returns the container for all the assets of VREditor.
FOnPlaceDrag...	OnPlaceDraggedMaterial()
FOnPlacePrev...	OnPlacePreviewActor()
FOnVRTickHan...	OnTickHandle()
FOnToggleVRM...	OnToggleDebugMode()
T	OvershootEaseOut ( T Alpha, const float OvershootAmount )
void	PlaySound ( USoundBase* SoundBase, const FVector& InWorldLocation, const float InVolume )	Plays sound at location.
void	PostTick ( const float DeltaTime )	Tick after the ViewportWorldInteraction is ticked
void	PreTick ( const float DeltaTime )	Tick before the ViewportWorldInteraction is ticked
void	RefreshActorPreviewWidget ( TSharedRef< SWidget > InWidget, int32 Index, AActor* Actor, bool bIsPanelDetached )	Refresh the current actor preview widget on an in-world UI panel
void	RefreshRadialMenuActionsSubmenu()	Call this to force the 'Actions' radial menu to refresh.
void	RefreshVREditorSequencer ( ISequencer* InCurrentSequencer )	Runtime and plugin modules can force VR Editor to refresh using this function
void	ResetActionsMenuGenerator()	Resets the delegate and button for the context-specific actions menu
void	SaveSequencerSettings ( bool bInKeyAllEnabled, EAutoChangeMode InAutoChangeMode, const USequencerSettings& InSequen... )
void	SetActionsMenuGenerator ( const FOnRadialMenuGenerated NewMen..., const FText NewLabel )	Sets a delegate for the context-specific actions menu
void	SetActuallyUsingVR ( const bool bShouldActuallyUseVR )	Static: Sets whether we should actually use an HMD. Call this before activating VR mode
void	SetRoomTransform ( const FTransform& NewRoomTransform )	Sets a new transform for the room, in world space.
void	SnapSelectedActorsToGround()	Snaps the current selected actor to the ground
void	StartExitingVRMode()	Call this to start exiting VR mode
void	ToggleDebugMode()	Toggles the debug mode.
void	ToggleFlashlight ( UVREditorInteractor* Interacto... )	Spawns a flashlight on the specified hand
void	TogglePIEAndVREditor()	Start or stop play-in-editor mode
void	ToggleSIEAndVREditor()	Start or stop simulate-in-editor mode
bool	UISystemIsActive()	Check whether the UISystem exists
void	UpdateExternalSlateUI ( TSharedRef< SWidget > InWidget, FName Name, FVector2D InSize )	General way to spawn an external SlateUI from a radial menu
void	UpdateExternalUMGUI ( const FVREditorFloatingUICreationCo... )	General way to spawn an external UMG UI from a radial menu
bool	WantsToExitMode()	Returns true if the user wants to exit this mode

Overridden from UEditorWorldExtension

	Name	Description
void	Init()	Initialize the VREditor
void	Shutdown()	Shutdown the VREditor
void	TransitionWorld ( UWorld* NewWorld, EEditorWorldExtensionTransitionStat... )	Reparent actors to a new world

Classes

	Name	Description
	FOnPlaceDraggedMaterial	Delegate to be called when a material is placed
	FOnPlacePreviewActor	Delegate to be called when a preview actor is placed
	FOnToggleVRModeDebug	Delegate to be called when the debug mode is toggled.
	FOnVRTickHandle	Gets the tick handle to give external systems the change to be ticked right after the ViewportWorldInteraction is ticked
	FSavedEditorState	Saved information about the editor and viewport we possessed, so we can restore it after exiting VR mode

Enums

	Name	Description
	EColors	Color types.

Typedefs

Name	Description
FOnVREditingModeExit

Constants

Name	Description
AssetContainerPath	The asset container path
bDebugModeEnabled	Whether currently in debug mode or not.

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

Take our survey

Dismiss