Click or drag to resize

Rectangular Structure

A set of rectilinear 2-dimensional coordinates.

Namespace:  AGI.Foundation.Coordinates
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public struct Rectangular : IEquatable<Rectangular>

The Rectangular type exposes the following members.

Constructors
  NameDescription
Public methodRectangular(Double)
Initializes a set of Rectangular coordinates from the first 2 consecutive elements in the provided array.
Public methodRectangular(Polar)
Initializes a set of Rectangular coordinates from the provided set of Polar coordinates.
Public methodRectangular(Double, Double)
Initializes a set of Rectangular coordinates from the provided values.
Public methodRectangular(Double, Int32)
Initializes a set of Rectangular coordinates from 2 consecutive elements in the provided array.
Top
Properties
  NameDescription
Public propertyHasZeroMagnitude
Gets a value indicating if the Magnitude of this instance is zero.
Public propertyIsUndefined
Gets whether or not any of the coordinates for this instance have the value NaN.
Public propertyItem
Gets the value of the specified element with index of 0 and 1 corresponding to the coordinates X, and Y.
Public propertyLength
Gets the number of elements in this set of coordinates.
Public propertyMagnitude
Gets the magnitude of this instance.
Public propertyMagnitudeSquared
Gets the square of the Magnitude of this instance.
Public propertyStatic memberUndefined
Gets a set of Rectangular coordinates with values of NaN.
Public propertyX
Gets the linear coordinate along the positive x-axis.
Public propertyY
Gets the linear coordinate along the positive y-axis.
Public propertyStatic memberZero
Gets a set of Rectangular coordinates with values of zero.
Top
Methods
  NameDescription
Public methodAdd
Adds the specified set of Rectangular coordinates to this instance.
Public methodCross
Forms the cross product of the specified set of Rectangular coordinates with this instance.
Public methodDivide
Divides this instance by a scalar.
Public methodDot
Forms the dot product of the specified set of Rectangular coordinates with this instance.
Public methodEquals(Object)
Indicates whether another object is exactly equal to this instance.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(Rectangular)
Indicates whether another instance of this type is exactly equal to this instance.
Public methodEqualsEpsilon
Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.
Public methodGetHashCode
Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ValueTypeGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInvert
Inverts this instance.
Public methodMultiply
Multiplies this instance by a scalar.
Public methodNormalize
Forms a set of UnitRectangular coordinates from this instance.
Public methodNormalize(Double)
Forms a set of UnitRectangular coordinates from this instance and returns the Magnitude of the original instance in the provided parameter.
Public methodRotate
Produces a set of Rectangular coordinates representing this instance which results from rotating the original axes used to represent this instance by the provided angle.
Public methodSubtract
Subtracts the specified set of Rectangular coordinates from this instance.
Public methodToString
Returns the string representation of the value of this instance.
(Overrides ValueTypeToString.)
Top
Operators
  NameDescription
Public operatorStatic memberAddition
Adds a specified set of Rectangular coordinates to another specified set of Cartesian coordinates.
Public operatorStatic memberDivision
Divides a specified set of Rectangular coordinates by a scalar.
Public operatorStatic memberEquality
Returns if the two instances are exactly equal.
Public operatorStatic member(UnitRectangular to Rectangular)
Converts a set of UnitRectangular coordinates to a set of Rectangular coordinates.
Public operatorStatic memberInequality
Returns if the two instances are not exactly equal.
Public operatorStatic memberMultiply(Double, Rectangular)
Multiplies a scalar by a specified set of set of Rectangular coordinates.
Public operatorStatic memberMultiply(Rectangular, Double)
Multiplies a specified set of Rectangular coordinates by a scalar.
Public operatorStatic memberSubtraction
Subtracts a specified set of Rectangular coordinates from another specified set of Rectangular coordinates.
Public operatorStatic memberUnaryNegation
Negates the specified set of Rectangular coordinates, yielding a new set of Rectangular coordinates.
Top
Remarks
The corresponding 3-dimensional coordinates are Cartesian coordinates.
See Also