com.jme3.app

Class VRConstants

java.lang.Object

com.jme3.app.VRConstants

public class VRConstants
extends java.lang.Object

Some constants dedicated to the VR module.

Since:

3.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SETTING_DEFAULT_ASPECT_RATIO An AppSettings parameter that set the default aspect ratio.
static java.lang.String	SETTING_DEFAULT_FOV An AppSettings parameter that set the default field of view (FOV) value.
static java.lang.String	SETTING_DISABLE_MSAA An AppSettings parameter that set if Multi Sample Anti Aliasing has to be enabled.
static java.lang.String	SETTING_DISABLE_VR An AppSettings parameter that set if the VR rendering has to be disabled, regardless VR API and devices are presents.
static java.lang.String	SETTING_ENABLE_MIRROR_WINDOW An AppSettings parameter that set if a mirror rendering has to be displayed on the screen.
static java.lang.String	SETTING_FLIP_EYES An AppSettings parameter that set to invert the eyes of the HMD.
static java.lang.String	SETTING_GUI_CURVED_SURFACE An AppSettings parameter that set if the GUI surface has to be curved.
static java.lang.String	SETTING_GUI_OVERDRAW An AppSettings parameter that set if the GUI has to be displayed even if it is behind objects.
static java.lang.String	SETTING_INSTANCE_RENDERING An AppSettings parameter that set if instance rendering has to be used.
static java.lang.String	SETTING_NO_GUI An AppSettings parameter that set if the GUI has to be ignored.
static java.lang.String	SETTING_SEATED_EXPERIENCE An AppSettings parameter that set if the VR user is seated.
static java.lang.String	SETTING_USE_COMPOSITOR An AppSettings parameter that set if the VR compositor has to be used.
static java.lang.String	SETTING_VR_FORCE An AppSettings parameter that set if the rendering has to use two eyes, regardless of VR API detection (turning this setting on without a VR system should lead to errors).
static java.lang.String	SETTING_VRAPI An AppSettings parameter that specifies the underlying VR API.
static int	SETTING_VRAPI_OCULUSVR_VALUE The identifier of the Oculus Rift system.
static int	SETTING_VRAPI_OPENVR_LWJGL_VALUE The identifier of the OpenVR from LWJGL system.
static int	SETTING_VRAPI_OPENVR_VALUE The identifier of the OpenVR system.
static int	SETTING_VRAPI_OSVR_VALUE The identifier of the OSVR system.

Constructor Summary

Constructors

Constructor and Description
VRConstants()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SETTING_USE_COMPOSITOR

public static final java.lang.String SETTING_USE_COMPOSITOR

An AppSettings parameter that set if the VR compositor has to be used.

Type: boolean
Usage: appSettings.put(VRConstants.SETTING_USE_COMPOSITOR, value)

See Also:

Constant Field Values

SETTING_VR_FORCE

public static final java.lang.String SETTING_VR_FORCE

An AppSettings parameter that set if the rendering has to use two eyes, regardless of VR API detection (turning this setting on without a VR system should lead to errors).

Type: boolean
Usage: appSettings.put(VRConstants.SETTING_VR_FORCE, value)

See Also:

Constant Field Values

SETTING_FLIP_EYES

public static final java.lang.String SETTING_FLIP_EYES

An AppSettings parameter that set to invert the eyes of the HMD. Type: boolean
Usage: appSettings.put(VRConstants.SETTING_FLIP_EYES, value)

See Also:

Constant Field Values

SETTING_GUI_OVERDRAW

public static final java.lang.String SETTING_GUI_OVERDRAW

An AppSettings parameter that set if the GUI has to be displayed even if it is behind objects. Type: boolean
Usage: appSettings.put(VRConstants.SETTING_GUI_OVERDRAW, value)

See Also:

Constant Field Values

SETTING_GUI_CURVED_SURFACE

public static final java.lang.String SETTING_GUI_CURVED_SURFACE

An AppSettings parameter that set if the GUI surface has to be curved. Type: boolean
Usage: appSettings.put(VRConstants.SETTING_GUI_CURVED_SURFACE, value)

See Also:

Constant Field Values

SETTING_ENABLE_MIRROR_WINDOW

public static final java.lang.String SETTING_ENABLE_MIRROR_WINDOW

An AppSettings parameter that set if a mirror rendering has to be displayed on the screen. Runs faster when set to false. Type: boolean
Usage: appSettings.put(VRConstants.SETTING_ENABLE_MIRROR_WINDOW, value)

See Also:

Constant Field Values

SETTING_DISABLE_VR

public static final java.lang.String SETTING_DISABLE_VR

An AppSettings parameter that set if the VR rendering has to be disabled, regardless VR API and devices are presents. Type: boolean
Usage: appSettings.put(VRConstants.SETTING_DISABLE_VR, value)

See Also:

Constant Field Values

SETTING_SEATED_EXPERIENCE

public static final java.lang.String SETTING_SEATED_EXPERIENCE

An AppSettings parameter that set if the VR user is seated. Type: boolean
Usage: appSettings.put(VRConstants.SETTING_SEATED_EXPERIENCE, value)

See Also:

Constant Field Values

SETTING_NO_GUI

public static final java.lang.String SETTING_NO_GUI

An AppSettings parameter that set if the GUI has to be ignored. Type: boolean
Usage: appSettings.put(VRConstants.SETTING_NO_GUI, value)

See Also:

Constant Field Values

SETTING_INSTANCE_RENDERING

public static final java.lang.String SETTING_INSTANCE_RENDERING

An AppSettings parameter that set if instance rendering has to be used. This setting requires some vertex shader changes (see Common/MatDefs/VR/Unshaded.j3md). Type: boolean
Usage: appSettings.put(VRConstants.SETTING_INSTANCE_RENDERING, value)

See Also:

Constant Field Values

SETTING_DISABLE_MSAA

public static final java.lang.String SETTING_DISABLE_MSAA

An AppSettings parameter that set if Multi Sample Anti Aliasing has to be enabled. Type: boolean
Usage: appSettings.put(VRConstants.SETTING_DISABLE_MSAA, value)

See Also:

Constant Field Values

SETTING_DEFAULT_FOV

public static final java.lang.String SETTING_DEFAULT_FOV

An AppSettings parameter that set the default field of view (FOV) value. Type: float
Usage: appSettings.put(VRConstants.SETTING_DEFAULT_FOV, value)

See Also:

Constant Field Values

SETTING_DEFAULT_ASPECT_RATIO

public static final java.lang.String SETTING_DEFAULT_ASPECT_RATIO

An AppSettings parameter that set the default aspect ratio. Type: float
Usage: appSettings.put(VRConstants.SETTING_DEFAULT_ASPECT_RATIO, value)

See Also:

Constant Field Values

SETTING_VRAPI

public static final java.lang.String SETTING_VRAPI

An AppSettings parameter that specifies the underlying VR API. Possible values are:

• SETTING_VRAPI_OPENVR_VALUE: Use OpenVR binding.
• SETTING_VRAPI_OSVR_VALUE: Use OSVR binding.
• SETTING_VRAPI_OPENVR_LWJGL_VALUE: Use OpenVR binding from LWJGL.
• SETTING_VRAPI_OCULUSVR_VALUE: Use Occulus Rift binding binding.

Type: int
Usage: appSettings.put(VRConstants.SETTING_VRAPI, value)

See Also:

Constant Field Values

SETTING_VRAPI_OPENVR_VALUE

public static final int SETTING_VRAPI_OPENVR_VALUE

The identifier of the OpenVR system.

See Also:

SETTING_VRAPI_OSVR_VALUE, SETTING_VRAPI_OPENVR_LWJGL_VALUE, SETTING_VRAPI_OCULUSVR_VALUE, Constant Field Values

SETTING_VRAPI_OSVR_VALUE

public static final int SETTING_VRAPI_OSVR_VALUE

The identifier of the OSVR system.

See Also:

SETTING_VRAPI_OPENVR_VALUE, SETTING_VRAPI_OPENVR_LWJGL_VALUE, SETTING_VRAPI_OCULUSVR_VALUE, Constant Field Values

SETTING_VRAPI_OPENVR_LWJGL_VALUE

public static final int SETTING_VRAPI_OPENVR_LWJGL_VALUE

The identifier of the OpenVR from LWJGL system.

See Also:

SETTING_VRAPI_OPENVR_VALUE, SETTING_VRAPI_OSVR_VALUE, SETTING_VRAPI_OCULUSVR_VALUE, Constant Field Values

SETTING_VRAPI_OCULUSVR_VALUE

public static final int SETTING_VRAPI_OCULUSVR_VALUE

The identifier of the Oculus Rift system.

See Also:

SETTING_VRAPI_OPENVR_VALUE, SETTING_VRAPI_OSVR_VALUE, SETTING_VRAPI_OPENVR_LWJGL_VALUE, Constant Field Values

Constructor Detail

VRConstants

public VRConstants()