Rectangular Structure

A set of rectilinear 2-dimensional coordinates.

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 Rectangular : IEquatable<Rectangular>, 
	IEquatableEpsilon<Rectangular>

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

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

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

The Rectangular type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	HasZeroMagnitude	Gets a value indicating whether the Magnitude of this instance is zero.
	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.
	Magnitude	Gets the magnitude of this instance.
	MagnitudeSquared	Gets the square of the Magnitude of this instance.
	Undefined	Gets a set of Rectangular coordinates with values of NaN.
	X	Gets the linear coordinate along the positive x-axis.
	Y	Gets the linear coordinate along the positive y-axis.
	Zero	Gets a set of Rectangular coordinates with values of zero.

Top

Methods

	Name	Description
	Add	Adds the specified set of Rectangular coordinates to this instance.
	Cross	Forms the cross product of the specified set of Rectangular coordinates with this instance.
	Divide	Divides this instance by a scalar.
	Dot	Forms the dot product of the specified set of Rectangular coordinates with this instance.
	Equals(Object)	Indicates whether another object is exactly equal to this instance. (Overrides ValueTypeEquals(Object).)
	Equals(Rectangular)	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.
	Normalize	Forms a set of UnitRectangular coordinates from this instance.
	Normalize(Double)	Forms a set of UnitRectangular coordinates from this instance and returns the Magnitude of the original instance in the provided parameter.
	Rotate	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.
	Subtract	Subtracts the specified set of Rectangular coordinates from this instance.
	ToString	Returns the string representation of the value of this instance. (Overrides ValueTypeToString.)

Top

Operators

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

Top

Remarks

The corresponding 3-dimensional coordinates are Cartesian coordinates.

Reference

AGI.Foundation.Coordinates Namespace