// Copyright (c) Wojciech Figat. All rights reserved. #if USE_LARGE_WORLDS using Real = System.Double; using Mathr = FlaxEngine.Mathd; #else using Real = System.Single; using Mathr = FlaxEngine.Mathf; #endif // ----------------------------------------------------------------------------- // Original code from SharpDX project. https://github.com/sharpdx/SharpDX/ // Greetings to Alexandre Mutel. Original code published with the following license: // ----------------------------------------------------------------------------- // Copyright (c) 2010-2014 SharpDX - Alexandre Mutel // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. // ----------------------------------------------------------------------------- // Original code from SlimMath project. http://code.google.com/p/slimmath/ // Greetings to SlimDX Group. Original code published with the following license: // ----------------------------------------------------------------------------- /* * Copyright (c) 2007-2011 SlimDX Group * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ using System; using System.Globalization; using System.Runtime.CompilerServices; namespace FlaxEngine { [Serializable] partial struct Plane : IEquatable, IFormattable { /// /// Initializes a new instance of the class. /// /// Any point that lies along the plane. /// The normal vector to the plane. public Plane(Vector3 point, Vector3 normal) { Normal = normal; D = -Vector3.Dot(normal, point); } /// /// Initializes a new instance of the struct. /// /// The normal of the plane. /// The distance of the plane along its normal from the origin public Plane(Vector3 value, Real d) { Normal = value; D = d; } /// /// Initializes a new instance of the struct. /// /// First point of a triangle defining the plane. /// Second point of a triangle defining the plane. /// Third point of a triangle defining the plane. public Plane(Vector3 point1, Vector3 point2, Vector3 point3) { Real x1 = point2.X - point1.X; Real y1 = point2.Y - point1.Y; Real z1 = point2.Z - point1.Z; Real x2 = point3.X - point1.X; Real y2 = point3.Y - point1.Y; Real z2 = point3.Z - point1.Z; Real yz = y1 * z2 - z1 * y2; Real xz = z1 * x2 - x1 * z2; Real xy = x1 * y2 - y1 * x2; Real invPyth = 1.0f / (Real)Math.Sqrt(yz * yz + xz * xz + xy * xy); Normal.X = yz * invPyth; Normal.Y = xz * invPyth; Normal.Z = xy * invPyth; D = -(Normal.X * point1.X + Normal.Y * point1.Y + Normal.Z * point1.Z); } /// /// Initializes a new instance of the struct. /// /// The values to assign to the A, B, C, and D components of the plane. This must be an array with four elements. /// Thrown when is null. /// Thrown when contains more or less than four elements. public Plane(Real[] values) { if (values == null) throw new ArgumentNullException(nameof(values)); if (values.Length != 4) throw new ArgumentOutOfRangeException(nameof(values), "There must be four and only four input values for Plane."); Normal.X = values[0]; Normal.Y = values[1]; Normal.Z = values[2]; D = values[3]; } /// /// Gets or sets the component at the specified index. /// /// The value of the A, B, C, or D component, depending on the index. /// The index of the component to access. Use 0 for the A component, 1 for the B component, 2 for the C component, and 3 for the D component. /// The value of the component at the specified index. /// Thrown when the is out of the range [0,3]. public Real this[int index] { get { switch (index) { case 0: return Normal.X; case 1: return Normal.Y; case 2: return Normal.Z; case 3: return D; } throw new ArgumentOutOfRangeException(nameof(index), "Indices for Plane run from 0 to 3, inclusive."); } set { switch (index) { case 0: Normal.X = value; break; case 1: Normal.Y = value; break; case 2: Normal.Z = value; break; case 3: D = value; break; default: throw new ArgumentOutOfRangeException(nameof(index), "Indices for Plane run from 0 to 3, inclusive."); } } } /// /// Changes the coefficients of the normal vector of the plane to make it of unit length. /// public void Normalize() { Real length = Normal.Length; if (length >= Mathr.Epsilon) { Real rcp = 1.0f / length; Normal.X *= rcp; Normal.Y *= rcp; Normal.Z *= rcp; D *= rcp; } } /// /// Creates an array containing the elements of the plane. /// /// A four-element array containing the components of the plane. public Real[] ToArray() { return new[] { Normal.X, Normal.Y, Normal.Z, D }; } /// /// Determines if there is an intersection between the current object and a point. /// /// The point to test. /// Whether the two objects intersected. public PlaneIntersectionType Intersects(ref Vector3 point) { return CollisionsHelper.PlaneIntersectsPoint(ref this, ref point); } /// /// Determines if there is an intersection between the current object and a . /// /// The ray to test. /// Whether the two objects intersected. public bool Intersects(ref Ray ray) { return CollisionsHelper.RayIntersectsPlane(ref ray, ref this, out Real _); } /// /// Determines if there is an intersection between the current object and a . /// /// The ray to test. /// When the method completes, contains the distance of the intersection, or 0 if there was no intersection. /// Whether the two objects intersected. public bool Intersects(ref Ray ray, out Real distance) { return CollisionsHelper.RayIntersectsPlane(ref ray, ref this, out distance); } /// /// Determines if there is an intersection between the current object and a . /// /// The ray to test. /// When the method completes, contains the point of intersection, or if there was no intersection. /// Whether the two objects intersected. public bool Intersects(ref Ray ray, out Vector3 point) { return CollisionsHelper.RayIntersectsPlane(ref ray, ref this, out point); } /// /// Determines if there is an intersection between the current object and a . /// /// The plane to test. /// Whether the two objects intersected. public bool Intersects(ref Plane plane) { return CollisionsHelper.PlaneIntersectsPlane(ref this, ref plane); } /// /// Determines if there is an intersection between the current object and a . /// /// The plane to test. /// When the method completes, contains the line of intersection as a , or a zero ray if there was no intersection. /// Whether the two objects intersected. public bool Intersects(ref Plane plane, out Ray line) { return CollisionsHelper.PlaneIntersectsPlane(ref this, ref plane, out line); } /// /// Determines if there is an intersection between the current object and a triangle. /// /// The first vertex of the triangle to test. /// The second vertex of the triangle to test. /// The third vertex of the triangle to test. /// Whether the two objects intersected. public PlaneIntersectionType Intersects(ref Vector3 vertex1, ref Vector3 vertex2, ref Vector3 vertex3) { return CollisionsHelper.PlaneIntersectsTriangle(ref this, ref vertex1, ref vertex2, ref vertex3); } /// /// Determines if there is an intersection between the current object and a . /// /// The box to test. /// Whether the two objects intersected. public PlaneIntersectionType Intersects(ref BoundingBox box) { return CollisionsHelper.PlaneIntersectsBox(ref this, ref box); } /// /// Determines if there is an intersection between the current object and a . /// /// The sphere to test. /// Whether the two objects intersected. public PlaneIntersectionType Intersects(ref BoundingSphere sphere) { return CollisionsHelper.PlaneIntersectsSphere(ref this, ref sphere); } /// /// Scales the plane by the given scaling factor. /// /// The plane to scale. /// The amount by which to scale the plane. /// When the method completes, contains the scaled plane. public static void Multiply(ref Plane value, Real scale, out Plane result) { result.Normal.X = value.Normal.X * scale; result.Normal.Y = value.Normal.Y * scale; result.Normal.Z = value.Normal.Z * scale; result.D = value.D * scale; } /// /// Scales the plane by the given scaling factor. /// /// The plane to scale. /// The amount by which to scale the plane. /// The scaled plane. public static Plane Multiply(Plane value, Real scale) { return new Plane(value.Normal * scale, value.D * scale); } /// /// Calculates the dot product of the specified vector and plane. /// /// The source plane. /// The source vector. /// When the method completes, contains the dot product of the specified plane and vector. public static void Dot(ref Plane left, ref Vector4 right, out Real result) { result = left.Normal.X * right.X + left.Normal.Y * right.Y + left.Normal.Z * right.Z + left.D * right.W; } /// /// Calculates the dot product of the specified vector and plane. /// /// The source plane. /// The source vector. /// The dot product of the specified plane and vector. public static Real Dot(Plane left, Vector4 right) { return left.Normal.X * right.X + left.Normal.Y * right.Y + left.Normal.Z * right.Z + left.D * right.W; } /// /// Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane. /// /// The source plane. /// The source vector. /// When the method completes, contains the dot product of a specified vector and the normal of the Plane plus the distance value of the plane. public static void DotCoordinate(ref Plane left, ref Vector3 right, out Real result) { result = left.Normal.X * right.X + left.Normal.Y * right.Y + left.Normal.Z * right.Z + left.D; } /// /// Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane. /// /// The source plane. /// The source vector. /// The dot product of a specified vector and the normal of the Plane plus the distance value of the plane. public static Real DotCoordinate(Plane left, Vector3 right) { return left.Normal.X * right.X + left.Normal.Y * right.Y + left.Normal.Z * right.Z + left.D; } /// /// Calculates the dot product of the specified vector and the normal of the plane. /// /// The source plane. /// The source vector. /// When the method completes, contains the dot product of the specified vector and the normal of the plane. public static void DotNormal(ref Plane left, ref Vector3 right, out Real result) { result = left.Normal.X * right.X + left.Normal.Y * right.Y + left.Normal.Z * right.Z; } /// /// Calculates the dot product of the specified vector and the normal of the plane. /// /// The source plane. /// The source vector. /// The dot product of the specified vector and the normal of the plane. public static Real DotNormal(Plane left, Vector3 right) { return left.Normal.X * right.X + left.Normal.Y * right.Y + left.Normal.Z * right.Z; } /// /// Changes the coefficients of the normal vector of the plane to make it of unit length. /// /// The source plane. /// When the method completes, contains the normalized plane. public static void Normalize(ref Plane plane, out Plane result) { Real magnitude = 1.0f / (Real)Math.Sqrt(plane.Normal.X * plane.Normal.X + plane.Normal.Y * plane.Normal.Y + plane.Normal.Z * plane.Normal.Z); result.Normal.X = plane.Normal.X * magnitude; result.Normal.Y = plane.Normal.Y * magnitude; result.Normal.Z = plane.Normal.Z * magnitude; result.D = plane.D * magnitude; } /// /// Changes the coefficients of the normal vector of the plane to make it of unit length. /// /// The source plane. /// The normalized plane. public static Plane Normalize(Plane plane) { Real magnitude = 1.0f / (Real)Math.Sqrt(plane.Normal.X * plane.Normal.X + plane.Normal.Y * plane.Normal.Y + plane.Normal.Z * plane.Normal.Z); return new Plane(plane.Normal * magnitude, plane.D * magnitude); } /// /// Transforms a normalized plane by a quaternion rotation. /// /// The normalized source plane. /// The quaternion rotation. /// When the method completes, contains the transformed plane. public static void Transform(ref Plane plane, ref Quaternion rotation, out Plane result) { Real x2 = rotation.X + rotation.X; Real y2 = rotation.Y + rotation.Y; Real z2 = rotation.Z + rotation.Z; Real wx = rotation.W * x2; Real wy = rotation.W * y2; Real wz = rotation.W * z2; Real xx = rotation.X * x2; Real xy = rotation.X * y2; Real xz = rotation.X * z2; Real yy = rotation.Y * y2; Real yz = rotation.Y * z2; Real zz = rotation.Z * z2; Real x = plane.Normal.X; Real y = plane.Normal.Y; Real z = plane.Normal.Z; result.Normal.X = x * (1.0f - yy - zz) + y * (xy - wz) + z * (xz + wy); result.Normal.Y = x * (xy + wz) + y * (1.0f - xx - zz) + z * (yz - wx); result.Normal.Z = x * (xz - wy) + y * (yz + wx) + z * (1.0f - xx - yy); result.D = plane.D; } /// /// Transforms a normalized plane by a quaternion rotation. /// /// The normalized source plane. /// The quaternion rotation. /// The transformed plane. public static Plane Transform(Plane plane, Quaternion rotation) { Transform(ref plane, ref rotation, out var result); return result; } /// /// Transforms a normalized plane by a matrix. /// /// The normalized source plane. /// The transformation matrix. /// When the method completes, contains the transformed plane. public static void Transform(ref Plane plane, ref Matrix transformation, out Plane result) { Real x = plane.Normal.X; Real y = plane.Normal.Y; Real z = plane.Normal.Z; Real d = plane.D; Matrix.Invert(ref transformation, out Matrix inverse); result.Normal.X = x * inverse.M11 + y * inverse.M12 + z * inverse.M13 + d * inverse.M14; result.Normal.Y = x * inverse.M21 + y * inverse.M22 + z * inverse.M23 + d * inverse.M24; result.Normal.Z = x * inverse.M31 + y * inverse.M32 + z * inverse.M33 + d * inverse.M34; result.D = x * inverse.M41 + y * inverse.M42 + z * inverse.M43 + d * inverse.M44; } /// /// Transforms a normalized plane by a matrix. /// /// The normalized source plane. /// The transformation matrix. /// When the method completes, contains the transformed plane. public static Plane Transform(Plane plane, Matrix transformation) { Transform(ref plane, ref transformation, out var result); return result; } /// /// Scales a plane by the given value. /// /// The amount by which to scale the plane. /// The plane to scale. /// The scaled plane. public static Plane operator *(Real scale, Plane plane) { return new Plane(plane.Normal * scale, plane.D * scale); } /// /// Scales a plane by the given value. /// /// The plane to scale. /// The amount by which to scale the plane. /// The scaled plane. public static Plane operator *(Plane plane, Real scale) { return new Plane(plane.Normal * scale, plane.D * scale); } /// /// Tests for equality between two objects. /// /// The first value to compare. /// The second value to compare. /// true if has the same value as ; otherwise, false. [MethodImpl(MethodImplOptions.AggressiveInlining)] public static bool operator ==(Plane left, Plane right) { return left.Equals(ref right); } /// /// Tests for inequality between two objects. /// /// The first value to compare. /// The second value to compare. /// true if has a different value than ; otherwise, false. [MethodImpl(MethodImplOptions.AggressiveInlining)] public static bool operator !=(Plane left, Plane right) { return !left.Equals(ref right); } /// /// Returns a that represents this instance. /// /// A that represents this instance. public override string ToString() { return string.Format(CultureInfo.CurrentCulture, "A:{0} B:{1} C:{2} D:{3}", Normal.X, Normal.Y, Normal.Z, D); } /// /// Returns a that represents this instance. /// /// The format. /// A that represents this instance. public string ToString(string format) { return string.Format(CultureInfo.CurrentCulture, "A:{0} B:{1} C:{2} D:{3}", Normal.X.ToString(format, CultureInfo.CurrentCulture), Normal.Y.ToString(format, CultureInfo.CurrentCulture), Normal.Z.ToString(format, CultureInfo.CurrentCulture), D.ToString(format, CultureInfo.CurrentCulture)); } /// /// Returns a that represents this instance. /// /// The format provider. /// A that represents this instance. public string ToString(IFormatProvider formatProvider) { return string.Format(formatProvider, "A:{0} B:{1} C:{2} D:{3}", Normal.X, Normal.Y, Normal.Z, D); } /// /// Returns a that represents this instance. /// /// The format. /// The format provider. /// A that represents this instance. public string ToString(string format, IFormatProvider formatProvider) { return string.Format(formatProvider, "A:{0} B:{1} C:{2} D:{3}", Normal.X.ToString(format, formatProvider), Normal.Y.ToString(format, formatProvider), Normal.Z.ToString(format, formatProvider), D.ToString(format, formatProvider)); } /// /// Returns a hash code for this instance. /// /// A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. public override int GetHashCode() { unchecked { return (Normal.GetHashCode() * 397) ^ D.GetHashCode(); } } /// /// Determines whether the specified is equal to this instance. /// /// The to compare with this instance. /// true if the specified is equal to this instance; otherwise, false. [MethodImpl(MethodImplOptions.AggressiveInlining)] public bool Equals(ref Plane other) { return Normal == other.Normal && D == other.D; } /// /// Determines whether the specified is equal to this instance. /// /// The to compare with this instance. /// true if the specified is equal to this instance; otherwise, false. [MethodImpl(MethodImplOptions.AggressiveInlining)] public bool Equals(Plane other) { return Equals(ref other); } /// /// Determines whether the specified is equal to this instance. /// /// The to compare with this instance. /// true if the specified is equal to this instance; otherwise, false. public override bool Equals(object value) { return value is Plane other && Equals(ref other); } } }