Shape (mini2Dx)

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

Direct Known Subclasses:

Circle, Polygon, Rectangle, RegularPolygon, Triangle
```
public abstract class Shape
extends java.lang.Object
```
Base class for shapes

Constructor Summary

Constructors
Constructor and Description

Shape()

Constructors
Constructor and Description
`Shape()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(float x, float y)` Adds components to the position of this `Shape`
`abstract boolean`	`contains(float x, float y)` Returns if a set of coordinates are contained inside this `Shape`
`abstract boolean`	`contains(Shape shape)` Returns if a `Shape` is contained inside this `Shape`
`abstract boolean`	`contains(com.badlogic.gdx.math.Vector2 vector2)` Returns if a `Vector2` is contained inside this `Shape`
`abstract Shape`	`copy()` Returns an exact copy of this `Shape`
`abstract void`	`draw(Graphics g)` Draws this shape using a `Graphics` instance
`abstract EdgeIterator`	`edgeIterator()` Returns an `EdgeIterator` for looping over the edges of this `Shape`
`boolean`	`equals(java.lang.Object obj)`
`abstract void`	`fill(Graphics g)` Fills this shape using a `Graphics` instance
`abstract float`	`getCenterX()` Returns the center x coordinate of this object.
`abstract float`	`getCenterY()` Returns the center y coordinate of this object.
`abstract 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`
`abstract float`	`getMaxX()` Returns the right-most x coordinate
`abstract float`	`getMaxY()` Returns the bottom-most y coordinate
`abstract float`	`getMinX()` Returns the left-most x coordinate
`abstract float`	`getMinY()` Returns the top-most y coordinate
`abstract int`	`getNumberOfSides()` Returns the number of edges of this object
`abstract Polygon`	`getPolygon()` Returns the `Polygon` representing this `Shape`
`abstract float`	`getRotation()` Returns the rotation of this `Shape`
`abstract float`	`getX()` Returns the x coordinate of this object
`abstract float`	`getY()` Returns the y coordinate of this object
`int`	`hashCode()`
`boolean`	`intersects(LineSegment lineSegment)` Returns if this `Shape` intersects the specified `LineSegment`
`abstract boolean`	`intersects(Shape shape)` Returns if this `Shape` intersects another `Shape`
`abstract boolean`	`intersectsLineSegment(float x1, float y1, float x2, float y2)` Returns if this `Shape` intersects a line segment
`abstract boolean`	`intersectsLineSegment(com.badlogic.gdx.math.Vector2 pointA, com.badlogic.gdx.math.Vector2 pointB)` Returns if this `Shape` intersects a line segment
`abstract boolean`	`isCircle()` Returns if this `Shape` is a `Circle`
`abstract void`	`rotate(float degrees)` Rotates this `Shape` by a specified amount of degrees with its first point as the origin
`abstract void`	`rotateAround(float originX, float originY, float degrees)` Rotates this `Shape` by a specified amount of degrees around a specified point
`abstract void`	`scale(float scale)` Scales the radius of this shape.
`abstract void`	`set(float x, float y)` Sets the x and y coordinate of this object
`abstract void`	`setCenter(float x, float y)` Sets the center x,y coordinate of this object
`abstract void`	`setCenterX(float x)` Sets the center x coordinate
`abstract void`	`setCenterY(float y)` Sets the center y coordianate
`abstract void`	`setRadius(float radius)` Sets the radius of this shape.
`abstract void`	`setRotation(float degrees)` Sets the rotation of this `Shape` with its first point as the origin
`abstract void`	`setRotationAround(float originX, float originY, float degrees)` Sets the rotation of this `Shape` with a specified point as the origin
`abstract void`	`setX(float x)` Sets the x coordinate of this object
`abstract void`	`setY(float y)` Sets the y coordinate of this object
`void`	`subtract(float x, float y)` Subtracts components from the position of this `Shape`
`abstract 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, toString, wait, wait, wait

- Constructor Detail
  - Shape
```
public Shape()
```
- Method Detail
  - copy
```
public abstract Shape copy()
```
    Returns an exact copy of this Shape
    
    Returns:
    
    A copy (new) instance of this Shape
  - contains
```
public abstract boolean contains(float x,
                                 float y)
```
    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 abstract boolean contains(com.badlogic.gdx.math.Vector2 vector2)
```
    Returns if a Vector2 is contained inside this Shape
    
    Parameters:
    
    vector2 - The Vector2 to check
    
    Returns:
    
    True if this Shape contains the specified Vector2
  - contains
```
public abstract boolean contains(Shape shape)
```
    Returns if a Shape is contained inside this Shape
    
    Parameters:
    
    shape - The Shape to check
    
    Returns:
    
    True if this Shape contains the specified Shape
  - intersects
```
public boolean intersects(LineSegment lineSegment)
```
    Returns if this Shape intersects the specified LineSegment
    
    Parameters:
    
    lineSegment - The LineSegment to check
    
    Returns:
    
    True if this Shape intersects the LineSegment
  - intersectsLineSegment
```
public abstract boolean intersectsLineSegment(com.badlogic.gdx.math.Vector2 pointA,
                                              com.badlogic.gdx.math.Vector2 pointB)
```
    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 abstract boolean intersectsLineSegment(float x1,
                                              float y1,
                                              float x2,
                                              float y2)
```
    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
  - intersects
```
public abstract boolean intersects(Shape shape)
```
    Returns if this Shape intersects another Shape
    
    Parameters:
    
    shape - The Shape to check
    
    Returns:
    
    True if this Shape intersects the specified Shape
  - getDistanceTo
```
public abstract float getDistanceTo(float x,
                                    float y)
```
    Returns the distance from this Shape to a set of coordinates
    
    Parameters:
    
    x - The x coordinate
    
    y - The y coordinate
    
    Returns:
    
    The distance
  - getDistanceTo
```
public float getDistanceTo(Point point)
```
    Returns the distance from this Shape to a Point
    
    Parameters:
    
    point - The Point to get the distance to
    
    Returns:
    
    The distance
  - add
```
public void add(float x,
                float y)
```
    Adds components to the position of this Shape
    
    Parameters:
    
    x - The x component
    
    y - The y component
  - subtract
```
public void subtract(float x,
                     float y)
```
    Subtracts components from the position of this Shape
    
    Parameters:
    
    x - The x component
    
    y - The y component
  - getRotation
```
public abstract float getRotation()
```
    Returns the rotation of this Shape
    
    Returns:
    
    The rotation in degrees
  - setRotation
```
public abstract void setRotation(float degrees)
```
    Sets the rotation of this Shape with its first point as the origin
    
    Parameters:
    
    degrees - The rotation in degrees
  - setRotationAround
```
public abstract void setRotationAround(float originX,
                                       float originY,
                                       float degrees)
```
    Sets the rotation of this Shape with a specified point as the origin
    
    Parameters:
    
    originX - The origin/center x coordinate
    
    originY - The origin/center y coordinate
    
    degrees - The rotation in degrees
  - rotate
```
public abstract void rotate(float degrees)
```
    Rotates this Shape by a specified amount of degrees with its first point as the origin
    
    Parameters:
    
    degrees - The rotation in degrees
  - rotateAround
```
public abstract void rotateAround(float originX,
                                  float originY,
                                  float degrees)
```
    Rotates this Shape by a specified amount of degrees around a specified point
    
    Parameters:
    
    originX - The origin/center x coordinate
    
    originY - The origin/center y coordinate
    
    degrees - The rotation in degrees
  - draw
```
public abstract void draw(Graphics g)
```
    Draws this shape using a Graphics instance
    
    Parameters:
    
    g - The Graphics context to render with
  - fill
```
public abstract void fill(Graphics g)
```
    Fills this shape using a Graphics instance
    
    Parameters:
    
    g - The Graphics context to render with
  - getX
```
public abstract float getX()
```
    Returns the x coordinate of this object
    
    Returns:
    
    0 by default
  - getY
```
public abstract float getY()
```
    Returns the y coordinate of this object
    
    Returns:
    
    0 by default
  - getCenterX
```
public abstract float getCenterX()
```
    Returns the center x coordinate of this object. Note for Circle this is the same as x.
    
    Returns:
    
    0 by default
  - getCenterY
```
public abstract float getCenterY()
```
    Returns the center y coordinate of this object. Note for Circle this is the same as y.
    
    Returns:
    
    0 by default
  - setCenter
```
public abstract void setCenter(float x,
                               float y)
```
    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 abstract void setCenterX(float x)
```
    Sets the center x coordinate
    
    Parameters:
    
    x - The x coordinate of the shape's center
  - setCenterY
```
public abstract void setCenterY(float y)
```
    Sets the center y coordianate
    
    Parameters:
    
    y - The y coordinate of the shape's center
  - setX
```
public abstract void setX(float x)
```
    Sets the x coordinate of this object
    
    Parameters:
    
    x - The x coordinate
  - setY
```
public abstract void setY(float y)
```
    Sets the y coordinate of this object
    
    Parameters:
    
    y - The y coordinate
  - set
```
public abstract void set(float x,
                         float y)
```
    Sets the x and y coordinate of this object
    
    Parameters:
    
    x - The x coordinate
    
    y - The y coordinate
  - setRadius
```
public abstract void setRadius(float radius)
```
    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 abstract void scale(float scale)
```
    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)
  - getMinX
```
public abstract float getMinX()
```
    Returns the left-most x coordinate
    
    Returns:
  - getMinY
```
public abstract float getMinY()
```
    Returns the top-most y coordinate
    
    Returns:
  - getMaxX
```
public abstract float getMaxX()
```
    Returns the right-most x coordinate
    
    Returns:
  - getMaxY
```
public abstract float getMaxY()
```
    Returns the bottom-most y coordinate
    
    Returns:
  - translate
```
public abstract void translate(float translateX,
                               float translateY)
```
    Translates the x and y coordinate of this object
    
    Parameters:
    
    translateX - The x translation amount
    
    translateY - The y translation amount
  - getNumberOfSides
```
public abstract int getNumberOfSides()
```
    Returns the number of edges of this object
    
    Returns:
    
    The number of sides/edges
  - edgeIterator
```
public abstract EdgeIterator edgeIterator()
```
    Returns an EdgeIterator for looping over the edges of this Shape
    
    Returns:
    
    The EdgeIterator
  - isCircle
```
public abstract boolean isCircle()
```
    Returns if this Shape is a Circle
    
    Returns:
    
    True if this Shape is a Circle
  - getPolygon
```
public abstract Polygon getPolygon()
```
    Returns the Polygon representing this Shape
    
    Returns:
    
    Null if this Shape is a Circle
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class Shape

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Shape

Method Detail

copy

contains

contains

contains

intersects

intersectsLineSegment

intersectsLineSegment

intersects

getDistanceTo

getDistanceTo

add

subtract

getRotation

setRotation

setRotationAround

rotate

rotateAround

draw

fill

getX

getY

getCenterX

getCenterY

setCenter

setCenterX

setCenterY

setX

setY

set

setRadius

scale

getMinX

getMinY

getMaxX

getMaxY

translate

getNumberOfSides

edgeIterator

isCircle

getPolygon

hashCode

equals