Polar Structure

A set of curvilinear 2-dimensional coordinates.

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

Syntax

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

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

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

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

The Polar type exposes the following members.

Constructors

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

Properties

	Name	Description
	Clock	Gets the angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.
	Item	Gets the value of the specified element with index of 0 and 1 corresponding to the coordinates Clock, and Radial.
	Length	Gets the number of elements in this set of coordinates.
	Radial	Gets the linear coordinate perpendicular to the z-axis.
	Zero	Gets a set of Polar coordinates with values of zero.

Methods

	Name	Description
	Equals(Object)	Indicates whether another object is exactly equal to this instance. (Overrides ValueTypeEquals(Object).)
	Equals(Polar)	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.)
	ToString	Returns the string representation of the value of this instance. (Overrides ValueTypeToString.)

Operators

	Name	Description
	Equality	Returns if the two instances are exactly equal.
	Inequality	Returns if the two instances are not exactly equal.

Remarks

The corresponding 3-dimensional coordinates are Cylindrical coordinates.