Package dev.prozilla.pine.core.component.sprite

Class GridGroup

java.lang.Object

dev.prozilla.pine.core.component.Component

dev.prozilla.pine.core.component.sprite.GridGroup

All Implemented Interfaces:

Destructible, Printable, ApplicationContext, ApplicationProvider, ComponentsContext, ComponentsProvider, EntityContext, EntityProvider, SceneContext, SceneProvider

public class GridGroup
extends Component

A component that groups 2D tiles together and aligns them in a grid pattern.

Field Summary

Fields

Modifier and Type	Field	Description
final Map<Vector2i,TileProvider>	coordinateToTile
TileRenderer	hoveringTile
int	size

Fields inherited from class dev.prozilla.pine.core.component.Component

entity, id, isActive

Constructor Summary

Constructors

Constructor	Description
GridGroup(int size)

Method Summary

Modifier and Type	Method	Description
TileRenderer	addTile(TileRenderer tile)	Adds a tile to this grid based on the tile's current coordinate.
TileRenderer	addTile(Entity entity)
TileRenderer	addTile(Prefab prefab)
TileRenderer	addTile(TilePrefab tilePrefab, int x, int y)
TileRenderer	addTile(TilePrefab tilePrefab, Vector2i coordinate)
Vector2f	coordinateToPosition(int x, int y)
Vector2f	coordinateToPosition(Vector2i coordinate)
boolean	destroyTile(Vector2i coordinate)
boolean	destroyTile(TileRenderer tile)
boolean	destroyTile(Entity entity)
String	getName()
TileRenderer	getTile(int x, int y)
TileRenderer	getTile(Vector2i coordinate)
boolean	hasTile(int x, int y)
boolean	hasTile(Vector2i coordinate)
boolean	isHovering(TileRenderer tile)
boolean	isHovering(Entity entity)
void	moveTile(Vector2i oldCoordinate, Vector2i newCoordinate)
Vector2i	positionToCoordinate(float x, float y)
Vector2i	positionToCoordinate(Vector2f position)
boolean	removeTile(Vector2i coordinate)
boolean	removeTile(TileRenderer tile)
boolean	removeTile(Entity entity)
static Vector2i[]	subgrid(int width, int height)	Returns an array of coordinates of a subgrid defined by the given dimensions.
static Vector2i[]	subgrid(Vector2i dimensions)	Returns an array of coordinates of a subgrid defined by the given dimensions.
static Vector2i[]	subgrid(Vector2i dimensions, Vector2i offset)	Returns an array of coordinates of a subgrid defined by the given dimensions, with a given offset.

Methods inherited from class dev.prozilla.pine.core.component.Component

destroy, equals, getApplication, getEntity, getScene, hashCode, onEntityChange, setActive, setEntity, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.prozilla.pine.core.ApplicationProvider

getAudioDevice, getConfig, getInput, getLocalStorage, getLogger, getModManager, getRenderer, getTimer, getTracker, getWindow

Methods inherited from interface dev.prozilla.pine.core.component.ComponentsProvider

getComponent, getComponentInParent, getComponentInParent, getComponents, getComponentsInChildren

Methods inherited from interface dev.prozilla.pine.core.entity.EntityContext

isDescendantOf

Methods inherited from interface dev.prozilla.pine.core.entity.EntityProvider

getChild, getChildWithTag, getFirstChild, getLastChild, getParentWithTag, getTransform, isDescendantOf

Methods inherited from interface dev.prozilla.pine.common.Printable

print, print

Methods inherited from interface dev.prozilla.pine.core.scene.SceneProvider

getCameraData, getWorld

Field Details

size

public int size

coordinateToTile

public final Map<Vector2i,TileProvider> coordinateToTile

hoveringTile

public TileRenderer hoveringTile

Constructor Details

GridGroup

public GridGroup(int size)

Method Details

getName

public String getName()

Overrides:

getName in class Component

addTile

public TileRenderer addTile(TilePrefab tilePrefab,
 Vector2i coordinate)

addTile

public TileRenderer addTile(TilePrefab tilePrefab,
 int x,
 int y)

addTile

public TileRenderer addTile(Prefab prefab)

addTile

public TileRenderer addTile(Entity entity)

addTile

public TileRenderer addTile(TileRenderer tile)
                     throws NullPointerException,
IllegalStateException

Adds a tile to this grid based on the tile's current coordinate.

Parameters:

tile - Tile to add to this grid

Throws:

IllegalStateException - If there is already a tile in this grid with the same coordinate

NullPointerException

destroyTile

public boolean destroyTile(Vector2i coordinate)

destroyTile

public boolean destroyTile(Entity entity)

destroyTile

public boolean destroyTile(TileRenderer tile)

removeTile

public boolean removeTile(Vector2i coordinate)

removeTile

public boolean removeTile(Entity entity)

removeTile

public boolean removeTile(TileRenderer tile)

hasTile

public boolean hasTile(int x,
 int y)

hasTile

public boolean hasTile(Vector2i coordinate)

getTile

public TileRenderer getTile(int x,
 int y)

getTile

public TileRenderer getTile(Vector2i coordinate)

moveTile

public void moveTile(Vector2i oldCoordinate,
 Vector2i newCoordinate)

isHovering

public boolean isHovering(TileRenderer tile)

isHovering

public boolean isHovering(Entity entity)

positionToCoordinate

public Vector2i positionToCoordinate(Vector2f position)

positionToCoordinate

public Vector2i positionToCoordinate(float x,
 float y)

coordinateToPosition

public Vector2f coordinateToPosition(Vector2i coordinate)

coordinateToPosition

public Vector2f coordinateToPosition(int x,
 int y)

subgrid

public static Vector2i[] subgrid(Vector2i dimensions,
 Vector2i offset)

Returns an array of coordinates of a subgrid defined by the given dimensions, with a given offset.

Parameters:

dimensions - The dimensions of the subgrid

offset - The offset of the subgrid

Returns:

The coordinates of the subgrid

See Also:

• subgrid(Vector2i)

subgrid

public static Vector2i[] subgrid(Vector2i dimensions)

Returns an array of coordinates of a subgrid defined by the given dimensions.

Parameters:

dimensions - The dimensions of the subgrid

Returns:

The coordinates of the subgrid

See Also:

• subgrid(int, int)

subgrid

public static Vector2i[] subgrid(int width,
 int height)

Returns an array of coordinates of a subgrid defined by the given dimensions.

The x-coordinates go from 0 to width - 1 and the y-coordinates go from 0 to height - 1.

The array is sorted first based on the x-coordinate, then the y-coordinate.

Parameters:

width - The width of the subgrid

height - The height of the subgrid

Returns:

The coordinates of the subgrid