org.mini2Dx.core.geom

Class Shape

java.lang.Object

org.mini2Dx.core.geom.Shape

All Implemented Interfaces:

Positionable, Sizeable

Direct Known Subclasses:

Circle, Polygon, Rectangle, RegularPolygon, Triangle

public abstract class Shape
extends java.lang.Object
implements Sizeable

Base class for shapes

Field Summary

Fields

Modifier and Type	Field and Description
protected Geometry	geometry
protected org.mini2Dx.gdx.utils.Array<PositionChangeListener>	positionChangeListeners
protected org.mini2Dx.gdx.utils.Array<SizeChangeListener>	sizeChangeListeners

Constructor Summary

Constructors

Constructor and Description
Shape() Constructor for shapes not belonging to the Geometry pool
Shape(Geometry geometry) Constructor for shapes belonging to the Geometry pool

Method Summary

Modifier and Type	Method and Description
void	add(float x, float y) Adds components to the position of this Shape
<T extends Positionable> void	addPostionChangeListener(PositionChangeListener<T> listener) Adds a Positionable to be notified of coordinate changes
<T extends Sizeable> void	addSizeChangeListener(SizeChangeListener<T> listener) Adds a SizeChangeListener to be notified of size changes
protected void	clearPositionChangeListeners()
static <T extends Positionable> void	clearPositionListeners(org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners)
static <T extends Positionable> void	clearPositionListeners(java.util.concurrent.locks.ReadWriteLock lock, org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners)
protected void	clearSizeChangeListeners()
static <T extends Sizeable> void	clearSizeListeners(org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners)
static <T extends Sizeable> void	clearSizeListeners(java.util.concurrent.locks.ReadWriteLock lock, org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners)
abstract Shape	copy() Returns an exact copy of this Shape
abstract void	dispose() Releases this Shape back to the Geometry pool (if it was created from the pool)
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
float	getDistanceTo(Positionable positionable) Returns the distance from this Shape to a Positionable
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
int	hashCode()
boolean	intersects(LineSegment lineSegment) Returns if this Shape intersects the specified LineSegment
abstract boolean	isCircle() Returns if this Shape is a Circle
void	moveTowards(float x, float y, float speed) Moves this Positionable towards a coordinate
void	moveTowards(Positionable positionable, float speed) Moves this Positionable towards another Positionable
protected void	notifyPositionChangeListeners()
static <T extends Positionable> void	notifyPositionListeners(org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners, T notifier)
static <T extends Positionable> void	notifyPositionListeners(java.util.concurrent.locks.ReadWriteLock lock, org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners, T notifier)
protected void	notifySizeChangeListeners()
static <T extends Sizeable> void	notifySizeListeners(org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners, T notifier)
static <T extends Sizeable> void	notifySizeListeners(java.util.concurrent.locks.ReadWriteLock lock, org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners, T notifier)
<T extends Positionable> void	removePositionChangeListener(PositionChangeListener<T> listener) Removes a PositionChangeListener to stop it being notified of coordinate changes
static <T extends Positionable> void	removePositionListener(org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners, PositionChangeListener listener)
static <T extends Positionable> void	removePositionListener(java.util.concurrent.locks.ReadWriteLock lock, org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners, PositionChangeListener listener)
<T extends Sizeable> void	removeSizeChangeListener(SizeChangeListener<T> listener) Removes a SizeChangeListener to stop it being notified of size changes
static <T extends Sizeable> void	removeSizeListener(org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners, SizeChangeListener listener)
static <T extends Sizeable> void	removeSizeListener(java.util.concurrent.locks.ReadWriteLock lock, org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners, SizeChangeListener listener)
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	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
void	setRotationAround(Point center, float degrees) Sets the rotation of this Shape with a specified point as the origin
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

Methods inherited from interface org.mini2Dx.core.geom.Sizeable

contains, contains, contains, getCenterX, getCenterY, getHeight, getMaxX, getMaxY, getMinX, getMinY, getWidth, intersects, intersectsLineSegment, intersectsLineSegment, scale, setCenter, setCenterX, setCenterY, setRadius

Methods inherited from interface org.mini2Dx.core.geom.Positionable

getDistanceTo, getX, getY, setX, setXY, setY

Field Detail

geometry

protected final Geometry geometry

positionChangeListeners

protected org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners

sizeChangeListeners

protected org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners

Constructor Detail

Shape

public Shape()

Constructor for shapes not belonging to the Geometry pool

Shape

public Shape(Geometry geometry)

Constructor for shapes belonging to the Geometry pool

Parameters:

geometry - The Geometry pool

Method Detail

dispose

public abstract void dispose()

Releases this Shape back to the Geometry pool (if it was created from the pool)

copy

public abstract Shape copy()

Returns an exact copy of this Shape

Returns:

A copy (new) instance of this Shape

intersects

public boolean intersects(LineSegment lineSegment)

Returns if this Shape intersects the specified LineSegment

Specified by:

intersects in interface Sizeable

Parameters:

lineSegment - The LineSegment to check

Returns:

True if this Shape intersects the LineSegment

getDistanceTo

public float getDistanceTo(Positionable positionable)

Returns the distance from this Shape to a Positionable

Specified by:

getDistanceTo in interface Positionable

Parameters:

positionable - The Positionable 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 void setRotationAround(Point center,
                              float degrees)

Sets the rotation of this Shape with a specified point as the origin

Parameters:

center - The origin Point

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

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

Specified by:

getNumberOfSides in interface Sizeable

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

Specified by:

isCircle in interface Sizeable

Returns:

True if this Shape is a Circle

getPolygon

public abstract Polygon getPolygon()

Returns the Polygon representing this Shape

Specified by:

getPolygon in interface Sizeable

Returns:

Null if this Shape is a Circle

moveTowards

public void moveTowards(float x,
                        float y,
                        float speed)

Description copied from interface: Positionable

Moves this Positionable towards a coordinate

Specified by:

moveTowards in interface Positionable

Parameters:

x - The target x coordinate

y - The target y coordinate

speed - The amount to move by

moveTowards

public void moveTowards(Positionable positionable,
                        float speed)

Description copied from interface: Positionable

Moves this Positionable towards another Positionable

Specified by:

moveTowards in interface Positionable

Parameters:

positionable - The target Positionable

speed - The amount to move by

addPostionChangeListener

public <T extends Positionable> void addPostionChangeListener(PositionChangeListener<T> listener)

Description copied from interface: Positionable

Adds a Positionable to be notified of coordinate changes

Specified by:

addPostionChangeListener in interface Positionable

Parameters:

listener - The PositionChangeListener to add

See Also:

Positionable.addPostionChangeListener(PositionChangeListener)

removePositionChangeListener

public <T extends Positionable> void removePositionChangeListener(PositionChangeListener<T> listener)

Description copied from interface: Positionable

Removes a PositionChangeListener to stop it being notified of coordinate changes

Specified by:

removePositionChangeListener in interface Positionable

Parameters:

listener - The PositionChangeListener to remove

See Also:

Positionable.removePositionChangeListener(PositionChangeListener)

addSizeChangeListener

public <T extends Sizeable> void addSizeChangeListener(SizeChangeListener<T> listener)

Description copied from interface: Sizeable

Adds a SizeChangeListener to be notified of size changes

Specified by:

addSizeChangeListener in interface Sizeable

Parameters:

listener - The SizeChangeListener to add

removeSizeChangeListener

public <T extends Sizeable> void removeSizeChangeListener(SizeChangeListener<T> listener)

Description copied from interface: Sizeable

Removes a SizeChangeListener to stop it being notified of size changes

Specified by:

removeSizeChangeListener in interface Sizeable

Parameters:

listener - The SizeChangeListener to remove

notifyPositionChangeListeners

protected void notifyPositionChangeListeners()

clearPositionChangeListeners

protected void clearPositionChangeListeners()

notifySizeChangeListeners

protected void notifySizeChangeListeners()

clearSizeChangeListeners

protected void clearSizeChangeListeners()

removePositionListener

public static <T extends Positionable> void removePositionListener(org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners,
                                                                   PositionChangeListener listener)

removePositionListener

public static <T extends Positionable> void removePositionListener(java.util.concurrent.locks.ReadWriteLock lock,
                                                                   org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners,
                                                                   PositionChangeListener listener)

notifyPositionListeners

public static <T extends Positionable> void notifyPositionListeners(org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners,
                                                                    T notifier)

notifyPositionListeners

public static <T extends Positionable> void notifyPositionListeners(java.util.concurrent.locks.ReadWriteLock lock,
                                                                    org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners,
                                                                    T notifier)

clearPositionListeners

public static <T extends Positionable> void clearPositionListeners(org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners)

clearPositionListeners

public static <T extends Positionable> void clearPositionListeners(java.util.concurrent.locks.ReadWriteLock lock,
                                                                   org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners)

removeSizeListener

public static <T extends Sizeable> void removeSizeListener(org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners,
                                                           SizeChangeListener listener)

removeSizeListener

public static <T extends Sizeable> void removeSizeListener(java.util.concurrent.locks.ReadWriteLock lock,
                                                           org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners,
                                                           SizeChangeListener listener)

notifySizeListeners

public static <T extends Sizeable> void notifySizeListeners(org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners,
                                                            T notifier)

notifySizeListeners

public static <T extends Sizeable> void notifySizeListeners(java.util.concurrent.locks.ReadWriteLock lock,
                                                            org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners,
                                                            T notifier)

clearSizeListeners

public static <T extends Sizeable> void clearSizeListeners(org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners)

clearSizeListeners

public static <T extends Sizeable> void clearSizeListeners(java.util.concurrent.locks.ReadWriteLock lock,
                                                           org.mini2Dx.gdx.utils.Array<SizeChangeListener> sizeChangeListeners)

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