XRRaycastHit.cs
5.45 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
using System;
using System.Runtime.InteropServices;
namespace UnityEngine.XR.ARSubsystems
{
/// <summary>
/// Represents the intersection of a raycast with a trackable.
/// </summary>
/// <seealso cref="XRRaycastSubsystem.Raycast(Ray, TrackableType, Unity.Collections.Allocator)"/>
/// <seealso cref="XRRaycastSubsystem.Raycast(Vector2, TrackableType, Unity.Collections.Allocator)"/>
[StructLayout(LayoutKind.Sequential)]
public struct XRRaycastHit : IEquatable<XRRaycastHit>
{
static readonly XRRaycastHit s_Default = new XRRaycastHit(
TrackableId.invalidId, Pose.identity, 0, TrackableType.None);
/// <summary>
/// A default-initialized raycast hit.
/// This may be different from a zero-initialized raycast hit.
/// </summary>
public static XRRaycastHit defaultValue => s_Default;
/// <summary>
/// The <see cref="TrackableId"/> of the trackable which was hit. This may be <see cref="TrackableId.invalidId"/>
/// as not all trackables have ids, e.g., feature points.
/// </summary>
public TrackableId trackableId
{
get => m_TrackableId;
set => m_TrackableId = value;
}
/// <summary>
/// The session-space <c>Pose</c> of the intersection.
/// </summary>
public Pose pose
{
get => m_Pose;
set => m_Pose = value;
}
/// <summary>
/// The session-space distance from the raycast origin to the intersection point.
/// </summary>
public float distance
{
get => m_Distance;
set => m_Distance = value;
}
/// <summary>
/// The type(s) of trackables which were hit by the ray.
/// </summary>
public TrackableType hitType
{
get => m_HitType;
set => m_HitType = value;
}
/// <summary>
/// Constructs an <see cref="XRRaycastHit"/>.
/// </summary>
/// <param name="trackableId">The <see cref="TrackableId"/> of the trackable which was hit.</param>
/// <param name="pose">The session-space <c>Pose</c> of the intersection.</param>
/// <param name="distance">The session-space distance from the raycast origin to the intersection point.</param>
/// <param name="hitType">The type(s) of trackables which were hit by the ray.</param>
public XRRaycastHit(
TrackableId trackableId,
Pose pose,
float distance,
TrackableType hitType)
{
m_TrackableId = trackableId;
m_Pose = pose;
m_Distance = distance;
m_HitType = hitType;
}
/// <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()
{
unchecked
{
var hash = m_TrackableId.GetHashCode();
hash = hash * 486187739 + m_Pose.GetHashCode();
hash = hash * 486187739 + m_Distance.GetHashCode();
hash = hash * 486187739 + ((int)m_HitType).GetHashCode();
return hash;
}
}
/// <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="XRRaycastHit"/> and
/// <see cref="Equals(XRRaycastHit)"/> also returns `true`; otherwise `false`.</returns>
public override bool Equals(object obj) => (obj is XRRaycastHit other) && Equals(other);
/// <summary>
/// Tests for equality.
/// </summary>
/// <param name="other">The other <see cref="XRRaycastHit"/> to compare against.</param>
/// <returns>`True` if every field in <paramref name="other"/> is equal to this <see cref="XRRaycastHit"/>, otherwise false.</returns>
public bool Equals(XRRaycastHit other)
{
return
(m_TrackableId.Equals(other.m_TrackableId)) &&
(m_Pose.Equals(other.m_Pose)) &&
(m_Distance.Equals(other.m_Distance)) &&
(m_HitType == other.m_HitType);
}
/// <summary>
/// Tests for equality. Same as <see cref="Equals(XRRaycastHit)"/>.
/// </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 ==(XRRaycastHit lhs, XRRaycastHit rhs) => lhs.Equals(rhs);
/// <summary>
/// Tests for inequality. Same as `!`<see cref="Equals(XRRaycastHit)"/>.
/// </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 !=(XRRaycastHit lhs, XRRaycastHit rhs) => !lhs.Equals(rhs);
TrackableId m_TrackableId;
Pose m_Pose;
float m_Distance;
TrackableType m_HitType;
}
}