com.bonzaiengine.material

Class SurfaceStandard

java.lang.Object

com.bonzaiengine.material.SurfaceStandard

All Implemented Interfaces:

ISurface, java.lang.Cloneable

public final class SurfaceStandard
extends java.lang.Object

Standard material, with the properties:

name Material name
ambient Material ambient color (default value: black)
diffuse Material diffuse color (default value: white)
emission Material emission color (default value: black)
specular/shininess Material specular color (default value: black) and shininess also called specular exponent (default value: 128)
transparency Material transparency (1-alpha)
useDiffuseAlpha use alpha channel of diffuse texture for alpha (default value: false)
forceAlphaTest use alpha test for texture transparency, when useDiffuseAlpha ise used (default value: false)
receiveLight receive dynamic lighting (default value: false)
twoSided two sided lighting (default value: false)
maps list texture map: diffuse, specular, normal, height, ...

Field Summary

Fields

Modifier and Type	Field and Description
Color3	ambient Material ambient color
Color3	diffuse Material diffuse color.
Color3	emission Material emission color
protected int	flags Materials flags
protected MapList	mapList List of texture maps
Color3	specular Material specular color

Method Summary

Modifier and Type	Method and Description
SurfaceStandard	clone()
boolean	equals(java.lang.Object obj)
boolean	equalsForMerge(SurfaceStandard mat)
TextureID.AlphaMode	getAlphaMode()
TextureID.AlphaMode	getMapAlphaMode(boolean withShader)
float	getShininess()
Shader	getSurfaceShader(GeometryData geometry, int numLights, int numClippingPlanes)
float	getTransparency()
boolean	hasAlpha()
boolean	isForceAlphaTest()
boolean	isReceiveLight()
boolean	isTwoSided()
boolean	isUseDiffuseAlpha()
void	set(SurfaceStandard src)
void	setForceAlphaTest(boolean forceAlphaTest)
void	setReceiveLight(boolean useLight)
void	setShader(MaterialShader shader)
void	setShininess(float shininess)
void	setTransparency(float transparency)
void	setTwoSided(boolean twoSided)
void	setUseDiffuseAlpha(boolean useDiffuseAlpha)
void	unreferenceAssets() Destroy this Material.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bonzaiengine.material.ISurface

getMapList, getShader

Field Detail

ambient

public final Color3 ambient

Material ambient color

diffuse

public final Color3 diffuse

Material diffuse color.
Alpha component of diffuse color may be used for material transparency/opacity

emission

public final Color3 emission

Material emission color

specular

public final Color3 specular

Material specular color

flags

protected int flags

Materials flags

mapList

protected final MapList mapList

List of texture maps

Method Detail

clone

public final SurfaceStandard clone()

Specified by:

clone in interface ISurface

set

public final void set(SurfaceStandard src)

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equalsForMerge

public final boolean equalsForMerge(SurfaceStandard mat)

getAlphaMode

public final TextureID.AlphaMode getAlphaMode()

getMapAlphaMode

public final TextureID.AlphaMode getMapAlphaMode(boolean withShader)

setShininess

public final void setShininess(float shininess)

getShininess

public final float getShininess()

setTransparency

public final void setTransparency(float transparency)

getTransparency

public final float getTransparency()

Returns:

transparency value in range [0; 1]
0: opaque
1: invisible
in between: transparent/translucent
Note: alpha of the material is: 1 - transparency

hasAlpha

public final boolean hasAlpha()

Returns:

true when transparency > 0

setUseDiffuseAlpha

public final void setUseDiffuseAlpha(boolean useDiffuseAlpha)

isUseDiffuseAlpha

public final boolean isUseDiffuseAlpha()

Returns:

true if the texture diffuse alpha is used for transparency

setForceAlphaTest

public final void setForceAlphaTest(boolean forceAlphaTest)

isForceAlphaTest

public final boolean isForceAlphaTest()

Returns:

true if alpha test is force for transparency

setTwoSided

public final void setTwoSided(boolean twoSided)

isTwoSided

public final boolean isTwoSided()

Returns:

true if the material has two sided lighting

isReceiveLight

public final boolean isReceiveLight()

setReceiveLight

public final void setReceiveLight(boolean useLight)

unreferenceAssets

public final void unreferenceAssets()

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

Specified by:

unreferenceAssets in interface ISurface

setShader

public final void setShader(MaterialShader shader)

Specified by:

setShader in interface ISurface

Parameters:

shader - shader to apply to this material

See Also:

MaterialGraph, Compiler.compile(MaterialShader)

getSurfaceShader

public final Shader getSurfaceShader(GeometryData geometry,
                                     int numLights,
                                     int numClippingPlanes)

Specified by:

getSurfaceShader in interface ISurface

Parameters:

geometry - optional geometry, could be null

numLights - TODO

Returns:

Shader