NL3D::UMaterial Class Reference

Game Interface for Material. More...

#include <u_material.h>

Public Types
enum	ZFunc { always = 0, never, equal, notequal, less, lessequal, greater, greaterequal, zfuncCount }
enum	TBlend { one = 0, zero, srcalpha, invsrcalpha, srccolor, invsrccolor, blendCount }
Texture Env Modes.

enum	TTexOperator { Replace = 0, Modulate, Add, AddSigned, InterpolateTexture, InterpolatePrevious, InterpolateDiffuse, InterpolateConstant, EMBM, Mad }
	Environements operators: Replace: out= arg0 Modulate: out= arg0 * arg1 Add: out= arg0 + arg1 AddSigned: out= arg0 + arg1 -0.5 Interpolate: out= arg0As + arg1*(1-As), where As is taken from the SrcAlpha of Texture/Previous/Diffuse/Constant, respectively if operator is InterpolateTexture/InterpolatePrevious/InterpolateDiffuse/InterpolateConstant. More...
enum	TTexSource { Texture = 0, Previous, Diffuse, Constant }
	Source argument. More...
enum	TTexOperand { SrcColor = 0, InvSrcColor, SrcAlpha, InvSrcAlpha }
	Operand for the argument. More...
Public Member Functions
	UMaterial ()
	Proxy interface.
	UMaterial (class CMaterial *object)
void	attach (class CMaterial *object)
	Attach an object to this proxy.
void	detach ()
	Detach the object.
bool	empty () const
	Return true if the proxy is empty() (not attached).
class CMaterial *	getObjectPtr () const
	For advanced usage, get the internal object ptr.
Texture.

void	setTexture (uint stage, UTexture *ptex)
bool	texturePresent (uint stage)
void	selectTextureSet (uint id)
	select from a texture set for this material (if available)
void	setTexture (UTexture *ptex)
bool	texturePresent ()
Blending.

void	setBlend (bool active)
void	setBlendFunc (TBlend src, TBlend dst)
void	setSrcBlend (TBlend val)
void	setDstBlend (TBlend val)
bool	getBlend () const
TBlend	getSrcBlend (void) const
TBlend	getDstBlend (void) const
Texture environnement.

void	texEnvOpRGB (uint stage, TTexOperator ope)
void	texEnvArg0RGB (uint stage, TTexSource src, TTexOperand oper)
void	texEnvArg1RGB (uint stage, TTexSource src, TTexOperand oper)
void	texEnvArg2RGB (uint stage, TTexSource src, TTexOperand oper)
void	texEnvOpAlpha (uint stage, TTexOperator ope)
void	texEnvArg0Alpha (uint stage, TTexSource src, TTexOperand oper)
void	texEnvArg1Alpha (uint stage, TTexSource src, TTexOperand oper)
void	texEnvArg2Alpha (uint stage, TTexSource src, TTexOperand oper)
ZBuffer.

void	setZFunc (ZFunc val)
void	setZWrite (bool active)
void	setZBias (float val)
ZFunc	getZFunc (void) const
bool	getZWrite (void) const
float	getZBias (void) const
Alpha test.

void	setAlphaTest (bool active)
bool	getAlphaTest () const
void	setAlphaTestThreshold (float threshold)
	change the threshold against alpha is tested.
float	getAlphaTestThreshold () const
Color/Lighting..

void	setColor (CRGBA rgba)
	The Color is used only if lighting is disabled. Also, color is replaced by per vertex color (if any).
CRGBA	getColor (void) const
Lighted material mgt. Relevant only if isLighted(). Used for get of UShape

bool	isLighted () const
CRGBA	getEmissive () const
CRGBA	getAmbient () const
CRGBA	getDiffuse () const
	return diffuse part. NB: A==opacity.
uint8	getOpacity () const
CRGBA	getSpecular () const
float	getShininess () const
Culling

void	setDoubleSided (bool doubleSided=true)
bool	getDoubleSided () const
Misc

void	initUnlit ()
	Init the material as unlit.
bool	isSupportedByDriver (UDriver &drv, bool forceBaseCaps=false)
Private Attributes
CMaterial *	_Object

Detailed Description

Game Interface for Material.

Material for gamers are Unlighted materials!! Only normal material unlighted is supported.

Author:: Lionel Berenguier; Nevrax France

Date:: 2001

Definition at line 48 of file u_material.h.

Member Enumeration Documentation

enum NL3D::UMaterial::TBlend

Enumerator:

one
zero
srcalpha
invsrcalpha
srccolor
invsrccolor
blendCount

Definition at line 52 of file u_material.h.

enum NL3D::UMaterial::TTexOperand

Operand for the argument.

For Alpha arguments, only SrcAlpha and InvSrcAlpha are Valid!!
SrcColor: arg= ColorSource. InvSrcColor: arg= 1-ColorSource. SrcAlpha: arg= AlphaSource. InvSrcAlpha: arg= 1-AlphaSource.

Enumerator:

SrcColor
InvSrcColor
SrcAlpha
InvSrcAlpha

Definition at line 86 of file u_material.h.

enum NL3D::UMaterial::TTexOperator

Environements operators: Replace: out= arg0 Modulate: out= arg0 * arg1 Add: out= arg0 + arg1 AddSigned: out= arg0 + arg1 -0.5 Interpolate*: out= arg0*As + arg1*(1-As), where As is taken from the SrcAlpha of Texture/Previous/Diffuse/Constant, respectively if operator is InterpolateTexture/InterpolatePrevious/InterpolateDiffuse/InterpolateConstant.

Multiply-Add (Mad) out= arg0 * arg1 + arg2. Must be supported by driver EMBM : apply to both color and alpha : the current texture, whose format is DSDT, is used to offset the texture in the next stage. NB : for EMBM and InterpolateConstant, this must be supported by driver.

Enumerator:

Replace
Modulate
Add
AddSigned
InterpolateTexture
InterpolatePrevious
InterpolateDiffuse
InterpolateConstant
EMBM
Mad

Definition at line 68 of file u_material.h.

enum NL3D::UMaterial::TTexSource

Source argument.

Texture: the arg is taken from the current texture of the stage. Previous: the arg is taken from the previous enabled stage. If stage 0, Previous==Diffuse. Diffuse: the arg is taken from the primary color vertex. Constant: the arg is taken from the constant color setuped for this texture stage.

Enumerator:

Texture
Previous
Diffuse
Constant

Definition at line 77 of file u_material.h.

enum NL3D::UMaterial::ZFunc

Enumerator:

always
never
equal
notequal
less
lessequal
greater
greaterequal
zfuncCount

Definition at line 51 of file u_material.h.

Constructor & Destructor Documentation

NL3D::UMaterial::UMaterial ( ) [inline]

Proxy interface.

Constructors

Definition at line 199 of file u_material.h.

References _Object.

NL3D::UMaterial::UMaterial ( class CMaterial * object ) [inline]

Definition at line 200 of file u_material.h.

References _Object.

Member Function Documentation

void NL3D::UMaterial::attach ( class CMaterial * object ) [inline]

Attach an object to this proxy.

Definition at line 202 of file u_material.h.

References _Object.

Referenced by NL3D::CDriverUser::setDisplay().

void NL3D::UMaterial::detach ( ) [inline]

Detach the object.

Definition at line 204 of file u_material.h.

References _Object.

Referenced by NL3D::CDriverUser::deleteMaterial().

bool NL3D::UMaterial::empty ( ) const [inline]

Return true if the proxy is empty() (not attached).

Definition at line 206 of file u_material.h.

References _Object.

Referenced by NL3D::CBloomEffect::~CBloomEffect().

bool NL3D::UMaterial::getAlphaTest ( ) const

Definition at line 54 of file u_material.cpp.

bool NL3D::UMaterial::isSupportedByDriver	(	UDriver &	drv,
		bool	forceBaseCaps = `false`
	)

void NL3D::UMaterial::setTexture	(	uint	stage,
		UTexture *	ptex
	)

void NL3D::UMaterial::texEnvArg0Alpha	(	uint	stage,
		TTexSource	src,
		TTexOperand	oper
	)

void NL3D::UMaterial::texEnvArg0RGB	(	uint	stage,
		TTexSource	src,
		TTexOperand	oper
	)

void NL3D::UMaterial::texEnvArg1Alpha	(	uint	stage,
		TTexSource	src,
		TTexOperand	oper
	)

void NL3D::UMaterial::texEnvArg1RGB	(	uint	stage,
		TTexSource	src,
		TTexOperand	oper
	)

void NL3D::UMaterial::texEnvArg2Alpha	(	uint	stage,
		TTexSource	src,
		TTexOperand	oper
	)

void NL3D::UMaterial::texEnvArg2RGB	(	uint	stage,
		TTexSource	src,
		TTexOperand	oper
	)

void NL3D::UMaterial::texEnvOpAlpha	(	uint	stage,
		TTexOperator	ope
	)

void NL3D::UMaterial::texEnvOpRGB	(	uint	stage,
		TTexOperator	ope
	)

NL3D::UMaterial Class Reference

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation