org.mini2Dx.core.collision.util

Class StaticCollisionBox

java.lang.Object

org.mini2Dx.core.geom.Shape

org.mini2Dx.core.geom.Rectangle

org.mini2Dx.core.collision.util.StaticCollisionBox

All Implemented Interfaces:

CollisionArea, CollisionObject, StaticCollision, Positionable, Sizeable, Interpolatable, org.mini2Dx.gdx.utils.Disposable

Direct Known Subclasses:

QuadTreeAwareStaticCollisionBox

public class StaticCollisionBox
extends Rectangle
implements CollisionArea, StaticCollision

An implementation of a collision box that does not register as an interpolating collision. Due to this, memory and CPU overhead are reduced compared to using the CollisionBox implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected Collisions	collisions

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

disposed, geometry, positionChangeListeners, sizeChangeListeners

Constructor Summary

Constructors

Constructor and Description
StaticCollisionBox()
StaticCollisionBox(float x, float y, float width, float height)
StaticCollisionBox(int id)
StaticCollisionBox(int id, Collisions collisions)
StaticCollisionBox(int id, float x, float y, float width, float height)
StaticCollisionBox(int id, Rectangle rectangle)
StaticCollisionBox(Rectangle rectangle)

Method Summary

Modifier and Type	Method and Description
void	dispose() Releases this Shape back to the Geometry pool (if it was created from the pool)
boolean	equals(java.lang.Object o)
void	forceTo(float x, float y) Sets the current x and y coordinate to the specified x and y and force updates the rendering position to match
void	forceTo(float x, float y, float width, float height) Sets the current x, y, width and height and force updates the rendering state to match
void	forceToHeight(float height) Sets the current height to the specified height and force updates the rendering bounds to match
void	forceToWidth(float width) Sets the current width to the specified width and force updates the rendering bounds to match
int	getId() Returns the unique id of this object
float	getRawRenderHeight() Returns the raw float value used for the render height coordinate
float	getRawRenderWidth() Returns the raw float value used for the render width coordinate
float	getRawRenderX() Returns the raw float value used for the render x coordinate
float	getRawRenderY() Returns the raw float value used for the render y coordinate
RenderCoordMode	getRenderCoordMode() Returns the mode used for calculating render coordinates
int	getRenderHeight() Returns the render height of this object using the set RenderCoordMode
int	getRenderWidth() Returns the render width of this object using the set RenderCoordMode
int	getRenderX() Returns the render x coordinate of this object using the set RenderCoordMode
int	getRenderY() Returns the render y coordinate of this object using the set RenderCoordMode
int	hashCode()
void	init(int id, float x, float y, float width, float height)
void	interpolate(float alpha) Called during interpolate phase each interpolate()
void	preUpdate() Called at the start of each update() before any changes are made to this object
protected void	release()
void	setRenderCoordMode(RenderCoordMode mode) Sets the mode used for calculating render coordinates
CollisionArea	setTo(float x, float y, float width, float height) Sets the current x, y, width and height

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

contains, contains, contains, contains, contains, copy, draw, edgeIterator, fill, getCenterX, getCenterY, getDistanceTo, getHeight, getMaxX, getMaxY, getMinX, getMinY, getNumberOfSides, getPolygon, getRotation, getVertices, getWidth, getX, getY, intersection, intersects, intersects, intersects, intersects, intersects, intersects, intersectsIgnoringEdges, intersectsLineSegment, intersectsLineSegment, isCircle, lerp, lerp, lerp, rotate, rotateAround, scale, set, set, setCenter, setCenterX, setCenterY, setHeight, setRadius, setRotation, setRotationAround, setSize, setSize, setWidth, setX, setXY, setXY, setY, toString, translate

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

add, addPostionChangeListener, addSizeChangeListener, clearPositionChangeListeners, clearPositionListeners, clearPositionListeners, clearSizeChangeListeners, clearSizeListeners, clearSizeListeners, getDistanceTo, intersects, moveTowards, moveTowards, notifyPositionChangeListeners, notifyPositionListeners, notifyPositionListeners, notifySizeChangeListeners, notifySizeListeners, notifySizeListeners, removePositionChangeListener, removePositionListener, removePositionListener, removeSizeChangeListener, removeSizeListener, removeSizeListener, setDisposed, setRotationAround, subtract

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

addSizeChangeListener, contains, contains, contains, getCenterX, getCenterY, getHeight, getMaxX, getMaxY, getMinX, getMinY, getNumberOfSides, getPolygon, getWidth, intersects, intersects, intersectsIgnoringEdges, intersectsLineSegment, intersectsLineSegment, isCircle, removeSizeChangeListener, scale, setCenter, setCenterX, setCenterY, setRadius

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

addPostionChangeListener, getDistanceTo, getDistanceTo, getX, getY, moveTowards, moveTowards, removePositionChangeListener, setX, setXY, setY

Field Detail

collisions

protected Collisions collisions

Constructor Detail

StaticCollisionBox

public StaticCollisionBox()

StaticCollisionBox

public StaticCollisionBox(float x,
                          float y,
                          float width,
                          float height)

StaticCollisionBox

public StaticCollisionBox(Rectangle rectangle)

StaticCollisionBox

public StaticCollisionBox(int id)

StaticCollisionBox

public StaticCollisionBox(int id,
                          Rectangle rectangle)

StaticCollisionBox

public StaticCollisionBox(int id,
                          float x,
                          float y,
                          float width,
                          float height)

StaticCollisionBox

public StaticCollisionBox(int id,
                          Collisions collisions)

Method Detail

init

public void init(int id,
                 float x,
                 float y,
                 float width,
                 float height)

release

protected void release()

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 interface CollisionObject

Specified by:

dispose in interface org.mini2Dx.gdx.utils.Disposable

Overrides:

dispose in class Rectangle

forceTo

public void forceTo(float x,
                    float y,
                    float width,
                    float height)

Description copied from interface: CollisionArea

Sets the current x, y, width and height and force updates the rendering state to match

Specified by:

forceTo in interface CollisionArea

Parameters:

x - The x coordinate to set

y - The y coordinate to set

width - The width to set

height - The height to set

forceToWidth

public void forceToWidth(float width)

Description copied from interface: CollisionArea

Sets the current width to the specified width and force updates the rendering bounds to match

Specified by:

forceToWidth in interface CollisionArea

Parameters:

width - The width to set

forceToHeight

public void forceToHeight(float height)

Description copied from interface: CollisionArea

Sets the current height to the specified height and force updates the rendering bounds to match

Specified by:

forceToHeight in interface CollisionArea

Parameters:

height - The height to set

getId

public int getId()

Description copied from interface: CollisionObject

Returns the unique id of this object

Specified by:

getId in interface CollisionObject

Returns:

preUpdate

public void preUpdate()

Description copied from interface: CollisionObject

Called at the start of each update() before any changes are made to this object

Specified by:

preUpdate in interface CollisionObject

Specified by:

preUpdate in interface Interpolatable

interpolate

public void interpolate(float alpha)

Description copied from interface: CollisionObject

Called during interpolate phase each interpolate()

Specified by:

interpolate in interface CollisionObject

Specified by:

interpolate in interface Interpolatable

Parameters:

alpha - The alpha value between 0.0 and 1.0

forceTo

public void forceTo(float x,
                    float y)

Description copied from interface: CollisionObject

Sets the current x and y coordinate to the specified x and y and force updates the rendering position to match

Specified by:

forceTo in interface CollisionObject

Parameters:

x - The x coordinate to set

y - The y coordinate to set

setTo

public CollisionArea setTo(float x,
                           float y,
                           float width,
                           float height)

Description copied from interface: CollisionArea

Sets the current x, y, width and height

Specified by:

setTo in interface CollisionArea

Parameters:

x - The x coordinate to set

y - The y coordinate to set

width - The width to set

height - The height to set

Returns:

This object

getRenderX

public int getRenderX()

Description copied from interface: CollisionObject

Returns the render x coordinate of this object using the set RenderCoordMode

Specified by:

getRenderX in interface CollisionObject

Returns:

getRenderY

public int getRenderY()

Description copied from interface: CollisionObject

Returns the render y coordinate of this object using the set RenderCoordMode

Specified by:

getRenderY in interface CollisionObject

Returns:

getRawRenderX

public float getRawRenderX()

Description copied from interface: CollisionObject

Returns the raw float value used for the render x coordinate

Specified by:

getRawRenderX in interface CollisionObject

Returns:

getRawRenderY

public float getRawRenderY()

Description copied from interface: CollisionObject

Returns the raw float value used for the render y coordinate

Specified by:

getRawRenderY in interface CollisionObject

Returns:

getRenderWidth

public int getRenderWidth()

Description copied from interface: CollisionArea

Returns the render width of this object using the set RenderCoordMode

Specified by:

getRenderWidth in interface CollisionArea

Returns:

getRenderHeight

public int getRenderHeight()

Description copied from interface: CollisionArea

Returns the render height of this object using the set RenderCoordMode

Specified by:

getRenderHeight in interface CollisionArea

Returns:

getRawRenderWidth

public float getRawRenderWidth()

Description copied from interface: CollisionArea

Returns the raw float value used for the render width coordinate

Specified by:

getRawRenderWidth in interface CollisionArea

Returns:

getRawRenderHeight

public float getRawRenderHeight()

Description copied from interface: CollisionArea

Returns the raw float value used for the render height coordinate

Specified by:

getRawRenderHeight in interface CollisionArea

Returns:

getRenderCoordMode

public RenderCoordMode getRenderCoordMode()

Description copied from interface: CollisionObject

Returns the mode used for calculating render coordinates

Specified by:

getRenderCoordMode in interface CollisionObject

Returns:

Defaults to RenderCoordMode.GLOBAL_DEFAULT

setRenderCoordMode

public void setRenderCoordMode(RenderCoordMode mode)

Description copied from interface: CollisionObject

Sets the mode used for calculating render coordinates

Specified by:

setRenderCoordMode in interface CollisionObject

Parameters:

mode - The RenderCoordMode value

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Rectangle

hashCode

public int hashCode()

Overrides:

hashCode in class Rectangle