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

Modifier and Type	Field and Description
public float	radius
public float	x
public float	y

Access	Constructor and Description
public	Circle() Constructs a new circle with all values set to zero
public	Circle(float X coordinate of the center of the circle x, float Y coordinate of the center of the circle y, float The radius of the circle radius) Constructs a new circle with the given X and Y coordinates and the given radius.
public	Circle(Vector2 The position `Vector2` of the center of the circle position, float The radius radius) Constructs a new circle using a given `Vector2` that contains the desired X and Y coordinates, and a given radius.
public	Circle(Circle The circle to construct a copy of. circle) Copy constructor
public	Circle(Vector2 The center of the new circle center, Vector2 Any point on the edge of the given circle edge) Creates a new `Circle` in terms of its center and a point on its edge.

Method Summary

Modifier and Type	Method and Description
public float	area() Returns: The area of this circle (as `MathUtils#PI` * radius * radius).
public float	circumference() Returns: The circumference of this circle (as 2 * `MathUtils#PI2`) * `radius`
public boolean	Returns: true if this circle contains the given point. contains(float X coordinate x, float Y coordinate y) Implements com.badlogic.gdx.math.Shape2D.contains. Checks whether or not this circle contains a given point.
public boolean	Returns: true if this circle contains this point; false otherwise. contains(Vector2 The `Vector2` that contains the point coordinates. point) Implements com.badlogic.gdx.math.Shape2D.contains. Checks whether or not this circle contains a given point.
public boolean	contains(Circle the other `Circle` c) Returns: whether this circle contains the other circle.
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 boolean	overlaps(Circle the other `Circle` c) Returns: whether this circle overlaps the other circle.
public void	set(float X coordinate of the center of the circle x, float Y coordinate of the center of the circle y, float Circle radius radius) Sets a new location and radius for this circle.
public void	set(Vector2 Position `Vector2` for this circle. position, float Circle radius radius) Sets a new location and radius for this circle.
public void	set(Circle The circle to copy the position and radius of. circle) Sets a new location and radius for this circle, based upon another circle.
public void	set(Vector2 The new center of the circle center, Vector2 Any point on the edge of the given circle edge) Sets this `Circle`'s values in terms of its center and a point on its edge.
public void	setPosition(Vector2 The position vector position) Sets the x and y-coordinates of circle center from vector
public void	setPosition(float The x-coordinate x, float The y-coordinate y) Sets the x and y-coordinates of circle center
public void	setRadius(float The radius radius) Sets the radius of circle
public void	setX(float The x-coordinate x) Sets the x-coordinate of circle center
public void	setY(float The y-coordinate y) Sets the y-coordinate of circle center
public String	toString() Overrides java.lang.Object.toString. Returns a `String` representation of this `Circle` of the form `x,y,radius`.

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

radius	back to summary
public float radius

x	back to summary
public float x

y	back to summary
public float y

Circle	back to summary
public Circle() Constructs a new circle with all values set to zero

Circle	back to summary
public Circle(float x, float y, float radius) Constructs a new circle with the given X and Y coordinates and the given radius. Parameters x:float X coordinate of the center of the circle y:float Y coordinate of the center of the circle radius:float The radius of the circle

Circle	back to summary
public Circle(Vector2 position, float radius) Constructs a new circle using a given `Vector2` that contains the desired X and Y coordinates, and a given radius. Parameters position:Vector2 The position `Vector2` of the center of the circle radius:float The radius

Circle	back to summary
public Circle(Circle circle) Copy constructor Parameters circle:Circle The circle to construct a copy of.

Circle	back to summary
public Circle(Vector2 center, Vector2 edge) Creates a new `Circle` in terms of its center and a point on its edge. Parameters center:Vector2 The center of the new circle edge:Vector2 Any point on the edge of the given circle

Method Detail

area	back to summary
public float area() Returns:float The area of this circle (as `MathUtils#PI` * radius * radius).

circumference	back to summary
public float circumference() Returns:float The circumference of this circle (as 2 * `MathUtils#PI2`) * `radius`

contains	back to summary
public boolean contains(float x, float y) Implements com.badlogic.gdx.math.Shape2D.contains. Checks whether or not this circle contains a given point. Parameters x:float X coordinate y:float Y coordinate Returns:boolean true if this circle contains the given point.

contains

back to summary

public boolean contains(float x, float y)

Implements com.badlogic.gdx.math.Shape2D.contains.

Checks whether or not this circle contains a given point.

Parameters

x:float: X coordinate
y:float: Y coordinate

Returns:boolean

true if this circle contains the given point.

contains back to summary

contains	back to summary
public boolean contains(Vector2 point) Implements com.badlogic.gdx.math.Shape2D.contains. Checks whether or not this circle contains a given point. Parameters point:Vector2 The `Vector2` that contains the point coordinates. Returns:boolean true if this circle contains this point; false otherwise.

public boolean contains(Vector2 point)

Implements com.badlogic.gdx.math.Shape2D.contains.

Checks whether or not this circle contains a given point.

Parameters

point:Vector2: The Vector2 that contains the point coordinates.

Returns:boolean

true if this circle contains this point; false otherwise.

contains	back to summary
public boolean contains(Circle c) Parameters c:Circle the other `Circle` Returns:boolean whether this circle contains the other circle.

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

overlaps	back to summary
public boolean overlaps(Circle c) Parameters c:Circle the other `Circle` Returns:boolean whether this circle overlaps the other circle.

set	back to summary
public void set(float x, float y, float radius) Sets a new location and radius for this circle. Parameters x:float X coordinate of the center of the circle y:float Y coordinate of the center of the circle radius:float Circle radius

set

back to summary

public void set(float x, float y, float radius)

Sets a new location and radius for this circle.

Parameters

x:float: X coordinate of the center of the circle
y:float: Y coordinate of the center of the circle
radius:float: Circle radius

set back to summary

set	back to summary
public void set(Vector2 position, float radius) Sets a new location and radius for this circle. Parameters position:Vector2 Position `Vector2` for this circle. radius:float Circle radius

public void set(Vector2 position, float radius)

Sets a new location and radius for this circle.

Parameters

position:Vector2: Position Vector2 for this circle.
radius:float: Circle radius

set	back to summary
public void set(Circle circle) Sets a new location and radius for this circle, based upon another circle. Parameters circle:Circle The circle to copy the position and radius of.

set

back to summary

public void set(Circle circle)

Sets a new location and radius for this circle, based upon another circle.

Parameters

circle:Circle: The circle to copy the position and radius of.

set back to summary

set	back to summary
public void set(Vector2 center, Vector2 edge) Sets this `Circle`'s values in terms of its center and a point on its edge. Parameters center:Vector2 The new center of the circle edge:Vector2 Any point on the edge of the given circle

public void set(Vector2 center, Vector2 edge)

Sets this Circle's values in terms of its center and a point on its edge.

Parameters

center:Vector2: The new center of the circle
edge:Vector2: Any point on the edge of the given circle

setPosition	back to summary
public void setPosition(Vector2 position) Sets the x and y-coordinates of circle center from vector Parameters position:Vector2 The position vector

setPosition

back to summary

public void setPosition(Vector2 position)

Sets the x and y-coordinates of circle center from vector

Parameters

position:Vector2: The position vector

setPosition	back to summary
public void setPosition(float x, float y) Sets the x and y-coordinates of circle center Parameters x:float The x-coordinate y:float The y-coordinate

setPosition

back to summary

public void setPosition(float x, float y)

Sets the x and y-coordinates of circle center

Parameters

x:float: The x-coordinate
y:float: The y-coordinate

setRadius	back to summary
public void setRadius(float radius) Sets the radius of circle Parameters radius:float The radius

setRadius

back to summary

public void setRadius(float radius)

Sets the radius of circle

Parameters

radius:float: The radius

setX	back to summary
public void setX(float x) Sets the x-coordinate of circle center Parameters x:float The x-coordinate

setX

back to summary

public void setX(float x)

Sets the x-coordinate of circle center

Parameters

x:float: The x-coordinate

setY	back to summary
public void setY(float y) Sets the y-coordinate of circle center Parameters y:float The y-coordinate

setY

back to summary

public void setY(float y)

Sets the y-coordinate of circle center

Parameters

y:float: The y-coordinate

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a `String` representation of this `Circle` of the form `x,y,radius`. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a String representation of this Circle of the form x,y,radius.

Annotations

@Override

public Class Circle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail