Package org.jbox2d.common

Class Vec2

java.lang.Object

org.jbox2d.common.Vec2

All Implemented Interfaces:

Serializable

public class Vec2
extends Object
implements Serializable

A 2D column vector.

Author:

Daniel Murphy

See Also:

• Serialized Form

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 40 - 129

Field Summary

Fields

Modifier and Type	Field	Description
float	x
float	y

Constructor Summary

Constructors

Constructor	Description
Vec2()	Default constructor does nothing (for performance).
Vec2(float x, float y)	Construct using coordinates.
Vec2(Vec2 toCopy)

Method Summary

Modifier and Type	Method	Description
final Vec2	abs()	Return a new vector that has positive components.
static Vec2	abs(Vec2 a)
final void	absLocal()
static void	absToOut(Vec2 a, Vec2 out)
final Vec2	add(Vec2 v)	Return the sum of this vector and another; does not alter either one.
final Vec2	addLocal(float x, float y)	Adds values to this vector and returns result - alters this vector.
final Vec2	addLocal(Vec2 v)	Add another vector to this one and returns result - alters this vector.
final Vec2	clone()	Return a copy of this vector.
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)
static float	dot(Vec2 a, Vec2 b)
boolean	equals(Object obj)
int	hashCode()
final boolean	isValid()	Does this vector contain finite coordinates?
final float	length()	Get the length of this vector (the norm).
final float	lengthSquared()	Get the length squared.
static Vec2	max(Vec2 a, Vec2 b)
static void	maxToOut(Vec2 a, Vec2 b, Vec2 out)
static Vec2	min(Vec2 a, Vec2 b)
static void	minToOut(Vec2 a, Vec2 b, Vec2 out)
final Vec2	mul(float a)	Return this vector multiplied by a scalar; does not alter this vector.
final Vec2	mulLocal(float a)	Multiply this vector by a number and return result - alters this vector.
final Vec2	negate()	Return the negation of this vector; does not alter this vector.
final Vec2	negateLocal()	Flip the vector and return it - alters this vector.
static void	negateToOut(Vec2 a, Vec2 out)
final float	normalize()	Convert this vector into a unit vector.
final Vec2	set(float x, float y)	Set the vector component-wise.
final Vec2	set(Vec2 v)	Set this vector to another vector.
final void	setZero()	Zero out this vector.
final Vec2	skew()	Get the skew vector such that dot(skew_vec, other) == cross(vec, other)
final void	skew(Vec2 out)	Get the skew vector such that dot(skew_vec, other) == cross(vec, other)
final Vec2	sub(Vec2 v)	Return the difference of this vector and another; does not alter either one.
final Vec2	subLocal(Vec2 v)	Subtract another vector from this one and return result - alters this vector.
final String	toString()

Methods inherited from class java.lang.Object

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

Field Details

x

public float x

y

public float y

Constructor Details

Vec2

public Vec2()

Default constructor does nothing (for performance).

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 43 - 44

Vec2

public Vec2(float x,
 float y)

Construct using coordinates.

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 46 - 47

Vec2

public Vec2(Vec2 toCopy)

Method Details

setZero

public final void setZero()

Zero out this vector.

set

public final Vec2 set(float x,
 float y)

Set the vector component-wise.

set

public final Vec2 set(Vec2 v)

Set this vector to another vector.

add

public final Vec2 add(Vec2 v)

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

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 149 - 153

sub

public final Vec2 sub(Vec2 v)

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

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 155 - 159

mul

public final Vec2 mul(float a)

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

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 161 - 165

negate

public final Vec2 negate()

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

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 146 - 147

negateLocal

public final Vec2 negateLocal()

Flip the vector and return it - alters this vector.

addLocal

public final Vec2 addLocal(Vec2 v)

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

addLocal

public final Vec2 addLocal(float x,
 float y)

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

subLocal

public final Vec2 subLocal(Vec2 v)

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

mulLocal

public final Vec2 mulLocal(float a)

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

skew

public final Vec2 skew()

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

skew

public final void skew(Vec2 out)

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

length

public final float length()

Get the length of this vector (the norm). Return the length of this vector.

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 88 - 92

lengthSquared

public final float lengthSquared()

Get the length squared. For performance, use this instead of length(). Return the squared length of this vector.

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 94 - 99

normalize

public final float normalize()

Convert this vector into a unit vector. Returns the length. Normalize this vector and return the length before normalization. Alters this vector.

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 101 - 114

isValid

public final boolean isValid()

Does this vector contain finite coordinates? True if the vector represents a pair of valid, non-infinite floating point numbers.

Repolink:

Github: erincatto/box2d include/box2d/b2_math.h Lines 116 - 120

abs

public final Vec2 abs()

Return a new vector that has positive components.

absLocal

public final void absLocal()

clone

public final Vec2 clone()

Return a copy of this vector.

Overrides:

clone in class Object

toString

public final String toString()

Overrides:

toString in class Object

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

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)