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

Modifier and Type	Field and Description
public final Vector3	direction
public final Vector3	origin
private static final long	serialVersionUID
pack-priv static Vector3	tmp

Access	Constructor and Description
public	Ray()
public	Ray(Vector3 The starting position origin, Vector3 The direction direction) Constructor, sets the starting position of the ray and the direction.

Method Summary

Modifier and Type	Method and Description
public Ray	cpy() Returns: a copy of this ray.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Vector3	Returns: The out param getEndPoint(final Vector3 The vector to set to the result out, final float The distance from the end point to the start point. distance) Returns the endpoint given the distance.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Ray	Returns: This ray for chaining. mul(Matrix4 The matrix matrix) Multiplies the ray by the given matrix.
public Ray	Returns: this ray for chaining set(Vector3 The starting position origin, Vector3 The direction direction) Sets the starting position and the direction of this ray.
public Ray	Returns: this ray for chaining set(float The x-component of the starting position x, float The y-component of the starting position y, float The z-component of the starting position z, float The x-component of the direction dx, float The y-component of the direction dy, float The z-component of the direction dz) Sets this ray from the given starting position and direction.
public Ray	Returns: This ray for chaining set(Ray The ray ray) Sets the starting position and direction from the given ray
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

direction	back to summary
public final Vector3 direction

origin	back to summary
public final Vector3 origin

serialVersionUID	back to summary
private static final long serialVersionUID

tmp	back to summary
pack-priv static Vector3 tmp

Ray	back to summary
public Ray()

Ray	back to summary
public Ray(Vector3 origin, Vector3 direction) Constructor, sets the starting position of the ray and the direction. Parameters origin:Vector3 The starting position direction:Vector3 The direction

Method Detail

cpy	back to summary
public Ray cpy() Returns:Ray a copy of this ray.

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

getEndPoint	back to summary
public Vector3 getEndPoint(final Vector3 out, final float distance) Returns the endpoint given the distance. This is calculated as startpoint + distance * direction. Parameters out:Vector3 The vector to set to the result distance:float The distance from the end point to the start point. Returns:Vector3 The out param

getEndPoint

back to summary

public Vector3 getEndPoint(final Vector3 out, final float distance)

Returns the endpoint given the distance. This is calculated as startpoint + distance * direction.

Parameters

out:Vector3: The vector to set to the result
distance:float: The distance from the end point to the start point.

Returns:Vector3

The out param

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

mul	back to summary
public Ray mul(Matrix4 matrix) Multiplies the ray by the given matrix. Use this to transform a ray into another coordinate system. Parameters matrix:Matrix4 The matrix Returns:Ray This ray for chaining.

mul

back to summary

public Ray mul(Matrix4 matrix)

Multiplies the ray by the given matrix. Use this to transform a ray into another coordinate system.

Parameters

matrix:Matrix4: The matrix

Returns:Ray

This ray for chaining.

set	back to summary
public Ray set(Vector3 origin, Vector3 direction) Sets the starting position and the direction of this ray. Parameters origin:Vector3 The starting position direction:Vector3 The direction Returns:Ray this ray for chaining

set

back to summary

public Ray set(Vector3 origin, Vector3 direction)

Sets the starting position and the direction of this ray.

Parameters

origin:Vector3: The starting position
direction:Vector3: The direction

Returns:Ray

this ray for chaining

set	back to summary
public Ray set(float x, float y, float z, float dx, float dy, float dz) Sets this ray from the given starting position and direction. Parameters x:float The x-component of the starting position y:float The y-component of the starting position z:float The z-component of the starting position dx:float The x-component of the direction dy:float The y-component of the direction dz:float The z-component of the direction Returns:Ray this ray for chaining

set

back to summary

public Ray set(float x, float y, float z, float dx, float dy, float dz)

Sets this ray from the given starting position and direction.

Parameters

x:float: The x-component of the starting position
y:float: The y-component of the starting position
z:float: The z-component of the starting position
dx:float: The x-component of the direction
dy:float: The y-component of the direction
dz:float: The z-component of the direction

Returns:Ray

this ray for chaining

set	back to summary
public Ray set(Ray ray) Sets the starting position and direction from the given ray Parameters ray:Ray The ray Returns:Ray This ray for chaining

set

back to summary

public Ray set(Ray ray)

Sets the starting position and direction from the given ray

Parameters

ray:Ray: The ray

Returns:Ray

This ray 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.

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.

public Class Ray

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail