APIdia Launch Partner
Top Description Fields Constructors Methods
com.badlogic.gdx.math.collision

public Class Segment

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable, com.badlogic.gdx.math.Vector3

A Segment is a line in 3-space having a starting and an ending position.
Author
mzechner

Field Summary

Modifier and TypeField and Description
public final Vector3
a

the starting position

public final Vector3
b

the ending position

private static final long

Constructor Summary

AccessConstructor and Description
public
Segment(Vector3
the first point
a
,
Vector3
the second point
b
)

Constructs a new Segment from the two points given.

public
Segment(float
the x-coordinate of the first point
aX
,
float
the y-coordinate of the first point
aY
,
float
the z-coordinate of the first point
aZ
,
float
the x-coordinate of the second point
bX
,
float
the y-coordinate of the second point
bY
,
float
the z-coordinate of the second point
bZ
)

Constructs a new Segment from the two points given.

Method Summary

Modifier and TypeMethod and Description
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 float
len()

public float
len2()

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

aback to summary
public final Vector3 a

the starting position

bback to summary
public final Vector3 b

the ending position

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Segmentback to summary
public Segment(Vector3 a, Vector3 b)

Constructs a new Segment from the two points given.

Parameters
a:Vector3

the first point

b:Vector3

the second point

Segmentback to summary
public Segment(float aX, float aY, float aZ, float bX, float bY, float bZ)

Constructs a new Segment from the two points given.

Parameters
aX:float

the x-coordinate of the first point

aY:float

the y-coordinate of the first point

aZ:float

the z-coordinate of the first point

bX:float

the x-coordinate of the second point

bY:float

the y-coordinate of the second point

bZ:float

the z-coordinate of the second point

Method Detail

equalsback 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
hashCodeback 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
lenback to summary
public float len()
len2back to summary
public float len2()