com.b3dgs.lionengine.game.background
Class AbstractRasteredBackgroundElement

java.lang.Object
  extended by com.b3dgs.lionengine.game.background.BackgroundElement
      extended by com.b3dgs.lionengine.game.background.AbstractRasteredBackgroundElement

public abstract class AbstractRasteredBackgroundElement
extends BackgroundElement

Specific background element, supporting raster effects.


Constructor Summary
AbstractRasteredBackgroundElement(int mainX, int mainY, Sprite sprite, int rastersNumber)
          Create a new rastered background element.
 
Method Summary
protected  void addRaster(Sprite sprite, int fr, int fg, int fb)
          Add a raster with specified colour code.
 Sprite getRaster(int id)
          Get raster surface from its id.
protected abstract  void load(Sprite sprite, int rastersNumber)
          Load rasters from original sprite.
 
Methods inherited from class com.b3dgs.lionengine.game.background.BackgroundElement
getMainX, getMainY, getOffsetX, getOffsetY, getSprite, setOffsetX, setOffsetY
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractRasteredBackgroundElement

public AbstractRasteredBackgroundElement(int mainX,
                                         int mainY,
                                         Sprite sprite,
                                         int rastersNumber)
Create a new rastered background element.

Parameters:
mainX - main location x.
mainY - main location y.
sprite - sprite to be rasterized.
rastersNumber - number of rasters.
Method Detail

load

protected abstract void load(Sprite sprite,
                             int rastersNumber)
Load rasters from original sprite.

Parameters:
sprite - original sprite.
rastersNumber - number of rasters to use.

getRaster

public Sprite getRaster(int id)
Get raster surface from its id.

Parameters:
id - raster id.
Returns:
raster surface.

addRaster

protected void addRaster(Sprite sprite,
                         int fr,
                         int fg,
                         int fb)
Add a raster with specified colour code.

Parameters:
sprite - original sprite.
fr - red color offset.
fg - green color offset.
fb - blue color offset.