From 9e71c73f05b2a1c3486cc97276946628143f197e Mon Sep 17 00:00:00 2001 From: richardTingle <6330028+richardTingle@users.noreply.github.com> Date: Fri, 19 Jan 2024 08:09:53 +0000 Subject: [PATCH] #2174 deprecate key classes in JME3-vr. This functionality is outdated (using OpenVR) and will be deleted in a future version. (#2175) User provided libraries supporting OpenXR should be used instead --- jme3-vr/src/main/java/com/jme3/app/VRAppState.java | 11 +++++++++++ jme3-vr/src/main/java/com/jme3/app/VRConstants.java | 5 +++++ jme3-vr/src/main/java/com/jme3/app/VREnvironment.java | 5 +++++ .../java/com/jme3/input/vr/AnalogActionState.java | 7 +++++++ .../java/com/jme3/input/vr/DigitalActionState.java | 7 +++++++ .../jme3/input/vr/lwjgl_openvr/LWJGLOpenVRInput.java | 5 +++++ jme3-vr/src/main/java/com/jme3/post/CartoonSSAO.java | 5 +++++ jme3-vr/src/main/java/com/jme3/post/FilterUtil.java | 5 +++++ .../src/main/java/com/jme3/post/PreNormalCaching.java | 5 +++++ .../java/com/jme3/shadow/AbstractShadowFilterVR.java | 5 +++++ .../com/jme3/shadow/AbstractShadowRendererVR.java | 5 +++++ .../jme3/shadow/DirectionalLightShadowFilterVR.java | 5 +++++ .../jme3/shadow/DirectionalLightShadowRendererVR.java | 5 +++++ .../jme3/shadow/InstancedDirectionalShadowFilter.java | 5 +++++ .../jme3/shadow/VRDirectionalLightShadowRenderer.java | 5 +++++ .../main/java/com/jme3/util/VRGUIPositioningMode.java | 5 +++++ jme3-vr/src/main/java/com/jme3/util/VRGuiManager.java | 5 +++++ jme3-vr/src/main/java/com/jme3/util/VRUtil.java | 5 +++++ 18 files changed, 100 insertions(+) diff --git a/jme3-vr/src/main/java/com/jme3/app/VRAppState.java b/jme3-vr/src/main/java/com/jme3/app/VRAppState.java index fa0956b2b2..f8fe39347f 100644 --- a/jme3-vr/src/main/java/com/jme3/app/VRAppState.java +++ b/jme3-vr/src/main/java/com/jme3/app/VRAppState.java @@ -72,7 +72,13 @@ * * Attaching an instance of this app state to an already started application may cause crashes. * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr + * + * @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 VRAppState extends AbstractAppState { public static final String ID = "VRAppState"; private static final Logger logger = Logger.getLogger(VRAppState.class.getName()); @@ -117,7 +123,12 @@ public VRAppState(VREnvironment environment) { * Create a new VR app state with given settings. The app state relies on the given {@link VREnvironment VR environment}. * @param settings the settings to use. * @param environment the {@link VREnvironment VR environment} that this app state is using. + * @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 VRAppState(AppSettings settings, VREnvironment environment){ this(environment); this.settings = settings; diff --git a/jme3-vr/src/main/java/com/jme3/app/VRConstants.java b/jme3-vr/src/main/java/com/jme3/app/VRConstants.java index d6ed724766..68dc7201b3 100644 --- a/jme3-vr/src/main/java/com/jme3/app/VRConstants.java +++ b/jme3-vr/src/main/java/com/jme3/app/VRConstants.java @@ -7,7 +7,12 @@ * 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. diff --git a/jme3-vr/src/main/java/com/jme3/app/VREnvironment.java b/jme3-vr/src/main/java/com/jme3/app/VREnvironment.java index 6dd41d6cde..85b7a527a0 100644 --- a/jme3-vr/src/main/java/com/jme3/app/VREnvironment.java +++ b/jme3-vr/src/main/java/com/jme3/app/VREnvironment.java @@ -31,7 +31,12 @@ * * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr * + * @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 VREnvironment { private static final Logger logger = Logger.getLogger(VREnvironment.class.getName()); diff --git a/jme3-vr/src/main/java/com/jme3/input/vr/AnalogActionState.java b/jme3-vr/src/main/java/com/jme3/input/vr/AnalogActionState.java index 8cf519ff0b..58b377d6a7 100644 --- a/jme3-vr/src/main/java/com/jme3/input/vr/AnalogActionState.java +++ b/jme3-vr/src/main/java/com/jme3/input/vr/AnalogActionState.java @@ -1,5 +1,12 @@ package com.jme3.input.vr; +/** + * @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 AnalogActionState{ /** diff --git a/jme3-vr/src/main/java/com/jme3/input/vr/DigitalActionState.java b/jme3-vr/src/main/java/com/jme3/input/vr/DigitalActionState.java index 1da865eecf..ffe4baebf3 100644 --- a/jme3-vr/src/main/java/com/jme3/input/vr/DigitalActionState.java +++ b/jme3-vr/src/main/java/com/jme3/input/vr/DigitalActionState.java @@ -1,5 +1,12 @@ package com.jme3.input.vr; +/** + * @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 DigitalActionState{ /** diff --git a/jme3-vr/src/main/java/com/jme3/input/vr/lwjgl_openvr/LWJGLOpenVRInput.java b/jme3-vr/src/main/java/com/jme3/input/vr/lwjgl_openvr/LWJGLOpenVRInput.java index 04d5e9dd38..26ad2d4b74 100644 --- a/jme3-vr/src/main/java/com/jme3/input/vr/lwjgl_openvr/LWJGLOpenVRInput.java +++ b/jme3-vr/src/main/java/com/jme3/input/vr/lwjgl_openvr/LWJGLOpenVRInput.java @@ -73,7 +73,12 @@ make helper functions to pull the following easily from raw data (DONE) * @author reden - phr00t * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr * @author Rickard Edén + * @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 LWJGLOpenVRInput implements VRInputAPI { private static final Logger logger = Logger.getLogger(LWJGLOpenVRInput.class.getName()); diff --git a/jme3-vr/src/main/java/com/jme3/post/CartoonSSAO.java b/jme3-vr/src/main/java/com/jme3/post/CartoonSSAO.java index 82c45001dd..eb1ddd5404 100644 --- a/jme3-vr/src/main/java/com/jme3/post/CartoonSSAO.java +++ b/jme3-vr/src/main/java/com/jme3/post/CartoonSSAO.java @@ -15,7 +15,12 @@ * @author reden - phr00t - https://github.com/phr00t * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr * + * @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 CartoonSSAO extends Filter{ private Pass normalPass; private Vector3f frustumCorner; diff --git a/jme3-vr/src/main/java/com/jme3/post/FilterUtil.java b/jme3-vr/src/main/java/com/jme3/post/FilterUtil.java index d8d2778742..f2d1d437ae 100644 --- a/jme3-vr/src/main/java/com/jme3/post/FilterUtil.java +++ b/jme3-vr/src/main/java/com/jme3/post/FilterUtil.java @@ -8,7 +8,12 @@ /** * * @author Rickard + * @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 FilterUtil { /** * A private constructor to inhibit instantiation of this class. diff --git a/jme3-vr/src/main/java/com/jme3/post/PreNormalCaching.java b/jme3-vr/src/main/java/com/jme3/post/PreNormalCaching.java index b2250e8d76..082e0edc07 100644 --- a/jme3-vr/src/main/java/com/jme3/post/PreNormalCaching.java +++ b/jme3-vr/src/main/java/com/jme3/post/PreNormalCaching.java @@ -11,7 +11,12 @@ * Pre normal caching class. * @author reden - phr00t - https://github.com/phr00t * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr + * @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 PreNormalCaching { private static FrameBuffer cachedPreNormals; diff --git a/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowFilterVR.java b/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowFilterVR.java index 3144a417e0..f49f4c7d66 100644 --- a/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowFilterVR.java +++ b/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowFilterVR.java @@ -55,7 +55,12 @@ * @author reden - phr00t - https://github.com/phr00t * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr * @param the type of the underlying renderer (subclass of {@link AbstractShadowRendererVR}). + * @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 abstract class AbstractShadowFilterVR extends Filter { protected T shadowRenderer; diff --git a/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowRendererVR.java b/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowRendererVR.java index 7338864dd8..ac2df723c4 100644 --- a/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowRendererVR.java +++ b/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowRendererVR.java @@ -75,7 +75,12 @@ * @author Rémy Bouquet aka Nehon * @author reden - phr00t - https://github.com/phr00t * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr + * @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 abstract class AbstractShadowRendererVR implements SceneProcessor, Savable { private static final LightFilter NULL_LIGHT_FILTER = new NullLightFilter(); protected int nbShadowMaps = 1; diff --git a/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowFilterVR.java b/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowFilterVR.java index 7d9adc02f6..77f3b71844 100644 --- a/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowFilterVR.java +++ b/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowFilterVR.java @@ -56,7 +56,12 @@ * @author Rémy Bouquet aka Nehon * @author reden - phr00t - https://github.com/phr00t * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr + * @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 DirectionalLightShadowFilterVR extends AbstractShadowFilterVR { /** diff --git a/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowRendererVR.java b/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowRendererVR.java index d0676eebb8..426cce6364 100644 --- a/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowRendererVR.java +++ b/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowRendererVR.java @@ -62,7 +62,12 @@ * @author Rémy Bouquet aka Nehon * @author reden - phr00t - https://github.com/phr00t * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr + * @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 DirectionalLightShadowRendererVR extends AbstractShadowRendererVR { protected float lambda = 0.65f; diff --git a/jme3-vr/src/main/java/com/jme3/shadow/InstancedDirectionalShadowFilter.java b/jme3-vr/src/main/java/com/jme3/shadow/InstancedDirectionalShadowFilter.java index a848409f70..cdcd25594e 100644 --- a/jme3-vr/src/main/java/com/jme3/shadow/InstancedDirectionalShadowFilter.java +++ b/jme3-vr/src/main/java/com/jme3/shadow/InstancedDirectionalShadowFilter.java @@ -9,7 +9,12 @@ * An instanced version of the {@link DirectionalLightShadowFilterVR directional light shadow filter}. * @author reden - phr00t - https://github.com/phr00t * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr + * @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 InstancedDirectionalShadowFilter extends DirectionalLightShadowFilterVR { private final Vector4f temp4f = new Vector4f(), temp4f2 = new Vector4f(); diff --git a/jme3-vr/src/main/java/com/jme3/shadow/VRDirectionalLightShadowRenderer.java b/jme3-vr/src/main/java/com/jme3/shadow/VRDirectionalLightShadowRenderer.java index 39ecdaed96..d4977ea098 100644 --- a/jme3-vr/src/main/java/com/jme3/shadow/VRDirectionalLightShadowRenderer.java +++ b/jme3-vr/src/main/java/com/jme3/shadow/VRDirectionalLightShadowRenderer.java @@ -44,7 +44,12 @@ * href="http://http.developer.nvidia.com/GPUGems3/gpugems3_ch10.html">http://http.developer.nvidia.com/GPUGems3/gpugems3_ch10.html
* * @author Rémy Bouquet aka Nehon + * @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 VRDirectionalLightShadowRenderer extends DirectionalLightShadowRenderer { /** diff --git a/jme3-vr/src/main/java/com/jme3/util/VRGUIPositioningMode.java b/jme3-vr/src/main/java/com/jme3/util/VRGUIPositioningMode.java index d3e32ea972..7d6f38960e 100644 --- a/jme3-vr/src/main/java/com/jme3/util/VRGUIPositioningMode.java +++ b/jme3-vr/src/main/java/com/jme3/util/VRGUIPositioningMode.java @@ -4,7 +4,12 @@ * An enumeration that describes the GUI display positioning modes. * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr * + * @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 enum VRGUIPositioningMode { MANUAL, AUTO_CAM_ALL, diff --git a/jme3-vr/src/main/java/com/jme3/util/VRGuiManager.java b/jme3-vr/src/main/java/com/jme3/util/VRGuiManager.java index 6bbd603ff6..61033e7ab6 100644 --- a/jme3-vr/src/main/java/com/jme3/util/VRGuiManager.java +++ b/jme3-vr/src/main/java/com/jme3/util/VRGuiManager.java @@ -28,7 +28,12 @@ * @author reden - phr00t - https://github.com/phr00t * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr * + * @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 VRGuiManager { private Camera camLeft, camRight; private float guiDistance = 1.5f; diff --git a/jme3-vr/src/main/java/com/jme3/util/VRUtil.java b/jme3-vr/src/main/java/com/jme3/util/VRUtil.java index 19a4c5c9be..ffff964527 100644 --- a/jme3-vr/src/main/java/com/jme3/util/VRUtil.java +++ b/jme3-vr/src/main/java/com/jme3/util/VRUtil.java @@ -11,7 +11,12 @@ * * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr * + * @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 VRUtil { private static final long SLEEP_PRECISION = TimeUnit.MILLISECONDS.toNanos(4);