Navigation
API > API/Editor > API/Editor/VREditor
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
| Type | Name | Description | |
|---|---|---|---|
| void | EnableVREditor
(
const bool bEnable, |
Enables or disables editor VR features. | |
| IVREditorModule & | Get () |
Singleton-like access to this module's interface. | |
| TSharedPtr< class FExtender > | Gets the radial menu extender. This can be used to add your own menu items to the VR radial menu | ||
| UVREditorModeBase * | |||
| bool | IsAvailable () |
Checks to see if this module is loaded and ready. | |
| bool | Checks to see whether its possible to use VR mode in this session. | ||
| bool | Checks to see if the VR Mode button should be active or grayed out (such as during SIE) | ||
| bool | Checks whether or not editor VR features are enabled | ||
| FOnVREditingModeEnter & | |||
| FOnVREditingModeExit & | |||
| void | UpdateActorPreview
(
TSharedRef< class SWidget > InWidget, |
Update the actor preview (for example, the view from a camera attached to a pawn) in VR mode | |
| void | UpdateExternalSlateUI
(
TSharedRef< SWidget > InSlateWidget, |
Update any external SlateUI spawned from the radial menu | |
| void | UpdateExternalUMGUI
(
const FVREditorFloatingUICreationContext& CreationContext |
Update any external UMG UI spawned from the radial menu |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| UVREditorMode * | GetVRMode () |
Use GetVRModeBase instead. | |
| bool | Test whether GetVRModeBase returns nullptr instead. This only returns true in the case of UVREditorMode. |