1. Epic GamesDeveloper
  3. UVREditorMode

UVREditorMode

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

Unreal Engine C++ API Reference > Editor > VREditor

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, Transient)  
class UVREditorMode : public UVREditorModeBase

Remarks

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

Variables

  Type Name Description
Protected variable FTimespan AppTimeModeEntered App time that we entered this mode
Protected variable UProperty TObjectPtr< class UVREditorAutoScaler > AutoScalerSystem Automatic scale system
Protected variable UProperty TObjectPtr< class AVREditorAvatarActor > AvatarActor Avatar visuals Actor with components to represent the VR avatar in the world, including motion controller meshes
Protected variable bool bIsFlashlightOn If there is currently a flashlight in the scene
Protected variable bool bIsFullyInitialized True if VR mode is fully initialized and ready to render
Protected variable bool bWantsToExitMode True if we currently want to exit VR mode.
Protected variable EGizmoHandleTypes CurrentGizmoType The current Gizmo type that is used for the TransformGizmo Actor
Protected variable USpotLightComponent * FlashlightComponent Flashlight Spotlight for the flashlight
Public variable UProperty Category, EditAnywhere BlueprintReadWrite noclear TSoftClassPtr< UVREditorInteractor > InteractorClass The controller to use when UnrealEd is in VR mode.
Protected variable UProperty TArray< TObjectPtr< UVREditorInteractor > > Interactors Interactors
Protected variable int32 MotionControllerID Input The Unreal controller ID for the motion controllers we're using
Protected variable FOnPlaceDraggedMaterial OnPlaceDraggedMaterialEvent Event broadcast when a material is placed
Protected variable FOnPlacePreviewActor OnPlacePreviewActorEvent Event broadcast when a preview actor is placed
Public variable FOnVREditingModeExit OnVREditingModeExit_Handler Used to override dockable area restoration behavior
Protected variable UProperty TObjectPtr< class UVREditorPlacement > PlacementSystem  
Protected variable UProperty TObjectPtr< class AVREditorTeleporter > TeleportActor Teleporter system
Public variable UProperty Category, EditAnywhere BlueprintReadWrite noclear TSoftClassPtr< AVREditorTeleporter > TeleporterClass The teleporter to use when UnrealEd is in VR mode.
Protected variable FOnVRTickHandle TickHandle Subsystems registered
Protected variable UProperty TObjectPtr< class UVREditorUISystem > UISystem Subsystems VR UI system
Protected variable TWeakPtr< class SWindow > VREditorWindowWeakPtr The VR editor window, if it's open right now
Protected variable UProperty TObjectPtr< class UViewportWorldInteraction > WorldInteraction World interaction World interaction manager

Constructors

  Type Name Description
Public function   Default constructor

Functions

  Type Name Description
Public function void  
Protected function void Startup/Shutdown
Public function UStaticMeshComponent *

CreateMesh ( AActor* OwningActor,
const FString& MeshName,
USceneComponent* AttachmentToComponent
)

 Helper functions to create a static mesh
Public function UStaticMeshComponent *

CreateMesh ( AActor* OwningActor,
UStaticMesh* Mesh,
USceneComponent* AttachmentToComponent
)

  
Public function UStaticMeshComponent *

CreateMotionControllerMesh ( AActor* OwningActor,
USceneComponent* AttachmentToComponent,
UStaticMesh* OptionalControllerMesh
)

 Create a static motion controller mesh for the current HMD platform
Public function void Will update the TransformGizmo Actor with the next Gizmo type
Protected function void  
Public function Const const UVREditorAssetContainer & Gets the container for all the assets of VREditor.
Public function Const FLinearColor

GetColor ( const EColors Color
)

 Gets the color.
Public function Const EGizmoHandleTypes Gets the current Gizmo handle type
Public function ISequencer * Returns the currently active sequencer
Public function Const float Get the default near clipping plane for VR editing.
Public function Const UVREditorInteractor *

GetHandInteractor ( const EControllerHand ControllerHand
)

 Gets the hand interactor
Public function Const FName  
Public function Const int32 Returns the Unreal controller ID for the motion controllers we're using
Public function Const FTransform Gets the transform of the user's HMD in room space
Public function Const const FSavedEditorState & Gets the saved editor state from entering the mode
Public function AVREditorTeleporter * Get Teleporter
Public function Const FTimespan Returns the time since the VR Editor mode was last entered
Public function UVREditorUISystem & Gets access to the VR UI system
Public function Const const UVREditorUISystem & Gets access to the VR UI system (const)
Public function Const const TArray< UVREditorInteractor * >  
Public function Const const UViewportWorldInteraction & Gets access to the world interaction system (const)
Public function UViewportWorldInteraction & Gets access to the world interaction system
Public function Const UFunction BlueprintCallable, Category float Gets the world scale factor, which can be multiplied by a scale vector to convert to room space
Public function Const bool Return true if currently aiming to teleport.
Public function Static bool Returns if the VR Mode is in debug mode.
Public function Const bool Returns whether or not the flashlight is visible
Public function Const bool If the mode was completely initialized
Public function Const bool

IsHandAimingTowardsCapsule ( UViewportInteractor* Interactor,
const FTransform& CapsuleTransform,
const FVector CapsuleStart,
const FVector CapsuleEnd,
const float CapsuleRadius,
const float MinDistanceToCapsule,
const FVector CapsuleFrontDirection,
const float MinDotForAimingAtCapsule
)

  
Public function Const UFunction BlueprintCallable, Category bool Returns whether game view is currently active.
Public function Const bool Lets other modules know if the radial menu is visible on a given interactor so input should be handled differently
Public function Const bool  
Public function Static UVREditorAssetContainer & Loads and returns the container for all the assets of VREditor.
Public function Virtual bool  
Public function FOnPlaceDraggedMaterial &  
Public function FOnPlacePreviewActor &  
Public function FOnVRTickHandle &  
Public function FOnToggleVRModeDebug &  
Public function Static T

OvershootEaseOut ( T Alpha,
const float OvershootAmount
)

  
Public function void

PlaySound ( USoundBase* SoundBase,
const FVector& InWorldLocation,
const float InVolume
)

 Plays sound at location.
Public function void

PostTick ( const float DeltaTime
)

 Tick after the ViewportWorldInteraction is ticked
Public function void

PreTick ( const float DeltaTime
)

 Tick before the ViewportWorldInteraction is ticked
Public function void

RefreshActorPreviewWidget ( TSharedRef< SWidget > InWidget,
int32 Index,
AActor* Actor,
bool bIsPanelDetached
)

 Refresh the current actor preview widget on an in-world UI panel
Public function void

RefreshVREditorSequencer ( ISequencer* InCurrentSequencer
)

 Runtime and plugin modules can force VR Editor to refresh using this function
Public function void

SaveSequencerSettings ( bool bInKeyAllEnabled,
EAutoChangeMode InAutoChangeMode,
const USequencerSettings& InSequencerSettings
)

  
Public function UFunction BlueprintCallable, Category void

SetGameView ( bool bGameView
)

 Display the scene more closely to how it would appear at runtime (as opposed to edit time).
Public function void

SetHMDDeviceTypeOverride ( FName InOverrideType
)

 Overrides the HMD device type, which is otherwise derived from the XR system name.
Public function void

SetRoomTransform ( const FTransform& NewRoomTransform
)

 Sets a new transform for the room, in world space.
Protected function void  
Public function Virtual Const bool  
Public function void Snaps the current selected actor to the ground
Public function void Call this to start exiting VR mode
Public function Static void Toggles the debug mode.
Public function void Spawns a flashlight on the specified hand
Protected function Virtual void

TransitionWorld ( UWorld* NewWorld,
EEditorWorldExtensionTransitionState TransitionState
)

  
Public function Const bool Check whether the UISystem exists
Public function void

UpdateExternalSlateUI ( TSharedRef< SWidget > InWidget,
FName Name,
FVector2D InSize
)

 General way to spawn an external Slate UI from a radial menu
Public function void General way to spawn an external UMG UI from a radial menu

Overridden from UVREditorModeBase

  Type Name Description
Public function Virtual TSharedRef< FBaseSavedEditorState > Derived classes can override this to return a derived state struct, and add their own saved state.
Public function Virtual void

Enter ()

 When the user actually enters the VR Editor mode
Public function Virtual void

Exit ( bool bShouldDisableStereo
)

 When the user leaves the VR Editor mode
Public function Virtual Const FTransform Gets the world space transform of the HMD (head)
Public function Virtual Const bool

GetLaserForHand ( EControllerHand InHand,
FVector& OutLaserStart,
FVector& OutLaserEnd
)

 Gives start and end points in world space for an active laser, or returns false if there is no active laser for the specified hand.
Public function Virtual Const FTransform Gets the world space transform of the calibrated VR room origin.
Public function Virtual void

Init ()

 Initialize the VREditor
Public function Virtual void Shutdown the VREditor
Public function Virtual Const bool Returns true if the user wants to exit this mode

Classes

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

Enums

  Type Name Description
Public enum EColors Color types.  

Typedefs

Name Description
FOnVREditingModeExit  

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page