XREnvironmentProbeSubsystemDescriptor.cs
15.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
using System;
#if UNITY_2020_2_OR_NEWER
using UnityEngine.SubsystemsImplementation;
#endif
namespace UnityEngine.XR.ARSubsystems
{
/// <summary>
/// Encapsulates the parameters for creating a new <see cref="XREnvironmentProbeSubsystemDescriptor"/>.
/// </summary>
public struct XREnvironmentProbeSubsystemCinfo : IEquatable<XREnvironmentProbeSubsystemCinfo>
{
/// <summary>
/// Specifies an identifier for the provider implementation of the subsystem.
/// </summary>
/// <value>
/// The identifier for the provider implementation of the subsystem.
/// </value>
public string id { get; set; }
#if UNITY_2020_2_OR_NEWER
/// <summary>
/// Specifies the provider implementation type to use for instantiation.
/// </summary>
/// <value>
/// The provider implementation type to use for instantiation.
/// </value>
public Type providerType { get; set; }
/// <summary>
/// Specifies the <c>XREnvironmentProbeSubsystem</c>-derived type that forwards casted calls to its provider.
/// </summary>
/// <value>
/// The type of the subsystem to use for instantiation. If null, <c>XREnvironmentProbeSubsystem</c> will be instantiated.
/// </value>
public Type subsystemTypeOverride { get; set; }
#endif
/// <summary>
/// Specifies the provider implementation type to use for instantiation.
/// </summary>
/// <value>
/// Specifies the provider implementation type to use for instantiation.
/// </value>
#if UNITY_2020_2_OR_NEWER
[Obsolete("XREnvironmentProbeSubsystem no longer supports the deprecated set of base classes for subsystems as of Unity 2020.2. Use providerType and, optionally, subsystemTypeOverride instead.", true)]
#endif
public Type implementationType { get; set; }
/// <summary>
/// Whether the implementation supports manual placement of environment probes.
/// </summary>
/// <value>
/// <c>true</c> if manual placement of environment probes is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsManualPlacement { get; set; }
/// <summary>
/// Whether the implementation supports removal of manually-placed environment probes.
/// </summary>
/// <value>
/// <c>true</c> if removal of manually-placed environment probes is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsRemovalOfManual { get; set; }
/// <summary>
/// Whether the implementation supports automatic placement of environment probes.
/// </summary>
/// <value>
/// <c>true</c> if automatic placement of environment probes is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsAutomaticPlacement { get; set; }
/// <summary>
/// Whether the implementation supports removal of automatically-placed environment probes.
/// </summary>
/// <value>
/// <c>true</c> if removal of automatically-placed environment probes is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsRemovalOfAutomatic { get; set; }
/// <summary>
/// Whether the implementation supports generation of environment textures.
/// </summary>
/// <value>
/// <c>true</c> if the generation of environment textures is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsEnvironmentTexture { get; set; }
/// <summary>
/// Whether the implementation supports generation of HDR environment textures.
/// </summary>
/// <value>
/// <c>true</c> if the generation of HDR environment textures is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsEnvironmentTextureHDR { get; set; }
/// <summary>
/// Tests for equality.
/// </summary>
/// <param name="other">The other <see cref="XREnvironmentProbeSubsystemCinfo"/> to compare against.</param>
/// <returns>`True` if every field in <paramref name="other"/> is equal to this <see cref="XREnvironmentProbeSubsystemCinfo"/>, otherwise false.</returns>
public bool Equals(XREnvironmentProbeSubsystemCinfo other)
{
return
ReferenceEquals(id, other.id)
#if UNITY_2020_2_OR_NEWER
&& ReferenceEquals(providerType, other.providerType)
&& ReferenceEquals(subsystemTypeOverride, other.subsystemTypeOverride)
#else
&& ReferenceEquals(implementationType, other.implementationType)
#endif
&& supportsManualPlacement.Equals(other.supportsManualPlacement)
&& supportsRemovalOfManual.Equals(other.supportsRemovalOfManual)
&& supportsAutomaticPlacement.Equals(other.supportsAutomaticPlacement)
&& supportsRemovalOfAutomatic.Equals(other.supportsRemovalOfAutomatic)
&& supportsEnvironmentTexture.Equals(other.supportsEnvironmentTexture)
&& supportsEnvironmentTextureHDR.Equals(other.supportsEnvironmentTextureHDR);
}
/// <summary>
/// Tests for equality.
/// </summary>
/// <param name="obj">The `object` to compare against.</param>
/// <returns>`True` if <paramref name="obj"/> is of type <see cref="XREnvironmentProbeSubsystemCinfo"/> and
/// <see cref="Equals(XREnvironmentProbeSubsystemCinfo)"/> also returns `true`; otherwise `false`.</returns>
public override bool Equals(System.Object obj)
{
return ((obj is XREnvironmentProbeSubsystemCinfo) && Equals((XREnvironmentProbeSubsystemCinfo)obj));
}
/// <summary>
/// Tests for equality. Same as <see cref="Equals(XREnvironmentProbeSubsystemCinfo)"/>.
/// </summary>
/// <param name="lhs">The left-hand side of the comparison.</param>
/// <param name="rhs">The right-hand side of the comparison.</param>
/// <returns>`True` if <paramref name="lhs"/> is equal to <paramref name="rhs"/>, otherwise `false`.</returns>
public static bool operator ==(XREnvironmentProbeSubsystemCinfo lhs, XREnvironmentProbeSubsystemCinfo rhs)
{
return lhs.Equals(rhs);
}
/// <summary>
/// Tests for inequality. Same as `!`<see cref="Equals(XREnvironmentProbeSubsystemCinfo)"/>.
/// </summary>
/// <param name="lhs">The left-hand side of the comparison.</param>
/// <param name="rhs">The right-hand side of the comparison.</param>
/// <returns>`True` if <paramref name="lhs"/> is not equal to <paramref name="rhs"/>, otherwise `false`.</returns>
public static bool operator !=(XREnvironmentProbeSubsystemCinfo lhs, XREnvironmentProbeSubsystemCinfo rhs)
{
return !(lhs == rhs);
}
/// <summary>
/// Generates a hash suitable for use with containers like `HashSet` and `Dictionary`.
/// </summary>
/// <returns>A hash code generated from this object's fields.</returns>
public override int GetHashCode()
{
int hashCode = 486187739;
unchecked
{
hashCode = (hashCode * 486187739) + HashCode.ReferenceHash(id);
#if UNITY_2020_2_OR_NEWER
hashCode = (hashCode * 486187739) + HashCode.ReferenceHash(providerType);
hashCode = (hashCode * 486187739) + HashCode.ReferenceHash(subsystemTypeOverride);
#else
hashCode = (hashCode * 486187739) + HashCode.ReferenceHash(implementationType);
#endif
hashCode = (hashCode * 486187739) + supportsManualPlacement.GetHashCode();
hashCode = (hashCode * 486187739) + supportsRemovalOfManual.GetHashCode();
hashCode = (hashCode * 486187739) + supportsAutomaticPlacement.GetHashCode();
hashCode = (hashCode * 486187739) + supportsRemovalOfAutomatic.GetHashCode();
hashCode = (hashCode * 486187739) + supportsEnvironmentTexture.GetHashCode();
hashCode = (hashCode * 486187739) + supportsEnvironmentTextureHDR.GetHashCode();
}
return hashCode;
}
}
/// <summary>
/// Specifies a functionality description that may be registered for each implementation that provides the
/// <see cref="XREnvironmentProbeSubsystem"/> interface.
/// </summary>
public class XREnvironmentProbeSubsystemDescriptor :
#if UNITY_2020_2_OR_NEWER
SubsystemDescriptorWithProvider<XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystem.Provider>
#else
SubsystemDescriptor<XREnvironmentProbeSubsystem>
#endif
{
/// <summary>
/// Constructs a <c>XREnvironmentProbeSubsystemDescriptor</c> based on the given parameters.
/// </summary>
/// <param name='environmentProbeSubsystemCinfo'>The parameters required to initialize the descriptor.</param>
XREnvironmentProbeSubsystemDescriptor(XREnvironmentProbeSubsystemCinfo environmentProbeSubsystemCinfo)
{
id = environmentProbeSubsystemCinfo.id;
#if UNITY_2020_2_OR_NEWER
providerType = environmentProbeSubsystemCinfo.providerType;
subsystemTypeOverride = environmentProbeSubsystemCinfo.subsystemTypeOverride;
#else
subsystemImplementationType = environmentProbeSubsystemCinfo.implementationType;
#endif
supportsManualPlacement = environmentProbeSubsystemCinfo.supportsManualPlacement;
supportsRemovalOfManual = environmentProbeSubsystemCinfo.supportsRemovalOfManual;
supportsAutomaticPlacement = environmentProbeSubsystemCinfo.supportsAutomaticPlacement;
supportsRemovalOfAutomatic = environmentProbeSubsystemCinfo.supportsRemovalOfAutomatic;
supportsEnvironmentTexture = environmentProbeSubsystemCinfo.supportsEnvironmentTexture;
supportsEnvironmentTextureHDR = environmentProbeSubsystemCinfo.supportsEnvironmentTextureHDR;
}
/// <summary>
/// Whether the implementation supports manual placement of environment probes.
/// </summary>
/// <value>
/// <c>true</c> if manual placement of environment probes is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsManualPlacement { get; private set; }
/// <summary>
/// Whether the implementation supports removal of manually-placed environment probes.
/// </summary>
/// <value>
/// <c>true</c> if removal of manually-placed environment probes is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsRemovalOfManual { get; private set; }
/// <summary>
/// Whether the implementation supports automatic placement of environment probes.
/// </summary>
/// <value>
/// <c>true</c> if automatic placement of environment probes is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsAutomaticPlacement { get; private set; }
/// <summary>
/// Whether the implementation supports removal of automatically-placed environment probes.
/// </summary>
/// <value>
/// <c>true</c> if removal of automatically-placed environment probes is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsRemovalOfAutomatic { get; private set; }
/// <summary>
/// Whether the implementation supports generation of environment textures.
/// </summary>
/// <value>
/// <c>true</c> if the generation of environment textures is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsEnvironmentTexture { get; private set; }
/// <summary>
/// Whether the implementation supports generation of HDR environment textures.
/// </summary>
/// <value>
/// <c>true</c> if the generation of HDR environment textures is supported. Otherwise, <c>false</c>.
/// </value>
public bool supportsEnvironmentTextureHDR { get; private set; }
/// <summary>
/// Creates a <c>XREnvironmentProbeSubsystemDescriptor</c> based on the given parameters validating that the
/// <c>id</c> and <c>implentationType</c> properties are specified.
/// </summary>
/// <param name='environmentProbeSubsystemCinfo'>The parameters required to initialize the descriptor.</param>
/// <returns>
/// The created <c>XREnvironmentProbeSubsystemDescriptor</c>.
/// </returns>
/// <exception cref="ArgumentException">Thrown when the values specified in the
/// <paramref name="environmentProbeSubsystemCinfo"/> parameter are invalid. Typically, this will occur
/// <list type="bullet">
/// <item>
/// <description>if <see cref="XREnvironmentProbeSubsystemCinfo.id"/> is <c>null</c> or empty</description>
/// </item>
/// <item>
/// <description>if <see cref="XREnvironmentProbeSubsystemCinfo.implementationType"/> is <c>null</c>
/// </description>
/// </item>
/// <item>
/// <description>if <see cref="XREnvironmentProbeSubsystemCinfo.implementationType"/> does not derive from the
/// <c>XREnvironmentProbeSubsystem</c> class
/// </description>
/// </item>
/// </list>
/// </exception>
internal static XREnvironmentProbeSubsystemDescriptor Create(XREnvironmentProbeSubsystemCinfo environmentProbeSubsystemCinfo)
{
if (String.IsNullOrEmpty(environmentProbeSubsystemCinfo.id))
{
throw new ArgumentException("Cannot create environment probe subsystem descriptor because id is invalid",
"environmentProbeSubsystemCinfo");
}
#if UNITY_2020_2_OR_NEWER
if (environmentProbeSubsystemCinfo.providerType == null
|| !environmentProbeSubsystemCinfo.providerType.IsSubclassOf(typeof(XREnvironmentProbeSubsystem.Provider)))
{
throw new ArgumentException("Cannot create environment probe subsystem descriptor because providerType is invalid",
"environmentProbeSubsystemCinfo");
}
if (environmentProbeSubsystemCinfo.subsystemTypeOverride != null
&& !environmentProbeSubsystemCinfo.subsystemTypeOverride.IsSubclassOf(typeof(XREnvironmentProbeSubsystem)))
{
throw new ArgumentException("Cannot create environment probe subsystem descriptor because subsystemTypeOverride is invalid",
"environmentProbeSubsystemCinfo");
}
#else
if ((environmentProbeSubsystemCinfo.implementationType == null)
|| !environmentProbeSubsystemCinfo.implementationType.IsSubclassOf(typeof(XREnvironmentProbeSubsystem)))
{
throw new ArgumentException("Cannot create environment probe subsystem descriptor because implementationType is invalid",
"environmentProbeSubsystemCinfo");
}
#endif
return new XREnvironmentProbeSubsystemDescriptor(environmentProbeSubsystemCinfo);
}
}
}