-
Notifications
You must be signed in to change notification settings - Fork 322
CHANGE: Refactor class conditional guards #2183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved the internal PR, approving this based on my review there. See link in description for discussion.
should add @ekcoh |
Description
Moves around some conditional guards so that we don't unnecessarily wrap entire classes. This stops downstream packages from having to also wrap Input System objects with similar conditionals.
Only device class definitions that get replaced by specific packages should be entirely wrapped.
This PR is a copy of the internal PR created here: https://github.cds.internal.unity3d.com/unity/com.unity.inputsystem/pull/5
Changes made
Removes
#if UNITY_INPUT_SYSTEM_ENABLE_XR && (ENABLE_VR || UNITY_GAMECORE) && !PACKAGE_DOCS_GENERATION
guards from wrapping entire class files under InputSystem/Plugins/XR/Devices and InputSystem/Plugins/XR/Haptics.
This makes it so any packages that want to use these Input System package objects don't have to also wrap the use of those objects with
#if ENABLE_VR
guards. Classes that should ignore Package Generation have been added to the filter.yml file.We now only wrap the use of device descriptors with
#if UNITY_INPUT_SYSTEM_ENABLE_XR
to prevent use when the XR Module package is not installed.Testing status & QA
Engines Supported: 6.2, 6.1, 6.0, 2022.3, 2021.3
Test 1:
Create project (or use an existing one)
Install Input System package
Install OpenXR package (this package uses the Input System but currently does not wrap any objects).
Switch platform from Standalone or Android into tvOS or QNX (ENABLE_VR conditional wont be defined on these platforms)
Expected result: No compiler errors
Test 2:
Create project (or use an existing one)
Install Input System package.
Install the com.unity.xr.oculus, com.unity.xr.openvr, and com.unity.xr.windowsmr packages (these packages override certain device class definitions).
Expected result: No compiler errors
Test 3:
Create project (or use an existing one)
Install Input System package.
Implement something that tries to leverage an XRHMD or XRController object
Switch platform to tvOS or QNX (ENABLE_VR conditional wont be defined on these platforms)
Execute code in Editor or in a build for the new platform.
Expected result: No runtime errors
Overall Product Risks
Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches if any.
Comments to reviewers
Please describe any additional information such as what to focus on, or historical info for the reviewers.
Checklist
Before review:
Changed
,Fixed
,Added
sections.Area_CanDoX
,Area_CanDoX_EvenIfYIsTheCase
,Area_WhenIDoX_AndYHappens_ThisIsTheResult
.During merge:
NEW: ___
.FIX: ___
.DOCS: ___
.CHANGE: ___
.RELEASE: 1.1.0-preview.3
.After merge: