UE4 Cardboard VR  1.0.2
Unreal Engine 4 plugin to run UE4 mobile VR projects on iOS and Android devices using Google Cardboard VR viewers.
Public Attributes | List of all members
UUNACardboardVRProjectSettings Class Reference

UNACardboardVR project settings. More...

#include <UNACardboardVRProjectSettings.h>

Inheritance diagram for UUNACardboardVRProjectSettings:

Public Attributes

bool bAlwaysShowQrScannerFirstTime = true
 Whether or not to automatically open the QR scanner at the first launch of the app (i.e. More...
 
bool bShowBackButton = false
 Whether or not to show the back button in the Cardboard native UI. More...
 
bool bShowNativeUI = true
 Whether or not to show the Cardboard native UI. More...
 
bool bShowToggleStereoModeButton = true
 Whether or not to show the stereo mode toggle button in the Cardboard native UI When pressed, the stereo rendering for HMD devices will be automatically toggled, and the UUNACardboardVRSubsystem::OnStereoModeChanged delegate will be triggered. More...
 
bool bVignetteEnabled = true
 Enable or not the HMD Vignette effect. More...
 
float VignetteHardness = 25.0f
 The HMD Vignette hardness. More...
 

Detailed Description

UNACardboardVR project settings.

Most of the settings can be updated at run-time using the UUNACardboardVRStatics class methods.

Member Data Documentation

◆ bAlwaysShowQrScannerFirstTime

bool UUNACardboardVRProjectSettings::bAlwaysShowQrScannerFirstTime = true

Whether or not to automatically open the QR scanner at the first launch of the app (i.e.

if no previous viewer device parameters were already cached). This procedure is required to properly setups the stereoscopy rendering as it retrieves the correct viewer device parameters. Alternatively, you can manually call UUNACardboardVRStatics::ScanForQRViewerProfile() when desired.

◆ bShowBackButton

bool UUNACardboardVRProjectSettings::bShowBackButton = false

Whether or not to show the back button in the Cardboard native UI.

When pressed, the following standard UE4 events will be triggered:

◆ bShowNativeUI

bool UUNACardboardVRProjectSettings::bShowNativeUI = true

Whether or not to show the Cardboard native UI.

This is a native overlay showing commonly useful buttons to allow the user to enable/disable the stereo view and to open the QR scanner to retrieve the cardboard viewer parameters. Several features of this native UI can be configured with dedicated settings (see bShowBackButton and bShowToggleStereoModeButton). You can also configure it at run-time using methods from UUNACardboardVRStatics.

◆ bShowToggleStereoModeButton

bool UUNACardboardVRProjectSettings::bShowToggleStereoModeButton = true

Whether or not to show the stereo mode toggle button in the Cardboard native UI When pressed, the stereo rendering for HMD devices will be automatically toggled, and the UUNACardboardVRSubsystem::OnStereoModeChanged delegate will be triggered.

◆ bVignetteEnabled

bool UUNACardboardVRProjectSettings::bVignetteEnabled = true

Enable or not the HMD Vignette effect.

◆ VignetteHardness

float UUNACardboardVRProjectSettings::VignetteHardness = 25.0f

The HMD Vignette hardness.

Larger values reduce the vignette effect.


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