Circle (mini2Dx)

java.lang.Object
- org.mini2Dx.core.geom.Shape
- - org.mini2Dx.core.geom.Circle

Direct Known Subclasses:

CollisionCircle, StaticCollisionCircle
```
public class Circle
extends Shape
```
Implements a circle

Constructor Summary

Constructors
Constructor and Description
`Circle(Circle circle)` Constructs a `Circle` as a copy of another
`Circle(float radius)` Constructs a `Circle` at 0,0 with a radius
`Circle(float centerX, float centerY, float radius)` Constructs a `Circle` with a center and radius

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(Circle circle)` Returns if another `Circle` is contained within this one
`boolean`	`contains(float x, float y)` Returns if a set of coordinates are contained inside this `Shape`
`boolean`	`contains(Polygon polygon)` Returns if this `Circle` contains a `Polygon`
`boolean`	`contains(Rectangle rectangle)` Returns if this `Circle` contains a `Rectangle`
`boolean`	`contains(Shape shape)` Returns if a `Shape` is contained inside this `Shape`
`boolean`	`contains(com.badlogic.gdx.math.Vector2 point)` Returns if a `Vector2` is contained inside this `Shape`
`Shape`	`copy()` Returns an exact copy of this `Shape`
`void`	`draw(Graphics g)` Draws this shape using a `Graphics` instance
`EdgeIterator`	`edgeIterator()` Returns an `EdgeIterator` for looping over the edges of this `Shape`
`boolean`	`equals(java.lang.Object obj)`
`void`	`fill(Graphics g)` Fills this shape using a `Graphics` instance
`Rectangle`	`getBoundingBox()` Returns the bounding box of this `Circle`
`float`	`getCenterX()` Returns the center x coordinate of this object.
`float`	`getCenterY()` Returns the center y coordinate of this object.
`float`	`getDistanceFromCenter(float x, float y)` Returns the distance from the center of this `Circle` to a point
`float`	`getDistanceFromCenter(com.badlogic.gdx.math.Vector2 point)` Returns the distance from the center of this `Circle` to a point
`float`	`getDistanceTo(float x, float y)` Returns the distance from the edge of this `Circle` to a point
`float`	`getDistanceTo(com.badlogic.gdx.math.Vector2 point)` Returns the distance from the edge of this `Circle` to a point
`float`	`getMaxX()` Returns the right-most x coordinate
`float`	`getMaxY()` Returns the bottom-most y coordinate
`float`	`getMinX()` Returns the left-most x coordinate
`float`	`getMinY()` Returns the top-most y coordinate
`int`	`getNumberOfSides()` Returns the number of edges of this object
`Polygon`	`getPolygon()` Returns the `Polygon` representing this `Shape`
`float`	`getRadius()`
`float`	`getRotation()` Returns the rotation of this `Shape`
`float`	`getX()` Returns the x coordinate of this object
`float`	`getY()` Returns the y coordinate of this object
`int`	`hashCode()`
`boolean`	`intersects(Circle circle)` Returns if the specified `Circle` intersects this one
`boolean`	`intersects(Rectangle rectangle)` Returns if the specified `Rectangle` intersects this `Circle`
`boolean`	`intersects(Shape shape)` Returns if this `Shape` intersects another `Shape`
`boolean`	`intersectsLineSegment(float x1, float y1, float x2, float y2)` Returns if this `Shape` intersects a line segment
`boolean`	`intersectsLineSegment(com.badlogic.gdx.math.Vector2 pointA, com.badlogic.gdx.math.Vector2 pointB)` Returns if this `Shape` intersects a line segment
`boolean`	`isCircle()` Returns if this `Shape` is a `Circle`
`Circle`	`lerp(Circle target, float alpha)`
`void`	`rotate(float degrees)` Rotates this `Shape` by a specified amount of degrees with its first point as the origin
`void`	`rotateAround(float centerX, float centerY, float degrees)` Rotates this `Shape` by a specified amount of degrees around a specified point
`void`	`scale(float scale)` Scales the radius of this shape.
`void`	`set(Circle circle)`
`void`	`set(float x, float y)` Sets the x and y coordinate of this object
`void`	`setCenter(float x, float y)` Sets the center x,y coordinate of this object
`void`	`setCenterX(float x)` Sets the center x coordinate
`void`	`setCenterY(float y)` Sets the center y coordianate
`void`	`setRadius(float radius)` Sets the radius of this shape.
`void`	`setRotation(float degrees)` Sets the rotation of this `Shape` with its first point as the origin
`void`	`setRotationAround(float centerX, float centerY, float degrees)` Sets the rotation of this `Shape` with a specified point as the origin
`void`	`setX(float x)` Sets the x coordinate of this object
`void`	`setY(float y)` Sets the y coordinate of this object
`void`	`translate(float translateX, float translateY)` Translates the x and y coordinate of this object

Methods inherited from class org.mini2Dx.core.geom.Shape
add, getDistanceTo, intersects, subtract

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Circle
```
public Circle(float radius)
```
    Constructs a Circle at 0,0 with a radius
    
    Parameters:
    
    radius - The Circle radius
  - Circle
```
public Circle(float centerX,
              float centerY,
              float radius)
```
    Constructs a Circle with a center and radius
    
    Parameters:
    
    centerX - The center x coordinate
    
    centerY - The center y coordinate
    
    radius - The radius
  - Circle
```
public Circle(Circle circle)
```
    Constructs a Circle as a copy of another
    
    Parameters:
    
    circle - The Circle to copy
- Method Detail
  - copy
```
public Shape copy()
```
    Description copied from class: Shape
    
    Returns an exact copy of this Shape
    
    Specified by:
    
    copy in class Shape
    
    Returns:
    
    A copy (new) instance of this Shape
  - lerp
```
public Circle lerp(Circle target,
                   float alpha)
```
  - contains
```
public boolean contains(com.badlogic.gdx.math.Vector2 point)
```
    Description copied from class: Shape
    
    Returns if a Vector2 is contained inside this Shape
    
    Specified by:
    
    contains in class Shape
    
    Parameters:
    
    point - The Vector2 to check
    
    Returns:
    
    True if this Shape contains the specified Vector2
  - contains
```
public boolean contains(float x,
                        float y)
```
    Description copied from class: Shape
    
    Returns if a set of coordinates are contained inside this Shape
    
    Specified by:
    
    contains in class Shape
    
    Parameters:
    
    x - The x coordinate to check
    
    y - The y coordinate to check
    
    Returns:
    
    True if this Shape contains the specified coordinates
  - contains
```
public boolean contains(Shape shape)
```
    Description copied from class: Shape
    
    Returns if a Shape is contained inside this Shape
    
    Specified by:
    
    contains in class Shape
    
    Parameters:
    
    shape - The Shape to check
    
    Returns:
    
    True if this Shape contains the specified Shape
  - contains
```
public boolean contains(Circle circle)
```
    Returns if another Circle is contained within this one
    
    Parameters:
    
    circle - The Circle to check
    
    Returns:
    
    True if the other Circle is contained within this one
  - contains
```
public boolean contains(Rectangle rectangle)
```
    Returns if this Circle contains a Rectangle
    
    Parameters:
    
    rectangle - The Rectangle to check
    
    Returns:
    
    True if this Circle contains the Rectangle
  - contains
```
public boolean contains(Polygon polygon)
```
    Returns if this Circle contains a Polygon
    
    Parameters:
    
    polygon - The Polygon to check
    
    Returns:
    
    True if this Circle contains the Polygon
  - intersects
```
public boolean intersects(Shape shape)
```
    Description copied from class: Shape
    
    Returns if this Shape intersects another Shape
    
    Specified by:
    
    intersects in class Shape
    
    Parameters:
    
    shape - The Shape to check
    
    Returns:
    
    True if this Shape intersects the specified Shape
  - intersectsLineSegment
```
public boolean intersectsLineSegment(com.badlogic.gdx.math.Vector2 pointA,
                                     com.badlogic.gdx.math.Vector2 pointB)
```
    Description copied from class: Shape
    
    Returns if this Shape intersects a line segment
    
    Specified by:
    
    intersectsLineSegment in class Shape
    
    Parameters:
    
    pointA - The first point in the line segment
    
    pointB - The second point in the line segment
    
    Returns:
    
    True if this Shape intersects the line segment
  - intersectsLineSegment
```
public boolean intersectsLineSegment(float x1,
                                     float y1,
                                     float x2,
                                     float y2)
```
    Description copied from class: Shape
    
    Returns if this Shape intersects a line segment
    
    Specified by:
    
    intersectsLineSegment in class Shape
    
    Parameters:
    
    x1 - The x coordinate of the first point
    
    y1 - The y coordinate of the first point
    
    x2 - The x coordinate of the second point
    
    y2 - The y coordinate of the second point
    
    Returns:
    
    True if this Shape intersects the line segment
  - intersects
```
public boolean intersects(Rectangle rectangle)
```
    Returns if the specified Rectangle intersects this Circle
    
    Parameters:
    
    rectangle - The Rectangle to test for intersection
    
    Returns:
    
    True if intersection occurs
  - intersects
```
public boolean intersects(Circle circle)
```
    Returns if the specified Circle intersects this one
    
    Parameters:
    
    circle - The Circle to test for intersection
    
    Returns:
    
    True if intersection occurs
  - getDistanceTo
```
public float getDistanceTo(com.badlogic.gdx.math.Vector2 point)
```
    Returns the distance from the edge of this Circle to a point
    
    Parameters:
    
    point - The point
    
    Returns:
    
    The distance to the point
  - getDistanceTo
```
public float getDistanceTo(float x,
                           float y)
```
    Returns the distance from the edge of this Circle to a point
    
    Specified by:
    
    getDistanceTo in class Shape
    
    Parameters:
    
    x - The x coordinate
    
    y - The y coordinate
    
    Returns:
    
    The distance to the point
  - getDistanceFromCenter
```
public float getDistanceFromCenter(com.badlogic.gdx.math.Vector2 point)
```
    Returns the distance from the center of this Circle to a point
    
    Parameters:
    
    point - The point
    
    Returns:
    
    The distane to the point
  - getDistanceFromCenter
```
public float getDistanceFromCenter(float x,
                                   float y)
```
    Returns the distance from the center of this Circle to a point
    
    Parameters:
    
    x - The x coordinate
    
    y - The y coordinate
    
    Returns:
    
    The distane to the point
  - getNumberOfSides
```
public int getNumberOfSides()
```
    Description copied from class: Shape
    
    Returns the number of edges of this object
    
    Specified by:
    
    getNumberOfSides in class Shape
    
    Returns:
    
    The number of sides/edges
  - draw
```
public void draw(Graphics g)
```
    Description copied from class: Shape
    
    Draws this shape using a Graphics instance
    
    Specified by:
    
    draw in class Shape
    
    Parameters:
    
    g - The Graphics context to render with
  - fill
```
public void fill(Graphics g)
```
    Description copied from class: Shape
    
    Fills this shape using a Graphics instance
    
    Specified by:
    
    fill in class Shape
    
    Parameters:
    
    g - The Graphics context to render with
  - set
```
public void set(Circle circle)
```
  - getX
```
public float getX()
```
    Description copied from class: Shape
    
    Returns the x coordinate of this object
    
    Specified by:
    
    getX in class Shape
    
    Returns:
    
    0 by default
  - getY
```
public float getY()
```
    Description copied from class: Shape
    
    Returns the y coordinate of this object
    
    Specified by:
    
    getY in class Shape
    
    Returns:
    
    0 by default
  - setX
```
public void setX(float x)
```
    Description copied from class: Shape
    
    Sets the x coordinate of this object
    
    Specified by:
    
    setX in class Shape
    
    Parameters:
    
    x - The x coordinate
  - setY
```
public void setY(float y)
```
    Description copied from class: Shape
    
    Sets the y coordinate of this object
    
    Specified by:
    
    setY in class Shape
    
    Parameters:
    
    y - The y coordinate
  - getCenterX
```
public float getCenterX()
```
    Description copied from class: Shape
    
    Returns the center x coordinate of this object. Note for Circle this is the same as x.
    
    Specified by:
    
    getCenterX in class Shape
    
    Returns:
    
    0 by default
  - getCenterY
```
public float getCenterY()
```
    Description copied from class: Shape
    
    Returns the center y coordinate of this object. Note for Circle this is the same as y.
    
    Specified by:
    
    getCenterY in class Shape
    
    Returns:
    
    0 by default
  - setCenter
```
public void setCenter(float x,
                      float y)
```
    Description copied from class: Shape
    
    Sets the center x,y coordinate of this object
    
    Specified by:
    
    setCenter in class Shape
    
    Parameters:
    
    x - The x coordinate of the shape's center
    
    y - The y coordinate of the shape's center
  - setCenterX
```
public void setCenterX(float x)
```
    Description copied from class: Shape
    
    Sets the center x coordinate
    
    Specified by:
    
    setCenterX in class Shape
    
    Parameters:
    
    x - The x coordinate of the shape's center
  - setCenterY
```
public void setCenterY(float y)
```
    Description copied from class: Shape
    
    Sets the center y coordianate
    
    Specified by:
    
    setCenterY in class Shape
    
    Parameters:
    
    y - The y coordinate of the shape's center
  - set
```
public void set(float x,
                float y)
```
    Description copied from class: Shape
    
    Sets the x and y coordinate of this object
    
    Specified by:
    
    set in class Shape
    
    Parameters:
    
    x - The x coordinate
    
    y - The y coordinate
  - getMinX
```
public float getMinX()
```
    Description copied from class: Shape
    
    Returns the left-most x coordinate
    
    Specified by:
    
    getMinX in class Shape
    
    Returns:
  - getMinY
```
public float getMinY()
```
    Description copied from class: Shape
    
    Returns the top-most y coordinate
    
    Specified by:
    
    getMinY in class Shape
    
    Returns:
  - getMaxX
```
public float getMaxX()
```
    Description copied from class: Shape
    
    Returns the right-most x coordinate
    
    Specified by:
    
    getMaxX in class Shape
    
    Returns:
  - getMaxY
```
public float getMaxY()
```
    Description copied from class: Shape
    
    Returns the bottom-most y coordinate
    
    Specified by:
    
    getMaxY in class Shape
    
    Returns:
  - getRadius
```
public float getRadius()
```
  - setRadius
```
public void setRadius(float radius)
```
    Description copied from class: Shape
    
    Sets the radius of this shape. For Polygon shapes, this will stretch in/out the shape from its center. Note that Polygons must be equilateral.
    
    Specified by:
    
    setRadius in class Shape
    
    Parameters:
    
    radius - The radius in pixels
  - scale
```
public void scale(float scale)
```
    Description copied from class: Shape
    
    Scales the radius of this shape. For Polygon shapes, this will stretch in/out the shape from its center. Note that Polygons must be equilateral.
    
    Specified by:
    
    scale in class Shape
    
    Parameters:
    
    scale - The amount to scale by (e.g. 2.0 = double the size)
  - translate
```
public void translate(float translateX,
                      float translateY)
```
    Description copied from class: Shape
    
    Translates the x and y coordinate of this object
    
    Specified by:
    
    translate in class Shape
    
    Parameters:
    
    translateX - The x translation amount
    
    translateY - The y translation amount
  - edgeIterator
```
public EdgeIterator edgeIterator()
```
    Description copied from class: Shape
    
    Returns an EdgeIterator for looping over the edges of this Shape
    
    Specified by:
    
    edgeIterator in class Shape
    
    Returns:
    
    The EdgeIterator
  - getBoundingBox
```
public Rectangle getBoundingBox()
```
    Returns the bounding box of this Circle
    
    Returns:
    
    A Rectangle representing the area of this Circle
  - getRotation
```
public float getRotation()
```
    Description copied from class: Shape
    
    Returns the rotation of this Shape
    
    Specified by:
    
    getRotation in class Shape
    
    Returns:
    
    The rotation in degrees
  - setRotation
```
public void setRotation(float degrees)
```
    Description copied from class: Shape
    
    Sets the rotation of this Shape with its first point as the origin
    
    Specified by:
    
    setRotation in class Shape
    
    Parameters:
    
    degrees - The rotation in degrees
  - setRotationAround
```
public void setRotationAround(float centerX,
                              float centerY,
                              float degrees)
```
    Description copied from class: Shape
    
    Sets the rotation of this Shape with a specified point as the origin
    
    Specified by:
    
    setRotationAround in class Shape
    
    Parameters:
    
    centerX - The origin/center x coordinate
    
    centerY - The origin/center y coordinate
    
    degrees - The rotation in degrees
  - rotate
```
public void rotate(float degrees)
```
    Description copied from class: Shape
    
    Rotates this Shape by a specified amount of degrees with its first point as the origin
    
    Specified by:
    
    rotate in class Shape
    
    Parameters:
    
    degrees - The rotation in degrees
  - rotateAround
```
public void rotateAround(float centerX,
                         float centerY,
                         float degrees)
```
    Description copied from class: Shape
    
    Rotates this Shape by a specified amount of degrees around a specified point
    
    Specified by:
    
    rotateAround in class Shape
    
    Parameters:
    
    centerX - The origin/center x coordinate
    
    centerY - The origin/center y coordinate
    
    degrees - The rotation in degrees
  - isCircle
```
public boolean isCircle()
```
    Description copied from class: Shape
    
    Returns if this Shape is a Circle
    
    Specified by:
    
    isCircle in class Shape
    
    Returns:
    
    True if this Shape is a Circle
  - getPolygon
```
public Polygon getPolygon()
```
    Description copied from class: Shape
    
    Returns the Polygon representing this Shape
    
    Specified by:
    
    getPolygon in class Shape
    
    Returns:
    
    Null if this Shape is a Circle
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Shape
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class Shape

Class Circle

Constructor Summary

Method Summary

Methods inherited from class org.mini2Dx.core.geom.Shape

Methods inherited from class java.lang.Object

Constructor Detail

Circle

Circle

Circle

Method Detail

copy

lerp

contains

contains

contains

contains

contains

contains

intersects

intersectsLineSegment

intersectsLineSegment

intersects

intersects

getDistanceTo

getDistanceTo

getDistanceFromCenter

getDistanceFromCenter

getNumberOfSides

draw

fill

set

getX

getY

setX

setY

getCenterX

getCenterY

setCenter

setCenterX

setCenterY

set

getMinX

getMinY

getMaxX

getMaxY

getRadius

setRadius

scale

translate

edgeIterator

getBoundingBox

getRotation

setRotation

setRotationAround

rotate

rotateAround

isCircle

getPolygon

hashCode

equals