SO3::SMaterial Class Reference

#include <SO3Material.h>

Inheritance diagram for SO3::SMaterial:
SO3::SData

List of all members.

Public Member Functions

 SMaterial (SScene *scene, std::string groupname, std::string materialName)
 ~SMaterial ()
SWidget * GetAssociatedWidget ()
void SetAssociatedWidget (SWidget *newAssociatedWidget)
SScene * GetScene ()
std::string GetGroupName ()
Ogre::MaterialPtr getOgreMaterialPointer ()
int GetNumTechniques ()
int GetNumPasses (unsigned int technique)
int GetNumTextureUnitStates (unsigned int technique, unsigned int pass)
std::string GetTechniqueName (unsigned int technique)
int GetTechniqueIndexByName (std::string techname)
std::string GetPassName (unsigned int technique, unsigned int pass)
int GetPassIndexByName (unsigned int technique, std::string passname)
std::string GetTextureUnitName (unsigned int technique, unsigned int pass, unsigned int textureUnit)
int GetTextureUnitIndexByName (unsigned int technique, unsigned int pass, std::string texname)
std::string GetTextureName (unsigned int technique, unsigned int pass, unsigned int textureUnit)
void SetTextureUScroll (unsigned int technique, unsigned int pass, unsigned int textureUnit, float value)
float GetTextureUScroll (unsigned int technique, unsigned int pass, unsigned int textureUnit)
void SetTextureVScroll (unsigned int technique, unsigned int pass, unsigned int textureUnit, float value)
float GetTextureVScroll (unsigned int technique, unsigned int pass, unsigned int textureUnit)
void SetTextureUScale (unsigned int technique, unsigned int pass, unsigned int textureUnit, float value)
float GetTextureUScale (unsigned int technique, unsigned int pass, unsigned int textureUnit)
void SetTextureVScale (unsigned int technique, unsigned int pass, unsigned int textureUnit, float value)
float GetTextureVScale (unsigned int technique, unsigned int pass, unsigned int textureUnit)
void SetTextureRotate (unsigned int technique, unsigned int pass, unsigned int textureUnit, const float &radianAngle)
const float GetTextureRotate (unsigned int technique, unsigned int pass, unsigned int textureUnit)
void SetTextureScrollAnimation (unsigned int technique, unsigned int pass, unsigned int textureUnit, float uSpeed, float vSpeed)
void SetTextureRotateAnimation (unsigned int technique, unsigned int pass, unsigned int textureUnit, float speed)
bool GetReceiveShadows ()
void SetReceiveShadows (bool state)
bool GetLightingEnabled (unsigned int tech, unsigned int pass)
void SetLightingEnabled (unsigned int tech, unsigned int pass, bool state)
void SetLightingEnabled (bool state)
void SetAmbientColor (int color)
void SetAmbientColor (unsigned int tech, unsigned int pass, int color)
int GetAmbientColor (unsigned int tech, unsigned int pass)
void SetDiffuseColor (int color)
void SetDiffuseColor (unsigned int tech, unsigned int pass, int color)
int GetDiffuseColor (unsigned int tech, unsigned int pass)
void SetSpecularColor (int color)
void SetSpecularColor (unsigned int tech, unsigned int pass, int color)
int GetSpecularColor (unsigned int tech, unsigned int pass)
void SetSelfIlluminationColor (int color)
void SetSelfIlluminationColor (unsigned int tech, unsigned int pass, int color)
int GetSelfIlluminationColor (unsigned int tech, unsigned int pass)
void SetShininess (float value)
void SetShininess (unsigned int tech, unsigned int pass, float value)
float GetShininess (unsigned int tech, unsigned int pass)
void SetTexture (unsigned int tech, unsigned int pass, unsigned int textureUnit, STexture *texture)
STexture * GetTexture (unsigned int tech, unsigned int pass, unsigned int textureUnit)

Protected Member Functions

Ogre::TextureUnitState * GetMaterialUnitState (unsigned int technique, unsigned int pass, unsigned int textureUnit)
Ogre::Pass * GetMaterialPass (unsigned int technique, unsigned int pass)

Protected Attributes

Ogre::MaterialPtr O3MaterialPtr
SScene * mScene
SWidget * associatedWidget
std::string mGroupName

Detailed Description

Definition at line 44 of file SO3Material.h.

Constructor & Destructor Documentation

SO3::SMaterial::SMaterial ( SScene *  scene,
std::string  groupname,
std::string  materialName 
)

Definition at line 15 of file SO3Material.cpp.

SO3::SMaterial::~SMaterial (  ) 

Definition at line 42 of file SO3Material.cpp.

Member Function Documentation

int SO3::SMaterial::GetAmbientColor ( unsigned int  tech,
unsigned int  pass 
)

Definition at line 476 of file SO3Material.cpp.

SWidget * SO3::SMaterial::GetAssociatedWidget (  ) 

Definition at line 407 of file SO3Material.cpp.

int SO3::SMaterial::GetDiffuseColor ( unsigned int  tech,
unsigned int  pass 
)

Definition at line 502 of file SO3Material.cpp.

std::string SO3::SMaterial::GetGroupName (  ) 

Definition at line 59 of file SO3Material.cpp.

bool SO3::SMaterial::GetLightingEnabled ( unsigned int  tech,
unsigned int  pass 
)

Definition at line 435 of file SO3Material.cpp.

Ogre::Pass * SO3::SMaterial::GetMaterialPass ( unsigned int  technique,
unsigned int  pass 
) [protected]

Definition at line 130 of file SO3Material.cpp.

Ogre::TextureUnitState * SO3::SMaterial::GetMaterialUnitState ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit 
) [protected]

Definition at line 101 of file SO3Material.cpp.

int SO3::SMaterial::GetNumPasses ( unsigned int  technique  ) 

Definition at line 71 of file SO3Material.cpp.

int SO3::SMaterial::GetNumTechniques (  ) 

Definition at line 64 of file SO3Material.cpp.

int SO3::SMaterial::GetNumTextureUnitStates ( unsigned int  technique,
unsigned int  pass 
)

Definition at line 86 of file SO3Material.cpp.

Ogre::MaterialPtr SO3::SMaterial::getOgreMaterialPointer (  ) 

Definition at line 49 of file SO3Material.cpp.

int SO3::SMaterial::GetPassIndexByName ( unsigned int  technique,
std::string  passname 
)

Definition at line 212 of file SO3Material.cpp.

std::string SO3::SMaterial::GetPassName ( unsigned int  technique,
unsigned int  pass 
)

Definition at line 195 of file SO3Material.cpp.

bool SO3::SMaterial::GetReceiveShadows (  ) 

Definition at line 421 of file SO3Material.cpp.

SScene * SO3::SMaterial::GetScene (  ) 

Definition at line 54 of file SO3Material.cpp.

int SO3::SMaterial::GetSelfIlluminationColor ( unsigned int  tech,
unsigned int  pass 
)

Definition at line 554 of file SO3Material.cpp.

float SO3::SMaterial::GetShininess ( unsigned int  tech,
unsigned int  pass 
)

Definition at line 580 of file SO3Material.cpp.

int SO3::SMaterial::GetSpecularColor ( unsigned int  tech,
unsigned int  pass 
)

Definition at line 528 of file SO3Material.cpp.

int SO3::SMaterial::GetTechniqueIndexByName ( std::string  techname  ) 

Definition at line 169 of file SO3Material.cpp.

std::string SO3::SMaterial::GetTechniqueName ( unsigned int  technique  ) 

Definition at line 149 of file SO3Material.cpp.

STexture * SO3::SMaterial::GetTexture ( unsigned int  tech,
unsigned int  pass,
unsigned int  textureUnit 
)

Definition at line 602 of file SO3Material.cpp.

std::string SO3::SMaterial::GetTextureName ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit 
)

Definition at line 276 of file SO3Material.cpp.

const float SO3::SMaterial::GetTextureRotate ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit 
)

Definition at line 378 of file SO3Material.cpp.

int SO3::SMaterial::GetTextureUnitIndexByName ( unsigned int  technique,
unsigned int  pass,
std::string  texname 
)

Definition at line 263 of file SO3Material.cpp.

std::string SO3::SMaterial::GetTextureUnitName ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit 
)

Definition at line 247 of file SO3Material.cpp.

float SO3::SMaterial::GetTextureUScale ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit 
)

Definition at line 338 of file SO3Material.cpp.

float SO3::SMaterial::GetTextureUScroll ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit 
)

Definition at line 298 of file SO3Material.cpp.

float SO3::SMaterial::GetTextureVScale ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit 
)

Definition at line 358 of file SO3Material.cpp.

float SO3::SMaterial::GetTextureVScroll ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit 
)

Definition at line 318 of file SO3Material.cpp.

void SO3::SMaterial::SetAmbientColor ( unsigned int  tech,
unsigned int  pass,
int  color 
)

Definition at line 468 of file SO3Material.cpp.

void SO3::SMaterial::SetAmbientColor ( int  color  ) 

Definition at line 461 of file SO3Material.cpp.

void SO3::SMaterial::SetAssociatedWidget ( SWidget *  newAssociatedWidget  ) 
Remarks:
: internal use only!

Definition at line 412 of file SO3Material.cpp.

void SO3::SMaterial::SetDiffuseColor ( unsigned int  tech,
unsigned int  pass,
int  color 
)

Definition at line 494 of file SO3Material.cpp.

void SO3::SMaterial::SetDiffuseColor ( int  color  ) 

Definition at line 487 of file SO3Material.cpp.

void SO3::SMaterial::SetLightingEnabled ( bool  state  ) 

Definition at line 454 of file SO3Material.cpp.

void SO3::SMaterial::SetLightingEnabled ( unsigned int  tech,
unsigned int  pass,
bool  state 
)

Definition at line 445 of file SO3Material.cpp.

void SO3::SMaterial::SetReceiveShadows ( bool  state  ) 

Definition at line 428 of file SO3Material.cpp.

void SO3::SMaterial::SetSelfIlluminationColor ( unsigned int  tech,
unsigned int  pass,
int  color 
)

Definition at line 546 of file SO3Material.cpp.

void SO3::SMaterial::SetSelfIlluminationColor ( int  color  ) 

Definition at line 539 of file SO3Material.cpp.

void SO3::SMaterial::SetShininess ( unsigned int  tech,
unsigned int  pass,
float  value 
)

Definition at line 572 of file SO3Material.cpp.

void SO3::SMaterial::SetShininess ( float  value  ) 

Definition at line 565 of file SO3Material.cpp.

void SO3::SMaterial::SetSpecularColor ( unsigned int  tech,
unsigned int  pass,
int  color 
)

Definition at line 520 of file SO3Material.cpp.

void SO3::SMaterial::SetSpecularColor ( int  color  ) 

Definition at line 513 of file SO3Material.cpp.

void SO3::SMaterial::SetTexture ( unsigned int  tech,
unsigned int  pass,
unsigned int  textureUnit,
STexture *  texture 
)

Definition at line 591 of file SO3Material.cpp.

void SO3::SMaterial::SetTextureRotate ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit,
const float &  radianAngle 
)

Sets the anticlockwise rotation factor applied to texture coordinates.

Definition at line 369 of file SO3Material.cpp.

void SO3::SMaterial::SetTextureRotateAnimation ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit,
float  speed 
)

Sets up an animated texture rotation for this layer.

Definition at line 398 of file SO3Material.cpp.

void SO3::SMaterial::SetTextureScrollAnimation ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit,
float  uSpeed,
float  vSpeed 
)

Sets up an animated scroll for the texture layer.

Definition at line 389 of file SO3Material.cpp.

void SO3::SMaterial::SetTextureUScale ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit,
float  value 
)

As setTextureScale, but sets only U value.

Definition at line 329 of file SO3Material.cpp.

void SO3::SMaterial::SetTextureUScroll ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit,
float  value 
)

Sets the translation offset of the texture, ie scrolls the texture, for the U value.

Definition at line 289 of file SO3Material.cpp.

void SO3::SMaterial::SetTextureVScale ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit,
float  value 
)

As setTextureScale, but sets only V value.

Definition at line 349 of file SO3Material.cpp.

void SO3::SMaterial::SetTextureVScroll ( unsigned int  technique,
unsigned int  pass,
unsigned int  textureUnit,
float  value 
)

As setTextureScrollU, but sets only V value.

Definition at line 309 of file SO3Material.cpp.

Member Data Documentation

SWidget* SO3::SMaterial::associatedWidget [protected]

Definition at line 50 of file SO3Material.h.

std::string SO3::SMaterial::mGroupName [protected]

Definition at line 51 of file SO3Material.h.

SScene* SO3::SMaterial::mScene [protected]

Definition at line 49 of file SO3Material.h.

Ogre::MaterialPtr SO3::SMaterial::O3MaterialPtr [protected]

Definition at line 48 of file SO3Material.h.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Mon Oct 31 14:42:35 2011 for SO3Engine by  doxygen 1.6.3