hondacrx
261 lines
9.0 KiB
C#
261 lines
9.0 KiB
C#
/*
|
|
* Copyright (C) 2012-2020 CypherCore <http://github.com/CypherCore>
|
|
* Copyright (C) 2003-2004 Eran Kampf eran@ekampf.com http://www.ekampf.com
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
using System;
|
|
using System.Runtime.Serialization;
|
|
using System.Security.Permissions;
|
|
|
|
namespace Framework.GameMath
|
|
{
|
|
/// <summary>
|
|
/// An enumeration representing the sides of the plane.
|
|
/// </summary>
|
|
public enum PlaneSide
|
|
{
|
|
/// <summary>
|
|
/// Represents the plane itself.
|
|
/// </summary>
|
|
None,
|
|
/// <summary>
|
|
/// Represents the positive halfspace of the plane (the side where the normal points to).
|
|
/// </summary>
|
|
Positive,
|
|
/// <summary>
|
|
/// Represents the negative halfspace of the plane
|
|
/// </summary>
|
|
Negative
|
|
}
|
|
|
|
/// <summary>
|
|
/// Represents a plane in 3D space.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The plane is described by a normal and a constant (N,D) which
|
|
/// denotes that the plane is consisting of points Q that
|
|
/// satisfies (N dot Q)+D = 0.
|
|
/// </remarks>
|
|
[Serializable]
|
|
public struct Plane : ISerializable, ICloneable
|
|
{
|
|
#region Private Fields
|
|
private Vector3 _normal;
|
|
private float _const;
|
|
#endregion
|
|
|
|
#region Constructors
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="Plane"/> class using given normal and constant values.
|
|
/// </summary>
|
|
/// <param name="normal">The plane's normal vector.</param>
|
|
/// <param name="constant">The plane's constant value.</param>
|
|
public Plane(Vector3 normal, float constant)
|
|
{
|
|
_normal = normal;
|
|
_const = constant;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="Plane"/> class using given normal and a point.
|
|
/// </summary>
|
|
/// <param name="normal">The plane's normal vector.</param>
|
|
/// <param name="point">A point on the plane in 3D space.</param>
|
|
public Plane(Vector3 normal, Vector3 point)
|
|
{
|
|
_normal = normal;
|
|
_const = Vector3.DotProduct(normal, point);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="Plane"/> class using 3 given points.
|
|
/// </summary>
|
|
/// <param name="p0">A point on the plane in 3D space.</param>
|
|
/// <param name="p1">A point on the plane in 3D space.</param>
|
|
/// <param name="p2">A point on the plane in 3D space.</param>
|
|
public Plane(Vector3 p0, Vector3 p1, Vector3 p2)
|
|
{
|
|
_normal = Vector3.CrossProduct(p2 - p1, p0 - p1);
|
|
_normal.Normalize();
|
|
_const = Vector3.DotProduct(_normal, p0);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="Plane"/> class using given a plane to assign values from.
|
|
/// </summary>
|
|
/// <param name="p">A 3D plane to assign values from.</param>
|
|
public Plane(Plane p)
|
|
{
|
|
_normal = p.Normal;
|
|
_const = p.Constant;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="Plane"/> class with serialized data.
|
|
/// </summary>
|
|
/// <param name="info">The object that holds the serialized object data.</param>
|
|
/// <param name="context">The contextual information about the source or destination.</param>
|
|
private Plane(SerializationInfo info, StreamingContext context)
|
|
{
|
|
_normal = (Vector3)info.GetValue("Normal", typeof(Vector3));
|
|
_const = info.GetSingle("Constant");
|
|
}
|
|
#endregion
|
|
|
|
#region Constants
|
|
/// <summary>
|
|
/// Plane on the X axis.
|
|
/// </summary>
|
|
public static readonly Plane XPlane = new(Vector3.XAxis, Vector3.Zero);
|
|
/// <summary>
|
|
/// Plane on the Y axis.
|
|
/// </summary>
|
|
public static readonly Plane YPlane = new(Vector3.YAxis, Vector3.Zero);
|
|
/// <summary>
|
|
/// Plane on the Z axis.
|
|
/// </summary>
|
|
public static readonly Plane ZPlane = new(Vector3.ZAxis, Vector3.Zero);
|
|
#endregion
|
|
|
|
#region Public Properties
|
|
/// <summary>
|
|
/// Gets or sets the plane's normal vector.
|
|
/// </summary>
|
|
public Vector3 Normal
|
|
{
|
|
get { return _normal; }
|
|
set { _normal = value; }
|
|
}
|
|
/// <summary>
|
|
/// Gets or sets the plane's constant value.
|
|
/// </summary>
|
|
public float Constant
|
|
{
|
|
get { return _const; }
|
|
set { _const = value; }
|
|
}
|
|
#endregion
|
|
|
|
#region ICloneable Members
|
|
/// <summary>
|
|
/// Creates an exact copy of this <see cref="Plane"/> object.
|
|
/// </summary>
|
|
/// <returns>The <see cref="Plane"/> object this method creates, cast as an object.</returns>
|
|
object ICloneable.Clone()
|
|
{
|
|
return new Plane(this);
|
|
}
|
|
/// <summary>
|
|
/// Creates an exact copy of this <see cref="Plane"/> object.
|
|
/// </summary>
|
|
/// <returns>The <see cref="Plane"/> object this method creates.</returns>
|
|
public Plane Clone()
|
|
{
|
|
return new Plane(this);
|
|
}
|
|
#endregion
|
|
|
|
#region ISerializable Members
|
|
/// <summary>
|
|
/// Populates a <see cref="SerializationInfo"/> with the data needed to serialize the target object.
|
|
/// </summary>
|
|
/// <param name="info">The <see cref="SerializationInfo"/> to populate with data. </param>
|
|
/// <param name="context">The destination (see <see cref="StreamingContext"/>) for this serialization.</param>
|
|
//[SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)]
|
|
public void GetObjectData(SerializationInfo info, StreamingContext context)
|
|
{
|
|
info.AddValue("Normal", _normal, typeof(Vector3));
|
|
info.AddValue("Constant", _const);
|
|
}
|
|
#endregion
|
|
|
|
#region Public Methods
|
|
/// <summary>
|
|
/// Flip the plane.
|
|
/// </summary>
|
|
public void Flip()
|
|
{
|
|
_normal = -_normal;
|
|
}
|
|
/// <summary>
|
|
/// Creates a new flipped plane (-normal, constant).
|
|
/// </summary>
|
|
/// <returns>A new <see cref="Plane"/> instance.</returns>
|
|
public Plane GetFlipped()
|
|
{
|
|
return new Plane(-_normal, _const);
|
|
}
|
|
/// <summary>
|
|
/// Get the shortest distance from a 3D vector to the plane.
|
|
/// </summary>
|
|
/// <param name="p">A <see cref="Vector3"/> instance.</param>
|
|
/// <returns>A float representing the shortest distance from the given vector to the plane.</returns>
|
|
public float GetDistanceToPlane(Vector3 p)
|
|
{
|
|
return Vector3.DotProduct(p, Normal) - Constant;
|
|
}
|
|
|
|
public void getEquation(ref Vector3 n, out float d)
|
|
{
|
|
double _d;
|
|
getEquation(ref n, out _d);
|
|
d = (float)_d;
|
|
}
|
|
|
|
void getEquation(ref Vector3 n, out double d)
|
|
{
|
|
n = _normal;
|
|
d = -_const;
|
|
}
|
|
#endregion
|
|
|
|
#region Overrides
|
|
/// <summary>
|
|
/// Returns the hashcode for this instance.
|
|
/// </summary>
|
|
/// <returns>A 32-bit signed integer hash code.</returns>
|
|
public override int GetHashCode()
|
|
{
|
|
return _normal.GetHashCode() ^ _const.GetHashCode();
|
|
}
|
|
/// <summary>
|
|
/// Returns a value indicating whether this instance is equal to
|
|
/// the specified object.
|
|
/// </summary>
|
|
/// <param name="obj">An object to compare to this instance.</param>
|
|
/// <returns>True if <paramref name="obj"/> is a <see cref="Plane"/> and has the same values as this instance; otherwise, False.</returns>
|
|
public override bool Equals(object obj)
|
|
{
|
|
if (obj is Plane)
|
|
{
|
|
Plane p = (Plane)obj;
|
|
return (_normal == p.Normal) && (_const == p.Constant);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns a string representation of this object.
|
|
/// </summary>
|
|
/// <returns>A string representation of this object.</returns>
|
|
public override string ToString()
|
|
{
|
|
return $"Plane[n={_normal}, c={_const}]";
|
|
}
|
|
#endregion
|
|
}
|
|
}
|