com.b3dgs.lionengine.game.map
Class AbstractTiledFogOfWar<TTile extends DefaultTile>

java.lang.Object
  extended by com.b3dgs.lionengine.game.map.AbstractTiledFogOfWar<TTile>
Type Parameters:
TTile - tile type used.

public abstract class AbstractTiledFogOfWar<TTile extends DefaultTile>
extends java.lang.Object

Designed to handle a fog of war (discovering tile and hidding tile).


Constructor Summary
AbstractTiledFogOfWar()
          Create a new tile based fog of war.
 
Method Summary
 void create(TileBasedMap<TTile> map)
          Create fog from existing map.
 boolean hasFogOfWar()
          Check if fog of war is enabled.
 boolean isFogged(int v, int h)
          In case of active fog of war, check if tile is hidden by fog.
 boolean isVisited(int v, int h)
          In case of active fog of war, check if tile has been discovered.
protected abstract  void onFogChanges(AbstractEntry<?,?,?> entry)
          Called when an entry make the fog change.
 void render(java.awt.Graphics2D g, StrategyCamera camera, int inTileWidth, int inTileHeight)
          Render fog map from camera viewpoint, showing a specified area.
 void setFogOfWar(boolean hide, boolean fog)
          Set fog of war state.
 void setFogTiles(TiledSprite hide, TiledSprite fog)
          Set fog tilesheet reference.
 void setOwner(java.util.Set<?> entrys, int id)
          Set owner id, to know which player has to be fogged.
 void updateEntryFOV(AbstractEntry<?,?,?> entry)
          Update entry field of view (fog of war).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractTiledFogOfWar

public AbstractTiledFogOfWar()
Create a new tile based fog of war.

Method Detail

create

public void create(TileBasedMap<TTile> map)
Create fog from existing map.

Parameters:
map - map reference.

setOwner

public void setOwner(java.util.Set<?> entrys,
                     int id)
Set owner id, to know which player has to be fogged.

Parameters:
entrys - entrys list
id - owner id

updateEntryFOV

public void updateEntryFOV(AbstractEntry<?,?,?> entry)
Update entry field of view (fog of war).

Parameters:
entry - entry reference.

onFogChanges

protected abstract void onFogChanges(AbstractEntry<?,?,?> entry)
Called when an entry make the fog change. See updateEntryFOV().

Parameters:
entry - entry which make the fog update.

setFogTiles

public void setFogTiles(TiledSprite hide,
                        TiledSprite fog)
Set fog tilesheet reference.

Parameters:
hide - hide tilesheet.
fog - fog tilesheet.

setFogOfWar

public void setFogOfWar(boolean hide,
                        boolean fog)
Set fog of war state.

Parameters:
hide - true to enable map hidding.
fog - true to enable fog map.

hasFogOfWar

public boolean hasFogOfWar()
Check if fog of war is enabled.

Returns:
true if fog of war is enabled.

isVisited

public boolean isVisited(int v,
                         int h)
In case of active fog of war, check if tile has been discovered.

Parameters:
v - vertical tile.
h - horizontal tile.
Returns:
true if already discovered.

isFogged

public boolean isFogged(int v,
                        int h)
In case of active fog of war, check if tile is hidden by fog.

Parameters:
v - vertical tile.
h - horizontal tile.
Returns:
true if hidden by fog.

render

public void render(java.awt.Graphics2D g,
                   StrategyCamera camera,
                   int inTileWidth,
                   int inTileHeight)
Render fog map from camera viewpoint, showing a specified area.

Parameters:
g - graphic output.
camera - camera viewpoint.
inTileWidth - number of rendered tiles in width.
inTileHeight - number of rendered tiles in height.