com.jme3.app.VRConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jme3-vr Show documentation
jMonkeyEngine is a 3-D game engine for adventurous Java developers
There is a newer version: 3.7.0-stable
package com.jme3.app;

import java.util.HashMap;
import com.jme3.system.AppSettings;

/**
 * Some constants dedicated to the VR module.
 * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr
 * @since 3.1.0
 * @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.
 */
@Deprecated
public class VRConstants {
    /**
     * An AppSettings parameter that set if the VR compositor has to be used.
     * 
     * Type: boolean

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_USE_COMPOSITOR, value)
     */
    public static final String SETTING_USE_COMPOSITOR = "VRUseCompositor";

    /**
     * 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: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_VR_FORCE, value)
     */
    public static final String SETTING_VR_FORCE = "VRForce";

    /**
     * An AppSettings parameter that set to invert the eyes of the HMD.
     * Type: boolean

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_FLIP_EYES, value)
     */
    public static final String SETTING_FLIP_EYES = "VRFlipEyes";

    /**
     * An AppSettings parameter that set if the GUI has to be displayed even if it is behind objects.
     * Type: boolean

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_GUI_OVERDRAW, value)
     *
     */
    public static final String SETTING_GUI_OVERDRAW = "VRGUIOverdraw";

    /**
     * An AppSettings parameter that set if the GUI surface has to be curved.
     * Type: boolean

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_GUI_CURVED_SURFACE, value)
     */
    public static final String SETTING_GUI_CURVED_SURFACE = "VRGUICurvedSurface";

    /**
     * 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: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_ENABLE_MIRROR_WINDOW, value)
     */
    public static final String SETTING_ENABLE_MIRROR_WINDOW = "VREnableMirrorWindow";

    /**
     * An AppSettings parameter that set if the VR rendering has to be disabled,
     * regardless VR API and devices are presents.
     * Type: boolean

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DISABLE_VR, value)
     */
    public static final String SETTING_DISABLE_VR = "VRDisable";


    /**
     * An AppSettings parameter that set if the VR user is seated.
     * Type: boolean

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_SEATED_EXPERIENCE, value)
     */
    public static final String SETTING_SEATED_EXPERIENCE = "VRSeatedExperience";

    /**
     * An AppSettings parameter that set if the GUI has to be ignored.
     * Type: boolean

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_NO_GUI, value)
     */
    public static final String SETTING_NO_GUI = "VRNoGUI";

    /**
     * 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: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_INSTANCE_RENDERING, value)
     */
    public static final String SETTING_INSTANCE_RENDERING = "VRInstanceRendering";

    /**
     * An AppSettings parameter that set if Multi Sample Anti Aliasing has to be enabled.
     * Type: boolean

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DISABLE_MSAA, value)
     */
    public static final String SETTING_DISABLE_MSAA = "VRDisableMSAA";

    /**
     * An AppSettings parameter that set the default field of view (FOV) value.
     * Type: float

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DEFAULT_FOV, value)
     */
    public static final String SETTING_DEFAULT_FOV = "VRDefaultFOV";

    /**
     * An AppSettings parameter that set the default aspect ratio.
     * Type: float

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DEFAULT_ASPECT_RATIO, value)
     */
    public static final String SETTING_DEFAULT_ASPECT_RATIO = "VRDefaultAspectRatio";

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

     * 

     * {@link VRConstants#SETTING_VRAPI_OPENVR_VALUE SETTING_VRAPI_OPENVR_VALUE}: Use OpenVR binding.
     * 
{@link VRConstants#SETTING_VRAPI_OSVR_VALUE SETTING_VRAPI_OSVR_VALUE}: Use OSVR binding.
     * 
{@link VRConstants#SETTING_VRAPI_OPENVR_LWJGL_VALUE SETTING_VRAPI_OPENVR_LWJGL_VALUE}: Use OpenVR binding from LWJGL.
     * 
{@link VRConstants#SETTING_VRAPI_OCULUSVR_VALUE SETTING_VRAPI_OCULUSVR_VALUE}: Use Oculus Rift binding binding.
     * 
     * Type: int

     * Usage: {@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_VRAPI, value)
     */
    public static final String SETTING_VRAPI = "VRAPI";

    /**
     * The identifier of the OpenVR system.
     *
     * Deprecated as only the lwjgl OpenVr version has been upgraded to modern action based inputs
     *
     * @see #SETTING_VRAPI_OSVR_VALUE
     * @see #SETTING_VRAPI_OPENVR_LWJGL_VALUE
     * @see #SETTING_VRAPI_OCULUSVR_VALUE
     */
    @Deprecated
    public static final int SETTING_VRAPI_OPENVR_VALUE       = 1;

    /**
     * The identifier of the OSVR system.
     *
     * Deprecated as an OpenVr system should be used instead for a non vender specific api
     *
     * @see #SETTING_VRAPI_OPENVR_VALUE
     * @see #SETTING_VRAPI_OPENVR_LWJGL_VALUE
     * @see #SETTING_VRAPI_OCULUSVR_VALUE
     */
    @Deprecated
    public static final int SETTING_VRAPI_OSVR_VALUE         = 2;

    /**
     * The identifier of the OpenVR from LWJGL system.
     *
     * @see #SETTING_VRAPI_OPENVR_VALUE
     * @see #SETTING_VRAPI_OSVR_VALUE
     * @see #SETTING_VRAPI_OCULUSVR_VALUE
     */
    public static final int SETTING_VRAPI_OPENVR_LWJGL_VALUE = 3;

    /**
     * The identifier of the Oculus Rift system.
     *
     * Deprecated as an OpenVr system should be used instead (and the rift itself is discontinued)
     *
     * @see #SETTING_VRAPI_OPENVR_VALUE
     * @see #SETTING_VRAPI_OSVR_VALUE
     * @see #SETTING_VRAPI_OPENVR_LWJGL_VALUE
     */
    @Deprecated
    public static final int SETTING_VRAPI_OCULUSVR_VALUE    = 4;

    /**
     * A private constructor to inhibit instantiation of this class.
     */
    private VRConstants() {
    }
}