- Cal3D 0.11 API Reference -

Classes | Public Member Functions
CalCoreMaterial Class Reference
Inheritance diagram for CalCoreMaterial:
cal3d::RefCounted

List of all members.

Classes

struct  Color
struct  Map

Public Member Functions

ColorgetAmbientColor ()
 Returns the ambient color.
ColorgetDiffuseColor ()
 Returns the diffuse color.
int getMapCount ()
 Returns the number of maps.
const std::string & getMapFilename (int mapId)
 Returns a specified map texture filename.
Cal::UserData getMapUserData (int mapId)
 Provides access to a specified map user data.
float getShininess ()
 Returns the shininess factor.
ColorgetSpecularColor ()
 Returns the specular color.
Cal::UserData getUserData ()
 Provides access to the user data.
std::vector< Map > & getVectorMap ()
 Returns the map vector.
bool reserve (int mapCount)
 Reserves memory for the maps.
void setAmbientColor (const Color &ambientColor)
 Sets the ambient color.
void setDiffuseColor (const Color &diffuseColor)
 Sets the diffuse color.
bool setMap (int mapId, const Map &map)
 Sets a specified map.
bool setMapUserData (int mapId, Cal::UserData userData)
 Stores specified map user data.
void setShininess (float shininess)
 Sets the shininess factor.
void setSpecularColor (const Color &specularColor)
 Sets the specular color.
void setFilename (const std::string &filename)
 Set the name of the file in which the core material is stored, if any.
const std::string & getFilename (void)
 Get the name of the file in which the core material is stored, if any.
void setName (const std::string &name)
 Set the symbolic name of the core material.
const std::string & getName (void)
 Get the symbolic name the core material.
void setUserData (Cal::UserData userData)
 Stores user data.

Member Function Documentation

CalCoreMaterial::Color & CalCoreMaterial::getAmbientColor ( )

Returns the ambient color.

This function returns the ambient color of the core material instance.

Returns:
A reference to the ambient color.
CalCoreMaterial::Color & CalCoreMaterial::getDiffuseColor ( )

Returns the diffuse color.

This function returns the diffuse color of the core material instance.

Returns:
A reference to the diffuse color.
const std::string & CalCoreMaterial::getFilename ( void  )

Get the name of the file in which the core material is stored, if any.

Returns:
One of the following values:
  • empty string if the material was not stored in a file
  • the path of the file
int CalCoreMaterial::getMapCount ( )

Returns the number of maps.

This function returns the number of mapss in the core material instance.

Returns:
The number of maps.
const std::string & CalCoreMaterial::getMapFilename ( int  mapId)

Returns a specified map texture filename.

This function returns the texture filename for a specified map ID of the core material instance.

Parameters:
mapIdThe ID of the map.
Returns:
One of the following values:
  • the filename of the map texture
  • an empty string if an error happend
Cal::UserData CalCoreMaterial::getMapUserData ( int  mapId)

Provides access to a specified map user data.

This function returns the user data stored in the specified map of the core material instance.

Parameters:
mapIdThe ID of the map.
Returns:
One of the following values:
  • the user data stored in the specified map
  • 0 if an error happend
const std::string & CalCoreMaterial::getName ( void  )

Get the symbolic name the core material.

Returns:
One of the following values:
  • empty string if the material was no associated to a symbolic name
  • the symbolic name
float CalCoreMaterial::getShininess ( )

Returns the shininess factor.

This function returns the shininess factor of the core material instance.

Returns:
The shininess factor.
CalCoreMaterial::Color & CalCoreMaterial::getSpecularColor ( )

Returns the specular color.

This function returns the specular color of the core material instance.

Returns:
A reference to the specular color.
Cal::UserData CalCoreMaterial::getUserData ( )

Provides access to the user data.

This function returns the user data stored in the core material instance.

Returns:
The user data stored in the core material instance.
std::vector< CalCoreMaterial::Map > & CalCoreMaterial::getVectorMap ( )

Returns the map vector.

This function returns the vector that contains all maps of the core material instance.

Returns:
A reference to the map vector.
bool CalCoreMaterial::reserve ( int  mapCount)

Reserves memory for the maps.

This function reserves memory for the maps of the core material instance.

Parameters:
mapCountThe number of maps that this core material instance should be able to hold.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
void CalCoreMaterial::setAmbientColor ( const Color ambientColor)

Sets the ambient color.

This function sets the ambient color of the core material instance.

Parameters:
ambientColorThe ambient color that should be set.
void CalCoreMaterial::setDiffuseColor ( const Color diffuseColor)

Sets the diffuse color.

This function sets the diffuse color of the core material instance.

Parameters:
ambientColorThe diffuse color that should be set.
void CalCoreMaterial::setFilename ( const std::string &  filename)

Set the name of the file in which the core material is stored, if any.

Parameters:
filenameThe path of the file.
bool CalCoreMaterial::setMap ( int  mapId,
const Map map 
)

Sets a specified map.

This function sets a specified map in the core material instance.

Parameters:
mapIdThe ID of the map.
mapThe map that should be set.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalCoreMaterial::setMapUserData ( int  mapId,
Cal::UserData  userData 
)

Stores specified map user data.

This function stores user data in a specified map of the core material instance.

Parameters:
mapIdThe ID of the map.
userDataThe user data that should be stored.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
void CalCoreMaterial::setName ( const std::string &  name)

Set the symbolic name of the core material.

Parameters:
nameA symbolic name.
void CalCoreMaterial::setShininess ( float  shininess)

Sets the shininess factor.

This function sets the shininess factor of the core material instance.

Parameters:
shininessThe shininess factor that should be set.
void CalCoreMaterial::setSpecularColor ( const Color specularColor)

Sets the specular color.

This function sets the specular color of the core material instance.

Parameters:
ambientColorThe specular color that should be set.
void CalCoreMaterial::setUserData ( Cal::UserData  userData)

Stores user data.

This function stores user data in the core material instance.

Parameters:
userDataThe user data that should be stored.

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

Generated at Sat Jul 2 2011 13:53:45 by The Cal3D Team with Doxygen 1.7.4