1. Epic GamesDeveloper
  3. UVPScoutingSubsystem

UVPScoutingSubsystem

Subsystem used for VR Scouting

API > API/Plugins > API/Plugins/VPUtilitiesEditor

Subsystem used for VR Scouting

   
Name UVPScoutingSubsystem
Type class
Header File /Engine/Plugins/Experimental/VirtualProductionUtilities/Source/VPUtilitiesEditor/Public/VPScoutingSubsystem.h
Include Path #include "VPScoutingSubsystem.h"

Syntax

UCLASS ()  
class UVPScoutingSubsystem : public UEditorSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UVPScoutingSubsystem()

   VPScoutingSubsystem.h  

Constants

Name Type Remarks Include Path
VProdPanelContextID const FName   VPScoutingSubsystem.h
VProdPanelGafferID const FName   VPScoutingSubsystem.h
VProdPanelID const FName 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. VPScoutingSubsystem.h
VProdPanelLeftID const FName   VPScoutingSubsystem.h
VProdPanelMeasureID const FName   VPScoutingSubsystem.h
VProdPanelRightID const FName   VPScoutingSubsystem.h
VProdPanelTimelineID const FName   VPScoutingSubsystem.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
GestureManager TObjectPtr< UVPScoutingSubsystemGestureManagerBase > GestureManager that manage some user input in VR editor. VPScoutingSubsystem.h
  • Transient
  • BlueprintReadOnly
  • Category="Virtual Production"
  • Meta=(DeprecatedProperty, DeprecationMessage="This property is deprecated")
GripNavSpeedCoeff float 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 VPScoutingSubsystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Virtual Production"
  • Meta=(DeprecatedProperty, DeprecationMessage="This property is deprecated")
IsSettingsMenuOpen bool Bool to keep track of whether the settings menu panel in the main menu is open VPScoutingSubsystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Main Menu"
  • Meta=(DeprecatedProperty, DeprecationMessage="This property is deprecated")
VPSubsystemHelpers TObjectPtr< UVPScoutingSubsystemHelpersBase > Subsystems can't have any Blueprint implementations, so we attach this class for any BP logic that we to provide. VPScoutingSubsystem.h
  • Transient
  • BlueprintReadOnly
  • Category="Virtual Production"
  • Meta=(DeprecatedProperty, DeprecationMessage="This property is deprecated")

Protected

Name Type Remarks Include Path Unreal Specifiers
EngineInitCompleteDelegate FDelegateHandle   VPScoutingSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   VPScoutingSubsystem.h  

AVREditorFloatingUI * GetPanelActor ( const FName& PanelID
) const

 Get UI panel Actor from the passed ID VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

UUserWidget * GetPanelWidget ( const FName& PanelID
) const

 Get UI panel widget from the passed ID VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

void HideInfoDisplayPanel()

 Hide VR Sequencer Window VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   VPScoutingSubsystem.h  

bool IsVRScoutingUIOpen ( const FName& PanelID
)

 Check whether a widget UI is open VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")
Open a widget UI in front of the user. VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

Static

Name Remarks Include Path Unreal Specifiers

static bool EnterVRMode()

 Enter VR Mode VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void ExitVRMode()

 Exit VR Mode VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static TArray< UVREditorInteractor * > GetActiveEditorVRControllers()

   VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static FString GetDirectorName()

   VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static float GetFlightSpeed()

 Get flight speed for scouting in VR VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static float GetGripNavSpeed()

 Get grip nav speed for scouting in VR VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static FString GetShowName()

   VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static const FName GetVProdPanelID ( const EVProdPanelIDs Panel
)

   VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static UVREditorMode * GetVREditorMode()

 Get VR Editor Mode object VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static bool IsHelperSystemEnabled()

 Whether the helper system on the controllers is enabled VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static bool IsLocationGridSnappingEnabled()

 Whether location grid snapping is enabled VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static bool IsRotationGridSnappingEnabled()

 Whether rotation grid snapping is enabled VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static bool IsUsingInertiaDamping()

 Whether grip nav inertia is enabled when scouting in VR VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static bool IsUsingMetricSystem()

 Whether the VR user wants to use the metric system instead of imperial VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static bool IsUsingTransformGizmo()

 Whether the VR user wants to have the transform gizmo enabled VPScoutingSubsystem.h
  • BlueprintPure
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void SetFlightSpeed ( const float InFlightSpeed
)

 Set flight speed for scouting in VR VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void SetGripNavSpeed ( const float InGripNavSpeed
)

 Set grip nav speed for scouting in VR VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void SetInertiaDampingCVar ( const float InInertiaDamping
)

 Set value of cvar "VI.HighSpeedInertiaDamping" VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void SetIsHelperSystemEnabled ( const bool bInIsHelperSystemEnabled
)

 Set whether the helper system on the controllers is enabled VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void SetIsUsingInertiaDamping ( const bool bInIsUsingInertiaDamping
)

 Set whether grip nav inertia is enabled when scouting in VR VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void SetIsUsingMetricSystem ( const bool bInUseMetricSystem
)

 Set whether the VR user wants to use the metric system instead of imperial VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void SetIsUsingTransformGizmo ( const bool bInIsUsingTransformGizmo
)

 Set whether the VR user wants to have the transform gizmo enabled VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void SetShowTransformGizmoCVar ( const bool bInShowTransformGizmoCVar
)

 Set value of cvar "VI.ShowTransformGizmo" VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void ToggleLocationGridSnapping()

 Toggle location grid snapping VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

static void ToggleRotationGridSnapping()

 Toggle rotation grid snapping VPScoutingSubsystem.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function will be removed from UE5.7")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page