mirror of
https://github.com/oliverbooth/X10D
synced 2024-11-23 00:38:47 +00:00
Add relational members to Sphere
This commit is contained in:
parent
0e62f233f0
commit
2c1da816ee
@ -1,11 +1,11 @@
|
||||
using System.Numerics;
|
||||
using System.Numerics;
|
||||
|
||||
namespace X10D.Drawing;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a sphere in 3D space, which uses single-precision floating-point numbers for its coordinates.
|
||||
/// </summary>
|
||||
public readonly struct Sphere : IEquatable<Sphere>
|
||||
public readonly struct Sphere : IEquatable<Sphere>, IComparable<Sphere>, IComparable
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Sphere" /> struct.
|
||||
@ -57,7 +57,7 @@ public readonly struct Sphere : IEquatable<Sphere>
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a value indicating whether two instances of <see cref="Cuboid" /> are not equal.
|
||||
/// Returns a value indicating whether two instances of <see cref="Sphere" /> are not equal.
|
||||
/// </summary>
|
||||
/// <param name="left">The first instance.</param>
|
||||
/// <param name="right">The second instance.</param>
|
||||
@ -70,6 +70,156 @@ public readonly struct Sphere : IEquatable<Sphere>
|
||||
return !left.Equals(right);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a value indicating whether the radius of one circle is less than that of another.
|
||||
/// </summary>
|
||||
/// <param name="left">The first instance.</param>
|
||||
/// <param name="right">The second instance.</param>
|
||||
/// <returns>
|
||||
/// <see langword="true" /> if the <see cref="Radius" /> of <paramref name="left" /> is less than that of
|
||||
/// <paramref name="right" />; otherwise, <see langword="false" />.
|
||||
/// </returns>
|
||||
public static bool operator <(Sphere left, Sphere right)
|
||||
{
|
||||
return left.CompareTo(right) < 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a value indicating whether the radius of one circle is greater than to that of another.
|
||||
/// </summary>
|
||||
/// <param name="left">The first instance.</param>
|
||||
/// <param name="right">The second instance.</param>
|
||||
/// <returns>
|
||||
/// <see langword="true" /> if the <see cref="Radius" /> of <paramref name="left" /> is greater than that of
|
||||
/// <paramref name="right" />; otherwise, <see langword="false" />.
|
||||
/// </returns>
|
||||
public static bool operator >(Sphere left, Sphere right)
|
||||
{
|
||||
return left.CompareTo(right) > 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a value indicating whether the radius of one circle is less than or equal to that of another.
|
||||
/// </summary>
|
||||
/// <param name="left">The first instance.</param>
|
||||
/// <param name="right">The second instance.</param>
|
||||
/// <returns>
|
||||
/// <see langword="true" /> if the <see cref="Radius" /> of <paramref name="left" /> is less than or equal to that of
|
||||
/// <paramref name="right" />; otherwise, <see langword="false" />.
|
||||
/// </returns>
|
||||
public static bool operator <=(Sphere left, Sphere right)
|
||||
{
|
||||
return left.CompareTo(right) <= 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a value indicating whether the radius of one circle is greater than or equal to that of another.
|
||||
/// </summary>
|
||||
/// <param name="left">The first instance.</param>
|
||||
/// <param name="right">The second instance.</param>
|
||||
/// <returns>
|
||||
/// <see langword="true" /> if the <see cref="Radius" /> of <paramref name="left" /> is greater than or equal to that of
|
||||
/// <paramref name="right" />; otherwise, <see langword="false" />.
|
||||
/// </returns>
|
||||
public static bool operator >=(Sphere left, Sphere right)
|
||||
{
|
||||
return left.CompareTo(right) >= 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Compares this instance to another <see cref="Sphere" />.
|
||||
/// </summary>
|
||||
/// <param name="obj">The other object.</param>
|
||||
/// <returns>
|
||||
/// A signed number indicating the relative values of this instance and <paramref name="obj" />.
|
||||
///
|
||||
/// <list type="table">
|
||||
/// <listheader>
|
||||
/// <term>Return value</term>
|
||||
/// <description>Meaning</description>
|
||||
/// </listheader>
|
||||
///
|
||||
/// <item>
|
||||
/// <term>Less than zero</term>
|
||||
/// <description>
|
||||
/// The <see cref="Radius" /> of this instance is less than that of <paramref name="obj" />.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>Zero</term>
|
||||
/// <description>
|
||||
/// This instance is equal to <paramref name="obj" />, or the <see cref="Radius" /> of both this instance
|
||||
/// and <paramref name="obj" /> are not a number (<see cref="float.NaN" />),
|
||||
/// <see cref="float.PositiveInfinity" />, or <see cref="float.NegativeInfinity" />.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>Greater than zero</term>
|
||||
/// <description>
|
||||
/// The <see cref="Radius" /> of this instance is greater than that of <paramref name="obj" />, or
|
||||
/// <paramref name="obj" /> is <see langword="null" />.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// </list>
|
||||
/// </returns>
|
||||
/// <remarks>Comparison only takes into consideration the <see cref="Radius" />.</remarks>
|
||||
/// <exception cref="ArgumentException"><paramref name="obj" /> is not an instance of <see cref="Sphere" />.</exception>
|
||||
public int CompareTo(object? obj)
|
||||
{
|
||||
if (ReferenceEquals(null, obj))
|
||||
{
|
||||
return 1;
|
||||
}
|
||||
|
||||
if (obj is not Sphere other)
|
||||
{
|
||||
throw new ArgumentException($"Object must be of type {GetType()}");
|
||||
}
|
||||
|
||||
return CompareTo(other);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Compares this instance to another <see cref="Sphere" />.
|
||||
/// </summary>
|
||||
/// <param name="other">The other sphere.</param>
|
||||
/// <returns>
|
||||
/// A signed number indicating the relative values of this instance and <paramref name="other" />.
|
||||
///
|
||||
/// <list type="table">
|
||||
/// <listheader>
|
||||
/// <term>Return value</term>
|
||||
/// <description>Meaning</description>
|
||||
/// </listheader>
|
||||
///
|
||||
/// <item>
|
||||
/// <term>Less than zero</term>
|
||||
/// <description>
|
||||
/// The <see cref="Radius" /> of this instance is less than that of <paramref name="other" />.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>Zero</term>
|
||||
/// <description>
|
||||
/// This instance is equal to <paramref name="other" />, or the <see cref="Radius" /> of both this instance
|
||||
/// and <paramref name="other" /> are not a number (<see cref="float.NaN" />),
|
||||
/// <see cref="float.PositiveInfinity" />, or <see cref="float.NegativeInfinity" />.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>Greater than zero</term>
|
||||
/// <description>
|
||||
/// The <see cref="Radius" /> of this instance is greater than that of <paramref name="other" />.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// </list>
|
||||
/// </returns>
|
||||
/// <remarks>Comparison only takes into consideration the <see cref="Radius" />.</remarks>
|
||||
public int CompareTo(Sphere other)
|
||||
{
|
||||
return Radius.CompareTo(other.Radius);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public override bool Equals(object? obj)
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user