Rectangle (mini2Dx)

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

All Implemented Interfaces:

Parallelogram

Direct Known Subclasses:

CollisionBox, ConcurrentPointQuadTree, PointQuadTree, StaticCollisionBox
```
public class Rectangle
extends Shape
implements Parallelogram
```
Implements a rectangle.

Constructor Summary

Constructors
Constructor and Description
`Rectangle()` Default constructor.
`Rectangle(float x, float y, float width, float height)` Constructor
`Rectangle(Rectangle rectangle)` Constructs a new `Rectangle` as a copy of another

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(Circle circle)`
`boolean`	`contains(float x, float y)` Returns if a set of coordinates are contained inside this `Shape`
`boolean`	`contains(Parallelogram parallelogram)`
`boolean`	`contains(Rectangle 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
`float`	`getCenterX()` Returns the x coordinate of the center of this `Rectangle`
`float`	`getCenterY()` Returns the y coordinate of the center of this `Rectangle`
`float`	`getDistanceTo(float x, float y)` Returns the distance from this `Shape` to a set of coordinates
`float`	`getDistanceTo(Point point)` Returns the distance from this `Shape` to a `Point`
`float`	`getHeight()` Returns the height of the shape
`float`	`getMaxX()` Returns the greatest x coordinate this `Rectangle`
`float`	`getMaxY()` Returns the greatest y coordinate this `Rectangle`
`float`	`getMinX()` Returns the least x coordinate this `Rectangle`
`float`	`getMinY()` Returns the least y coordinate this `Rectangle`
`int`	`getNumberOfSides()` Returns the number of edges of this object
`Polygon`	`getPolygon()` Returns the `Polygon` representing this `Shape`
`float`	`getRotation()` Returns the rotation of this `Shape`
`float[]`	`getVertices()` Returns the vertices that make up this `Rectangle`
`float`	`getWidth()` Returns the width of the shape
`float`	`getX()` Returns the x coordinate of this object
`float`	`getY()` Returns the y coordinate of this object
`int`	`hashCode()`
`Rectangle`	`intersection(Rectangle rect)`
`boolean`	`intersects(Circle circle)` Returns if the specified `Circle` intersects this `Rectangle`
`boolean`	`intersects(float x, float y, float width, float height)` Returns if this shape intersects a specified rectangle dimensions
`boolean`	`intersects(Parallelogram parallelogram)`
`boolean`	`intersects(Polygon polygon)` Returns if the specified `Polygon` intersects this `Rectangle`
`boolean`	`intersects(Rectangle rectangle)` Returns if the specified `Rectangle` intersects this one
`boolean`	`intersects(Shape shape)` Returns if this `Shape` intersects another `Shape`
`boolean`	`intersects(Triangle triangle)` Returns if the specified `Triangle` intersects this `Rectangle`
`boolean`	`intersectsLineSegment(float x1, float y1, float x2, float y2)` Returns if this `Shape` intersects a line segment
`boolean`	`intersectsLineSegment(LineSegment lineSegment)` Returns if this shape intersects a specified `LineSegment`
`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`
`Rectangle`	`lerp(Rectangle 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(float x, float y)` Sets the x and y coordinate of this object
`Rectangle`	`set(float x, float y, float width, float height)`
`void`	`set(Rectangle rectangle)`
`void`	`set(com.badlogic.gdx.math.Vector2 position)`
`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
`Rectangle`	`setHeight(float height)`
`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`	`setRotationAround(Point center, float degrees)` Sets the current rotation of the shape around a center point
`Rectangle`	`setSize(float sizeXY)`
`Rectangle`	`setSize(float width, float height)`
`Rectangle`	`setWidth(float width)`
`void`	`setX(float x)` Sets the x coordinate of this object
`void`	`setY(float y)` Sets the y coordinate of this object
`java.lang.String`	`toString()`
`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, intersects, subtract

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

- Constructor Detail
  - Rectangle
```
public Rectangle()
```
    Default constructor. Creates a Rectangle at 0,0 with a width and height of 1
  - Rectangle
```
public Rectangle(float x,
                 float y,
                 float width,
                 float height)
```
    Constructor
    
    Parameters:
    
    x - The x coordinate of the Rectangle
    
    y - The y coordinate of the Rectangle
    
    width - The width of the Rectangle
    
    height - The height of the Rectangle
  - Rectangle
```
public Rectangle(Rectangle rectangle)
```
    Constructs a new Rectangle as a copy of another
    
    Parameters:
    
    rectangle - The Rectangle 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
  - 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 interface Parallelogram
    
    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(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(Shape shape)
```
    Description copied from class: Shape
    
    Returns if a Shape is contained inside this Shape
    
    Specified by:
    
    contains in interface Parallelogram
    
    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(Parallelogram parallelogram)
```
  - contains
```
public boolean contains(Rectangle rectangle)
```
  - contains
```
public boolean contains(Circle circle)
```
  - intersects
```
public boolean intersects(Shape shape)
```
    Description copied from class: Shape
    
    Returns if this Shape intersects another Shape
    
    Specified by:
    
    intersects in interface Parallelogram
    
    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(LineSegment lineSegment)
```
    Description copied from interface: Parallelogram
    
    Returns if this shape intersects a specified LineSegment
    
    Specified by:
    
    intersectsLineSegment in interface Parallelogram
    
    Parameters:
    
    lineSegment - The LineSegment to test for intersection
    
    Returns:
    
    True if an intersection occurs
  - intersects
```
public boolean intersects(Circle circle)
```
    Returns if the specified Circle intersects this Rectangle
    
    Parameters:
    
    circle - The Circle to test for intersection
    
    Returns:
    
    True if the Circle intersects
  - intersects
```
public boolean intersects(Rectangle rectangle)
```
    Returns if the specified Rectangle intersects this one
    
    Parameters:
    
    rectangle - The Rectangle to test for intersection
    
    Returns:
    
    True if the Rectangles intersect
  - intersects
```
public boolean intersects(Parallelogram parallelogram)
```
  - intersects
```
public boolean intersects(float x,
                          float y,
                          float width,
                          float height)
```
    Description copied from interface: Parallelogram
    
    Returns if this shape intersects a specified rectangle dimensions
    
    Specified by:
    
    intersects in interface Parallelogram
    
    Parameters:
    
    x - The x coordinate of the rectangle
    
    y - The y coordinate of the rectangle
    
    width - The width of the rectangle
    
    height - The height of the rectangle
    
    Returns:
    
    True if an intersection occurs
  - intersects
```
public boolean intersects(Triangle triangle)
```
    Returns if the specified Triangle intersects this Rectangle
    
    Parameters:
    
    triangle - The Triangle to check
    
    Returns:
    
    True if this Rectangle and the Triangle intersect
  - intersects
```
public boolean intersects(Polygon polygon)
```
    Returns if the specified Polygon intersects this Rectangle
    
    Parameters:
    
    polygon - The Polygon to check
    
    Returns:
    
    True if this Rectangle and the Polygon intersect
  - 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
  - intersection
```
public Rectangle intersection(Rectangle rect)
```
  - 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
    
    See Also:
    
    Shape.getNumberOfSides()
  - 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
    
    See Also:
    
    Shape.draw(Graphics)
  - 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
  - lerp
```
public Rectangle lerp(Rectangle target,
                      float alpha)
```
  - getDistanceTo
```
public float getDistanceTo(Point point)
```
    Description copied from class: Shape
    
    Returns the distance from this Shape to a Point
    
    Overrides:
    
    getDistanceTo in class Shape
    
    Parameters:
    
    point - The Point to get the distance to
    
    Returns:
    
    The distance
  - getDistanceTo
```
public float getDistanceTo(float x,
                           float y)
```
    Description copied from class: Shape
    
    Returns the distance from this Shape to a set of coordinates
    
    Specified by:
    
    getDistanceTo in class Shape
    
    Parameters:
    
    x - The x coordinate
    
    y - The y coordinate
    
    Returns:
    
    The distance
  - getRotation
```
public float getRotation()
```
    Description copied from class: Shape
    
    Returns the rotation of this Shape
    
    Specified by:
    
    getRotation in interface Parallelogram
    
    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 interface Parallelogram
    
    Specified by:
    
    setRotation in class Shape
    
    Parameters:
    
    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 interface Parallelogram
    
    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 interface Parallelogram
    
    Specified by:
    
    rotateAround in class Shape
    
    Parameters:
    
    centerX - The origin/center x coordinate
    
    centerY - The origin/center y coordinate
    
    degrees - The rotation in degrees
  - setRotationAround
```
public void setRotationAround(Point center,
                              float degrees)
```
    Description copied from interface: Parallelogram
    
    Sets the current rotation of the shape around a center point
    
    Specified by:
    
    setRotationAround in interface Parallelogram
    
    Parameters:
    
    center - The center point to rotate around
    
    degrees - The rotation angle 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
  - set
```
public Rectangle set(float x,
                     float y,
                     float width,
                     float height)
```
  - set
```
public void set(Rectangle rectangle)
```
  - 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
  - set
```
public void set(com.badlogic.gdx.math.Vector2 position)
```
  - getX
```
public float getX()
```
    Description copied from class: Shape
    
    Returns the x coordinate of this object
    
    Specified by:
    
    getX in interface Parallelogram
    
    Specified by:
    
    getX 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
  - getY
```
public float getY()
```
    Description copied from class: Shape
    
    Returns the y coordinate of this object
    
    Specified by:
    
    getY in interface Parallelogram
    
    Specified by:
    
    getY in class Shape
    
    Returns:
    
    0 by default
  - 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
  - getWidth
```
public float getWidth()
```
    Description copied from interface: Parallelogram
    
    Returns the width of the shape
    
    Specified by:
    
    getWidth in interface Parallelogram
    
    Returns:
  - setWidth
```
public Rectangle setWidth(float width)
```
  - getHeight
```
public float getHeight()
```
    Description copied from interface: Parallelogram
    
    Returns the height of the shape
    
    Specified by:
    
    getHeight in interface Parallelogram
    
    Returns:
  - setHeight
```
public Rectangle setHeight(float height)
```
  - setSize
```
public Rectangle setSize(float width,
                         float height)
```
  - setSize
```
public Rectangle setSize(float sizeXY)
```
  - 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
  - getCenterX
```
public float getCenterX()
```
    Returns the x coordinate of the center of this Rectangle
    
    Specified by:
    
    getCenterX in class Shape
    
    Returns:
  - getCenterY
```
public float getCenterY()
```
    Returns the y coordinate of the center of this Rectangle
    
    Specified by:
    
    getCenterY in class Shape
    
    Returns:
  - 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
  - getMinX
```
public float getMinX()
```
    Returns the least x coordinate this Rectangle
    
    Specified by:
    
    getMinX in class Shape
    
    Returns:
  - getMinY
```
public float getMinY()
```
    Returns the least y coordinate this Rectangle
    
    Specified by:
    
    getMinY in class Shape
    
    Returns:
  - getMaxX
```
public float getMaxX()
```
    Returns the greatest x coordinate this Rectangle
    
    Specified by:
    
    getMaxX in interface Parallelogram
    
    Specified by:
    
    getMaxX in class Shape
    
    Returns:
  - getMaxY
```
public float getMaxY()
```
    Returns the greatest y coordinate this Rectangle
    
    Specified by:
    
    getMaxY in interface Parallelogram
    
    Specified by:
    
    getMaxY in class Shape
    
    Returns:
  - getVertices
```
public float[] getVertices()
```
    Returns the vertices that make up this Rectangle
    
    Returns:
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - 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 Rectangle

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Rectangle

Rectangle

Rectangle

Method Detail

copy

contains

contains

contains

contains

contains

contains

intersects

intersectsLineSegment

intersects

intersects

intersects

intersects

intersects

intersects

intersectsLineSegment

intersectsLineSegment

intersection

getNumberOfSides

draw

fill

lerp

getDistanceTo

getDistanceTo

getRotation

setRotation

rotate

rotateAround

setRotationAround

setRotationAround

set

set

set

set

getX

setX

getY

setY

getWidth

setWidth

getHeight

setHeight

setSize

setSize

setRadius

scale

translate

edgeIterator

getCenterX

getCenterY

setCenter

setCenterX

setCenterY

getMinX

getMinY

getMaxX

getMaxY

getVertices

toString

isCircle

getPolygon

hashCode

equals