org.andengine.opengl.texture.atlas.buildable

Class BuildableTextureAtlas<S extends ITextureAtlasSource,T extends ITextureAtlas<S>>

java.lang.Object

org.andengine.opengl.texture.atlas.buildable.BuildableTextureAtlas<S,T>

All Implemented Interfaces:

IBuildableTextureAtlas<S,T>, ITextureAtlas<S>, ITexture

Direct Known Subclasses:

BuildableBitmapTextureAtlas

public class BuildableTextureAtlas<S extends ITextureAtlasSource,T extends ITextureAtlas<S>>
extends java.lang.Object
implements IBuildableTextureAtlas<S,T>

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

Since:

21:26:38 - 12.08.2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuildableTextureAtlas.TextureAtlasSourceWithWithLocationCallback<T extends ITextureAtlasSource>

Nested classes/interfaces inherited from interface org.andengine.opengl.texture.atlas.ITextureAtlas

ITextureAtlas.ITextureAtlasStateListener<T extends ITextureAtlasSource>

Constructor Summary

Constructors

Constructor and Description
BuildableTextureAtlas(T pTextureAtlas)

Method Summary

Modifier and Type	Method and Description
void	addEmptyTextureAtlasSource(int pTextureX, int pTextureY, int pWidth, int pHeight)
void	addTextureAtlasSource(S pTextureAtlasSource, Callback<S> pCallback) When all ITextureAtlasSources are added you have to call build(ITextureAtlasBuilder).
void	addTextureAtlasSource(S pTextureAtlasSource, int pTextureX, int pTextureY) Deprecated.
void	addTextureAtlasSource(S pTextureAtlasSource, int pTextureX, int pTextureY, int pTextureAtlasSourcePadding) Deprecated.
void	bind(GLState pGLState)
void	bind(GLState pGLState, int pGLActiveTexture)
IBuildableTextureAtlas<S,T>	build(ITextureAtlasBuilder<S,T> pTextureAtlasBuilder) May draw over already added ITextureAtlasSource.
void	clearTextureAtlasSources()
int	getHardwareTextureID()
int	getHeight()
PixelFormat	getPixelFormat()
ITextureAtlas.ITextureAtlasStateListener<S>	getTextureAtlasStateListener()
TextureOptions	getTextureOptions()
ITextureAtlas.ITextureAtlasStateListener<S>	getTextureStateListener() Deprecated.
int	getWidth()
boolean	hasTextureAtlasStateListener()
boolean	hasTextureStateListener() Deprecated.
boolean	isLoadedToHardware()
boolean	isUpdateOnHardwareNeeded()
void	load()
void	load(GLState pGLState)
void	loadToHardware(GLState pGLState)
void	reloadToHardware(GLState pGLState)
void	removeTextureAtlasSource(ITextureAtlasSource pTextureAtlasSource) Removes a ITextureAtlasSource before build(ITextureAtlasBuilder) is called.
void	removeTextureAtlasSource(S pTextureAtlasSource, int pTextureX, int pTextureY)
void	setNotLoadedToHardware()
void	setTextureAtlasStateListener(ITextureAtlas.ITextureAtlasStateListener<S> pTextureAtlasStateListener)
void	setTextureStateListener(ITextureStateListener pTextureStateListener) Deprecated.
void	setUpdateOnHardwareNeeded(boolean pUpdateOnHardwareNeeded)
void	unload()
void	unload(GLState pGLState)
void	unloadFromHardware(GLState pGLState)

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildableTextureAtlas

public BuildableTextureAtlas(T pTextureAtlas)

Method Detail

getWidth

public int getWidth()

Specified by:

getWidth in interface ITexture

getHeight

public int getHeight()

Specified by:

getHeight in interface ITexture

getHardwareTextureID

public int getHardwareTextureID()

Specified by:

getHardwareTextureID in interface ITexture

isLoadedToHardware

public boolean isLoadedToHardware()

Specified by:

isLoadedToHardware in interface ITexture

setNotLoadedToHardware

public void setNotLoadedToHardware()

Specified by:

setNotLoadedToHardware in interface ITexture

isUpdateOnHardwareNeeded

public boolean isUpdateOnHardwareNeeded()

Specified by:

isUpdateOnHardwareNeeded in interface ITexture

setUpdateOnHardwareNeeded

public void setUpdateOnHardwareNeeded(boolean pUpdateOnHardwareNeeded)

Specified by:

setUpdateOnHardwareNeeded in interface ITexture

load

public void load()

Specified by:

load in interface ITexture

See Also:

TextureManager#loadTexture(ITexture)}.

load

public void load(GLState pGLState)
          throws java.io.IOException

Specified by:

load in interface ITexture

Throws:

java.io.IOException

See Also:

TextureManager#loadTexture(GLState, ITexture)}.

unload

public void unload()

Specified by:

unload in interface ITexture

See Also:

TextureManager#unloadTexture(ITexture)}.

unload

public void unload(GLState pGLState)

Specified by:

unload in interface ITexture

See Also:

TextureManager#unloadTexture(GLState, ITexture)}.

loadToHardware

public void loadToHardware(GLState pGLState)
                    throws java.io.IOException

Specified by:

loadToHardware in interface ITexture

Throws:

java.io.IOException

unloadFromHardware

public void unloadFromHardware(GLState pGLState)

Specified by:

unloadFromHardware in interface ITexture

reloadToHardware

public void reloadToHardware(GLState pGLState)
                      throws java.io.IOException

Specified by:

reloadToHardware in interface ITexture

Throws:

java.io.IOException

bind

public void bind(GLState pGLState)

Specified by:

bind in interface ITexture

bind

public void bind(GLState pGLState,
                 int pGLActiveTexture)

Specified by:

bind in interface ITexture

pGLActiveTexture - from GLES20.GL_TEXTURE0 to GLES20.GL_TEXTURE31.

getPixelFormat

public PixelFormat getPixelFormat()

Specified by:

getPixelFormat in interface ITexture

getTextureOptions

public TextureOptions getTextureOptions()

Specified by:

getTextureOptions in interface ITexture

addTextureAtlasSource

@Deprecated
public void addTextureAtlasSource(S pTextureAtlasSource,
                                              int pTextureX,
                                              int pTextureY)

Deprecated.

Description copied from interface: IBuildableTextureAtlas

Most likely this is not the method you'd want to be using, as the ITextureAtlasSource won't get built through this BuildableTextureAtlas.

Specified by:

addTextureAtlasSource in interface IBuildableTextureAtlas<S extends ITextureAtlasSource,T extends ITextureAtlas<S>>

Specified by:

addTextureAtlasSource in interface ITextureAtlas<S extends ITextureAtlasSource>

addTextureAtlasSource

@Deprecated
public void addTextureAtlasSource(S pTextureAtlasSource,
                                              int pTextureX,
                                              int pTextureY,
                                              int pTextureAtlasSourcePadding)

Deprecated.

Description copied from interface: IBuildableTextureAtlas

Most likely this is not the method you'd want to be using, as the ITextureAtlasSource won't get built through this BuildableTextureAtlas.

Specified by:

addTextureAtlasSource in interface IBuildableTextureAtlas<S extends ITextureAtlasSource,T extends ITextureAtlas<S>>

Specified by:

addTextureAtlasSource in interface ITextureAtlas<S extends ITextureAtlasSource>

removeTextureAtlasSource

public void removeTextureAtlasSource(S pTextureAtlasSource,
                                     int pTextureX,
                                     int pTextureY)

Specified by:

removeTextureAtlasSource in interface ITextureAtlas<S extends ITextureAtlasSource>

clearTextureAtlasSources

public void clearTextureAtlasSources()

Specified by:

clearTextureAtlasSources in interface ITextureAtlas<S extends ITextureAtlasSource>

hasTextureStateListener

@Deprecated
public boolean hasTextureStateListener()

Deprecated.

Specified by:

hasTextureStateListener in interface ITextureAtlas<S extends ITextureAtlasSource>

Specified by:

hasTextureStateListener in interface ITexture

See Also:

BuildableBitmapTextureAtlas#hasTextureAtlasStateListener()}

hasTextureAtlasStateListener

public boolean hasTextureAtlasStateListener()

Specified by:

hasTextureAtlasStateListener in interface ITextureAtlas<S extends ITextureAtlasSource>

getTextureStateListener

@Deprecated
public ITextureAtlas.ITextureAtlasStateListener<S> getTextureStateListener()

Deprecated.

Specified by:

getTextureStateListener in interface ITextureAtlas<S extends ITextureAtlasSource>

Specified by:

getTextureStateListener in interface ITexture

See Also:

BuildableBitmapTextureAtlas#setTextureStateListener(ITextureAtlasStateListener)}

getTextureAtlasStateListener

public ITextureAtlas.ITextureAtlasStateListener<S> getTextureAtlasStateListener()

Specified by:

getTextureAtlasStateListener in interface ITextureAtlas<S extends ITextureAtlasSource>

setTextureStateListener

@Deprecated
public void setTextureStateListener(ITextureStateListener pTextureStateListener)

Deprecated.

Specified by:

setTextureStateListener in interface ITextureAtlas<S extends ITextureAtlasSource>

Specified by:

setTextureStateListener in interface ITexture

See Also:

BuildableBitmapTextureAtlas#setTextureStateListener(ITextureAtlasStateListener)}

setTextureAtlasStateListener

public void setTextureAtlasStateListener(ITextureAtlas.ITextureAtlasStateListener<S> pTextureAtlasStateListener)

Specified by:

setTextureAtlasStateListener in interface ITextureAtlas<S extends ITextureAtlasSource>

addEmptyTextureAtlasSource

public void addEmptyTextureAtlasSource(int pTextureX,
                                       int pTextureY,
                                       int pWidth,
                                       int pHeight)

Specified by:

addEmptyTextureAtlasSource in interface ITextureAtlas<S extends ITextureAtlasSource>

addTextureAtlasSource

public void addTextureAtlasSource(S pTextureAtlasSource,
                                  Callback<S> pCallback)

Description copied from interface: IBuildableTextureAtlas

When all ITextureAtlasSources are added you have to call build(ITextureAtlasBuilder).

Specified by:

addTextureAtlasSource in interface IBuildableTextureAtlas<S extends ITextureAtlasSource,T extends ITextureAtlas<S>>

Parameters:

pTextureAtlasSource - to be added.

removeTextureAtlasSource

public void removeTextureAtlasSource(ITextureAtlasSource pTextureAtlasSource)

Description copied from interface: IBuildableTextureAtlas

Removes a ITextureAtlasSource before build(ITextureAtlasBuilder) is called.

Specified by:

removeTextureAtlasSource in interface IBuildableTextureAtlas<S extends ITextureAtlasSource,T extends ITextureAtlas<S>>

build

public IBuildableTextureAtlas<S,T> build(ITextureAtlasBuilder<S,T> pTextureAtlasBuilder)
                                  throws ITextureAtlasBuilder.TextureAtlasBuilderException

Description copied from interface: IBuildableTextureAtlas

May draw over already added ITextureAtlasSource.

Specified by:

build in interface IBuildableTextureAtlas<S extends ITextureAtlasSource,T extends ITextureAtlas<S>>

Parameters:

pTextureAtlasBuilder - the ITextureAtlasBuilder to use for building the ITextureAtlasSource in this BuildableBitmapTextureAtlas.

Returns:

itself for method chaining.

Throws:

ITextureAtlasBuilder.TextureAtlasBuilderException - i.e. when the ITextureAtlasSource didn't fit into this BuildableBitmapTextureAtlas.