UnitRectangular Structure

A set of rectilinear 2-dimensional coordinates with unit magnitude.

Namespace: AGI.Foundation.Coordinates
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public struct UnitRectangular : IEquatable<UnitRectangular>, 
	IEquatableEpsilon<UnitRectangular>

Public Structure UnitRectangular
	Implements IEquatable(Of UnitRectangular), IEquatableEpsilon(Of UnitRectangular)

public value class UnitRectangular : IEquatable<UnitRectangular>, 
	IEquatableEpsilon<UnitRectangular>

[<SealedAttribute>]
type UnitRectangular =  
    struct
        interface IEquatable<UnitRectangular>
        interface IEquatableEpsilon<UnitRectangular>
    end

The UnitRectangular type exposes the following members.

Constructors

	Name	Description
	UnitRectangular(Double)	Initializes a set of UnitRectangular coordinates from the provided polar coordinates.
	UnitRectangular(Double)	Initializes a set of UnitRectangular coordinates from the first 2 consecutive elements in the provided array.
	UnitRectangular(Rectangular)	Initializes a set of UnitRectangular coordinates from the provided set of Rectangular coordinates.
	UnitRectangular(Double, Double)	Initializes a set of UnitRectangular coordinates from the provided values.
	UnitRectangular(Double, Int32)	Initializes a set of UnitRectangular coordinates from 2 consecutive elements in the provided array.
	UnitRectangular(Double, Double, Double)	Initializes a set of UnitRectangular coordinates from the provided values.

Top

Properties

	Name	Description
	IsUndefined	Gets a value indicating whether or not any of the coordinates for this instance have the value NaN.
	Item	Gets the value of the specified element with index of 0 and 1 corresponding to the coordinates X, and Y.
	Length	Gets the number of elements in this set of coordinates.
	MostOrthogonalAxis	Gets the axis which is most orthogonal to this instance.
	MostParallelAxis	Gets the axis which is most parallel to this instance.
	Undefined	Gets a set of UnitRectangular coordinates with values of NaN.
	UnitX	Gets a set of UnitRectangular coordinates representing the x-axis.
	UnitY	Gets a set of UnitRectangular coordinates representing the y-axis.
	X	Gets the linear coordinate along the positive x-axis.
	Y	Gets the linear coordinate along the positive y-axis.

Top

Methods

	Name	Description
	Add(Rectangular)	Adds the specified set of Rectangular coordinates to this instance.
	Add(UnitRectangular)	Adds the specified set of UnitRectangular coordinates to this instance.
	AngleBetween	Determines the angle in radians between the specified set of UnitRectangular coordinates and this instance.
	Divide	Divides this instance by a scalar.
	Dot(Rectangular)	Forms the dot product of the specified set of Rectangular coordinates with this instance.
	Dot(UnitRectangular)	Forms the dot product of the specified set of UnitRectangular coordinates with this instance.
	Equals(Object)	Indicates whether another object is exactly equal to this instance. (Overrides ValueTypeEquals(Object).)
	Equals(UnitRectangular)	Indicates whether another instance of this type is exactly equal to this instance.
	EqualsEpsilon	Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.
	GetHashCode	Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table. (Overrides ValueTypeGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Invert	Inverts this instance.
	Multiply	Multiplies this instance by a scalar.
	Rotate	Produces a set of UnitRectangular coordinates representing this instance which results from rotating the original axes used to represent this instance by the provided angle.
	Subtract(Rectangular)	Subtracts the specified set of Rectangular coordinates from this instance.
	Subtract(UnitRectangular)	Subtracts the specified set of UnitRectangular coordinates from this instance.
	ToString	Returns the string representation of the value of this instance. (Overrides ValueTypeToString.)

Top

Operators

	Name	Description
	Addition(Rectangular, UnitRectangular)	Adds a specified set of UnitRectangular coordinates to a specified set of Rectangular coordinates.
	Addition(UnitRectangular, Rectangular)	Adds a specified set of UnitRectangular coordinates to a specified set of Rectangular coordinates.
	Addition(UnitRectangular, UnitRectangular)	Adds a specified set of UnitRectangular coordinates to another specified set of UnitRectangular coordinates.
	Division	Divides a specified set of UnitRectangular coordinates by a scalar.
	Equality	Returns if the two instances are exactly equal.
	Inequality	Returns if the two instances are not exactly equal.
	Multiply(Double, UnitRectangular)	Multiplies a scalar by a specified set of UnitRectangular coordinates.
	Multiply(UnitRectangular, Double)	Multiplies a specified set of UnitRectangular coordinates by a scalar.
	Subtraction(Rectangular, UnitRectangular)	Subtracts a specified set of UnitRectangular coordinates from a specified set of Rectangular coordinates.
	Subtraction(UnitRectangular, Rectangular)	Subtracts a specified set of Rectangular coordinates from a specified set of UnitRectangular coordinates.
	Subtraction(UnitRectangular, UnitRectangular)	Subtracts a specified set of UnitRectangular coordinates from another specified set of UnitRectangular coordinates.
	UnaryNegation	Negates the specified UnitRectangular, yielding a new UnitRectangular.

Top

Remarks

The normalization of the rectilinear coordinate pair is accomplished in the usual way. It should be noted that this does not guarantee a result whose magnitude will be 1.0 in cases where an individual component underflows upon squaring.

The corresponding 3-dimensional coordinates are UnitCartesian coordinates.

Reference

AGI.Foundation.Coordinates Namespace