Companion

external object Companion : Packable<Cartesian2> (source)

Properties

Link copied to clipboard
external val ONE: Cartesian2

An immutable Cartesian2 instance initialized to (1.0, 1.0).

Link copied to clipboard
open external override val packedLength: Int

The number of elements used to pack the object into an array.

Link copied to clipboard
external val UNIT_X: Cartesian2

An immutable Cartesian2 instance initialized to (1.0, 0.0).

Link copied to clipboard
external val UNIT_Y: Cartesian2

An immutable Cartesian2 instance initialized to (0.0, 1.0).

Link copied to clipboard
external val ZERO: Cartesian2

An immutable Cartesian2 instance initialized to (0.0, 0.0).

Functions

Link copied to clipboard
external fun abs(cartesian: Cartesian2, result: Cartesian2): Cartesian2

Computes the absolute value of the provided Cartesian.

Link copied to clipboard
external fun add(left: Cartesian2, right: Cartesian2, result: Cartesian2): Cartesian2

Computes the componentwise sum of two Cartesians.

Link copied to clipboard
external fun angleBetween(left: Cartesian2, right: Cartesian2): Double

Returns the angle, in radians, between the provided Cartesians.

Link copied to clipboard
external fun clamp(value: Cartesian2, min: Cartesian2, max: Cartesian2, result: Cartesian2): Cartesian2

Constrain a value to lie between two values.

Link copied to clipboard
external fun clone(cartesian: Cartesian2, result: Cartesian2? = definedExternally): Cartesian2

Duplicates a Cartesian2 instance.

Link copied to clipboard
external fun cross(left: Cartesian2, right: Cartesian2): Double

Computes the magnitude of the cross product that would result from implicitly setting the Z coordinate of the input vectors to 0

Link copied to clipboard
external fun distance(left: Cartesian2, right: Cartesian2): Double

Computes the distance between two points.

Link copied to clipboard
external fun distanceSquared(left: Cartesian2, right: Cartesian2): Double

Computes the squared distance between two points. Comparing squared distances using this function is more efficient than comparing distances using Cartesian2.distance.

Link copied to clipboard
external fun divideByScalar(cartesian: Cartesian2, scalar: Double, result: Cartesian2): Cartesian2

Divides the provided Cartesian componentwise by the provided scalar.

Link copied to clipboard
external fun divideComponents(left: Cartesian2, right: Cartesian2, result: Cartesian2): Cartesian2

Computes the componentwise quotient of two Cartesians.

Link copied to clipboard
external fun dot(left: Cartesian2, right: Cartesian2): Double

Computes the dot (scalar) product of two Cartesians.

Link copied to clipboard
external fun equals(left: Cartesian2? = definedExternally, right: Cartesian2? = definedExternally): Boolean

Compares the provided Cartesians componentwise and returns true if they are equal, false otherwise.

Link copied to clipboard
external fun equalsEpsilon(left: Cartesian2? = definedExternally, right: Cartesian2? = definedExternally, relativeEpsilon: Double? = definedExternally, absoluteEpsilon: Double? = definedExternally): Boolean

Compares the provided Cartesians componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.

Link copied to clipboard
external fun fromArray(array: ReadonlyArray<JsDouble>, startingIndex: Int? = definedExternally, result: Cartesian2? = definedExternally): Cartesian2

Creates a Cartesian2 from two consecutive elements in an array.

Link copied to clipboard
external fun fromCartesian3(cartesian: Cartesian3, result: Cartesian2? = definedExternally): Cartesian2

Creates a Cartesian2 instance from an existing Cartesian3. This simply takes the x and y properties of the Cartesian3 and drops z.

Link copied to clipboard
external fun fromCartesian4(cartesian: Cartesian4, result: Cartesian2? = definedExternally): Cartesian2

Creates a Cartesian2 instance from an existing Cartesian4. This simply takes the x and y properties of the Cartesian4 and drops z and w.

Link copied to clipboard
external fun fromElements(x: Double, y: Double, result: Cartesian2? = definedExternally): Cartesian2

Creates a Cartesian2 instance from x and y coordinates.

Link copied to clipboard
external fun lerp(start: Cartesian2, end: Cartesian2, t: Double, result: Cartesian2): Cartesian2

Computes the linear interpolation or extrapolation at t using the provided cartesians.

Link copied to clipboard
external fun magnitude(cartesian: Cartesian2): Double

Computes the Cartesian's magnitude (length).

Link copied to clipboard
external fun magnitudeSquared(cartesian: Cartesian2): Double

Computes the provided Cartesian's squared magnitude.

Link copied to clipboard
external fun maximumByComponent(first: Cartesian2, second: Cartesian2, result: Cartesian2): Cartesian2

Compares two Cartesians and computes a Cartesian which contains the maximum components of the supplied Cartesians.

Link copied to clipboard
external fun maximumComponent(cartesian: Cartesian2): Double

Computes the value of the maximum component for the supplied Cartesian.

Link copied to clipboard
external fun minimumByComponent(first: Cartesian2, second: Cartesian2, result: Cartesian2): Cartesian2

Compares two Cartesians and computes a Cartesian which contains the minimum components of the supplied Cartesians.

Link copied to clipboard
external fun minimumComponent(cartesian: Cartesian2): Double

Computes the value of the minimum component for the supplied Cartesian.

Link copied to clipboard
external fun mostOrthogonalAxis(cartesian: Cartesian2, result: Cartesian2): Cartesian2

Returns the axis that is most orthogonal to the provided Cartesian.

Link copied to clipboard
external fun multiplyByScalar(cartesian: Cartesian2, scalar: Double, result: Cartesian2): Cartesian2

Multiplies the provided Cartesian componentwise by the provided scalar.

Link copied to clipboard
external fun multiplyComponents(left: Cartesian2, right: Cartesian2, result: Cartesian2): Cartesian2

Computes the componentwise product of two Cartesians.

Link copied to clipboard
external fun negate(cartesian: Cartesian2, result: Cartesian2): Cartesian2

Negates the provided Cartesian.

Link copied to clipboard
external fun normalize(cartesian: Cartesian2, result: Cartesian2): Cartesian2

Computes the normalized form of the supplied Cartesian.

Link copied to clipboard
open external override fun pack(value: Cartesian2, array: ReadonlyArray<JsDouble>, startingIndex: Int? = definedExternally): ReadonlyArray<JsDouble>

Stores the provided instance into the provided array.

Link copied to clipboard
external fun packArray(array: ReadonlyArray<Cartesian2>, result: ReadonlyArray<JsDouble>? = definedExternally): ReadonlyArray<JsDouble>

Flattens an array of Cartesian2s into an array of components.

Link copied to clipboard
external fun subtract(left: Cartesian2, right: Cartesian2, result: Cartesian2): Cartesian2

Computes the componentwise difference of two Cartesians.

Link copied to clipboard
open external override fun unpack(array: ReadonlyArray<JsDouble>, startingIndex: Int? = definedExternally, result: Cartesian2? = definedExternally): Cartesian2

Retrieves an instance from a packed array.

Link copied to clipboard
external fun unpackArray(array: ReadonlyArray<JsDouble>, result: ReadonlyArray<Cartesian2>? = definedExternally): ReadonlyArray<Cartesian2>

Unpacks an array of cartesian components into an array of Cartesian2s.