alchemist/it.unibo.alchemist.model.positions/Euclidean2DPosition

Euclidean2DPosition

class Euclidean2DPosition : AbstractEuclideanPosition<Euclidean2DPosition> , Position2D<Euclidean2DPosition> , Vector2D<Euclidean2DPosition>

Constructors

Euclidean2DPosition

constructor(xp: Double, yp: Double)

constructor(c: DoubleArray)

Types

object Companion

Constant values and utility methods for Euclidean2DPosition.

Properties

open val asAngle: Double

Computes the angle with atan2(y, x).

override val coordinates: DoubleArray

Allows to get the position as a Number array.

override val dimensions: Int

open val magnitude: Double

Finds the magnitude of a vector.

open override val x: Double

open override val y: Double

open override val zero: Euclidean2DPosition

Origin.

Functions

open fun angleBetween(other: Euclidean2DPosition): Double

Computes the angle in radians between two vectors.

override fun boundingBox(range: Double): List<Euclidean2DPosition>

Given a range, produces N coordinates, representing the N opposite vertices of the hypercube having the current coordinate as center and circumscribing the N-sphere defined by the range. In the case of bidimensional coordinates, it must return the opposite vertices of the square circumscribing the circle with center in this position and radius range.

open fun coerceAtLeast(minimumMagnitude: Double): Euclidean2DPosition

open fun coerceAtMost(maximumMagnitude: Double): Euclidean2DPosition

open fun coerceIn(minimumMagnitude: Double, maximumMagnitude: Double): Euclidean2DPosition

Performs a coercion at least and at most.

open operator fun component1(): Double

x coordinate.

open operator fun component2(): Double

y coordinate.

override fun distanceTo(other: Euclidean2DPosition): Double

Computes the distance between this position and another compatible position.

open operator override fun div(other: Double): Euclidean2DPosition

Division by a Double.

open fun dot(other: Euclidean2DPosition): Double

Computes the dot product between two vectors.

operator override fun equals(other: Any?): Boolean

fromCoordinates

open override fun fromCoordinates(coordinates: DoubleArray): Euclidean2DPosition

Builds a new Vector from the provided coordinates.

operator override fun get(dimension: Int): Double

Allows to access the value of a coordinate.

override fun hashCode(): Int

open fun isInRectangle(origin: Vector2D<*>, width: Double, height: Double): Boolean

Checks whether the given point is inside a rectangular region described by an origin point and width and height values (only positive).

open operator fun minus(other: Pair<Double, Double>): Euclidean2DPosition

Allows subtraction with a Pair.

operator fun minus(other: Euclidean2DPosition): Euclidean2DPosition

Same as minus, with the internal representation of other.

operator override fun minus(other: DoubleArray): Euclidean2DPosition

Considers both positions as vectors, and returns the difference between this position and the passed one.

open override fun newFrom(x: Double, y: Double): Euclidean2DPosition

Creates a new Vector2D with the same type of the current one with different x and y.

open override fun normal(): Euclidean2DPosition

Find the normal of a vector.

open fun normalized(): Euclidean2DPosition

open operator fun plus(other: Pair<Double, Double>): Euclidean2DPosition

Allows summaction with a Pair.

operator fun plus(other: Euclidean2DPosition): Euclidean2DPosition

Same as plus, with the internal representation of other.

operator override fun plus(other: DoubleArray): Euclidean2DPosition

Considers both positions as vectors, and sums them.

open fun resized(newLen: Double): Euclidean2DPosition

open fun surrounding(radius: Double, count: Int = 12): List<Euclidean2DPosition>

Creates a list of count points equally spaced in the circle of given radius with center in this vector.

surroundingPointAt

open fun surroundingPointAt(versor: Euclidean2DPosition, distance: Double): Euclidean2DPosition

Computes a point which is at a certain distance and angle (expressed as a versor centered in this node) from this one.

open fun surroundingPointAt(angle: Double, distance: Double): Euclidean2DPosition

Computes a point which is at a certain distance and angle (in radians) from this one.

open operator override fun times(other: Double): Euclidean2DPosition

Multiplication by a Double.

open override fun toString(): String

Prints the coordinates.