UE5 Cardboard VR 1.3.0
Unreal Engine plugin to run UE4 and UE5 mobile VR projects on iOS and Android devices using Google Cardboard VR viewers.
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
UUNACardboardVRStatics Class Reference

Static UNACardboardVR methods that can be called from both Blueprint and C++. More...

#include <UNACardboardVRStatics.h>

Inheritance diagram for UUNACardboardVRStatics:

Static Public Member Functions

static FString GetCardboardV1DeviceParams ()
 Gets Cardboard V1 device parameters. More...
 
static FString GetSavedDeviceParams ()
 Gets currently saved device parameters. More...
 
static void RecenterHeadTracker ()
 Recenters the head tracker. More...
 
static void SaveDeviceParams (const FString &encodedDeviceParams)
 Set the device parameters and saves them. More...
 
static void SaveDeviceParamsFromURL (const FString &uri)
 Set the device parameters from an input URL and saves them. More...
 
static void ScanForQRViewerProfile ()
 Open the QR scanner to scan the viewer profile. More...
 
static void SetBackButtonVisibility (bool bVisible)
 Set the back button visibility in the native UI. More...
 
static void SetBaseOffsetYaw (float OffsetYaw)
 Set a custom Offset Yaw angle that it's added to the head-tracked orientation. More...
 
static void SetNativeUIVisibility (bool bVisible)
 Set the native overlay UI visibility. More...
 
static void SetToggleStereoModeButtonVisibity (bool bVisible)
 Set the toggle stereo mode button visibility in the native UI. More...
 

Detailed Description

Static UNACardboardVR methods that can be called from both Blueprint and C++.

Some features (mainly Delegates) are available using the UUNACardboardVRSubsystem subsystem.

Member Function Documentation

◆ GetCardboardV1DeviceParams()

static FString UUNACardboardVRStatics::GetCardboardV1DeviceParams ( )
static

Gets Cardboard V1 device parameters.

Returns
The encoded device parameters, in a format compatible with SaveDeviceParams().
See also
CardboardQrCode_getCardboardV1DeviceParams()

◆ GetSavedDeviceParams()

static FString UUNACardboardVRStatics::GetSavedDeviceParams ( )
static

Gets currently saved device parameters.

Returns
The encoded device parameters, in a format compatible with SaveDeviceParams().
See also
CardboardQrCode_getSavedDeviceParams()

◆ RecenterHeadTracker()

static void UUNACardboardVRStatics::RecenterHeadTracker ( )
static

Recenters the head tracker.

See also
CardboardHeadTracker_recenter()

◆ SaveDeviceParams()

static void UUNACardboardVRStatics::SaveDeviceParams ( const FString &  encodedDeviceParams)
static

Set the device parameters and saves them.

Parameters
encodedDeviceParamsThe encoded device parameters. Encoded device params can be generated through the "viewer profile generator" (https://wwgc.firebaseapp.com/). They are usually a string similar to CgZHb29nbGUSEkNhcmRib2FyZCBJL08gMjAxNR0rGBU9JQHegj0qEAAASEIAAEhCAABIQgAASEJYADUpXA89OggeZnc-Ej6aPlAAYAM. If the input string is empty, the Cardboard Viewer v1 default params will be loaded.
See also
SaveDeviceParamsFromURL()
UUNACardboardVRProjectSettings::encodedDeviceParams
CardboardQrCode_saveDeviceParams()

◆ SaveDeviceParamsFromURL()

static void UUNACardboardVRStatics::SaveDeviceParamsFromURL ( const FString &  uri)
static

Set the device parameters from an input URL and saves them.

Parameters
uriAn URI as documented by CardboardQrCode_saveDeviceParams(). URI embedding custom device params can be generated through the "viewer profile generator" (https://wwgc.firebaseapp.com/).
See also
SaveDeviceParams()
CardboardQrCode_saveDeviceParams()

◆ ScanForQRViewerProfile()

static void UUNACardboardVRStatics::ScanForQRViewerProfile ( )
static

Open the QR scanner to scan the viewer profile.

At the end of the procedure device params are updated.

◆ SetBackButtonVisibility()

static void UUNACardboardVRStatics::SetBackButtonVisibility ( bool  bVisible)
static

Set the back button visibility in the native UI.

Note
for the button to be visible, also the native UI must be visible (see SetNativeUIVisibility()) and the stereo mode enabled.

◆ SetBaseOffsetYaw()

static void UUNACardboardVRStatics::SetBaseOffsetYaw ( float  OffsetYaw)
static

Set a custom Offset Yaw angle that it's added to the head-tracked orientation.

Parameters
OffsetYawYaw in degrees.

◆ SetNativeUIVisibility()

static void UUNACardboardVRStatics::SetNativeUIVisibility ( bool  bVisible)
static

Set the native overlay UI visibility.

Parameters
bVisibleIf true, then the Cardboard overlay UI is shown on screen. Its parts can be configured through the dedicated methods (see SetToggleStereoModeButtonVisibity() and SetBackButtonVisibility()).

◆ SetToggleStereoModeButtonVisibity()

static void UUNACardboardVRStatics::SetToggleStereoModeButtonVisibity ( bool  bVisible)
static

Set the toggle stereo mode button visibility in the native UI.

Note
for the toggle button to be visible, also the native UI must be visible (see SetNativeUIVisibility()).

The documentation for this class was generated from the following file: