Navigation
API > API/Editor > API/Editor/VREditor
| Name | UVREditorModeBase |
| Type | class |
| Header File | /Engine/Source/Editor/VREditor/Public/VREditorModeBase.h |
| Include Path | #include "VREditorModeBase.h" |
Syntax
UCLASS (MinimalAPI, Abstract, BlueprintType, Blueprintable, Transient)
class UVREditorModeBase : public UEditorWorldExtension
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UEditorWorldExtension → UVREditorModeBase
Structs
| Name | Remarks |
|---|---|
| FBaseSavedEditorState | Saved information about the editor and viewport we possessed, so we can restore it after exiting VR mode |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnVRModeEntryComplete | TMulticastDelegate_NoParams< void > | Delegate to be called when async VR mode entry has been completed. | VREditorModeBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Enter() |
VREditorModeBase.h | ||
virtual void Exit
(
bool bShouldDisableStereo |
VREditorModeBase.h | ||
virtual FTransform GetHeadTransform() |
Returns the user's head pose in world space. | VREditorModeBase.h | |
virtual bool GetLaserForHand
(
EControllerHand InHand, |
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. | VREditorModeBase.h | |
SLevelViewport & GetLevelViewportPossessedForVR () |
VREditorModeBase.h | ||
const SLevelViewport & GetLevelViewportPossessedForVR () |
TODO: Deprecate these in favor of replacements below; viewport may be null. | VREditorModeBase.h | |
virtual FTransform GetRoomTransform() |
Returns the transform which takes poses from XR tracking space ("room" space) to world space. | VREditorModeBase.h | |
TSharedPtr< const SLevelViewport > GetVrLevelViewport () |
VREditorModeBase.h | ||
TSharedPtr< SLevelViewport > GetVrLevelViewport () |
VREditorModeBase.h | ||
virtual void Init() |
VREditorModeBase.h | ||
virtual bool IsActuallyUsingVR() |
Returns true if we're actually using VR, or false if we're faking it | VREditorModeBase.h | |
FOnVRModeEntryComplete & OnVRModeEntryComplete() |
VREditorModeBase.h | ||
virtual void SetActuallyUsingVR
(
bool bShouldActuallyUseVR |
Sets whether we should actually use an HMD. Call this before activating VR mode | VREditorModeBase.h | |
virtual void Shutdown() |
VREditorModeBase.h | ||
virtual bool WantsToExitMode() |
Returns true if the user wants to exit this mode | VREditorModeBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CloseViewport
(
bool bShouldDisableStereo |
Close the current viewport | VREditorModeBase.h | |
virtual TSharedRef< FBaseSavedEditorState > CreateSavedState() |
Derived classes can override this to return a derived state struct, and add their own saved state. | VREditorModeBase.h | |
virtual void DisableStereo() |
VREditorModeBase.h | ||
virtual void EnableStereo() |
VREditorModeBase.h | ||
| Gets the saved editor state from entering the mode | VREditorModeBase.h | ||
const FBaseSavedEditorState & SavedEditorStateChecked () |
VREditorModeBase.h | ||
virtual void StartViewport
(
TSharedPtr< SLevelViewport > Viewport |
Start using the viewport passed | VREditorModeBase.h | |
virtual void StereoViewportSetup
(
TSharedRef< SLevelViewport > Viewport |
VREditorModeBase.h | ||
virtual void StereoViewportShutdown
(
TSharedRef< SLevelViewport > Viewport |
VREditorModeBase.h |