1. Epic GamesDeveloper
  3. UVREditorModeBase

UVREditorModeBase

API > API/Editor > API/Editor/VREditor

Inheritance Hierarchy

References

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

Syntax

class UVREditorModeBase : public UEditorWorldExtension

Variables

  Type Name Description
Protected variable bool bActuallyUsingVR True if we're in using an actual HMD in this mode, or false if we're "faking" VR mode for testing
Protected variable FOnVRModeEntryComplete OnVRModeEntryCompleteEvent Delegate broadcast when async VR mode entry is completed.
Protected variable TSharedPtr< FBaseSavedEditorState > SavedEditorStatePtr  
Protected variable TWeakPtr< SLevelViewport > VREditorLevelViewportWeakPtr  

Functions

  Type Name Description
Protected function Virtual void

CloseViewport ( bool bShouldDisableStereo
)

 Close the current viewport
Protected function Virtual TSharedRef< FBaseSavedEditorState > Derived classes can override this to return a derived state struct, and add their own saved state.
Protected function Virtual void  
Protected function Virtual void  
Public function Virtual void

Enter ()

  
Public function Virtual void

Exit ( bool bShouldDisableStereo
)

  
Public function Virtual Const FTransform Returns the user's head pose in world space.
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 SLevelViewport & TODO: Deprecate these in favor of replacements below; viewport may be null.
Public function Const const SLevelViewport & TODO: Deprecate these in favor of replacements below; viewport may be null.
Public function Virtual Const FTransform Returns the transform which takes poses from XR tracking space ("room" space) to world space.
Public function Const TSharedPtr< const SLevelViewport >  
Public function TSharedPtr< SLevelViewport >  
Public function Virtual Const bool Returns true if we're actually using VR, or false if we're faking it
Public function FOnVRModeEntryComplete &  
Protected function FBaseSavedEditorState & Gets the saved editor state from entering the mode
Protected function Const const FBaseSavedEditorState &  
Public function Virtual void

SetActuallyUsingVR ( bool bShouldActuallyUseVR
)

 Sets whether we should actually use an HMD. Call this before activating VR mode
Protected function Virtual void Start using the viewport passed
Public function Virtual Const bool Returns true if the user wants to exit this mode

Overridden from UEditorWorldExtension

  Type Name Description
Public function Virtual void

Init ()

 Initialize extension
Public function Virtual void Shut down extension when world is destroyed

Classes

  Type Name Description
Protected struct FBaseSavedEditorState Saved information about the editor and viewport we possessed, so we can restore it after exiting VR mode  

Typedefs

Name Description
FOnVRModeEntryComplete Delegate to be called when async VR mode entry has been completed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page