Package com.jme3.app

Class VRConstants

java.lang.Object

com.jme3.app.VRConstants

@Deprecated
public class VRConstants
extends Object

Deprecated.

The jme3-vr module is deprecated and will be removed in a future version (as it only supports OpenVR). For new Virtual Reality projects, use user libraries that provide OpenXR support. See Virtual Reality JME wiki section for more information.

Some constants dedicated to the VR module.

Since:

3.1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SETTING_DEFAULT_ASPECT_RATIO	Deprecated. An AppSettings parameter that set the default aspect ratio.
static final String	SETTING_DEFAULT_FOV	Deprecated. An AppSettings parameter that set the default field of view (FOV) value.
static final String	SETTING_DISABLE_MSAA	Deprecated. An AppSettings parameter that set if Multi Sample Anti Aliasing has to be enabled.
static final String	SETTING_DISABLE_VR	Deprecated. An AppSettings parameter that set if the VR rendering has to be disabled, regardless VR API and devices are presents.
static final String	SETTING_ENABLE_MIRROR_WINDOW	Deprecated. An AppSettings parameter that set if a mirror rendering has to be displayed on the screen.
static final String	SETTING_FLIP_EYES	Deprecated. An AppSettings parameter that set to invert the eyes of the HMD.
static final String	SETTING_GUI_CURVED_SURFACE	Deprecated. An AppSettings parameter that set if the GUI surface has to be curved.
static final String	SETTING_GUI_OVERDRAW	Deprecated. An AppSettings parameter that set if the GUI has to be displayed even if it is behind objects.
static final String	SETTING_INSTANCE_RENDERING	Deprecated. An AppSettings parameter that set if instance rendering has to be used.
static final String	SETTING_NO_GUI	Deprecated. An AppSettings parameter that set if the GUI has to be ignored.
static final String	SETTING_SEATED_EXPERIENCE	Deprecated. An AppSettings parameter that set if the VR user is seated.
static final String	SETTING_USE_COMPOSITOR	Deprecated. An AppSettings parameter that set if the VR compositor has to be used.
static final String	SETTING_VR_FORCE	Deprecated. 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 final String	SETTING_VRAPI	Deprecated. An AppSettings parameter that specifies the underlying VR API.
static final int	SETTING_VRAPI_OCULUSVR_VALUE	Deprecated.
static final int	SETTING_VRAPI_OPENVR_LWJGL_VALUE	Deprecated. The identifier of the OpenVR from LWJGL system.
static final int	SETTING_VRAPI_OPENVR_VALUE	Deprecated.
static final int	SETTING_VRAPI_OSVR_VALUE	Deprecated.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

SETTING_USE_COMPOSITOR

public static final String SETTING_USE_COMPOSITOR

Deprecated.

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 String SETTING_VR_FORCE

Deprecated.

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 String SETTING_FLIP_EYES

Deprecated.

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 String SETTING_GUI_OVERDRAW

Deprecated.

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 String SETTING_GUI_CURVED_SURFACE

Deprecated.

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 String SETTING_ENABLE_MIRROR_WINDOW

Deprecated.

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 String SETTING_DISABLE_VR

Deprecated.

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 String SETTING_SEATED_EXPERIENCE

Deprecated.

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 String SETTING_NO_GUI

Deprecated.

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 String SETTING_INSTANCE_RENDERING

Deprecated.

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 String SETTING_DISABLE_MSAA

Deprecated.

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 String SETTING_DEFAULT_FOV

Deprecated.

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 String SETTING_DEFAULT_ASPECT_RATIO

Deprecated.

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 String SETTING_VRAPI

Deprecated.

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 Oculus Rift binding binding.

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

See Also:

• Constant Field Values

SETTING_VRAPI_OPENVR_VALUE

@Deprecated
public static final int SETTING_VRAPI_OPENVR_VALUE

Deprecated.

The identifier of the OpenVR system. Deprecated as only the lwjgl OpenVr version has been upgraded to modern action based inputs

See Also:

• SETTING_VRAPI_OSVR_VALUE
• SETTING_VRAPI_OPENVR_LWJGL_VALUE
• SETTING_VRAPI_OCULUSVR_VALUE
• Constant Field Values

SETTING_VRAPI_OSVR_VALUE

@Deprecated
public static final int SETTING_VRAPI_OSVR_VALUE

Deprecated.

The identifier of the OSVR system. Deprecated as an OpenVr system should be used instead for a non vender specific api

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

Deprecated.

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

@Deprecated
public static final int SETTING_VRAPI_OCULUSVR_VALUE

Deprecated.

The identifier of the Oculus Rift system. Deprecated as an OpenVr system should be used instead (and the rift itself is discontinued)

See Also:

• SETTING_VRAPI_OPENVR_VALUE
• SETTING_VRAPI_OSVR_VALUE
• SETTING_VRAPI_OPENVR_LWJGL_VALUE
• Constant Field Values