org.cell2d.space

Class SpaceState<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>

java.lang.Object

org.cell2d.Thinker<T,U,V>

org.cell2d.GameState<T,U,V>

org.cell2d.space.SpaceState<T,U,V>

Type Parameters:

T - The type of CellGame that uses this SpaceState

U - The type of SpaceState that this SpaceState is for SpaceThinker interaction purposes

V - The type of SpaceThinker that this SpaceState uses

Direct Known Subclasses:

BasicSpaceState

public abstract class SpaceState<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>
extends GameState<T,U,V>

A SpaceState is a type of GameState that handles gameplay in a continuous two-dimensional space. Space in a SpaceState is divided into rectangular cells of equal width and equal height. A SpaceState automatically creates more cells as SpaceObjects enter where they would be if they existed.

SpaceObjects may be assigned to one SpaceState each in much the same way that SubThinkers are assigned to Thinkers. Similarly to SubThinkers, the actual addition or removal of a SpaceObject to or from a SpaceState is delayed until any and all current iterations over its SpaceThinkers, SpaceObjects, or MobileObjects, such as the periods during which MobileObjects move or SpaceThinkers take their time-dependent actions, have been completed. Multiple delayed instructions may be successfully given to SpaceStates regarding the same SpaceObject without having to wait until all iterations have finished.

SpaceStates use cells to organize SpaceObjects by location, improving the efficiency of processes like MobileObject movement that are concerned only with SpaceObjects in a small region of space. For maximum efficiency, cells should be set to be large enough that SpaceObjects do not change which cells they are in too frequently, but small enough that not too many SpaceObjects are in each cell at any one time.

Like the SpaceThinkers that it uses, a SpaceState has an EventGroup of before-movement Events that it performs once each frame. A SpaceState performs these Events at the beginning of its frameActions(). Immediately afterward, the SpaceState moves each of its MobileObjects by the sum of its velocity and step multiplied by its time factor, then resets its step to (0, 0). This, along with manual calls to the MobileObject's doMovement() method, is when the MobileObject interacts with the solid surfaces of SpaceObjects in its path if it has Cell2D's standard collision mechanics enabled.

Viewports may be assigned to one SpaceState each with an integer ID in the context of that SpaceState. Only one Viewport may be assigned to a given SpaceState with a given ID at once.

HUDs may be assigned to a SpaceState to render visuals in front of the SpaceState's own. Only one HUD may be assigned to a given SpaceState in this capacity at once. A SpaceState's HUD uses the entire screen as its rendering region.

SpaceLayers may be assigned to a SpaceState with an integer ID in the context of that SpaceState. Only one SpaceLayer may be assigned to a given SpaceState with a given ID at once. SpaceLayers with higher IDs are rendered in front of those with lower ones. SpaceLayers with positive IDs are rendered in front of the SpaceState's SpaceObjects, and SpaceLayers with negative IDs are rendered behind its SpaceObjects. SpaceLayers may not be assigned with an ID of 0.

See Also:

SpaceThinker, SpaceObject, Viewport, HUD, SpaceLayer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpaceState.DrawMode A DrawMode is a procedure by which a SpaceState determines the order in which to draw SpaceObjects with the same draw priority over one another.

Constructor Summary

Constructors

Constructor and Description
SpaceState(java.lang.Class<T> gameClass, java.lang.Class<U> stateClass, java.lang.Class<V> subThinkerClass, T game, int id, long cellWidth, long cellHeight, SpaceState.DrawMode drawMode) Constructs a SpaceState of the specified CellGame with the specified ID.

Method Summary

Modifier and Type	Method and Description
boolean	addObject(SpaceObject object) Adds the specified SpaceObject to this SpaceState if it is not already assigned to a SpaceState.
void	addSubThinkerActions(T game, U state, V subThinker) Actions for this Thinker to take immediately after adding a SubThinker to itself, before the added SubThinker takes its addedActions().
<O extends SpaceObject> java.util.List<O>	boundingBoxesMeet(Hitbox hitbox, java.lang.Class<O> cls) Returns all of this SpaceState's SpaceObjects of the specified class whose overlap Hitboxes' rectangular bounding boxes touch or intersect the specified Hitbox's rectangular bounding box.
void	clearEmptyCells() Removes any cells that no longer have SpaceObjects in them, freeing up the memory that they occupied.
void	clearLayers() Removes from this SpaceState all SpaceLayers that are currently assigned to it.
void	clearObjects() Removes from this SpaceState all of the SpaceObjects that are currently assigned to it.
void	clearViewports() Removes from this SpaceState all Viewports that are currently assigned to it.
void	frameActions(T game, U state) Actions for this Thinker to take once each frame.
EventGroup<T,U>	getBeforeMovementEvents() Returns the EventGroup of this SpaceState's before-movement Events.
long	getCellHeight() Returns the height of each of this SpaceState's cells.
long	getCellWidth() Returns the width of each of this SpaceState's cells.
SpaceState.DrawMode	getDrawMode() Returns this SpaceState's DrawMode.
HUD	getHUD() Returns the HUD that is assigned to this SpaceState, or null if there is none.
SpaceLayer	getLayer(int id) Returns the SpaceLayer that is assigned to this SpaceState with the specified ID.
int	getNumLayers() Returns the number of SpaceLayers that are assigned to this SpaceState.
int	getNumMobileObjects() Returns the number of MobileObjects that are assigned to this SpaceState.
int	getNumObjects() Returns the number of SpaceObjects that are assigned to this SpaceState.
int	getNumViewports() Returns the number of Viewports that are assigned to this SpaceState.
CellVector	getSpacePoint(int x, int y) Returns the point in this SpaceState, as seen through one of its Viewports, that corresponds to the specified point in pixels on the screen.
Viewport<T,U>	getViewport(int id) Returns the Viewport that is assigned to this SpaceState with the specified ID.
<O extends SpaceObject> O	intersectingSolidObject(Hitbox hitbox, java.lang.Class<O> cls) Returns one of this SpaceState's SpaceObjects of the specified class whose solid Hitbox overlaps the specified Hitbox, or null if there is none.
<O extends SpaceObject> java.util.List<O>	intersectingSolidObjects(Hitbox hitbox, java.lang.Class<O> cls) Returns all of this SpaceState's SpaceObjects of the specified class whose solid Hitboxes overlap the specified Hitbox.
<O extends SpaceObject> boolean	isIntersectingSolidObject(Hitbox hitbox, java.lang.Class<O> cls) Returns whether this SpaceState has any SpaceObjects of the specified class whose solid Hitboxes overlap the specified Hitbox.
<O extends SpaceObject> boolean	isOverlappingObject(Hitbox hitbox, java.lang.Class<O> cls) Returns whether this SpaceState has any SpaceObjects of the specified class that overlap the specified Hitbox.
boolean	iteratingThroughMobileObjects() Returns whether any Iterators over this SpaceState's list of MobileObjects are in progress.
boolean	iteratingThroughObjects() Returns whether any Iterators over this SpaceState's list of SpaceObjects are in progress.
void	loadArea(CellVector origin, Area<T,U> area) Loads the specified Area about the specified origin point.
void	loadArea(long originX, long originY, Area<T,U> area) Loads the specified Area about the specified origin point.
SafeIterator<MobileObject>	mobileObjectIterator() Returns a new SafeIterator over this SpaceState's list of MobileObjects.
<O extends SpaceObject> O	nearestIntersectingSolidObject(CellVector point, Hitbox hitbox, java.lang.Class<O> cls) Returns this SpaceState's SpaceObject of the specified class whose solid Hitbox overlaps the specified Hitbox whose center is nearest to the specified point, or null if there is none.
<O extends SpaceObject> O	nearestIntersectingSolidObject(long pointX, long pointY, Hitbox hitbox, java.lang.Class<O> cls) Returns this SpaceState's SpaceObject of the specified class whose solid Hitbox overlaps the specified Hitbox whose center is nearest to the specified point, or null if there is none.
<O extends SpaceObject> O	nearestObject(CellVector point, java.lang.Class<O> cls) Returns this SpaceState's SpaceObject of the specified class whose center is nearest to the specified point, or null if this SpaceState has no SpaceObjects of that class.
<O extends SpaceObject> O	nearestObject(long pointX, long pointY, java.lang.Class<O> cls) Returns this SpaceState's SpaceObject of the specified class whose center is nearest to the specified point, or null if this SpaceState has no SpaceObjects of that class.
<O extends SpaceObject> O	nearestObjectWithinCircle(CellVector point, CellVector center, long radius, java.lang.Class<O> cls) Returns this SpaceState's SpaceObject of the specified class within the specified circular region whose center is nearest to the specified point, or null if there is none.
<O extends SpaceObject> O	nearestObjectWithinCircle(long pointX, long pointY, long centerX, long centerY, long radius, java.lang.Class<O> cls) Returns this SpaceState's SpaceObject of the specified class within the specified circular region whose center is nearest to the specified point, or null if there is none.
<O extends SpaceObject> O	nearestObjectWithinRectangle(CellVector point, long x1, long y1, long x2, long y2, java.lang.Class<O> cls) Returns this SpaceState's SpaceObject of the specified class within the specified rectangular region whose center is nearest to the specified point, or null if there is none.
<O extends SpaceObject> O	nearestObjectWithinRectangle(long pointX, long pointY, long x1, long y1, long x2, long y2, java.lang.Class<O> cls) Returns this SpaceState's SpaceObject of the specified class within the specified rectangular region whose center is nearest to the specified point, or null if there is none.
<O extends SpaceObject> O	nearestOverlappingObject(CellVector point, Hitbox hitbox, java.lang.Class<O> cls) Returns this SpaceState's SpaceObject of the specified class that overlaps the specified Hitbox whose center is nearest to the specified point, or null if there is none.
<O extends SpaceObject> O	nearestOverlappingObject(long pointX, long pointY, Hitbox hitbox, java.lang.Class<O> cls) Returns this SpaceState's SpaceObject of the specified class that overlaps the specified Hitbox whose center is nearest to the specified point, or null if there is none.
<O extends SpaceObject> boolean	objectIsWithinCircle(CellVector center, long radius, java.lang.Class<O> cls) Returns whether this SpaceState has any SpaceObjects of the specified class with their centers within the specified circular region.
<O extends SpaceObject> boolean	objectIsWithinCircle(long centerX, long centerY, long radius, java.lang.Class<O> cls) Returns whether this SpaceState has any SpaceObjects of the specified class with their centers within the specified circular region.
<O extends SpaceObject> boolean	objectIsWithinRectangle(long x1, long y1, long x2, long y2, java.lang.Class<O> cls) Returns whether this SpaceState has any SpaceObjects of the specified class with their centers within the specified rectangular region.
SafeIterator<SpaceObject>	objectIterator() Returns a new SafeIterator over this SpaceState's list of SpaceObjects.
<O extends SpaceObject> java.util.List<O>	objectsWithinCircle(CellVector center, long radius, java.lang.Class<O> cls) Returns all of this SpaceState's SpaceObjects of the specified class with their centers within the specified circular region.
<O extends SpaceObject> java.util.List<O>	objectsWithinCircle(long centerX, long centerY, long radius, java.lang.Class<O> cls) Returns all of this SpaceState's SpaceObjects of the specified class with their centers within the specified circular region.
<O extends SpaceObject> java.util.List<O>	objectsWithinRectangle(long x1, long y1, long x2, long y2, java.lang.Class<O> cls) Returns all of this SpaceState's SpaceObjects of the specified class with their centers within the specified rectangular region.
<O extends SpaceObject> O	objectWithinCircle(CellVector center, long radius, java.lang.Class<O> cls) Returns one of this SpaceState's SpaceObjects of the specified class with its center within the specified circular region, or null if there is none.
<O extends SpaceObject> O	objectWithinCircle(long centerX, long centerY, long radius, java.lang.Class<O> cls) Returns one of this SpaceState's SpaceObjects of the specified class with its center within the specified circular region, or null if there is none.
<O extends SpaceObject> O	objectWithinRectangle(long x1, long y1, long x2, long y2, java.lang.Class<O> cls) Returns one of this SpaceState's SpaceObjects of the specified class with its center within the specified rectangular region, or null if there is none.
<O extends SpaceObject> O	overlappingObject(Hitbox hitbox, java.lang.Class<O> cls) Returns one of this SpaceState's SpaceObjects of the specified class that overlaps the specified Hitbox, or null if there is none.
<O extends SpaceObject> java.util.List<O>	overlappingObjects(Hitbox hitbox, java.lang.Class<O> cls) Returns all of this SpaceState's SpaceObjects of the specified class that overlap the specified Hitbox.
boolean	rectangleIsVisible(long x1, long y1, long x2, long y2) Returns whether any part of the specified rectangular region of this SpaceState's space is visible through any of its Viewports.
void	removeAboveLine(long y) Removes from this SpaceState all of its SpaceObjects that lie entirely above the specified horizontal line.
void	removeBelowLine(long y) Removes from this SpaceState all of its SpaceObjects that lie entirely below the specified horizontal line.
void	removeLeftOfLine(long x) Removes from this SpaceState all of its SpaceObjects that lie entirely to the left of the specified vertical line.
boolean	removeObject(SpaceObject object) Removes the specified SpaceObject from this SpaceState if it is currently assigned to it.
void	removeOutsideRectangle(long x1, long y1, long x2, long y2) Removes from this SpaceState all of its SpaceObjects that lie entirely outside the specified rectangular region.
void	removeRectangle(long x1, long y1, long x2, long y2) Removes from this SpaceState all of its SpaceObjects that lie entirely inside the specified rectangular region.
void	removeRightOfLine(long x) Removes from this SpaceState all of its SpaceObjects that lie entirely to the right of the specified vertical line.
void	removeSubThinkerActions(T game, U state, V subThinker) Actions for this Thinker to take immediately before removing a SubThinker from itself, after the soon-to-be-removed SubThinker takes its removedActions().
void	renderActions(T game, Graphics g, int x1, int y1, int x2, int y2) Actions for this GameState to take each frame to render its visuals.
void	setCellDimensions(long cellWidth, long cellHeight) Sets the dimensions of each of this SpaceState's cells to the specified values.
void	setDrawMode(SpaceState.DrawMode drawMode) Sets this SpaceState's DrawMode.
void	setHUD(HUD hud) Sets the HUD that is assigned to this SpaceState to the specified one.
void	setLayer(int id, SpaceLayer layer) Sets the SpaceLayer that is assigned to this SpaceState with the specified ID to the specified SpaceLayer.
boolean	setViewport(int id, Viewport<T,U> viewport) Sets the Viewport that is assigned to this SpaceState with the specified ID to the specified Viewport, if it is not already assigned to a SpaceState.
<O extends SpaceObject> java.util.List<O>	solidBoundingBoxesMeet(Hitbox hitbox, java.lang.Class<O> cls) Returns all of this SpaceState's solid SpaceObjects of the specified class whose solid Hitboxes' rectangular bounding boxes touch or intersect the specified Hitbox's rectangular bounding box.

Methods inherited from class org.cell2d.GameState

addAnimInstance, addAnimInstance, bindFinishedActions, charDeletedActions, charTypedActions, clearAnimInstances, enteredActions, getAnimation, getAnimInstance, getEffectiveTimeFactor, getGame, getGameState, getID, getNumAnimInstances, getThis, isActive, leftActions, removeAnimInstance, setAnimation, setAnimInstance, stringBeganActions, stringCanceledActions, stringDeletedActions, stringFinishedActions

Methods inherited from class org.cell2d.Thinker

addSubThinker, clearLineages, clearSubThinkers, getFrameEvents, getGameClass, getNumSubThinkers, getStateClass, getSubThinkerClass, getTimeFactor, getTimerValue, iteratingThroughSubThinkers, removeLineage, removeSubThinker, setTimeFactor, setTimerValue, subThinkerIterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpaceState

public SpaceState(java.lang.Class<T> gameClass,
                  java.lang.Class<U> stateClass,
                  java.lang.Class<V> subThinkerClass,
                  T game,
                  int id,
                  long cellWidth,
                  long cellHeight,
                  SpaceState.DrawMode drawMode)

Constructs a SpaceState of the specified CellGame with the specified ID.

Parameters:

gameClass - The Class object representing the type of CellGame that uses this SpaceState

stateClass - The Class object representing the type of SpaceState that this SpaceState is for SpaceThinker interaction purposes

subThinkerClass - The Class object representing the type of SpaceThinker that this SpaceState uses

game - The CellGame to which this SpaceState belongs

id - This SpaceState's ID

cellWidth - The width of each of this SpaceState's cells

cellHeight - The height of each of this SpaceState's cells

drawMode - This SpaceState's DrawMode

Method Detail

addSubThinkerActions

public void addSubThinkerActions(T game,
                                 U state,
                                 V subThinker)

Description copied from class: Thinker

Actions for this Thinker to take immediately after adding a SubThinker to itself, before the added SubThinker takes its addedActions().

Overrides:

addSubThinkerActions in class Thinker<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>

Parameters:

game - This Thinker's GameState's CellGame, or null if it has no GameState

state - This Thinker's GameState, or null if it has none

subThinker - The SubThinker that was added

removeSubThinkerActions

public void removeSubThinkerActions(T game,
                                    U state,
                                    V subThinker)

Description copied from class: Thinker

Actions for this Thinker to take immediately before removing a SubThinker from itself, after the soon-to-be-removed SubThinker takes its removedActions().

Overrides:

removeSubThinkerActions in class Thinker<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>

Parameters:

game - This Thinker's GameState's CellGame, or null if it has no GameState

state - This Thinker's GameState, or null if it has none

subThinker - The SubThinker that is about to be removed

getBeforeMovementEvents

public final EventGroup<T,U> getBeforeMovementEvents()

Returns the EventGroup of this SpaceState's before-movement Events.

Returns:

The EventGroup of this SpaceState's before-movement Events

getCellWidth

public final long getCellWidth()

Returns the width of each of this SpaceState's cells.

Returns:

The width of each of this SpaceState's cells

getCellHeight

public final long getCellHeight()

Returns the height of each of this SpaceState's cells.

Returns:

The height of each of this SpaceState's cells

setCellDimensions

public final void setCellDimensions(long cellWidth,
                                    long cellHeight)

Sets the dimensions of each of this SpaceState's cells to the specified values. The more SpaceObjects are currently assigned to this SpaceState, the longer this operation takes, as SpaceObjects need to be reorganized.

Parameters:

cellWidth - The new width of each of this SpaceState's cells

cellHeight - The new height of each of this SpaceState's cells

clearEmptyCells

public final void clearEmptyCells()

Removes any cells that no longer have SpaceObjects in them, freeing up the memory that they occupied. The more cells this SpaceState has, the longer this operation takes.

getDrawMode

public final SpaceState.DrawMode getDrawMode()

Returns this SpaceState's DrawMode.

Returns:

This SpaceState's DrawMode

setDrawMode

public final void setDrawMode(SpaceState.DrawMode drawMode)

Sets this SpaceState's DrawMode.

Parameters:

drawMode - The new DrawMode

loadArea

public final void loadArea(CellVector origin,
                           Area<T,U> area)

Loads the specified Area about the specified origin point.

Parameters:

origin - The origin point about which to load the Area

area - The Area to load

loadArea

public final void loadArea(long originX,
                           long originY,
                           Area<T,U> area)

Loads the specified Area about the specified origin point.

Parameters:

originX - The x-coordinate of the origin point about which to load the Area

originY - The y-coordinate of the origin point about which to load the Area

area - The Area to load

getNumObjects

public final int getNumObjects()

Returns the number of SpaceObjects that are assigned to this SpaceState.

Returns:

The number of SpaceObjects that are assigned to this SpaceState

iteratingThroughObjects

public final boolean iteratingThroughObjects()

Returns whether any Iterators over this SpaceState's list of SpaceObjects are in progress.

Returns:

Whether any Iterators over this SpaceState's list of SpaceObjects are in progress

objectIterator

public final SafeIterator<SpaceObject> objectIterator()

Returns a new SafeIterator over this SpaceState's list of SpaceObjects.

Returns:

A new SafeIterator over this SpaceState's list of SpaceObjects

addObject

public final boolean addObject(SpaceObject object)

Adds the specified SpaceObject to this SpaceState if it is not already assigned to a SpaceState.

Parameters:

object - The SpaceObject to be added

Returns:

Whether the addition occurred

removeObject

public final boolean removeObject(SpaceObject object)

Removes the specified SpaceObject from this SpaceState if it is currently assigned to it.

Parameters:

object - The SpaceObject to be removed

Returns:

Whether the removal occurred

clearObjects

public final void clearObjects()

Removes from this SpaceState all of the SpaceObjects that are currently assigned to it.

removeRectangle

public final void removeRectangle(long x1,
                                  long y1,
                                  long x2,
                                  long y2)

Removes from this SpaceState all of its SpaceObjects that lie entirely inside the specified rectangular region. Removed SpaceObjects may touch the region's boundary, as long as no part of them lies outside it.

Parameters:

x1 - The x-coordinate of the region's left edge

y1 - The y-coordinate of the region's top edge

x2 - The x-coordinate of the region's right edge

y2 - The y-coordinate of the region's bottom edge

removeOutsideRectangle

public final void removeOutsideRectangle(long x1,
                                         long y1,
                                         long x2,
                                         long y2)

Removes from this SpaceState all of its SpaceObjects that lie entirely outside the specified rectangular region. Removed SpaceObjects may touch the region's boundary, as long as no part of them lies inside it.

Parameters:

x1 - The x-coordinate of the region's left edge

y1 - The y-coordinate of the region's top edge

x2 - The x-coordinate of the region's right edge

y2 - The y-coordinate of the region's bottom edge

removeLeftOfLine

public final void removeLeftOfLine(long x)

Removes from this SpaceState all of its SpaceObjects that lie entirely to the left of the specified vertical line. Removed SpaceObjects may touch the line, as long as no part of them lies to the right of it.

Parameters:

x - The line's x-coordinate

removeRightOfLine

public final void removeRightOfLine(long x)

Removes from this SpaceState all of its SpaceObjects that lie entirely to the right of the specified vertical line. Removed SpaceObjects may touch the line, as long as no part of them lies to the left of it.

Parameters:

x - The line's x-coordinate

removeAboveLine

public final void removeAboveLine(long y)

Removes from this SpaceState all of its SpaceObjects that lie entirely above the specified horizontal line. Removed SpaceObjects may touch the line, as long as no part of them lies below it.

Parameters:

y - The line's y-coordinate

removeBelowLine

public final void removeBelowLine(long y)

Removes from this SpaceState all of its SpaceObjects that lie entirely below the specified horizontal line. Removed SpaceObjects may touch the line, as long as no part of them lies above it.

Parameters:

y - The line's y-coordinate

getNumMobileObjects

public final int getNumMobileObjects()

Returns the number of MobileObjects that are assigned to this SpaceState.

Returns:

The number of MobileObjects that are assigned to this SpaceState

iteratingThroughMobileObjects

public final boolean iteratingThroughMobileObjects()

Returns whether any Iterators over this SpaceState's list of MobileObjects are in progress.

Returns:

Whether any Iterators over this SpaceState's list of MobileObjects are in progress

mobileObjectIterator

public final SafeIterator<MobileObject> mobileObjectIterator()

Returns a new SafeIterator over this SpaceState's list of MobileObjects.

Returns:

A new SafeIterator over this SpaceState's list of MobileObjects

nearestObject

public final <O extends SpaceObject> O nearestObject(CellVector point,
                                                     java.lang.Class<O> cls)

Returns this SpaceState's SpaceObject of the specified class whose center is nearest to the specified point, or null if this SpaceState has no SpaceObjects of that class.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

point - The point to check distance to

cls - The Class object that represents the SpaceObject subclass

Returns:

The nearest SpaceObject of the specified class to the specified point

nearestObject

public final <O extends SpaceObject> O nearestObject(long pointX,
                                                     long pointY,
                                                     java.lang.Class<O> cls)

Returns this SpaceState's SpaceObject of the specified class whose center is nearest to the specified point, or null if this SpaceState has no SpaceObjects of that class.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

pointX - The x-coordinate of the point to check the distance to

pointY - The y-coordinate of the point to check the distance to

cls - The Class object that represents the SpaceObject subclass

Returns:

The nearest SpaceObject of the specified class to the specified point

objectIsWithinRectangle

public final <O extends SpaceObject> boolean objectIsWithinRectangle(long x1,
                                                                     long y1,
                                                                     long x2,
                                                                     long y2,
                                                                     java.lang.Class<O> cls)

Returns whether this SpaceState has any SpaceObjects of the specified class with their centers within the specified rectangular region.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

x1 - The x-coordinate of the region's left edge

y1 - The y-coordinate of the region's top edge

x2 - The x-coordinate of the region's right edge

y2 - The y-coordinate of the region's bottom edge

cls - The Class object that represents the SpaceObject subclass

Returns:

Whether there are any SpaceObjects of the specified class within the specified rectangular region

objectWithinRectangle

public final <O extends SpaceObject> O objectWithinRectangle(long x1,
                                                             long y1,
                                                             long x2,
                                                             long y2,
                                                             java.lang.Class<O> cls)

Returns one of this SpaceState's SpaceObjects of the specified class with its center within the specified rectangular region, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

x1 - The x-coordinate of the region's left edge

y1 - The y-coordinate of the region's top edge

x2 - The x-coordinate of the region's right edge

y2 - The y-coordinate of the region's bottom edge

cls - The Class object that represents the SpaceObject subclass

Returns:

A SpaceObject of the specified class within the specified rectangular region

objectsWithinRectangle

public final <O extends SpaceObject> java.util.List<O> objectsWithinRectangle(long x1,
                                                                              long y1,
                                                                              long x2,
                                                                              long y2,
                                                                              java.lang.Class<O> cls)

Returns all of this SpaceState's SpaceObjects of the specified class with their centers within the specified rectangular region.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

x1 - The x-coordinate of the region's left edge

y1 - The y-coordinate of the region's top edge

x2 - The x-coordinate of the region's right edge

y2 - The y-coordinate of the region's bottom edge

cls - The Class object that represents the SpaceObject subclass

Returns:

All of the SpaceObjects of the specified class within the specified rectangular region

nearestObjectWithinRectangle

public final <O extends SpaceObject> O nearestObjectWithinRectangle(CellVector point,
                                                                    long x1,
                                                                    long y1,
                                                                    long x2,
                                                                    long y2,
                                                                    java.lang.Class<O> cls)

Returns this SpaceState's SpaceObject of the specified class within the specified rectangular region whose center is nearest to the specified point, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

point - The point to check the distance to

x1 - The x-coordinate of the region's left edge

y1 - The y-coordinate of the region's top edge

x2 - The x-coordinate of the region's right edge

y2 - The y-coordinate of the region's bottom edge

cls - The Class object that represents the SpaceObject subclass

Returns:

The SpaceObject of the specified class within the specified rectangular region that is nearest to the specified point

nearestObjectWithinRectangle

public final <O extends SpaceObject> O nearestObjectWithinRectangle(long pointX,
                                                                    long pointY,
                                                                    long x1,
                                                                    long y1,
                                                                    long x2,
                                                                    long y2,
                                                                    java.lang.Class<O> cls)

Returns this SpaceState's SpaceObject of the specified class within the specified rectangular region whose center is nearest to the specified point, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

pointX - The x-coordinate of the point to check the distance to

pointY - The y-coordinate of the point to check the distance to

x1 - The x-coordinate of the region's left edge

y1 - The y-coordinate of the region's top edge

x2 - The x-coordinate of the region's right edge

y2 - The y-coordinate of the region's bottom edge

cls - The Class object that represents the SpaceObject subclass

Returns:

The SpaceObject of the specified class within the specified rectangular region that is nearest to the specified point

objectIsWithinCircle

public final <O extends SpaceObject> boolean objectIsWithinCircle(CellVector center,
                                                                  long radius,
                                                                  java.lang.Class<O> cls)

Returns whether this SpaceState has any SpaceObjects of the specified class with their centers within the specified circular region.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

center - The region's center

radius - The region's radius

cls - The Class object that represents the SpaceObject subclass

Returns:

Whether there are any SpaceObjects of the specified class within the specified circular region

objectIsWithinCircle

public final <O extends SpaceObject> boolean objectIsWithinCircle(long centerX,
                                                                  long centerY,
                                                                  long radius,
                                                                  java.lang.Class<O> cls)

Returns whether this SpaceState has any SpaceObjects of the specified class with their centers within the specified circular region.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

centerX - The x-coordinate of the region's center

centerY - The y-coordinate of the region's center

radius - The region's radius

cls - The Class object that represents the SpaceObject subclass

Returns:

Whether there are any SpaceObjects of the specified class within the specified circular region

objectWithinCircle

public final <O extends SpaceObject> O objectWithinCircle(CellVector center,
                                                          long radius,
                                                          java.lang.Class<O> cls)

Returns one of this SpaceState's SpaceObjects of the specified class with its center within the specified circular region, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

center - The region's center

radius - The region's radius

cls - The Class object that represents the SpaceObject subclass

Returns:

A SpaceObject of the specified class within the specified circular region

objectWithinCircle

public final <O extends SpaceObject> O objectWithinCircle(long centerX,
                                                          long centerY,
                                                          long radius,
                                                          java.lang.Class<O> cls)

Returns one of this SpaceState's SpaceObjects of the specified class with its center within the specified circular region, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

centerX - The x-coordinate of the region's center

centerY - The y-coordinate of the region's center

radius - The region's radius

cls - The Class object that represents the SpaceObject subclass

Returns:

A SpaceObject of the specified class within the specified circular region

objectsWithinCircle

public final <O extends SpaceObject> java.util.List<O> objectsWithinCircle(CellVector center,
                                                                           long radius,
                                                                           java.lang.Class<O> cls)

Returns all of this SpaceState's SpaceObjects of the specified class with their centers within the specified circular region.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

center - The region's center

radius - The region's radius

cls - The Class object that represents the SpaceObject subclass

Returns:

All of the SpaceObjects of the specified class within the specified circular region

objectsWithinCircle

public final <O extends SpaceObject> java.util.List<O> objectsWithinCircle(long centerX,
                                                                           long centerY,
                                                                           long radius,
                                                                           java.lang.Class<O> cls)

Returns all of this SpaceState's SpaceObjects of the specified class with their centers within the specified circular region.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

centerX - The x-coordinate of the region's center

centerY - The y-coordinate of the region's center

radius - The region's radius

cls - The Class object that represents the SpaceObject subclass

Returns:

All of the SpaceObjects of the specified class within the specified circular region

nearestObjectWithinCircle

public final <O extends SpaceObject> O nearestObjectWithinCircle(CellVector point,
                                                                 CellVector center,
                                                                 long radius,
                                                                 java.lang.Class<O> cls)

Returns this SpaceState's SpaceObject of the specified class within the specified circular region whose center is nearest to the specified point, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

point - The point to check the distance to

center - The region's center

radius - The region's radius

cls - The Class object that represents the SpaceObject subclass

Returns:

The SpaceObject of the specified class within the specified circular region that is nearest to the specified point

nearestObjectWithinCircle

public final <O extends SpaceObject> O nearestObjectWithinCircle(long pointX,
                                                                 long pointY,
                                                                 long centerX,
                                                                 long centerY,
                                                                 long radius,
                                                                 java.lang.Class<O> cls)

Returns this SpaceState's SpaceObject of the specified class within the specified circular region whose center is nearest to the specified point, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

pointX - The x-coordinate of the point to check the distance to

pointY - The y-coordinate of the point to check the distance to

centerX - The x-coordinate of the region's center

centerY - The y-coordinate of the region's center

radius - The region's radius

cls - The Class object that represents the SpaceObject subclass

Returns:

The SpaceObject of the specified class within the specified circular region that is nearest to the specified point

isOverlappingObject

public final <O extends SpaceObject> boolean isOverlappingObject(Hitbox hitbox,
                                                                 java.lang.Class<O> cls)

Returns whether this SpaceState has any SpaceObjects of the specified class that overlap the specified Hitbox.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

hitbox - The Hitbox to check for overlapping

cls - The Class object that represents the SpaceObject subclass

Returns:

Whether there are any SpaceObjects of the specified class that overlap the specified Hitbox

overlappingObject

public final <O extends SpaceObject> O overlappingObject(Hitbox hitbox,
                                                         java.lang.Class<O> cls)

Returns one of this SpaceState's SpaceObjects of the specified class that overlaps the specified Hitbox, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

hitbox - The Hitbox to check for overlapping

cls - The Class object that represents the SpaceObject subclass

Returns:

A SpaceObject of the specified class that overlaps the specified Hitbox

overlappingObjects

public final <O extends SpaceObject> java.util.List<O> overlappingObjects(Hitbox hitbox,
                                                                          java.lang.Class<O> cls)

Returns all of this SpaceState's SpaceObjects of the specified class that overlap the specified Hitbox.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

hitbox - The Hitbox to check for overlapping

cls - The Class object that represents the SpaceObject subclass

Returns:

All of the SpaceObjects of the specified class that overlap the specified Hitbox

nearestOverlappingObject

public final <O extends SpaceObject> O nearestOverlappingObject(CellVector point,
                                                                Hitbox hitbox,
                                                                java.lang.Class<O> cls)

Returns this SpaceState's SpaceObject of the specified class that overlaps the specified Hitbox whose center is nearest to the specified point, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

point - The point to check the distance to

hitbox - The Hitbox to check for overlapping

cls - The Class object that represents the SpaceObject subclass

Returns:

The SpaceObject of the specified class that overlaps the specified Hitbox that is nearest to the specified point

nearestOverlappingObject

public final <O extends SpaceObject> O nearestOverlappingObject(long pointX,
                                                                long pointY,
                                                                Hitbox hitbox,
                                                                java.lang.Class<O> cls)

Returns this SpaceState's SpaceObject of the specified class that overlaps the specified Hitbox whose center is nearest to the specified point, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

pointX - The x-coordinate of the point to check the distance to

pointY - The y-coordinate of the point to check the distance to

hitbox - The Hitbox to check for overlapping

cls - The Class object that represents the SpaceObject subclass

Returns:

The SpaceObject of the specified class that overlaps the specified Hitbox that is nearest to the specified point

boundingBoxesMeet

public final <O extends SpaceObject> java.util.List<O> boundingBoxesMeet(Hitbox hitbox,
                                                                         java.lang.Class<O> cls)

Returns all of this SpaceState's SpaceObjects of the specified class whose overlap Hitboxes' rectangular bounding boxes touch or intersect the specified Hitbox's rectangular bounding box.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

hitbox - The Hitbox whose bounding box to check

cls - The Class object that represents the SpaceObject subclass

Returns:

All of the SpaceObjects of the specified class whose overlap Hitboxes' bounding boxes meet the specified Hitbox's bounding box

isIntersectingSolidObject

public final <O extends SpaceObject> boolean isIntersectingSolidObject(Hitbox hitbox,
                                                                       java.lang.Class<O> cls)

Returns whether this SpaceState has any SpaceObjects of the specified class whose solid Hitboxes overlap the specified Hitbox.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

hitbox - The Hitbox to check for overlapping

cls - The Class object that represents the SpaceObject subclass

Returns:

Whether there are any SpaceObjects of the specified class whose solid Hitboxes overlap the specified Hitbox

intersectingSolidObject

public final <O extends SpaceObject> O intersectingSolidObject(Hitbox hitbox,
                                                               java.lang.Class<O> cls)

Returns one of this SpaceState's SpaceObjects of the specified class whose solid Hitbox overlaps the specified Hitbox, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

hitbox - The Hitbox to check for overlapping

cls - The Class object that represents the SpaceObject subclass

Returns:

A SpaceObject of the specified class whose solid Hitbox overlaps the specified Hitbox

intersectingSolidObjects

public final <O extends SpaceObject> java.util.List<O> intersectingSolidObjects(Hitbox hitbox,
                                                                                java.lang.Class<O> cls)

Returns all of this SpaceState's SpaceObjects of the specified class whose solid Hitboxes overlap the specified Hitbox.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

hitbox - The Hitbox to check for overlapping

cls - The Class object that represents the SpaceObject subclass

Returns:

All of the SpaceObjects of the specified class whose solid Hitboxes overlap the specified Hitbox

nearestIntersectingSolidObject

public final <O extends SpaceObject> O nearestIntersectingSolidObject(CellVector point,
                                                                      Hitbox hitbox,
                                                                      java.lang.Class<O> cls)

Returns this SpaceState's SpaceObject of the specified class whose solid Hitbox overlaps the specified Hitbox whose center is nearest to the specified point, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

point - The point to check the distance to

hitbox - The Hitbox to check for overlapping

cls - The Class object that represents the SpaceObject subclass

Returns:

The SpaceObject of the specified class whose solid Hitbox overlaps the specified Hitbox that is nearest to the specified point

nearestIntersectingSolidObject

public final <O extends SpaceObject> O nearestIntersectingSolidObject(long pointX,
                                                                      long pointY,
                                                                      Hitbox hitbox,
                                                                      java.lang.Class<O> cls)

Returns this SpaceState's SpaceObject of the specified class whose solid Hitbox overlaps the specified Hitbox whose center is nearest to the specified point, or null if there is none.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

pointX - The x-coordinate of the point to check the distance to

pointY - The y-coordinate of the point to check the distance to

hitbox - The Hitbox to check for overlapping

cls - The Class object that represents the SpaceObject subclass

Returns:

The SpaceObject of the specified class whose solid Hitbox overlaps the specified Hitbox that is nearest to the specified point

solidBoundingBoxesMeet

public final <O extends SpaceObject> java.util.List<O> solidBoundingBoxesMeet(Hitbox hitbox,
                                                                              java.lang.Class<O> cls)

Returns all of this SpaceState's solid SpaceObjects of the specified class whose solid Hitboxes' rectangular bounding boxes touch or intersect the specified Hitbox's rectangular bounding box.

Type Parameters:

O - The subclass of SpaceObject to search for

Parameters:

hitbox - The Hitbox whose bounding box to check

cls - The Class object that represents the SpaceObject subclass

Returns:

All of the solid SpaceObjects of the specified class whose solid Hitboxes' bounding boxes meet the specified Hitbox's bounding box

getNumViewports

public final int getNumViewports()

Returns the number of Viewports that are assigned to this SpaceState.

Returns:

The number of Viewports that are assigned to this SpaceState

getViewport

public final Viewport<T,U> getViewport(int id)

Returns the Viewport that is assigned to this SpaceState with the specified ID.

Parameters:

id - The ID of the Viewport to be returned

Returns:

The Viewport that is assigned to this SpaceState with the specified ID

setViewport

public final boolean setViewport(int id,
                                 Viewport<T,U> viewport)

Sets the Viewport that is assigned to this SpaceState with the specified ID to the specified Viewport, if it is not already assigned to a SpaceState. If there is already a Viewport assigned with the specified ID, it will be removed from this SpaceState. If the specified Viewport is null, the Viewport with the specified ID will be removed if there is one, but it will not be replaced with anything.

Parameters:

id - The ID with which to assign the specified Viewport

viewport - The Viewport to add with the specified ID

Returns:

Whether the addition occurred

clearViewports

public final void clearViewports()

Removes from this SpaceState all Viewports that are currently assigned to it.

getSpacePoint

public final CellVector getSpacePoint(int x,
                                      int y)

Returns the point in this SpaceState, as seen through one of its Viewports, that corresponds to the specified point in pixels on the screen. If the specified point is not in the rendering region of one of this SpaceState's Viewports with its camera in this SpaceState, this method will return null.

Parameters:

x - The x-coordinate of the screen point

y - The y-coordinate of the screen point

Returns:

The SpaceState point that corresponds to the specified screen point

rectangleIsVisible

public final boolean rectangleIsVisible(long x1,
                                        long y1,
                                        long x2,
                                        long y2)

Returns whether any part of the specified rectangular region of this SpaceState's space is visible through any of its Viewports.

Parameters:

x1 - The x-coordinate of the region's left edge

y1 - The y-coordinate of the region's top edge

x2 - The x-coordinate of the region's right edge

y2 - The y-coordinate of the region's bottom edge

Returns:

Whether the specified rectangular region of this SpaceState's space is visible through any of its Viewports

getHUD

public final HUD getHUD()

Returns the HUD that is assigned to this SpaceState, or null if there is none.

Returns:

This SpaceState's HUD

setHUD

public final void setHUD(HUD hud)

Sets the HUD that is assigned to this SpaceState to the specified one. If there is already an HUD assigned to this SpaceState, it will be removed. If the specified HUD is null, the current HUD will be removed if there is one, but it will not be replaced with anything.

Parameters:

hud - The HUD to add

getNumLayers

public final int getNumLayers()

Returns the number of SpaceLayers that are assigned to this SpaceState.

Returns:

The number of SpaceLayers that are assigned to this SpaceState

getLayer

public final SpaceLayer getLayer(int id)

Returns the SpaceLayer that is assigned to this SpaceState with the specified ID.

Parameters:

id - The ID of the SpaceLayer to be returned

Returns:

The SpaceLayer that is assigned to this SpaceState with the specified ID

setLayer

public final void setLayer(int id,
                           SpaceLayer layer)

Sets the SpaceLayer that is assigned to this SpaceState with the specified ID to the specified SpaceLayer. If there is already a SpaceLayer assigned with the specified ID, it will be removed from this SpaceState. If the specified SpaceLayer is null, the SpaceLayer with the specified ID will be removed if there is one, but it will not be replaced with anything.

Parameters:

id - The ID with which to assign the specified SpaceLayer

layer - The SpaceLayer to add with the specified ID

clearLayers

public final void clearLayers()

Removes from this SpaceState all SpaceLayers that are currently assigned to it.

frameActions

public void frameActions(T game,
                         U state)

Description copied from class: Thinker

Actions for this Thinker to take once each frame.

Overrides:

frameActions in class Thinker<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>

Parameters:

game - This Thinker's GameState's CellGame

state - This Thinker's GameState

renderActions

public void renderActions(T game,
                          Graphics g,
                          int x1,
                          int y1,
                          int x2,
                          int y2)

Description copied from class: GameState

Actions for this GameState to take each frame to render its visuals.

Overrides:

renderActions in class GameState<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>

Parameters:

game - This GameState's CellGame

g - The Graphics context to which this GameState is rendering its visuals this frame

x1 - The x-coordinate in pixels of the screen's left edge on the Graphics context

y1 - The y-coordinate in pixels of the screen's top edge on the Graphics context

x2 - The x-coordinate in pixels of the screen's right edge on the screen on the Graphics context

y2 - The y-coordinate in pixels of the screen's bottom edge on the Graphics context