libGDX 1.14.2 · com.badlogic.gdx.math.Vector2 · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final Vector2	One
private static final long	serialVersionUID
public static final Vector2	X
public float	x the x-component of this vector
public static final Vector2	Y
public float	y the y-component of this vector
public static final Vector2	Zero

Access	Constructor and Description
public	Vector2() Constructs a new vector at (0,0)
public	Vector2(float The x-component x, float The y-component y) Constructs a vector with the given components
public	Vector2(Vector2 The vector v) Constructs a vector from the given vector

Method Summary

Modifier and Type	Method and Description
public Vector2	add(Vector2 v) Implements com.badlogic.gdx.math.Vector.add. Adds the given vector to this vector
public Vector2	Returns: This vector for chaining add(float The x-component x, float The y-component y) Adds the given components to this vector
public float	angle() Deprecated use `angleDeg()` instead. Returns: the angle in degrees of this vector (point) relative to the x-axis.
public float	angle(Vector2 reference) Deprecated use `angleDeg(Vector2)` instead. Beware of the changes in returned angle to counter-clockwise and the range. Returns: the angle in degrees of this vector (point) relative to the given vector.
public float	angleDeg() Returns: the angle in degrees of this vector (point) relative to the x-axis.
public float	angleDeg(Vector2 reference) Returns: the angle in degrees of this vector (point) relative to the given vector.
public static float	angleDeg(float x, float y) Returns: the angle in degrees of this vector (point) relative to the x-axis.
public float	angleRad() Returns: the angle in radians of this vector (point) relative to the x-axis.
public float	angleRad(Vector2 reference) Returns: the angle in radians of this vector (point) relative to the given vector.
public static float	angleRad(float x, float y) Returns: the angle in radians of this vector (point) relative to the x-axis.
public Vector2	clamp(float min, float max) Implements com.badlogic.gdx.math.Vector.clamp. Clamps this vector's length to given min and max values
public Vector2	cpy() Implements com.badlogic.gdx.math.Vector.cpy.
public float	Returns: the cross product crs(Vector2 the other vector v) Calculates the 2D cross product between this and the given vector.
public float	Returns: the cross product crs(float the x-coordinate of the other vector x, float the y-coordinate of the other vector y) Calculates the 2D cross product between this and the given vector.
public static float	dot(float x1, float y1, float x2, float y2)
public float	dot(Vector2 v) Implements com.badlogic.gdx.math.Vector.dot.
public float	dot(float ox, float oy)
public static float	dst(float x1, float y1, float x2, float y2)
public float	dst(Vector2 v) Implements com.badlogic.gdx.math.Vector.dst.
public float	dst(float The x-component of the other vector x, float The y-component of the other vector y) Returns: the distance between this and the other vector
public static float	dst2(float x1, float y1, float x2, float y2)
public float	dst2(Vector2 v) Implements com.badlogic.gdx.math.Vector.dst2. This method is faster than `Vector#dst(Vector)` because it avoids calculating a square root.
public float	dst2(float The x-component of the other vector x, float The y-component of the other vector y) Returns: the squared distance between this and the other vector
public boolean	epsilonEquals(Vector2 other, float epsilon) Implements com.badlogic.gdx.math.Vector.epsilonEquals. Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing.
public boolean	Returns: whether the vectors are the same. epsilonEquals(float x, float y, float epsilon) Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing.
public boolean	Returns: true if vector are equal, otherwise false epsilonEquals(final Vector2 other vector to compare other) Compares this vector with the other vector using MathUtils.FLOAT_ROUNDING_ERROR for fuzzy equality testing
public boolean	Returns: true if vector are equal, otherwise false epsilonEquals(float x component of the other vector to compare x, float y component of the other vector to compare y) Implements com.badlogic.gdx.math.Vector.epsilonEquals. Compares this vector with the other vector using MathUtils.FLOAT_ROUNDING_ERROR for fuzzy equality testing
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Vector2	Returns: this vector for chaining fromString(String the string. v) Sets this `Vector2` to the value represented by the specified string according to the format of `toString()`.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasOppositeDirection(Vector2 vector) Implements com.badlogic.gdx.math.Vector.hasOppositeDirection.
public boolean	hasSameDirection(Vector2 vector) Implements com.badlogic.gdx.math.Vector.hasSameDirection.
public boolean	Returns: Whether this and the other vector are equal with exact precision idt(final Vector2 The other vector vector) Returns true if this vector and the vector parameter have identical components.
public Vector2	interpolate(Vector2 target, float alpha, Interpolation interpolation) Implements com.badlogic.gdx.math.Vector.interpolate. Interpolates between this vector and the given target vector by alpha (within range [0,1]) using the given Interpolation method.
public boolean	isCollinear(Vector2 other, float epsilon) Implements com.badlogic.gdx.math.Vector.isCollinear.
public boolean	isCollinear(Vector2 other) Implements com.badlogic.gdx.math.Vector.isCollinear.
public boolean	isCollinearOpposite(Vector2 other, float epsilon) Implements com.badlogic.gdx.math.Vector.isCollinearOpposite.
public boolean	isCollinearOpposite(Vector2 other) Implements com.badlogic.gdx.math.Vector.isCollinearOpposite.
public boolean	isOnLine(Vector2 other) Implements com.badlogic.gdx.math.Vector.isOnLine.
public boolean	isOnLine(Vector2 other, float epsilon) Implements com.badlogic.gdx.math.Vector.isOnLine.
public boolean	isPerpendicular(Vector2 vector) Implements com.badlogic.gdx.math.Vector.isPerpendicular.
public boolean	isPerpendicular(Vector2 vector, float epsilon) Implements com.badlogic.gdx.math.Vector.isPerpendicular.
public boolean	isUnit() Implements com.badlogic.gdx.math.Vector.isUnit.
public boolean	isUnit(final float margin) Implements com.badlogic.gdx.math.Vector.isUnit.
public boolean	isZero() Implements com.badlogic.gdx.math.Vector.isZero.
public boolean	isZero(final float margin) Implements com.badlogic.gdx.math.Vector.isZero.
public static float	len(float x, float y)
public float	len() Implements com.badlogic.gdx.math.Vector.len.
public static float	len2(float x, float y)
public float	len2() Implements com.badlogic.gdx.math.Vector.len2. This method is faster than `Vector#len()` because it avoids calculating a square root.
public Vector2	lerp(Vector2 target, float alpha) Implements com.badlogic.gdx.math.Vector.lerp. Linearly interpolates between this vector and the target vector by alpha which is in the range [0,1].
public Vector2	limit(float limit) Implements com.badlogic.gdx.math.Vector.limit. Limits the length of this vector, based on the desired maximum length.
public Vector2	limit2(float limit2) Implements com.badlogic.gdx.math.Vector.limit2. Limits the length of this vector, based on the desired maximum length squared.
public Vector2	Returns: this vector mul(Matrix3 the matrix mat) Left-multiplies this vector by the given matrix
public Vector2	mulAdd(Vector2 vec, float scalar) Implements com.badlogic.gdx.math.Vector.mulAdd, com.badlogic.gdx.math.Vector.mulAdd. First scale a supplied vector, then add it to this vector.
public Vector2	mulAdd(Vector2 vec, Vector2 mulVec) Implements com.badlogic.gdx.math.Vector.mulAdd. First scale a supplied vector, then add it to this vector.
public Vector2	nor() Implements com.badlogic.gdx.math.Vector.nor. Normalizes this vector.
public Vector2	rotate(float the angle in degrees degrees) Deprecated use `rotateDeg(float)` instead. Rotates the Vector2 by the given angle, counter-clockwise assuming the y-axis points up.
public Vector2	rotate90(int dir) Rotates the Vector2 by 90 degrees in the specified direction, where >= 0 is counter-clockwise and < 0 is clockwise.
public Vector2	rotateAround(Vector2 center Vector2 reference, float the angle in degrees degrees) Deprecated use `rotateAroundDeg(Vector2, float)` instead. Rotates the Vector2 by the given angle around reference vector, counter-clockwise assuming the y-axis points up.
public Vector2	rotateAroundDeg(Vector2 center Vector2 reference, float the angle in degrees degrees) Rotates the Vector2 by the given angle around reference vector, counter-clockwise assuming the y-axis points up.
public Vector2	rotateAroundRad(Vector2 center Vector2 reference, float the angle in radians radians) Rotates the Vector2 by the given angle around reference vector, counter-clockwise assuming the y-axis points up.
public Vector2	rotateDeg(float the angle in degrees degrees) Rotates the Vector2 by the given angle, counter-clockwise assuming the y-axis points up.
public Vector2	rotateRad(float the angle in radians radians) Rotates the Vector2 by the given angle, counter-clockwise assuming the y-axis points up.
public Vector2	scl(float scalar) Implements com.badlogic.gdx.math.Vector.scl, com.badlogic.gdx.math.Vector.scl. Scales this vector by a scalar
public Vector2	Returns: This vector for chaining scl(float x, float y) Multiplies this vector by a scalar
public Vector2	scl(Vector2 v) Implements com.badlogic.gdx.math.Vector.scl. Scales this vector by another vector
public Vector2	set(Vector2 v) Implements com.badlogic.gdx.math.Vector.set. Sets this vector from the given vector
public Vector2	Returns: This vector for chaining set(float The x-component x, float The y-component y) Sets the components of this vector
public Vector2	setAngle(float The angle in degrees to set. degrees) Deprecated use `setAngleDeg(float)` instead. Sets the angle of the vector in degrees relative to the x-axis, towards the positive y-axis (typically counter-clockwise).
public Vector2	setAngleDeg(float The angle in degrees to set. degrees) Sets the angle of the vector in degrees relative to the x-axis, towards the positive y-axis (typically counter-clockwise).
public Vector2	setAngleRad(float The angle in radians to set. radians) Sets the angle of the vector in radians relative to the x-axis, towards the positive y-axis (typically counter-clockwise).
public Vector2	setLength(float len) Implements com.badlogic.gdx.math.Vector.setLength. Sets the length of this vector.
public Vector2	setLength2(float len2) Implements com.badlogic.gdx.math.Vector.setLength2. Sets the length of this vector, based on the square of the desired length.
public Vector2	setToRandomDirection() Implements com.badlogic.gdx.math.Vector.setToRandomDirection. Sets this vector to the unit vector with a random direction
public Vector2	setZero() Implements com.badlogic.gdx.math.Vector.setZero. Sets the components of this vector to 0
public Vector2	sub(Vector2 v) Implements com.badlogic.gdx.math.Vector.sub. Subtracts the given vector from this vector.
public Vector2	Returns: This vector for chaining sub(float The x-component of the other vector x, float The y-component of the other vector y) Subtracts the other vector from this vector.
public String	Returns: a string representation of this object. toString() Overrides java.lang.Object.toString. Converts this `Vector2` to a string in the format `(x,y)`.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

One	back to summary
public static final Vector2 One

serialVersionUID	back to summary
private static final long serialVersionUID

X	back to summary
public static final Vector2 X

x	back to summary
public float x the x-component of this vector

Y	back to summary
public static final Vector2 Y

y	back to summary
public float y the y-component of this vector

Zero	back to summary
public static final Vector2 Zero

Vector2	back to summary
public Vector2() Constructs a new vector at (0,0)

Vector2	back to summary
public Vector2(float x, float y) Constructs a vector with the given components Parameters x:float The x-component y:float The y-component

Vector2	back to summary
public Vector2(Vector2 v) Constructs a vector from the given vector Parameters v:Vector2 The vector

Method Detail

add	back to summary
public Vector2 add(Vector2 v) Implements com.badlogic.gdx.math.Vector.add. Doc from com.badlogic.gdx.math.Vector.add. Adds the given vector to this vector Annotations @Override

add

back to summary

public Vector2 add(Vector2 v)

Implements com.badlogic.gdx.math.Vector.add.

Doc from com.badlogic.gdx.math.Vector.add.

Adds the given vector to this vector

Annotations

@Override

add	back to summary
public Vector2 add(float x, float y) Adds the given components to this vector Parameters x:float The x-component y:float The y-component Returns:Vector2 This vector for chaining

add

back to summary

public Vector2 add(float x, float y)

Adds the given components to this vector

Parameters

x:float: The x-component
y:float: The y-component

Returns:Vector2

This vector for chaining

angle	back to summary
public float angle() Deprecated use `angleDeg()` instead. Returns:float the angle in degrees of this vector (point) relative to the x-axis. Angles are towards the positive y-axis (typically counter-clockwise) and between 0 and 360. Annotations @Deprecated

angle	back to summary
public float angle(Vector2 reference) Deprecated use `angleDeg(Vector2)` instead. Beware of the changes in returned angle to counter-clockwise and the range. Returns:float the angle in degrees of this vector (point) relative to the given vector. Angles are towards the negative y-axis (typically clockwise) between -180 and +180 Annotations @Deprecated

angleDeg	back to summary
public float angleDeg() Returns:float the angle in degrees of this vector (point) relative to the x-axis. Angles are towards the positive y-axis (typically counter-clockwise) and in the [0, 360) range.

angleDeg	back to summary
public float angleDeg(Vector2 reference) Returns:float the angle in degrees of this vector (point) relative to the given vector. Angles are towards the positive y-axis (typically counter-clockwise.) in the [0, 360) range

angleDeg	back to summary
public static float angleDeg(float x, float y) Returns:float the angle in degrees of this vector (point) relative to the x-axis. Angles are towards the positive y-axis (typically counter-clockwise) and in the [0, 360) range.

angleRad	back to summary
public float angleRad() Returns:float the angle in radians of this vector (point) relative to the x-axis. Angles are towards the positive y-axis. (typically counter-clockwise)

angleRad	back to summary
public float angleRad(Vector2 reference) Returns:float the angle in radians of this vector (point) relative to the given vector. Angles are towards the positive y-axis. (typically counter-clockwise.)

angleRad	back to summary
public static float angleRad(float x, float y) Returns:float the angle in radians of this vector (point) relative to the x-axis. Angles are towards the positive y-axis. (typically counter-clockwise)

clamp	back to summary
public Vector2 clamp(float min, float max) Implements com.badlogic.gdx.math.Vector.clamp. Doc from com.badlogic.gdx.math.Vector.clamp. Clamps this vector's length to given min and max values Annotations @Override

clamp

back to summary

public Vector2 clamp(float min, float max)

Implements com.badlogic.gdx.math.Vector.clamp.

Doc from com.badlogic.gdx.math.Vector.clamp.

Clamps this vector's length to given min and max values

Annotations

@Override

cpy	back to summary
public Vector2 cpy() Implements com.badlogic.gdx.math.Vector.cpy. Annotations @Override

cpy

back to summary

public Vector2 cpy()

Implements com.badlogic.gdx.math.Vector.cpy.

Annotations

@Override

crs	back to summary
public float crs(Vector2 v) Calculates the 2D cross product between this and the given vector. Parameters v:Vector2 the other vector Returns:float the cross product

crs

back to summary

public float crs(Vector2 v)

Calculates the 2D cross product between this and the given vector.

Parameters

v:Vector2: the other vector

Returns:float

the cross product

crs	back to summary
public float crs(float x, float y) Calculates the 2D cross product between this and the given vector. Parameters x:float the x-coordinate of the other vector y:float the y-coordinate of the other vector Returns:float the cross product

crs

back to summary

public float crs(float x, float y)

Calculates the 2D cross product between this and the given vector.

Parameters

x:float: the x-coordinate of the other vector
y:float: the y-coordinate of the other vector

Returns:float

the cross product

dot	back to summary
public static float dot(float x1, float y1, float x2, float y2)

dot	back to summary
public float dot(Vector2 v) Implements com.badlogic.gdx.math.Vector.dot. Annotations @Override

dot

back to summary

public float dot(Vector2 v)

Implements com.badlogic.gdx.math.Vector.dot.

Annotations

@Override

dot	back to summary
public float dot(float ox, float oy)

dst	back to summary
public static float dst(float x1, float y1, float x2, float y2)

dst	back to summary
public float dst(Vector2 v) Implements com.badlogic.gdx.math.Vector.dst. Annotations @Override

dst

back to summary

public float dst(Vector2 v)

Implements com.badlogic.gdx.math.Vector.dst.

Annotations

@Override

dst	back to summary
public float dst(float x, float y) Parameters x:float The x-component of the other vector y:float The y-component of the other vector Returns:float the distance between this and the other vector

dst2	back to summary
public static float dst2(float x1, float y1, float x2, float y2)

dst2 back to summary

dst2	back to summary
public float dst2(Vector2 v) Implements com.badlogic.gdx.math.Vector.dst2. Doc from com.badlogic.gdx.math.Vector.dst2. This method is faster than `Vector#dst(Vector)` because it avoids calculating a square root. It is useful for comparisons, but not for getting accurate distances, as the return value is the square of the actual distance. Annotations @Override

public float dst2(Vector2 v)

Implements com.badlogic.gdx.math.Vector.dst2.

Doc from com.badlogic.gdx.math.Vector.dst2.

This method is faster than Vector#dst(Vector) because it avoids calculating a square root. It is useful for comparisons, but not for getting accurate distances, as the return value is the square of the actual distance.

Annotations

@Override

dst2	back to summary
public float dst2(float x, float y) Parameters x:float The x-component of the other vector y:float The y-component of the other vector Returns:float the squared distance between this and the other vector

epsilonEquals	back to summary
public boolean epsilonEquals(Vector2 other, float epsilon) Implements com.badlogic.gdx.math.Vector.epsilonEquals. Doc from com.badlogic.gdx.math.Vector.epsilonEquals. Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing. Annotations @Override

epsilonEquals

back to summary

public boolean epsilonEquals(Vector2 other, float epsilon)

Implements com.badlogic.gdx.math.Vector.epsilonEquals.

Doc from com.badlogic.gdx.math.Vector.epsilonEquals.

Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing.

Annotations

@Override

epsilonEquals	back to summary
public boolean epsilonEquals(float x, float y, float epsilon) Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing. Returns:boolean whether the vectors are the same.

epsilonEquals

back to summary

public boolean epsilonEquals(float x, float y, float epsilon)

Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing.

Returns:boolean: whether the vectors are the same.

epsilonEquals	back to summary
public boolean epsilonEquals(final Vector2 other) Compares this vector with the other vector using MathUtils.FLOAT_ROUNDING_ERROR for fuzzy equality testing Parameters other:Vector2 other vector to compare Returns:boolean true if vector are equal, otherwise false

epsilonEquals

back to summary

public boolean epsilonEquals(final Vector2 other)

Compares this vector with the other vector using MathUtils.FLOAT_ROUNDING_ERROR for fuzzy equality testing

Parameters

other:Vector2: other vector to compare

Returns:boolean

true if vector are equal, otherwise false

epsilonEquals	back to summary
public boolean epsilonEquals(float x, float y) Implements com.badlogic.gdx.math.Vector.epsilonEquals. Compares this vector with the other vector using MathUtils.FLOAT_ROUNDING_ERROR for fuzzy equality testing Parameters x:float x component of the other vector to compare y:float y component of the other vector to compare Returns:boolean true if vector are equal, otherwise false

epsilonEquals

back to summary

public boolean epsilonEquals(float x, float y)

Implements com.badlogic.gdx.math.Vector.epsilonEquals.

Compares this vector with the other vector using MathUtils.FLOAT_ROUNDING_ERROR for fuzzy equality testing

Parameters

x:float: x component of the other vector to compare
y:float: y component of the other vector to compare

Returns:boolean

true if vector are equal, otherwise false

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

fromString back to summary

fromString	back to summary
public Vector2 fromString(String v) Sets this `Vector2` to the value represented by the specified string according to the format of `toString()`. Parameters v:String the string. Returns:Vector2 this vector for chaining

public Vector2 fromString(String v)

Sets this Vector2 to the value represented by the specified string according to the format of toString().

Parameters

v:String: the string.

Returns:Vector2

this vector for chaining

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

hasOppositeDirection	back to summary
public boolean hasOppositeDirection(Vector2 vector) Implements com.badlogic.gdx.math.Vector.hasOppositeDirection. Annotations @Override

hasOppositeDirection

back to summary

public boolean hasOppositeDirection(Vector2 vector)

Implements com.badlogic.gdx.math.Vector.hasOppositeDirection.

Annotations

@Override

hasSameDirection	back to summary
public boolean hasSameDirection(Vector2 vector) Implements com.badlogic.gdx.math.Vector.hasSameDirection. Annotations @Override

hasSameDirection

back to summary

public boolean hasSameDirection(Vector2 vector)

Implements com.badlogic.gdx.math.Vector.hasSameDirection.

Annotations

@Override

idt	back to summary
public boolean idt(final Vector2 vector) Returns true if this vector and the vector parameter have identical components. Parameters vector:Vector2 The other vector Returns:boolean Whether this and the other vector are equal with exact precision

idt

back to summary

public boolean idt(final Vector2 vector)

Returns true if this vector and the vector parameter have identical components.

Parameters

vector:Vector2: The other vector

Returns:boolean

Whether this and the other vector are equal with exact precision

interpolate	back to summary
public Vector2 interpolate(Vector2 target, float alpha, Interpolation interpolation) Implements com.badlogic.gdx.math.Vector.interpolate. Doc from com.badlogic.gdx.math.Vector.interpolate. Interpolates between this vector and the given target vector by alpha (within range [0,1]) using the given Interpolation method. the result is stored in this vector. Annotations @Override

interpolate

back to summary

public Vector2 interpolate(Vector2 target, float alpha, Interpolation interpolation)

Implements com.badlogic.gdx.math.Vector.interpolate.

Doc from com.badlogic.gdx.math.Vector.interpolate.

Interpolates between this vector and the given target vector by alpha (within range [0,1]) using the given Interpolation method. the result is stored in this vector.

Annotations

@Override

isCollinear	back to summary
public boolean isCollinear(Vector2 other, float epsilon) Implements com.badlogic.gdx.math.Vector.isCollinear. Annotations @Override

isCollinear

back to summary

public boolean isCollinear(Vector2 other, float epsilon)

Implements com.badlogic.gdx.math.Vector.isCollinear.

Annotations

@Override

isCollinear	back to summary
public boolean isCollinear(Vector2 other) Implements com.badlogic.gdx.math.Vector.isCollinear. Annotations @Override

isCollinear

back to summary

public boolean isCollinear(Vector2 other)

Implements com.badlogic.gdx.math.Vector.isCollinear.

Annotations

@Override

isCollinearOpposite	back to summary
public boolean isCollinearOpposite(Vector2 other, float epsilon) Implements com.badlogic.gdx.math.Vector.isCollinearOpposite. Annotations @Override

isCollinearOpposite

back to summary

public boolean isCollinearOpposite(Vector2 other, float epsilon)

Implements com.badlogic.gdx.math.Vector.isCollinearOpposite.

Annotations

@Override

isCollinearOpposite

back to summary

public boolean isCollinearOpposite(Vector2 other)

Implements com.badlogic.gdx.math.Vector.isCollinearOpposite.

Annotations

@Override

isOnLine

back to summary

public boolean isOnLine(Vector2 other)

Implements com.badlogic.gdx.math.Vector.isOnLine.

Annotations

@Override

isOnLine

back to summary

public boolean isOnLine(Vector2 other, float epsilon)

Implements com.badlogic.gdx.math.Vector.isOnLine.

Annotations

@Override

isPerpendicular

back to summary

public boolean isPerpendicular(Vector2 vector)

Implements com.badlogic.gdx.math.Vector.isPerpendicular.

Annotations

@Override

isPerpendicular

back to summary

public boolean isPerpendicular(Vector2 vector, float epsilon)

Implements com.badlogic.gdx.math.Vector.isPerpendicular.

Annotations

@Override

isUnit

back to summary

public boolean isUnit()

Implements com.badlogic.gdx.math.Vector.isUnit.

Annotations

@Override

isUnit

back to summary

public boolean isUnit(final float margin)

Implements com.badlogic.gdx.math.Vector.isUnit.

Annotations

@Override

isZero

back to summary

public boolean isZero()

Implements com.badlogic.gdx.math.Vector.isZero.

Annotations

@Override

isZero

back to summary

public boolean isZero(final float margin)

Implements com.badlogic.gdx.math.Vector.isZero.

Annotations

@Override

len	back to summary
public static float len(float x, float y)

len

back to summary

public float len()

Implements com.badlogic.gdx.math.Vector.len.

Annotations

@Override

len2	back to summary
public static float len2(float x, float y)

len2 back to summary

public float len2()

Implements com.badlogic.gdx.math.Vector.len2.

Doc from com.badlogic.gdx.math.Vector.len2.

This method is faster than Vector#len() because it avoids calculating a square root. It is useful for comparisons, but not for getting exact lengths, as the return value is the square of the actual length.

Annotations

@Override

lerp

back to summary

public Vector2 lerp(Vector2 target, float alpha)

Implements com.badlogic.gdx.math.Vector.lerp.

Doc from com.badlogic.gdx.math.Vector.lerp.

Linearly interpolates between this vector and the target vector by alpha which is in the range [0,1]. The result is stored in this vector.

Annotations

@Override

limit

back to summary

public Vector2 limit(float limit)

Implements com.badlogic.gdx.math.Vector.limit.

Doc from com.badlogic.gdx.math.Vector.limit.

Limits the length of this vector, based on the desired maximum length.

Annotations

@Override

limit2

back to summary

public Vector2 limit2(float limit2)

Implements com.badlogic.gdx.math.Vector.limit2.

Doc from com.badlogic.gdx.math.Vector.limit2.

Limits the length of this vector, based on the desired maximum length squared.

This method is slightly faster than limit().

Annotations

@Override

mul

back to summary

public Vector2 mul(Matrix3 mat)

Left-multiplies this vector by the given matrix

Parameters

mat:Matrix3: the matrix

Returns:Vector2

this vector

mulAdd

back to summary

public Vector2 mulAdd(Vector2 vec, float scalar)

Implements com.badlogic.gdx.math.Vector.mulAdd, com.badlogic.gdx.math.Vector.mulAdd.

Doc from com.badlogic.gdx.math.Vector.mulAdd.

First scale a supplied vector, then add it to this vector.

Annotations

@Override

mulAdd

back to summary

public Vector2 mulAdd(Vector2 vec, Vector2 mulVec)

Implements com.badlogic.gdx.math.Vector.mulAdd.

Doc from com.badlogic.gdx.math.Vector.mulAdd.

First scale a supplied vector, then add it to this vector.

Annotations

@Override

nor

back to summary

public Vector2 nor()

Implements com.badlogic.gdx.math.Vector.nor.

Doc from com.badlogic.gdx.math.Vector.nor.

Normalizes this vector. Does nothing if it is zero.

Annotations

@Override

rotate back to summary

public Vector2 rotate(float degrees)

Deprecated

use rotateDeg(float) instead.

Rotates the Vector2 by the given angle, counter-clockwise assuming the y-axis points up.

Parameters

degrees:float: the angle in degrees

Annotations

@Deprecated

rotate90	back to summary
public Vector2 rotate90(int dir) Rotates the Vector2 by 90 degrees in the specified direction, where >= 0 is counter-clockwise and < 0 is clockwise.

rotateAround back to summary

public Vector2 rotateAround(Vector2 reference, float degrees)

Deprecated

use rotateAroundDeg(Vector2, float) instead.

Rotates the Vector2 by the given angle around reference vector, counter-clockwise assuming the y-axis points up.

Parameters

reference:Vector2: center Vector2
degrees:float: the angle in degrees

Annotations

@Deprecated

rotateAroundDeg

back to summary

public Vector2 rotateAroundDeg(Vector2 reference, float degrees)

Rotates the Vector2 by the given angle around reference vector, counter-clockwise assuming the y-axis points up.

Parameters

reference:Vector2: center Vector2
degrees:float: the angle in degrees

rotateAroundRad

back to summary

public Vector2 rotateAroundRad(Vector2 reference, float radians)

Rotates the Vector2 by the given angle around reference vector, counter-clockwise assuming the y-axis points up.

Parameters

reference:Vector2: center Vector2
radians:float: the angle in radians

rotateDeg

back to summary

public Vector2 rotateDeg(float degrees)

Rotates the Vector2 by the given angle, counter-clockwise assuming the y-axis points up.

Parameters

degrees:float: the angle in degrees

rotateRad

back to summary

public Vector2 rotateRad(float radians)

Rotates the Vector2 by the given angle, counter-clockwise assuming the y-axis points up.

Parameters

radians:float: the angle in radians

scl

back to summary

public Vector2 scl(float scalar)

Implements com.badlogic.gdx.math.Vector.scl, com.badlogic.gdx.math.Vector.scl.

Doc from com.badlogic.gdx.math.Vector.scl.

Scales this vector by a scalar

Annotations

@Override

scl

back to summary

public Vector2 scl(float x, float y)

Multiplies this vector by a scalar

Returns:Vector2: This vector for chaining

scl

back to summary

public Vector2 scl(Vector2 v)

Implements com.badlogic.gdx.math.Vector.scl.

Doc from com.badlogic.gdx.math.Vector.scl.

Scales this vector by another vector

Annotations

@Override

set

back to summary

public Vector2 set(Vector2 v)

Implements com.badlogic.gdx.math.Vector.set.

Doc from com.badlogic.gdx.math.Vector.set.

Sets this vector from the given vector

Annotations

@Override

set

back to summary

public Vector2 set(float x, float y)

Sets the components of this vector

Parameters

x:float: The x-component
y:float: The y-component

Returns:Vector2

This vector for chaining

setAngle back to summary

public Vector2 setAngle(float degrees)

Deprecated

use setAngleDeg(float) instead.

Sets the angle of the vector in degrees relative to the x-axis, towards the positive y-axis (typically counter-clockwise).

Parameters

degrees:float: The angle in degrees to set.

Annotations

@Deprecated

setAngleDeg

back to summary

public Vector2 setAngleDeg(float degrees)

Sets the angle of the vector in degrees relative to the x-axis, towards the positive y-axis (typically counter-clockwise).

Parameters

degrees:float: The angle in degrees to set.

setAngleRad

back to summary

public Vector2 setAngleRad(float radians)

Sets the angle of the vector in radians relative to the x-axis, towards the positive y-axis (typically counter-clockwise).

Parameters

radians:float: The angle in radians to set.

setLength

back to summary

public Vector2 setLength(float len)

Implements com.badlogic.gdx.math.Vector.setLength.

Doc from com.badlogic.gdx.math.Vector.setLength.

Sets the length of this vector. Does nothing if this vector is zero.

Annotations

@Override

setLength2

back to summary

public Vector2 setLength2(float len2)

Implements com.badlogic.gdx.math.Vector.setLength2.

Doc from com.badlogic.gdx.math.Vector.setLength2.

Sets the length of this vector, based on the square of the desired length. Does nothing if this vector is zero.

This method is slightly faster than setLength().

Annotations

@Override

setToRandomDirection

back to summary

public Vector2 setToRandomDirection()

Implements com.badlogic.gdx.math.Vector.setToRandomDirection.

Doc from com.badlogic.gdx.math.Vector.setToRandomDirection.

Sets this vector to the unit vector with a random direction

Annotations

@Override

setZero

back to summary

public Vector2 setZero()

Implements com.badlogic.gdx.math.Vector.setZero.

Doc from com.badlogic.gdx.math.Vector.setZero.

Sets the components of this vector to 0

Annotations

@Override

sub

back to summary

public Vector2 sub(Vector2 v)

Implements com.badlogic.gdx.math.Vector.sub.

Doc from com.badlogic.gdx.math.Vector.sub.

Subtracts the given vector from this vector.

Annotations

@Override

sub

back to summary

public Vector2 sub(float x, float y)

Subtracts the other vector from this vector.

Parameters

x:float: The x-component of the other vector
y:float: The y-component of the other vector

Returns:Vector2

This vector for chaining

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Converts this Vector2 to a string in the format (x,y).

Returns:String

a string representation of this object.

Annotations

@Override

public Class Vector2

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail