11package com .jme3 .app ;
22
33import java .util .HashMap ;
4-
54import com .jme3 .system .AppSettings ;
65
76/**
109 * @since 3.1.0
1110 */
1211public class VRConstants {
13-
14- /**
15- * An AppSettings parameter that set if the VR compositor has to be used.
16- * <p>
17- * <b>Type: </b><code>boolean</code><br>
18- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_USE_COMPOSITOR, value)</code>
19- */
12+ /**
13+ * An AppSettings parameter that set if the VR compositor has to be used.
14+ * <p>
15+ * <b>Type: </b><code>boolean</code><br>
16+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_USE_COMPOSITOR, value)</code>
17+ */
2018 public static final String SETTING_USE_COMPOSITOR = "VRUseCompositor" ;
21-
19+
2220 /**
23- * An AppSettings parameter that set if the rendering has to use two eyes,
21+ * An AppSettings parameter that set if the rendering has to use two eyes,
2422 * regardless of VR API detection (turning this setting on without a VR system should lead to errors).
2523 * <p>
26- * <b>Type: </b><code>boolean</code><br>
27- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_VR_FORCE, value)</code>
28-
24+ * <b>Type: </b><code>boolean</code><br>
25+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_VR_FORCE, value)</code>
2926 */
3027 public static final String SETTING_VR_FORCE = "VRForce" ;
31-
28+
3229 /**
3330 * An AppSettings parameter that set to invert the eyes of the HMD.
3431 * <b>Type: </b><code>boolean</code><br>
35- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_FLIP_EYES, value)</code>
32+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_FLIP_EYES, value)</code>
3633 */
3734 public static final String SETTING_FLIP_EYES = "VRFlipEyes" ;
38-
35+
3936 /**
4037 * An AppSettings parameter that set if the GUI has to be displayed even if it is behind objects.
4138 * <b>Type: </b><code>boolean</code><br>
42- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_GUI_OVERDRAW, value)</code>
43- *
39+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_GUI_OVERDRAW, value)</code>
40+ *
4441 */
4542 public static final String SETTING_GUI_OVERDRAW = "VRGUIOverdraw" ;
46-
43+
4744 /**
4845 * An AppSettings parameter that set if the GUI surface has to be curved.
4946 * <b>Type: </b><code>boolean</code><br>
50- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_GUI_CURVED_SURFACE, value)</code>
47+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_GUI_CURVED_SURFACE, value)</code>
5148 */
5249 public static final String SETTING_GUI_CURVED_SURFACE = "VRGUICurvedSurface" ;
53-
50+
5451 /**
55- * An AppSettings parameter that set if a mirror rendering has to be displayed on the screen.
52+ * An AppSettings parameter that set if a mirror rendering has to be displayed on the screen.
5653 * Runs faster when set to <code>false</code>.
5754 * <b>Type: </b><code>boolean</code><br>
58- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_ENABLE_MIRROR_WINDOW, value)</code>
55+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_ENABLE_MIRROR_WINDOW, value)</code>
5956 */
6057 public static final String SETTING_ENABLE_MIRROR_WINDOW = "VREnableMirrorWindow" ;
61-
58+
6259 /**
63- * An AppSettings parameter that set if the VR rendering has to be disabled,
60+ * An AppSettings parameter that set if the VR rendering has to be disabled,
6461 * regardless VR API and devices are presents.
6562 * <b>Type: </b><code>boolean</code><br>
66- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DISABLE_VR, value)</code>
63+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DISABLE_VR, value)</code>
6764 */
6865 public static final String SETTING_DISABLE_VR = "VRDisable" ;
69-
70-
66+
67+
7168 /**
7269 * An AppSettings parameter that set if the VR user is seated.
7370 * <b>Type: </b><code>boolean</code><br>
74- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_SEATED_EXPERIENCE, value)</code>
71+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_SEATED_EXPERIENCE, value)</code>
7572 */
7673 public static final String SETTING_SEATED_EXPERIENCE = "VRSeatedExperience" ;
77-
74+
7875 /**
7976 * An AppSettings parameter that set if the GUI has to be ignored.
8077 * <b>Type: </b><code>boolean</code><br>
81- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_NO_GUI, value)</code>
78+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_NO_GUI, value)</code>
8279 */
8380 public static final String SETTING_NO_GUI = "VRNoGUI" ;
84-
81+
8582 /**
86- * An AppSettings parameter that set if instance rendering has to be used.
83+ * An AppSettings parameter that set if instance rendering has to be used.
8784 * This setting requires some vertex shader changes (see Common/MatDefs/VR/Unshaded.j3md).
8885 * <b>Type: </b><code>boolean</code><br>
89- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_INSTANCE_RENDERING, value)</code>
86+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_INSTANCE_RENDERING, value)</code>
9087 */
9188 public static final String SETTING_INSTANCE_RENDERING = "VRInstanceRendering" ;
92-
89+
9390 /**
9491 * An AppSettings parameter that set if Multi Sample Anti Aliasing has to be enabled.
9592 * <b>Type: </b><code>boolean</code><br>
96- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DISABLE_MSAA, value)</code>
93+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DISABLE_MSAA, value)</code>
9794 */
9895 public static final String SETTING_DISABLE_MSAA = "VRDisableMSAA" ;
99-
96+
10097 /**
10198 * An AppSettings parameter that set the default field of view (FOV) value.
10299 * <b>Type: </b><code>float</code><br>
103- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DEFAULT_FOV, value)</code>
100+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DEFAULT_FOV, value)</code>
104101 */
105102 public static final String SETTING_DEFAULT_FOV = "VRDefaultFOV" ;
106-
103+
107104 /**
108105 * An AppSettings parameter that set the default aspect ratio.
109106 * <b>Type: </b><code>float</code><br>
110- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DEFAULT_ASPECT_RATIO, value)</code>
107+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_DEFAULT_ASPECT_RATIO, value)</code>
111108 */
112109 public static final String SETTING_DEFAULT_ASPECT_RATIO = "VRDefaultAspectRatio" ;
113-
110+
114111 /**
115112 * An AppSettings parameter that specifies the underlying VR API. Possible values are:<br>
116113 * <ul>
@@ -120,35 +117,34 @@ public class VRConstants {
120117 * <li>{@link VRConstants#SETTING_VRAPI_OCULUSVR_VALUE SETTING_VRAPI_OCULUSVR_VALUE}: Use Oculus Rift binding binding.
121118 * </ul>
122119 * <b>Type: </b><code>int</code><br>
123- * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_VRAPI, value)</code>
124-
120+ * <b>Usage: </b><code>{@link AppSettings appSettings}.{@link HashMap#put(Object, Object) put}(VRConstants.SETTING_VRAPI, value)</code>
125121 */
126122 public static final String SETTING_VRAPI = "VRAPI" ;
127-
123+
128124 /**
129125 * The identifier of the OpenVR system.
130126 * @see #SETTING_VRAPI_OSVR_VALUE
131127 * @see #SETTING_VRAPI_OPENVR_LWJGL_VALUE
132128 * @see #SETTING_VRAPI_OCULUSVR_VALUE
133129 */
134130 public static final int SETTING_VRAPI_OPENVR_VALUE = 1 ;
135-
131+
136132 /**
137133 * The identifier of the OSVR system.
138134 * @see #SETTING_VRAPI_OPENVR_VALUE
139135 * @see #SETTING_VRAPI_OPENVR_LWJGL_VALUE
140136 * @see #SETTING_VRAPI_OCULUSVR_VALUE
141137 */
142138 public static final int SETTING_VRAPI_OSVR_VALUE = 2 ;
143-
139+
144140 /**
145141 * The identifier of the OpenVR from LWJGL system.
146142 * @see #SETTING_VRAPI_OPENVR_VALUE
147143 * @see #SETTING_VRAPI_OSVR_VALUE
148144 * @see #SETTING_VRAPI_OCULUSVR_VALUE
149145 */
150146 public static final int SETTING_VRAPI_OPENVR_LWJGL_VALUE = 3 ;
151-
147+
152148 /**
153149 * The identifier of the Oculus Rift system.
154150 * @see #SETTING_VRAPI_OPENVR_VALUE
0 commit comments