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

Modifier and Type	Field and Description
private static final long	serialVersionUID
public int	x
public int	y
public int	z

Access	Constructor and Description
public	GridPoint3() Constructs a 3D grid point with all coordinates pointing to the origin (0, 0, 0).
public	GridPoint3(int X coordinate x, int Y coordinate y, int Z coordinate z) Constructs a 3D grid point.
public	GridPoint3(GridPoint3 The 3D grid point to make a copy of. point) Copy constructor

Method Summary

Modifier and Type	Method and Description
public GridPoint3	Returns: this 3d grid point for chaining. add(GridPoint3 The other point other) Adds another 3D grid point to this point.
public GridPoint3	Returns: this 3d grid point for chaining. add(int The x-coordinate of the other point x, int The y-coordinate of the other point y, int The z-coordinate of the other point z) Adds another 3D grid point to this point.
public GridPoint3	cpy() Returns: a copy of this grid point
public float	dst(GridPoint3 The other point other) Returns: the distance between this point and the other vector.
public float	dst(int The x-coordinate of the other point x, int The y-coordinate of the other point y, int The z-coordinate of the other point z) Returns: the distance between this point and the other point.
public float	dst2(GridPoint3 The other point other) Returns: the squared distance between this point and the other point.
public float	dst2(int The x-coordinate of the other point x, int The y-coordinate of the other point y, int The z-coordinate of the other point z) Returns: the squared distance between this point and the other point.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public GridPoint3	Returns: this GridPoint3 for chaining. set(GridPoint3 The 3D grid point to copy coordinates of. point) Sets the coordinates of this 3D grid point to that of another.
public GridPoint3	Returns: this GridPoint3D for chaining. set(int X coordinate x, int Y coordinate y, int Z coordinate z) Sets the coordinates of this GridPoint3D.
public GridPoint3	Returns: this 3d grid point for chaining. sub(GridPoint3 The other point other) Subtracts another 3D grid point from this point.
public GridPoint3	Returns: this 3d grid point for chaining. sub(int The x-coordinate of the other point x, int The y-coordinate of the other point y, int The z-coordinate of the other point z) Subtracts another 3D grid point from this point.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

serialVersionUID	back to summary
private static final long serialVersionUID

x	back to summary
public int x

y	back to summary
public int y

z	back to summary
public int z

GridPoint3	back to summary
public GridPoint3() Constructs a 3D grid point with all coordinates pointing to the origin (0, 0, 0).

GridPoint3	back to summary
public GridPoint3(int x, int y, int z) Constructs a 3D grid point. Parameters x:int X coordinate y:int Y coordinate z:int Z coordinate

GridPoint3	back to summary
public GridPoint3(GridPoint3 point) Copy constructor Parameters point:GridPoint3 The 3D grid point to make a copy of.

Method Detail

add	back to summary
public GridPoint3 add(GridPoint3 other) Adds another 3D grid point to this point. Parameters other:GridPoint3 The other point Returns:GridPoint3 this 3d grid point for chaining.

add

back to summary

public GridPoint3 add(GridPoint3 other)

Adds another 3D grid point to this point.

Parameters

other:GridPoint3: The other point

Returns:GridPoint3

this 3d grid point for chaining.

add	back to summary
public GridPoint3 add(int x, int y, int z) Adds another 3D grid point to this point. Parameters x:int The x-coordinate of the other point y:int The y-coordinate of the other point z:int The z-coordinate of the other point Returns:GridPoint3 this 3d grid point for chaining.

add

back to summary

public GridPoint3 add(int x, int y, int z)

Adds another 3D grid point to this point.

Parameters

x:int: The x-coordinate of the other point
y:int: The y-coordinate of the other point
z:int: The z-coordinate of the other point

Returns:GridPoint3

this 3d grid point for chaining.

cpy	back to summary
public GridPoint3 cpy() Returns:GridPoint3 a copy of this grid point

dst	back to summary
public float dst(GridPoint3 other) Parameters other:GridPoint3 The other point Returns:float the distance between this point and the other vector.

dst	back to summary
public float dst(int x, int y, int z) Parameters x:int The x-coordinate of the other point y:int The y-coordinate of the other point z:int The z-coordinate of the other point Returns:float the distance between this point and the other point.

dst2	back to summary
public float dst2(GridPoint3 other) Parameters other:GridPoint3 The other point Returns:float the squared distance between this point and the other point.

dst2	back to summary
public float dst2(int x, int y, int z) Parameters x:int The x-coordinate of the other point y:int The y-coordinate of the other point z:int The z-coordinate of the other point Returns:float the squared distance between this point and the other point.

equals back to summary

equals	back to summary
public boolean equals(Object o) 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 o)

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

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

set	back to summary
public GridPoint3 set(GridPoint3 point) Sets the coordinates of this 3D grid point to that of another. Parameters point:GridPoint3 The 3D grid point to copy coordinates of. Returns:GridPoint3 this GridPoint3 for chaining.

set

back to summary

public GridPoint3 set(GridPoint3 point)

Sets the coordinates of this 3D grid point to that of another.

Parameters

point:GridPoint3: The 3D grid point to copy coordinates of.

Returns:GridPoint3

this GridPoint3 for chaining.

set	back to summary
public GridPoint3 set(int x, int y, int z) Sets the coordinates of this GridPoint3D. Parameters x:int X coordinate y:int Y coordinate z:int Z coordinate Returns:GridPoint3 this GridPoint3D for chaining.

set

back to summary

public GridPoint3 set(int x, int y, int z)

Sets the coordinates of this GridPoint3D.

Parameters

x:int: X coordinate
y:int: Y coordinate
z:int: Z coordinate

Returns:GridPoint3

this GridPoint3D for chaining.

sub	back to summary
public GridPoint3 sub(GridPoint3 other) Subtracts another 3D grid point from this point. Parameters other:GridPoint3 The other point Returns:GridPoint3 this 3d grid point for chaining.

sub

back to summary

public GridPoint3 sub(GridPoint3 other)

Subtracts another 3D grid point from this point.

Parameters

other:GridPoint3: The other point

Returns:GridPoint3

this 3d grid point for chaining.

sub	back to summary
public GridPoint3 sub(int x, int y, int z) Subtracts another 3D grid point from this point. Parameters x:int The x-coordinate of the other point y:int The y-coordinate of the other point z:int The z-coordinate of the other point Returns:GridPoint3 this 3d grid point for chaining.

sub

back to summary

public GridPoint3 sub(int x, int y, int z)

Subtracts another 3D grid point from this point.

Parameters

x:int: The x-coordinate of the other point
y:int: The y-coordinate of the other point
z:int: The z-coordinate of the other point

Returns:GridPoint3

this 3d grid point for chaining.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class GridPoint3

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail