com.bonzaiengine.material

Class Material

java.lang.Object

com.bonzaiengine.material.Material

All Implemented Interfaces:

IMaterial, java.lang.Cloneable, java.lang.Comparable<IMaterial>

public final class Material
extends java.lang.Object
implements IMaterial

Material described with shader (MaterialShader), shader parameters (ShaderState) and textures (MapList).

The surface of a material abstraction allow to render the material differently depending on the rendering context.
The default surface is referenced by SurfaceTypes.SURFACE_DEFAULT name (or null). To render the material with a specific surface, use RenderOptions.setSurface(String).

See Also:

ISurface, MaterialShader

Constructor Summary

Constructors

Constructor and Description
Material(java.lang.String name, boolean addDefaultSurface)

Method Summary

Modifier and Type	Method and Description
ISurface	addSurface(java.lang.String surfaceName, ISurface surface)
Material	clone()
int	compareTo(IMaterial o)
AssetKey	getKey()
ISurface	getSurface(java.lang.String surfaceName)
java.lang.Iterable<ISurface>	getSurfaces()
ISurface	removeSurface(java.lang.String surfaceName)
java.lang.String	toString()
void	unreferenceAssets() Destroy this Material.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bonzaiengine.material.IMaterial

getName, setName

Constructor Detail

Material

public Material(java.lang.String name,
                boolean addDefaultSurface)

Method Detail

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public final Material clone()

Specified by:

clone in interface IMaterial

Overrides:

clone in class java.lang.Object

compareTo

public final int compareTo(IMaterial o)

Specified by:

compareTo in interface java.lang.Comparable<IMaterial>

getKey

public final AssetKey getKey()

Specified by:

getKey in interface IMaterial

getSurface

public ISurface getSurface(java.lang.String surfaceName)

Specified by:

getSurface in interface IMaterial

Returns:

the MapList of this IMaterial

getSurfaces

public java.lang.Iterable<ISurface> getSurfaces()

Specified by:

getSurfaces in interface IMaterial

Returns:

the MapList of this IMaterial

addSurface

public final ISurface addSurface(java.lang.String surfaceName,
                                 ISurface surface)

Parameters:

surfaceName - surface name

surface - Surface

Returns:

the Surface previously bound to the specified surface name

removeSurface

public final ISurface removeSurface(java.lang.String surfaceName)

Parameters:

surfaceName - surface name to remove

Returns:

the ISurface removed, if any

unreferenceAssets

public final void unreferenceAssets()

Destroy this Material.
After calling this method, getSurface(String) will return null and texture will be unreferenced

Specified by:

unreferenceAssets in interface IMaterial