playn.android

Class AndroidAssets

java.lang.Object

playn.core.Assets

playn.android.AndroidAssets

public class AndroidAssets
extends Assets

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AndroidAssets.BitmapOptions Extends BitmapFactory.Options with PlayN asset scale configuration.
static interface	AndroidAssets.BitmapOptionsAdjuster See setBitmapOptionsAdjuster(playn.android.AndroidAssets.BitmapOptionsAdjuster).

Constructor Summary

Constructors

Constructor and Description
AndroidAssets(AndroidPlatform plat)

Method Summary

Modifier and Type	Method and Description
byte[]	getBytesSync(String path)
Sound	getMusic(String path)
Image	getRemoteImage(String url, int width, int height)
Sound	getSound(String path)
String	getTextSync(String path)
android.graphics.Typeface	getTypeface(String path) Loads a typeface from path.
void	setAssetScale(float scaleFactor) Configures the default scale to use for assets.
void	setBitmapOptionsAdjuster(AndroidAssets.BitmapOptionsAdjuster optionsAdjuster) Configures a class that will adjust the AndroidAssets.BitmapOptions used to decode loaded bitmaps.
void	setExpansionFile(int mainVersion, int patchVersion) Configures assets to be loaded from existing expansion files.
void	setPathPrefix(String prefix) Configures a prefix which is prepended to all asset paths prior to loading.

Methods inherited from class playn.core.Assets

getBytes, getImage, getImageSync, getRemoteImage, getText

Methods inherited from class java.lang.Object

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

Constructor Detail

AndroidAssets

public AndroidAssets(AndroidPlatform plat)

Method Detail

setPathPrefix

public void setPathPrefix(String prefix)

Configures a prefix which is prepended to all asset paths prior to loading. Android assets are normally loaded via the Android AssetManager, which expects all assets to be in the assets directory. This prefix is thus inserted between assets and the path supplied to any of the various get methods.

setExpansionFile

public void setExpansionFile(int mainVersion,
                             int patchVersion)
                      throws IOException

Configures assets to be loaded from existing expansion files. Android supports two expansion files, a main and patch file. The versions for each are passed to this method. If you are not using either of the files, supply 0 for the version. Both files will be searched for resources.

Expansion resources do not make an assumption that the resources are in a directory named 'assets' in contrast to the Android resource manager. Use setPathPrefix(java.lang.String) to configure the path within the expansion files.

Expansion files are expected to be existing and zipped, following the Android expansion file guidelines.

Due to Android limitations, fonts and typefaces can not be loaded from expansion files. Fonts should be kept within the default Android assets directory so they may be loaded via the AssetManager.

Throws:

IOException - if any expansion files are missing.

setAssetScale

public void setAssetScale(float scaleFactor)

Configures the default scale to use for assets. This allows one to use higher resolution imagery than the device might normally. For example, one can supply scale 2 here, and configure the graphics scale to 1.25 in order to use iOS Retina graphics (640x960) on a WXGA (480x800) device.

setBitmapOptionsAdjuster

public void setBitmapOptionsAdjuster(AndroidAssets.BitmapOptionsAdjuster optionsAdjuster)

Configures a class that will adjust the AndroidAssets.BitmapOptions used to decode loaded bitmaps. An app may wish to use different bitmap configs for different images (say RGB_565 for its non-transparent images) or adjust the dithering settings.

getTypeface

public android.graphics.Typeface getTypeface(String path)

Loads a typeface from path. This can then be registered via AndroidGraphics.registerFont(android.graphics.Typeface, java.lang.String, playn.core.Font.Style, java.lang.String...).

getRemoteImage

public Image getRemoteImage(String url,
                            int width,
                            int height)

Overrides:

getRemoteImage in class Assets

getSound

public Sound getSound(String path)

Specified by:

getSound in class Assets

getMusic

public Sound getMusic(String path)

Overrides:

getMusic in class Assets

getTextSync

public String getTextSync(String path)
                   throws Exception

Specified by:

getTextSync in class Assets

Throws:

Exception

getBytesSync

public byte[] getBytesSync(String path)
                    throws Exception

Specified by:

getBytesSync in class Assets

Throws:

Exception