CollisionPoint (mini2Dx-core 2.0.0-beta.7 API)

java.lang.Object
- org.mini2Dx.gdx.math.Vector2
- - org.mini2Dx.core.geom.Point
  - - org.mini2Dx.core.collision.CollisionPoint

All Implemented Interfaces:

java.io.Serializable, CollisionObject, Positionable, PositionChangeListener<CollisionPoint>, Interpolatable, org.mini2Dx.gdx.math.Vector<org.mini2Dx.gdx.math.Vector2>, org.mini2Dx.gdx.utils.Disposable

Direct Known Subclasses:

QuadTreeAwareCollisionPoint
```
public class CollisionPoint
extends Point
implements CollisionObject, PositionChangeListener<CollisionPoint>
```
An implementation of Point that allows for interpolation. Game objects can use this class to move around the game world and retrieve the appropriate rendering coordinates during render phase.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Collisions collisions
- Fields inherited from class org.mini2Dx.core.geom.Point
  disposed, positionChangeListeners
- Fields inherited from class org.mini2Dx.gdx.math.Vector2
  x, X, y, Y, Zero

Fields
Modifier and Type	Field and Description
`protected Collisions`	`collisions`

Constructor Summary

Constructors
Constructor and Description
`CollisionPoint()`
`CollisionPoint(float x, float y)`
`CollisionPoint(int id)`
`CollisionPoint(int id, Collisions collisions)`
`CollisionPoint(int id, float x, float y)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Positionable> void`	`addPostionChangeListener(PositionChangeListener<T> listener)` Adds a `Positionable` to be notified of coordinate changes
`void`	`clearPositionChangeListeners()` Removes all listeners
`void`	`dispose()` Releases this `Point` 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
`int`	`getId()` Returns the unique id of this object
`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`	`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()`
`protected void`	`init(int id, float x, float y)`
`void`	`interpolate(float alpha)` Called during interpolate phase each interpolate()
`void`	`notifyPositionChangeListeners()` Notifies all listeners of the current position.
`void`	`positionChanged(CollisionPoint moved)`
`void`	`preUpdate()` Called at the start of each update() before any changes are made to this object
`protected void`	`release()`
`<T extends Positionable> void`	`removePositionChangeListener(PositionChangeListener<T> listener)` Removes a `PositionChangeListener` to stop it being notified of coordinate changes
`void`	`setRenderCoordMode(RenderCoordMode mode)` Sets the mode used for calculating render coordinates
`java.lang.String`	`toString()`

Methods inherited from class org.mini2Dx.core.geom.Point
add, add, copy, equals, equals, equals, getDistanceTo, getDistanceTo, getX, getY, isOnLineBetween, moveTowards, moveTowards, mul, mulAdd, mulAdd, rotateAround, rotateAround, scl, scl, scl, set, set, setDisposed, setX, setXY, setY, sub, sub

Methods inherited from class org.mini2Dx.gdx.math.Vector2
angle, angle, angleDeg, angleDeg, angleRad, angleRad, clamp, cpy, crs, crs, dot, dot, dot, dst, dst, dst, dst2, dst2, dst2, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, fromString, hasOppositeDirection, hasSameDirection, interpolate, isCollinear, isCollinear, isCollinearOpposite, isCollinearOpposite, isOnLine, isOnLine, isPerpendicular, isPerpendicular, isUnit, isUnit, isZero, isZero, len, len, len2, len2, lerp, limit, limit2, nor, rotate, rotate90, rotateAround, rotateAroundDeg, rotateAroundRad, rotateDeg, rotateRad, setAngle, setAngleDeg, setAngleRad, setLength, setLength2, setToRandomDirection, setZero

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

Methods inherited from interface org.mini2Dx.core.geom.Positionable
getDistanceTo, getDistanceTo, getX, getY, moveTowards, moveTowards, setX, setXY, setY

- Field Detail
  - collisions
```
protected Collisions collisions
```
- Constructor Detail
  - CollisionPoint
```
public CollisionPoint()
```
  - CollisionPoint
```
public CollisionPoint(int id)
```
  - CollisionPoint
```
public CollisionPoint(float x,
                      float y)
```
  - CollisionPoint
```
public CollisionPoint(int id,
                      float x,
                      float y)
```
  - CollisionPoint
```
public CollisionPoint(int id,
                      Collisions collisions)
```
- Method Detail
  - init
```
protected void init(int id,
                    float x,
                    float y)
```
  - release
```
protected void release()
```
  - dispose
```
public void dispose()
```
    Description copied from class: Point
    
    Releases this Point 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 Point
  - 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
  - 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:
  - 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
  - getId
```
public int getId()
```
    Description copied from interface: CollisionObject
    
    Returns the unique id of this object
    
    Specified by:
    
    getId in interface CollisionObject
    
    Returns:
  - positionChanged
```
public void positionChanged(CollisionPoint moved)
```
    Specified by:
    
    positionChanged in interface PositionChangeListener<CollisionPoint>
  - 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
    
    Overrides:
    
    addPostionChangeListener in class Point
    
    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
    
    Overrides:
    
    removePositionChangeListener in class Point
    
    Parameters:
    
    listener - The PositionChangeListener to remove
    
    See Also:
    
    Positionable.removePositionChangeListener(PositionChangeListener)
  - notifyPositionChangeListeners
```
public void notifyPositionChangeListeners()
```
    Description copied from interface: Positionable
    
    Notifies all listeners of the current position. Note: This is automatically called when the position changes.
    
    Specified by:
    
    notifyPositionChangeListeners in interface Positionable
    
    Overrides:
    
    notifyPositionChangeListeners in class Point
  - clearPositionChangeListeners
```
public void clearPositionChangeListeners()
```
    Description copied from interface: Positionable
    
    Removes all listeners
    
    Specified by:
    
    clearPositionChangeListeners in interface Positionable
    
    Overrides:
    
    clearPositionChangeListeners in class Point
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class org.mini2Dx.gdx.math.Vector2
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class org.mini2Dx.gdx.math.Vector2
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class org.mini2Dx.gdx.math.Vector2

Class CollisionPoint

Field Summary

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

Fields inherited from class org.mini2Dx.gdx.math.Vector2

Constructor Summary

Method Summary

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

Methods inherited from class org.mini2Dx.gdx.math.Vector2

Methods inherited from class java.lang.Object

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

Field Detail

collisions

Constructor Detail

CollisionPoint

CollisionPoint

CollisionPoint

CollisionPoint

CollisionPoint

Method Detail

init

release

dispose

preUpdate

interpolate

forceTo

getRenderX

getRenderY

getRawRenderX

getRawRenderY

getRenderCoordMode

setRenderCoordMode

getId

positionChanged

addPostionChangeListener

removePositionChangeListener

notifyPositionChangeListeners

clearPositionChangeListeners

equals

hashCode

toString