IVREditorModule

The public interface to this module

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IModuleInterface

IVREditorModule

References

Module

VREditor

Header

/Engine/Source/Editor/VREditor/Public/IVREditorModule.h

Include

#include "IVREditorModule.h"

Syntax

class IVREditorModule : public IModuleInterface

Remarks

The public interface to this module

Functions

Name Description

Public function

void

 

EnableVREditor

(
    const bool bEnable,
    const bool bForceWithoutHMD
)

Enables or disables editor VR features.

Public function Static

IVREditorMod...

 

Get()

Singleton-like access to this module's interface.

Public function

TSharedPtr< ...

 

GetRadialMenuExtender()

Gets the radial menu extender. This can be used to add your own menu items to the VR radial menu

Public function

UVREditorMod...

 

GetVRMode()

Get the current VREditor running

Public function Static

bool

 

IsAvailable()

Checks to see if this module is loaded and ready.

Public function Const

bool

 

IsVREditorAvailable()

Checks to see whether its possible to use VR mode in this session.

Public function Const

bool

 

IsVREditorButtonActive()

Checks to see if the VR Mode button should be active or grayed out (such as during SIE)

Public function Const

bool

 

IsVREditorEnabled()

Checks whether or not editor VR features are enabled

Public function

bool

 

IsVREditorModeActive()

Check if the VR Editor is currently running

Public function

FOnVREditing...

 

OnVREditingModeEnter()

Public function

FOnVREditing...

 

OnVREditingModeExit()

Public function

void

 

UpdateActorPreview

(
    TSharedRef< class SWidget > InWidge...,
    int32 Index,
    AActor* Actor,
    bool bIsDetached
)

Update the actor preview (for example, the view from a camera attached to a pawn) in VR mode

Public function

void

 

UpdateExternalSlateUI

(
    TSharedRef< SWidget > InSlateWidget,
    FName Name,
    FVector2D InSize
)

Update any external SlateUI spawned from the radial menu

Public function

void

 

UpdateExternalUMGUI

(
    const FVREditorFloatingUICreationCo...
)

Update any external UMG UI spawned from the radial menu