Rectangle (mini2Dx)

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

All Implemented Interfaces:

Positionable, Sizeable

Direct Known Subclasses:

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

Field Summary
- Fields inherited from class org.mini2Dx.core.geom.Shape
  geometry, positionChangeListeners, sizeChangeListeners

Constructor Summary

Constructors
Constructor and Description
`Rectangle()` Default constructor.
`Rectangle(float x, float y, float width, float height)` Constructor
`Rectangle(Geometry geometry)` Constructs a `Rectangle` belonging to the `Geometry` pool
`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(Rectangle rectangle)`
`boolean`	`contains(Sizeable shape)` Returns if this shape contains the specified shape
`boolean`	`contains(org.mini2Dx.gdx.math.Vector2 point)` Returns if a `Vector2` is contained inside this shape
`Shape`	`copy()` Returns an exact copy of this `Shape`
`void`	`dispose()` Releases this `Shape` back to the `Geometry` pool (if it was created from the pool)
`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 this distance between this object's x,y coordinates and the provided xy coordinates
`float`	`getHeight()` Returns the height of this object
`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 this object
`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)`
`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(Sizeable shape)` Returns if this shape intersects a 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(org.mini2Dx.gdx.math.Vector2 pointA, org.mini2Dx.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.
`Rectangle`	`set(float x, float y, float width, float height)`
`void`	`set(Rectangle rectangle)`
`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
`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`	`setXY(float x, float y)` Sets the x and y coordinate of this object
`void`	`setXY(org.mini2Dx.gdx.math.Vector2 position)`
`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 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(Geometry geometry)
```
    Constructs a Rectangle belonging to the Geometry pool
    
    Parameters:
    
    geometry - The Geometry pool
  - 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
  - dispose
```
public void dispose()
```
    Description copied from class: Shape
    
    Releases this Shape back to the Geometry pool (if it was created from the pool)
    
    Specified by:
    
    dispose in class Shape
  - 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 interface: Sizeable
    
    Returns if a set of coordinates are contained inside this 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(org.mini2Dx.gdx.math.Vector2 point)
```
    Description copied from interface: Sizeable
    
    Returns if a Vector2 is contained inside this shape
    
    Parameters:
    
    point - The Vector2 to check
    
    Returns:
    
    True if this shape contains the specified Vector2
  - contains
```
public boolean contains(Sizeable shape)
```
    Description copied from interface: Sizeable
    
    Returns if this shape contains the specified shape
    
    Parameters:
    
    shape - The Sizeable to check
    
    Returns:
    
    True if this Sizeable is inside this shape
  - contains
```
public boolean contains(Rectangle rectangle)
```
  - contains
```
public boolean contains(Circle circle)
```
  - intersects
```
public boolean intersects(Sizeable shape)
```
    Description copied from interface: Sizeable
    
    Returns if this shape intersects a shape
    
    Parameters:
    
    shape - The Sizeable to check
    
    Returns:
    
    True if this shape intersects the specified Sizeable
  - 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(float x,
                          float y,
                          float width,
                          float height)
```
  - 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(org.mini2Dx.gdx.math.Vector2 pointA,
                                     org.mini2Dx.gdx.math.Vector2 pointB)
```
    Description copied from interface: Sizeable
    
    Returns if this shape intersects a line segment
    
    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 interface: Sizeable
    
    Returns if this shape intersects a line segment
    
    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 interface Sizeable
    
    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(float x,
                           float y)
```
    Description copied from interface: Positionable
    
    Returns this distance between this object's x,y coordinates and the provided xy coordinates
    
    Parameters:
    
    x - The x coordinate to measure distance to
    
    y - The y coordinate to measure distance to
    
    Returns:
    
    0 if the xy coordinates are the same
  - 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
  - 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
  - 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)
```
  - setXY
```
public void setXY(float x,
                  float y)
```
    Description copied from interface: Positionable
    
    Sets the x and y coordinate of this object
    
    Parameters:
    
    x - The x coordinate
    
    y - The y coordinate
  - setXY
```
public void setXY(org.mini2Dx.gdx.math.Vector2 position)
```
  - getX
```
public float getX()
```
    Description copied from interface: Positionable
    
    Returns the x coordinate of this object
    
    Returns:
    
    0 by default
  - setX
```
public void setX(float x)
```
    Description copied from interface: Positionable
    
    Sets the x coordinate of this object
    
    Parameters:
    
    x - The x coordinate
  - getY
```
public float getY()
```
    Description copied from interface: Positionable
    
    Returns the y coordinate of this object
    
    Returns:
    
    0 by default
  - setY
```
public void setY(float y)
```
    Description copied from interface: Positionable
    
    Sets the y coordinate of this object
    
    Parameters:
    
    y - The y coordinate
  - getWidth
```
public float getWidth()
```
    Description copied from interface: Sizeable
    
    Returns the width of this object
    
    Returns:
    
    0 by default
  - setWidth
```
public Rectangle setWidth(float width)
```
  - getHeight
```
public float getHeight()
```
    Description copied from interface: Sizeable
    
    Returns the height of this object
    
    Returns:
    
    0 by default
  - 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 interface: Sizeable
    
    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.
    
    Parameters:
    
    radius - The radius in pixels
  - scale
```
public void scale(float scale)
```
    Description copied from interface: Sizeable
    
    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.
    
    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
    
    Returns:
  - getCenterY
```
public float getCenterY()
```
    Returns the y coordinate of the center of this Rectangle
    
    Returns:
  - setCenter
```
public void setCenter(float x,
                      float y)
```
    Description copied from interface: Sizeable
    
    Sets the center x,y coordinate of this object
    
    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 interface: Sizeable
    
    Sets the center x coordinate
    
    Parameters:
    
    x - The x coordinate of the shape's center
  - setCenterY
```
public void setCenterY(float y)
```
    Description copied from interface: Sizeable
    
    Sets the center y coordianate
    
    Parameters:
    
    y - The y coordinate of the shape's center
  - getMinX
```
public float getMinX()
```
    Returns the least x coordinate this Rectangle
    
    Returns:
  - getMinY
```
public float getMinY()
```
    Returns the least y coordinate this Rectangle
    
    Returns:
  - getMaxX
```
public float getMaxX()
```
    Returns the greatest x coordinate this Rectangle
    
    Returns:
  - getMaxY
```
public float getMaxY()
```
    Returns the greatest y coordinate this Rectangle
    
    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 interface Sizeable
    
    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 interface Sizeable
    
    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

Field Summary

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

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

Rectangle

Method Detail

dispose

copy

contains

contains

contains

contains

contains

intersects

intersects

intersects

intersects

intersects

intersects

intersectsLineSegment

intersectsLineSegment

intersection

getNumberOfSides

draw

fill

lerp

getDistanceTo

getRotation

setRotation

rotate

rotateAround

setRotationAround

set

set

setXY

setXY

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