org.andengine.entity.scene.background

Class Background

java.lang.Object

org.andengine.entity.scene.background.Background

All Implemented Interfaces:

IDrawHandler, IUpdateHandler, IBackground

Direct Known Subclasses:

EntityBackground, ParallaxBackground

public class Background
extends java.lang.Object
implements IBackground

(c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

14:08:17 - 19.07.2010

Nested Class Summary

Nested classes/interfaces inherited from interface org.andengine.engine.handler.IUpdateHandler

IUpdateHandler.IUpdateHandlerMatcher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Background()
	Background(Color pColor)
	Background(float pRed, float pGreen, float pBlue)
	Background(float pRed, float pGreen, float pBlue, float pAlpha)

Method Summary

Modifier and Type	Method and Description
void	clearBackgroundModifiers()
boolean	isColorEnabled()
void	onDraw(GLState pGLState, Camera pCamera)
void	onUpdate(float pSecondsElapsed)
void	registerBackgroundModifier(IModifier<IBackground> pBackgroundModifier)
void	reset()
void	setColor(Color pColor)
void	setColor(float pRed, float pGreen, float pBlue) Sets the color using the arithmetic scheme (0.0f - 1.0f RGB triple).
void	setColor(float pRed, float pGreen, float pBlue, float pAlpha) Sets the color using the arithmetic scheme (0.0f - 1.0f RGBA quadruple).
void	setColorEnabled(boolean pColorEnabled)
boolean	unregisterBackgroundModifier(IModifier<IBackground> pBackgroundModifier)

Methods inherited from class java.lang.Object

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

Constructor Detail

Background

protected Background()

Background

public Background(float pRed,
                  float pGreen,
                  float pBlue)

Background

public Background(float pRed,
                  float pGreen,
                  float pBlue,
                  float pAlpha)

Background

public Background(Color pColor)

Method Detail

setColor

public void setColor(float pRed,
                     float pGreen,
                     float pBlue)

Sets the color using the arithmetic scheme (0.0f - 1.0f RGB triple).

Specified by:

setColor in interface IBackground

Parameters:

pRed - The red color value. Should be between 0.0 and 1.0, inclusive.

pGreen - The green color value. Should be between 0.0 and 1.0, inclusive.

pBlue - The blue color value. Should be between 0.0 and 1.0, inclusive.

setColor

public void setColor(float pRed,
                     float pGreen,
                     float pBlue,
                     float pAlpha)

Sets the color using the arithmetic scheme (0.0f - 1.0f RGBA quadruple).

Specified by:

setColor in interface IBackground

Parameters:

pRed - The red color value. Should be between 0.0 and 1.0, inclusive.

pGreen - The green color value. Should be between 0.0 and 1.0, inclusive.

pBlue - The blue color value. Should be between 0.0 and 1.0, inclusive.

pAlpha - The alpha color value. Should be between 0.0 and 1.0, inclusive.

setColor

public void setColor(Color pColor)

Specified by:

setColor in interface IBackground

isColorEnabled

public boolean isColorEnabled()

Specified by:

isColorEnabled in interface IBackground

setColorEnabled

public void setColorEnabled(boolean pColorEnabled)

Specified by:

setColorEnabled in interface IBackground

registerBackgroundModifier

public void registerBackgroundModifier(IModifier<IBackground> pBackgroundModifier)

Specified by:

registerBackgroundModifier in interface IBackground

unregisterBackgroundModifier

public boolean unregisterBackgroundModifier(IModifier<IBackground> pBackgroundModifier)

Specified by:

unregisterBackgroundModifier in interface IBackground

clearBackgroundModifiers

public void clearBackgroundModifiers()

Specified by:

clearBackgroundModifiers in interface IBackground

onUpdate

public void onUpdate(float pSecondsElapsed)

Specified by:

onUpdate in interface IUpdateHandler

onDraw

public void onDraw(GLState pGLState,
                   Camera pCamera)

Specified by:

onDraw in interface IDrawHandler

reset

public void reset()

Specified by:

reset in interface IUpdateHandler