Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > VPUtilitiesEditor > UVPScoutingSubsystem

Light Theme

Dark Theme

UVPScoutingSubsystem

Subsystem used for VR Scouting

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubsystem

UDynamicSubsystem

UEditorSubsystem

UVPScoutingSubsystem

References

Module	VPUtilitiesEditor
Header	/Engine/Plugins/Experimental/VirtualProductionUtilities/Source/VPUtilitiesEditor/Public/VPScoutingSubsystem.h
Include	#include "VPScoutingSubsystem.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UVPScoutingSubsystem : public UEditorSubsystem

Remarks

Subsystem used for VR Scouting

Variables

	Name	Description
UVPScoutingSubs...	GestureManager	GestureManager that manage some user input in VR editor.
float	GripNavSpeedCoeff	This is a multiplier for grip nav speed so we can keep the grip nav value in the range 0-1 and increase this variable if we need a bigger range
bool	IsSettingsMenuOpen	Bool to keep track of whether the settings menu panel in the main menu is open
UVPScoutingSubs...	VPSubsystemHelpers	Subsystems can't have any Blueprint implementations, so we attach this class for any BP logic that we to provide.

Constructors

	Name	Description
	UVPScoutingSubsystem()

Functions

	Name	Description
void	ExitVRMode()	Exit VR Mode
TArray< UVRE...	GetActiveEditorVRControllers()
FString	GetDirectorName()
float	GetFlightSpeed()	Get flight speed for scouting in VR
float	GetGripNavSpeed()	Get grip nav speed for scouting in VR
AVREditorFlo...	GetPanelActor ( const FName& PanelID )	Get UI panel Actor from the passed ID
UUserWidget ...	GetPanelWidget ( const FName& PanelID )	Get UI panel widget from the passed ID
FString	GetShowName()
const FName	GetVProdPanelID ( const EVProdPanelIDs Panel )
void	HideInfoDisplayPanel()	Hide VR Sequencer Window
bool	IsHelperSystemEnabled()	Whether the helper system on the controllers is enabled
bool	IsLocationGridSnappingEnabled()	Whether location grid snapping is enabled
bool	IsRotationGridSnappingEnabled()	Whether rotation grid snapping is enabled
bool	IsUsingInertiaDamping()	Whether grip nav inertia is enabled when scouting in VR
bool	IsUsingMetricSystem()	Whether the VR user wants to use the metric system instead of imperial
bool	IsUsingTransformGizmo()	Whether the VR user wants to have the transform gizmo enabled
bool	IsVRScoutingUIOpen ( const FName& PanelID )	Check whether a widget UI is open
void	SetFlightSpeed ( const float InFlightSpeed )	Set flight speed for scouting in VR
void	SetGripNavSpeed ( const float InGripNavSpeed )	Set grip nav speed for scouting in VR
void	SetInertiaDampingCVar ( const float InInertiaDamping )	Set value of cvar "VI.HighSpeedInertiaDamping"
void	SetIsHelperSystemEnabled ( const bool bInIsHelperSystemEnabled )	Set whether the helper system on the controllers is enabled
void	SetIsUsingInertiaDamping ( const bool bInIsUsingInertiaDamping )	Set whether grip nav inertia is enabled when scouting in VR
void	SetIsUsingMetricSystem ( const bool bInUseMetricSystem )	Set whether the VR user wants to use the metric system instead of imperial
void	SetIsUsingTransformGizmo ( const bool bInIsUsingTransformGizmo )	Set whether the VR user wants to have the transform gizmo enabled
void	SetShowTransformGizmoCVar ( const bool bInShowTransformGizmoCVa... )	Set value of cvar "VI.ShowTransformGizmo"
void	ToggleLocationGridSnapping()	Toggle location grid snapping
void	ToggleRotationGridSnapping()	Toggle rotation grid snapping
void	ToggleVRScoutingUI ( FVREditorFloatingUICreationContext ... )	Open a widget UI in front of the user.

Overridden from USubsystem

		Name	Description
	void	Deinitialize()	Implement this for deinitialization of instances of the system
	void	Initialize ( FSubsystemCollectionBase& Collecti... )	Implement this for initialization of instances of the system

Constants

Name	Description
VProdPanelContextID
VProdPanelGafferID
VProdPanelID	Static IDs when submitting open/close requests for the VProd main menu panels. VREditorUISystem uses FNames to manage its panels, so these should be used for consistency.
VProdPanelLeftID
VProdPanelMeasureID
VProdPanelRightID
VProdPanelTimelineID

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss