gVirtualXRay::Material Class Reference

Material is a class to handle materials. More...

#include <Material.h>

Collaboration diagram for gVirtualXRay::Material:

Public Member Functions
	Material ()
	Default constructor. More...
	Material (const Material &aMaterial)
	Copy constructor. More...
	~Material ()
	Destructor. More...
Material &	operator= (const Material &aMaterial)
	Copy operator. More...
void	setAmbientColour (float aRedChannel, float aGreenChannel, float aBlueChannel, float aAlphaChannel)
	Set the ambient colour. More...
void	setDiffuseColour (float aRedChannel, float aGreenChannel, float aBlueChannel, float aAlphaChannel)
	Set the diffuse colour. More...
void	setSpecularColour (float aRedChannel, float aGreenChannel, float aBlueChannel, float aAlphaChannel)
	Set the specular colour. More...
void	setShininess (float aShininessValue)
	Set the shininess of the material. More...
const float *	getAmbientColour () const
	Accessor on the ambient colour. More...
const float *	getDiffuseColour () const
	Accessor on the diffuse colour. More...
const float *	getSpecularColour () const
	Accessor on the specular colour. More...
float	getShininess () const
	Accessor on the shininess of the material. More...

Protected Attributes
float	m_p_ambient_colour [4]
	Ambient colour. More...
float	m_p_diffuse_colour [4]
	Diffuse colour. More...
float	m_p_specular_colour [4]
	Specular colour. More...
float	m_shininess
	Shininess. More...

Detailed Description

Material is a class to handle materials.

Definition at line 86 of file Material.h.

Constructor & Destructor Documentation

Material() [1/2]

gVirtualXRay::Material::Material ( )

inline

Default constructor.

Ambient colour

Diffuse colour

Specular colour

Definition at line 68 of file Material.inl.

Material() [2/2]

gVirtualXRay::Material::Material ( const Material &  aMaterial )

inline

Copy constructor.

Definition at line 93 of file Material.inl.

~Material()

gVirtualXRay::Material::~Material ( )

inline

Destructor.

Definition at line 101 of file Material.inl.

Member Function Documentation

getAmbientColour()

const float * gVirtualXRay::Material::getAmbientColour ( ) const

inline

Accessor on the ambient colour.

Returns

the ambient colour

Definition at line 179 of file Material.inl.

getDiffuseColour()

const float * gVirtualXRay::Material::getDiffuseColour ( ) const

inline

Accessor on the diffuse colour.

Returns

the diffuse colour

Definition at line 187 of file Material.inl.

getShininess()

float gVirtualXRay::Material::getShininess ( ) const

inline

Accessor on the shininess of the material.

Returns

the amount of shininess

Definition at line 203 of file Material.inl.

getSpecularColour()

const float * gVirtualXRay::Material::getSpecularColour ( ) const

inline

Accessor on the specular colour.

Returns

the specular colour

Definition at line 195 of file Material.inl.

operator=()

Material & gVirtualXRay::Material::operator= ( const Material &  aMaterial )

inline

Copy operator.

Definition at line 108 of file Material.inl.

setAmbientColour()

void gVirtualXRay::Material::setAmbientColour ( float  aRedChannel, float  aGreenChannel, float  aBlueChannel, float  aAlphaChannel  )

inline

Set the ambient colour.

Parameters

aRedChannel	red channel of the colour
aGreenChannel	green channel of the colour
aBlueChannel	blue channel of the colour
aAlphaChannel	alpha channel of the colour

Definition at line 129 of file Material.inl.

setDiffuseColour()

void gVirtualXRay::Material::setDiffuseColour ( float  aRedChannel, float  aGreenChannel, float  aBlueChannel, float  aAlphaChannel  )

inline

Set the diffuse colour.

Parameters

aRedChannel	red channel of the colour
aGreenChannel	green channel of the colour
aBlueChannel	blue channel of the colour
aAlphaChannel	alpha channel of the colour

Definition at line 143 of file Material.inl.

setShininess()

void gVirtualXRay::Material::setShininess ( float  aShininessValue )

inline

Set the shininess of the material.

Parameters

aShininessValue

amount of shininess

Definition at line 172 of file Material.inl.

setSpecularColour()

void gVirtualXRay::Material::setSpecularColour ( float  aRedChannel, float  aGreenChannel, float  aBlueChannel, float  aAlphaChannel  )

inline

Set the specular colour.

Parameters

aRedChannel	red channel of the colour
aGreenChannel	green channel of the colour
aBlueChannel	blue channel of the colour
aAlphaChannel	alpha channel of the colour

Definition at line 158 of file Material.inl.

Field Documentation

m_p_ambient_colour

float gVirtualXRay::Material::m_p_ambient_colour[4]

protected

Ambient colour.

Definition at line 208 of file Material.h.

m_p_diffuse_colour

float gVirtualXRay::Material::m_p_diffuse_colour[4]

protected

Diffuse colour.

Definition at line 212 of file Material.h.

m_p_specular_colour

float gVirtualXRay::Material::m_p_specular_colour[4]

protected

Specular colour.

Definition at line 216 of file Material.h.

m_shininess

float gVirtualXRay::Material::m_shininess

protected

Shininess.

Definition at line 220 of file Material.h.

---

The documentation for this class was generated from the following files:

• /home/fpvidal/PROGRAMMING/RELEASE/gVirtualXray-2.0.10-Source/gvxr/include/gVirtualXRay/Material.h
• /home/fpvidal/PROGRAMMING/RELEASE/gVirtualXray-2.0.10-Source/gvxr/include/gVirtualXRay/Material.inl