Vector2D

public final class Vector2D

Represents a 2-dimensional vector in plane

This class can be used to create a vector for any entity with x and y as x and y points in canvas plane. The canvas plane follows cartesian coordinate system but with origin at top left corner and positive x-axis along right direction and positive y-axis along downward direction.

For ex: Here representation of position vector in canvas plane could be given as - val position = Vector2D(25f, 25f)

Constructors

Vector2D

Vector2D Vector2D(Float x, Float y)

Types

Companion

public class Companion

Functions

equals

Boolean equals(Object other)

Equals method to check the equality between two vectors

getX

final Float getX()

getY

final Float getY()

hashCode

Integer hashCode()

setX

final Unit setX(Float x)

setY

final Unit setY(Float y)

Properties

private Float x

private Float y

Extensions

add

final Vector2D add(Vector2D other)

addWithScalarMultiply

final Vector2D addWithScalarMultiply(Vector2D other, Float scalar)

To add a vector to this vector and multiplies the other vector with scalar

angleBetween

final Float angleBetween(Vector2D other)

Returns angle between this vector and other vector

dec

final Vector2D dec(Float factor)

Decrements this vector by factor

distance

final Float distance(Vector2D other)

Calculates Euclidean distance between two vectors

div

final Vector2D div(Float x, Float y)

To divide this vector by x and y values

divAssign

final Unit divAssign(Float factor)

divide

final Vector2D divide(Float factor)

To divide this vector by single factor

dot

final Float dot(Vector2D other)

Calculates the dot product of two vectors

heading

final Float heading()

Calculate the angle of rotation for this vector(only 2D vectors).

inc

final Vector2D inc(Float factor)

Increments this vector by factor

lerp

final Vector2D lerp(Float x, Float y, Float amt)

Linear interpolate the vector to another vector

limit

final Vector2D limit(Float max)

Limit the magnitude of this vector to the value used for the max parameter. val v = Vector2D(10, 20); // v has components 10.0, 20.0 v.limit(5); // v's components are set to // 2.2271771, 4.4543543

mag

final Float mag()

Calculates the magnitude (length) of the vector and returns the result asa float

magSq

final Float magSq()

Calculates the squared magnitude of this vector and returns the result as a float

minusAssign

final Unit minusAssign(Vector2D other)

multiply

final Vector2D multiply(Float x, Float y)

To multiply this vector with x factor and y factor

final Vector2D multiply(Float factor)