- Cal3D 0.11 API Reference - |
Classes | |
struct | Color |
struct | Map |
Public Member Functions | |
CalCoreMaterial (const CalCoreMaterial &inOther) | |
const Color & | getAmbientColor () const |
Returns the ambient color. More... | |
const Color & | getDiffuseColor () const |
Returns the diffuse color. More... | |
int | getMapCount () const |
Returns the number of maps. More... | |
const std::string & | getMapFilename (int mapId) const |
Returns a specified map texture filename. More... | |
const std::string & | getMapType (int mapId) |
Returns a specified map type. More... | |
Cal::UserData | getMapUserData (int mapId) |
Provides access to a specified map user data. More... | |
const Cal::UserData | getMapUserData (int mapId) const |
Provides access to a specified map user data. More... | |
float | getShininess () const |
Returns the shininess factor. More... | |
const Color & | getSpecularColor () const |
Returns the specular color. More... | |
Cal::UserData | getUserData () |
Provides access to the user data. More... | |
const Cal::UserData | getUserData () const |
Provides access to the user data. More... | |
std::vector< Map > & | getVectorMap () |
Returns the map vector. More... | |
const std::vector< Map > & | getVectorMap () const |
Returns the map vector. More... | |
bool | reserve (int mapCount) |
Reserves memory for the maps. More... | |
void | setAmbientColor (const Color &ambientColor) |
Sets the ambient color. More... | |
void | setDiffuseColor (const Color &diffuseColor) |
Sets the diffuse color. More... | |
bool | setMap (int mapId, const Map &map) |
Sets a specified map. More... | |
bool | setMapUserData (int mapId, Cal::UserData userData) |
Stores specified map user data. More... | |
void | setShininess (float shininess) |
Sets the shininess factor. More... | |
void | setSpecularColor (const Color &specularColor) |
Sets the specular color. More... | |
void | setFilename (const std::string &filename) |
Set the name of the file in which the core material is stored, if any. More... | |
const std::string & | getFilename (void) const |
Get the name of the file in which the core material is stored, if any. More... | |
void | setName (const std::string &name) |
Set the symbolic name of the core material. More... | |
const std::string & | getName (void) const |
Get the symbolic name the core material. More... | |
void | setUserData (Cal::UserData userData) |
Stores user data. More... | |
bool | getAlphaBlending () |
bool | getTwoSided () |
bool | getSelfIllumination () |
![]() | |
int | getRefCount () const |
Additional Inherited Members | |
![]() | |
virtual | ~RefCounted () |
Protected so users of refcounted classes don't use std::auto_ptr or the delete operator. More... | |
const CalCoreMaterial::Color & CalCoreMaterial::getAmbientColor | ( | ) | const |
Returns the ambient color.
This function returns the ambient color of the core material instance.
const CalCoreMaterial::Color & CalCoreMaterial::getDiffuseColor | ( | ) | const |
Returns the diffuse color.
This function returns the diffuse color of the core material instance.
const std::string & CalCoreMaterial::getFilename | ( | void | ) | const |
Get the name of the file in which the core material is stored, if any.
int CalCoreMaterial::getMapCount | ( | ) | const |
Returns the number of maps.
This function returns the number of mapss in the core material instance.
const std::string & CalCoreMaterial::getMapFilename | ( | int | mapId | ) | const |
Returns a specified map texture filename.
This function returns the texture filename for a specified map ID of the core material instance.
mapId | The ID of the map. |
const std::string & CalCoreMaterial::getMapType | ( | int | mapId | ) |
Returns a specified map type.
This function returns the map type for a specified map ID of the core material instance. The type will be an exporter-specific string which explains what the Map is meant to be used for, such as "Opacity"
mapId | The ID of the map. |
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.
mapId | The ID of the map. |
const Cal::UserData CalCoreMaterial::getMapUserData | ( | int | mapId | ) | const |
Provides access to a specified map user data.
This function returns the user data stored in the specified map of the core material instance.
mapId | The ID of the map. |
const std::string & CalCoreMaterial::getName | ( | void | ) | const |
Get the symbolic name the core material.
float CalCoreMaterial::getShininess | ( | ) | const |
Returns the shininess factor.
This function returns the shininess factor of the core material instance.
const CalCoreMaterial::Color & CalCoreMaterial::getSpecularColor | ( | ) | const |
Returns the specular color.
This function returns the specular color of the core material instance.
Cal::UserData CalCoreMaterial::getUserData | ( | ) |
Provides access to the user data.
This function returns the user data stored in the core material instance.
const Cal::UserData CalCoreMaterial::getUserData | ( | ) | const |
Provides access to the user data.
This function 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.
const std::vector< CalCoreMaterial::Map > & CalCoreMaterial::getVectorMap | ( | ) | const |
Returns the map vector.
This function returns the vector that contains all maps of the core material instance.
bool CalCoreMaterial::reserve | ( | int | mapCount | ) |
Reserves memory for the maps.
This function reserves memory for the maps of the core material instance.
mapCount | The number of maps that this core material instance should be able to hold. |
void CalCoreMaterial::setAmbientColor | ( | const Color & | ambientColor | ) |
Sets the ambient color.
This function sets the ambient color of the core material instance.
ambientColor | The 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.
ambientColor | The 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.
filename | The 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.
mapId | The ID of the map. |
map | The map that should be set. |
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.
mapId | The ID of the map. |
userData | The user data that should be stored. |
void CalCoreMaterial::setName | ( | const std::string & | name | ) |
Set the symbolic name of the core material.
name | A symbolic name. |
void CalCoreMaterial::setShininess | ( | float | shininess | ) |
Sets the shininess factor.
This function sets the shininess factor of the core material instance.
shininess | The 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.
ambientColor | The 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.
userData | The user data that should be stored. |