com.almasb.fxgl.core.math

Class Vec2

java.lang.Object

com.almasb.fxgl.core.math.Vec2

All Implemented Interfaces:

Poolable, Serializable

public final class Vec2
extends Object
implements Serializable, Poolable

A 2D column vector with float precision. Can be used to represent a point in 2D space. Can be used instead of JavaFX Point2D to avoid object allocations. This is also preferred for private or scoped fields. Source: jbox2d.

Author:

Almas Baimagambetov (almaslvl@gmail.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
float	x
float	y

Constructor Summary

Constructors

Constructor and Description
Vec2()
Vec2(double x, double y) Convenience ctor for double values.
Vec2(float x, float y)
Vec2(javafx.geometry.Point2D toCopy)
Vec2(Vec2 toCopy)

Method Summary

Modifier and Type	Method and Description
Vec2	abs()
static Vec2	abs(Vec2 a)
Vec2	absLocal() Modify this vector to have only positive components.
static void	absToOut(Vec2 a, Vec2 out)
Vec2	add(double otherX, double otherY) Return the sum of this vector and another; does not alter either one.
Vec2	add(javafx.geometry.Point2D vector) Return the sum of this vector and another; does not alter either one.
Vec2	add(Vec2 v) Return the sum of this vector and another; does not alter either one.
Vec2	addLocal(double x, double y) Adds values to this vector and returns result - alters this vector.
Vec2	addLocal(Vec2 v) Add another vector to this one and returns result - alters this vector.
float	angle()
float	angle(double otherX, double otherY)
float	angle(javafx.geometry.Point2D other)
float	angle(Vec2 other)
Vec2	clone()
Vec2	copy()
static Vec2	cross(float s, Vec2 a)
static Vec2	cross(Vec2 a, float s)
static float	cross(Vec2 a, Vec2 b)
static void	crossToOut(float s, Vec2 a, Vec2 out)
static void	crossToOut(Vec2 a, float s, Vec2 out)
static void	crossToOutUnsafe(float s, Vec2 a, Vec2 out)
static void	crossToOutUnsafe(Vec2 a, float s, Vec2 out)
double	distance(double otherX, double otherY)
double	distance(javafx.geometry.Point2D other)
double	distance(Vec2 other)
boolean	distanceGreaterThanOrEqual(double otherX, double otherY, double distance)
boolean	distanceLessThanOrEqual(double otherX, double otherY, double distance)
double	distanceSquared(double otherX, double otherY)
static float	dot(Vec2 a, Vec2 b)
boolean	equals(Object obj)
boolean	equalsPoint2D(javafx.geometry.Point2D p)
static Vec2	fromAngle(double degrees)
int	hashCode()
boolean	isValid() True if the vector represents a pair of valid, non-infinite floating point numbers.
float	length()
float	lengthSquared()
static Vec2	max(Vec2 a, Vec2 b)
static void	maxToOut(Vec2 a, Vec2 b, Vec2 out)
Vec2	midpoint(javafx.geometry.Point2D other)
Vec2	midpoint(Vec2 other)
static Vec2	min(Vec2 a, Vec2 b)
static void	minToOut(Vec2 a, Vec2 b, Vec2 out)
Vec2	mul(double a) Return this vector multiplied by a scalar; does not alter this vector.
Vec2	mulLocal(double a) Multiply this vector by a number and return result - alters this vector.
Vec2	negate() Return the negation of this vector; does not alter this vector.
Vec2	negateLocal() Flip the vector and return it - alters this vector.
static void	negateToOut(Vec2 a, Vec2 out)
float	normalize() Normalize this vector and return the length before normalization.
Vec2	normalizeLocal() Normalizes and returns this vector.
Vec2	normalizeVec()
void	reset() Resets the object for reuse.
Vec2	set(float x, float y) Set this vector component-wise.
Vec2	set(javafx.geometry.Point2D vector) Set this vector to another vector.
Vec2	set(Vec2 v) Set this vector to another vector.
Vec2	setFromAngle(double degrees) Set this vector from angle.
void	setZero() Zero out this vector.
Vec2	skew() Get the skew vector such that dot(skew_vec, other) == cross(vec, other).
void	skew(Vec2 out) Get the skew vector such that dot(skew_vec, other) == cross(vec, other); does not alter this vector.
Vec2	sub(double otherX, double otherY) Return the difference of this vector and another; does not alter either one.
Vec2	sub(javafx.geometry.Point2D vector) Return the difference of this vector and another; does not alter either one.
Vec2	sub(Vec2 v) Return the difference of this vector and another; does not alter either one.
Vec2	subLocal(double x, double y) Subtract another vector from this one and return result - alters this vector.
Vec2	subLocal(Vec2 v) Subtract another vector from this one and return result - alters this vector.
javafx.geometry.Point2D	toPoint2D() Note: object allocation.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

public float x

y

public float y

Constructor Detail

Vec2

public Vec2()

Vec2

public Vec2(float x,
            float y)

Vec2

public Vec2(double x,
            double y)

Convenience ctor for double values. Note: values will be typecast to float.

Parameters:

x - x component

y - y component

Vec2

public Vec2(Vec2 toCopy)

Vec2

public Vec2(javafx.geometry.Point2D toCopy)

Method Detail

setZero

public void setZero()

Zero out this vector.

set

public Vec2 set(float x,
                float y)

Set this vector component-wise.

Parameters:

x - x component

y - y component

Returns:

this vector

set

public Vec2 set(Vec2 v)

Set this vector to another vector.

Returns:

this vector

set

public Vec2 set(javafx.geometry.Point2D vector)

Set this vector to another vector.

Returns:

this vector

setFromAngle

public Vec2 setFromAngle(double degrees)

Set this vector from angle.

Parameters:

degrees - angle in degrees

Returns:

this vector

add

public Vec2 add(Vec2 v)

Return the sum of this vector and another; does not alter either one.

Returns:

new vector

add

public Vec2 add(javafx.geometry.Point2D vector)

Return the sum of this vector and another; does not alter either one.

Returns:

new vector

add

public Vec2 add(double otherX,
                double otherY)

Return the sum of this vector and another; does not alter either one.

Returns:

new vector

sub

public Vec2 sub(Vec2 v)

Return the difference of this vector and another; does not alter either one.

Returns:

new vector

sub

public Vec2 sub(javafx.geometry.Point2D vector)

Return the difference of this vector and another; does not alter either one.

Returns:

new vector

sub

public Vec2 sub(double otherX,
                double otherY)

Return the difference of this vector and another; does not alter either one.

Returns:

new vector

mul

public Vec2 mul(double a)

Return this vector multiplied by a scalar; does not alter this vector.

Returns:

new vector

negate

public Vec2 negate()

Return the negation of this vector; does not alter this vector.

Returns:

new vector

negateLocal

public Vec2 negateLocal()

Flip the vector and return it - alters this vector.

Returns:

this vector

addLocal

public Vec2 addLocal(Vec2 v)

Add another vector to this one and returns result - alters this vector.

Returns:

this vector

addLocal

public Vec2 addLocal(double x,
                     double y)

Adds values to this vector and returns result - alters this vector.

Returns:

this vector

subLocal

public Vec2 subLocal(Vec2 v)

Subtract another vector from this one and return result - alters this vector.

Returns:

this vector

subLocal

public Vec2 subLocal(double x,
                     double y)

Subtract another vector from this one and return result - alters this vector.

Returns:

this vector

mulLocal

public Vec2 mulLocal(double a)

Multiply this vector by a number and return result - alters this vector.

Returns:

this vector

skew

public Vec2 skew()

Get the skew vector such that dot(skew_vec, other) == cross(vec, other).

Returns:

new vector

skew

public void skew(Vec2 out)

Get the skew vector such that dot(skew_vec, other) == cross(vec, other); does not alter this vector.

Parameters:

out - the out vector to alter

length

public float length()

Returns:

the length of this vector

lengthSquared

public float lengthSquared()

Returns:

the squared length of this vector

distance

public double distance(Vec2 other)

distance

public double distance(javafx.geometry.Point2D other)

distance

public double distance(double otherX,
                       double otherY)

distanceSquared

public double distanceSquared(double otherX,
                              double otherY)

distanceLessThanOrEqual

public boolean distanceLessThanOrEqual(double otherX,
                                       double otherY,
                                       double distance)

distanceGreaterThanOrEqual

public boolean distanceGreaterThanOrEqual(double otherX,
                                          double otherY,
                                          double distance)

normalizeVec

public Vec2 normalizeVec()

Returns:

new normalized vector

normalize

public float normalize()

Normalize this vector and return the length before normalization. Alters this vector.

Returns:

length before normalization

normalizeLocal

public Vec2 normalizeLocal()

Normalizes and returns this vector. Alters this vector.

Returns:

this vector

midpoint

public Vec2 midpoint(Vec2 other)

midpoint

public Vec2 midpoint(javafx.geometry.Point2D other)

isValid

public boolean isValid()

True if the vector represents a pair of valid, non-infinite floating point numbers.

abs

public Vec2 abs()

Returns:

new vector that has positive components

absLocal

public Vec2 absLocal()

Modify this vector to have only positive components.

Returns:

this vector

angle

public float angle()

Returns:

angle in degrees (-180, 180] between this vector and X axis (1, 0)

angle

public float angle(Vec2 other)

Parameters:

other - other vector

Returns:

angle in degrees (-180, 180] between this vector and other

angle

public float angle(javafx.geometry.Point2D other)

Parameters:

other - other vector

Returns:

angle in degrees (-180, 180] between this vector and other

angle

public float angle(double otherX,
                   double otherY)

Parameters:

otherX - x component of other vector

otherY - y component of other vector

Returns:

angle in degrees (-180, 180] between this vector and other

clone

public Vec2 clone()

Overrides:

clone in class Object

Returns:

a copy of this vector

copy

public Vec2 copy()

Returns:

a copy of this vector (new instance)

toPoint2D

public javafx.geometry.Point2D toPoint2D()

Note: object allocation.

Returns:

JavaFX Point2D representation

toString

public String toString()

Overrides:

toString in class Object

reset

public void reset()

Description copied from interface: Poolable

Resets the object for reuse. Object references should be nulled and fields may be set to default values.

Specified by:

reset in interface Poolable

fromAngle

public static Vec2 fromAngle(double degrees)

abs

public static Vec2 abs(Vec2 a)

absToOut

public static void absToOut(Vec2 a,
                            Vec2 out)

dot

public static float dot(Vec2 a,
                        Vec2 b)

cross

public static float cross(Vec2 a,
                          Vec2 b)

cross

public static Vec2 cross(Vec2 a,
                         float s)

crossToOut

public static void crossToOut(Vec2 a,
                              float s,
                              Vec2 out)

crossToOutUnsafe

public static void crossToOutUnsafe(Vec2 a,
                                    float s,
                                    Vec2 out)

cross

public static Vec2 cross(float s,
                         Vec2 a)

crossToOut

public static void crossToOut(float s,
                              Vec2 a,
                              Vec2 out)

crossToOutUnsafe

public static void crossToOutUnsafe(float s,
                                    Vec2 a,
                                    Vec2 out)

negateToOut

public static void negateToOut(Vec2 a,
                               Vec2 out)

min

public static Vec2 min(Vec2 a,
                       Vec2 b)

max

public static Vec2 max(Vec2 a,
                       Vec2 b)

minToOut

public static void minToOut(Vec2 a,
                            Vec2 b,
                            Vec2 out)

maxToOut

public static void maxToOut(Vec2 a,
                            Vec2 b,
                            Vec2 out)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsPoint2D

public boolean equalsPoint2D(javafx.geometry.Point2D p)

Parameters:

p - Point2D representation

Returns:

true if vector equals Point2D given default error tolerance for float comparison