SO3Engine
|
#include <SO3Pass.h>
Public Member Functions | |
SPass (STechnique *technique, Ogre::Pass *ogrePassRef) | |
~SPass () | |
STechnique * | GetTechnique () |
Ogre::Pass * | GetOgrePassPointer () |
int | GetNumTextureUnitStates () |
std::string | GetTextureUnitName (const unsigned int &textureUnit) |
int | GetTextureUnitIndexByName (const std::string &texname) |
std::string | GetTextureName (const unsigned int &textureUnit) |
std::string | GetTextureFileName (const unsigned int &textureUnit) |
void | SetTextureUScroll (const unsigned int &textureUnit, const float &value) |
float | GetTextureUScroll (const unsigned int &textureUnit) |
void | SetTextureVScroll (const unsigned int &textureUnit, const float &value) |
float | GetTextureVScroll (const unsigned int &textureUnit) |
void | SetTextureUScale (const unsigned int &textureUnit, const float &value) |
float | GetTextureUScale (const unsigned int &textureUnit) |
void | SetTextureVScale (const unsigned int &textureUnit, const float &value) |
float | GetTextureVScale (const unsigned int &textureUnit) |
void | SetTextureRotate (const unsigned int &textureUnit, const float &radianAngle) |
const float | GetTextureRotate (const unsigned int &textureUnit) |
void | SetTextureScrollAnimation (const unsigned int &textureUnit, const float &uSpeed, const float &vSpeed) |
void | SetTextureRotateAnimation (const unsigned int &textureUnit, const float &speed) |
bool | GetLightingEnabled () |
void | SetLightingEnabled (const bool &state) |
void | SetAmbientColor (const int &color) |
void | SetAmbientColor (Ogre::ColourValue color) |
int | GetAmbientColor () |
void | SetDiffuseColor (const int &color) |
void | SetDiffuseColor (Ogre::ColourValue color) |
int | GetDiffuseColor () |
void | SetSpecularColor (const int &color) |
void | SetSpecularColor (Ogre::ColourValue color) |
int | GetSpecularColor () |
void | SetSelfIlluminationColor (const int &color) |
void | SetSelfIlluminationColor (Ogre::ColourValue color) |
int | GetSelfIlluminationColor () |
void | SetShininess (const float &value) |
float | GetShininess () |
void | SetUseVertexColor (bool state) |
bool | GetUseVertexColor () |
void | SetTexture (const unsigned int &textureUnit, STexture *texture, std::string name="") |
STexture * | GetTexture (const unsigned int &textureUnit) |
int | GetTextureUnitByType (SShaderGenerator::ShaderMapType type) |
const Ogre::GpuNamedConstants | GetVertexProgramParameters () |
void | SetVertexProgramAutoParameter (const std::string ¶mName, const Ogre::GpuProgramParameters::AutoConstantType ¶mType, const size_t ¶mExtraInfos) |
void | SetVertexProgramParameter (const std::string ¶mName, const std::string &value) |
const Ogre::GpuNamedConstants | GetFragmentProgramParameters () |
void | SetFragmentProgramAutoParameter (const std::string ¶mName, const Ogre::GpuProgramParameters::AutoConstantType ¶mType, const size_t ¶mExtraInfos) |
void | SetFragmentProgramParameter (const std::string ¶mName, const std::string &value) |
SceneBlendFactor | GetSourceBlendFactor () const |
SceneBlendFactor | GetDestBlendFactor () const |
SceneBlendFactor | GetSourceBlendFactorAlpha () const |
SceneBlendFactor | GetDestBlendFactorAlpha () const |
void | SetSceneBlending (const SPass::SceneBlendFactor sourceFactor, const SPass::SceneBlendFactor destFactor) |
void | SetSceneBlending (const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor, const SceneBlendFactor sourceFactorAlpha, const SceneBlendFactor destFactorAlpha) |
SceneBlendOperation | GetSceneBlendingOperation () const |
SceneBlendOperation | GetSceneBlendingOperationAlpha () const |
void | SetSceneBlendingOperation (SceneBlendOperation op, SceneBlendOperation alphaOp) |
void | SetDepthCheckEnabled (bool enabled) |
bool | GetDepthCheckEnabled () const |
void | SetDepthWriteEnabled (bool enabled) |
bool | GetDepthWriteEnabled () const |
void | SetDepthFunction (CompareFunction func) |
CompareFunction | GetDepthFunction () const |
void | SetAlphaRejection (CompareFunction func, unsigned char value, bool alphaToCoverageEnabled=false) |
CompareFunction | GetAlphaRejectionFunction () const |
unsigned char | GetAlphaRejectionValue () const |
bool | GetAlphaToCoverage () const |
void | SetColourWriteEnabled (bool state) |
bool | GetColourWriteEnabled () const |
void | SetCullingMode (const bool state) |
bool | GetCullingMode () const |
void | SetPointSize (Ogre::Real size) |
float | GetPointSize () |
bool | IsPointCloud () |
void | SetPolygonMode (PolygonMode mode) |
PolygonMode | GetPolygonMode () |
bool | IsShaderGenerated () |
void | CleanGeneratedShader () |
void | BuildShader (bool force=false) |
void | SetTextureUnitColorBlendModeFactor (const unsigned int &textureUnit, float factor) |
float | GetTextureUnitColorBlendModeFactor (const unsigned int &textureUnit) |
void | RemoveTexture (const unsigned int &textureUnit) |
void | SetTextureByType (STexture *tex, SShaderGenerator::ShaderMapType type) |
std::string | GetTextureUnitNameByType (SShaderGenerator::ShaderMapType type) |
void | UpdateGeneratedPass (bool full=false) |
void | OrderTexturesUnitsByType () |
Public Member Functions inherited from SO3::SData | |
SData (const std::string &dataName) | |
virtual | ~SData () |
std::string | GetName () const |
SUserObjectBindings & | GetUserObjectBindings () |
const SUserObjectBindings & | GetUserObjectBindings () const |
Static Public Member Functions | |
static std::string | GetTextureUnitTypedName (Ogre::TextureUnitState *unit) |
static SShaderGenerator::ShaderMapType | GetTextureUnitType (Ogre::TextureUnitState *unit) |
Protected Attributes | |
Ogre::Pass * | ogrePass |
STechnique * | parentTechnique |
bool | mGeneratedShader |
float | mPointSize |
Protected Attributes inherited from SO3::SData | |
std::string | name |
Detailed Description
Member Enumeration Documentation
◆ CompareFunction
◆ PolygonMode
◆ SceneBlendFactor
◆ SceneBlendOperation
Constructor & Destructor Documentation
◆ SPass()
SO3::SPass::SPass | ( | STechnique * | technique, |
Ogre::Pass * | ogrePassRef | ||
) |
Definition at line 27 of file SO3Pass.cpp.
◆ ~SPass()
SO3::SPass::~SPass | ( | ) |
Definition at line 79 of file SO3Pass.cpp.
Member Function Documentation
◆ BuildShader()
void SO3::SPass::BuildShader | ( | bool | force = false | ) |
Definition at line 165 of file SO3Pass.cpp.
◆ CleanGeneratedShader()
void SO3::SPass::CleanGeneratedShader | ( | ) |
Definition at line 156 of file SO3Pass.cpp.
◆ GetAlphaRejectionFunction()
SPass::CompareFunction SO3::SPass::GetAlphaRejectionFunction | ( | ) | const |
Gets the alpha reject function.
Definition at line 986 of file SO3Pass.cpp.
◆ GetAlphaRejectionValue()
unsigned char SO3::SPass::GetAlphaRejectionValue | ( | ) | const |
Gets the alpha reject value.
Definition at line 991 of file SO3Pass.cpp.
◆ GetAlphaToCoverage()
bool SO3::SPass::GetAlphaToCoverage | ( | ) | const |
Gets whether to use alpha to coverage (A2C) when blending alpha rejected values.
Definition at line 996 of file SO3Pass.cpp.
◆ GetAmbientColor()
int SO3::SPass::GetAmbientColor | ( | ) |
Definition at line 493 of file SO3Pass.cpp.
◆ GetColourWriteEnabled()
bool SO3::SPass::GetColourWriteEnabled | ( | ) | const |
Gets whether the pass write the color or not
Definition at line 1008 of file SO3Pass.cpp.
◆ GetCullingMode()
bool SO3::SPass::GetCullingMode | ( | ) | const |
Gets hardware and software culling mode state
Definition at line 1023 of file SO3Pass.cpp.
◆ GetDepthCheckEnabled()
bool SO3::SPass::GetDepthCheckEnabled | ( | ) | const |
Returns whether or not this pass renders with depth-buffer checking on or not.
Definition at line 949 of file SO3Pass.cpp.
◆ GetDepthFunction()
SPass::CompareFunction SO3::SPass::GetDepthFunction | ( | ) | const |
Returns the function used to compare depth values when depth checking is on.
Definition at line 974 of file SO3Pass.cpp.
◆ GetDepthWriteEnabled()
bool SO3::SPass::GetDepthWriteEnabled | ( | ) | const |
Returns whether or not this pass renders with depth-buffer writing on or not.
Definition at line 962 of file SO3Pass.cpp.
◆ GetDestBlendFactor()
SPass::SceneBlendFactor SO3::SPass::GetDestBlendFactor | ( | ) | const |
Definition at line 891 of file SO3Pass.cpp.
◆ GetDestBlendFactorAlpha()
SPass::SceneBlendFactor SO3::SPass::GetDestBlendFactorAlpha | ( | ) | const |
Definition at line 901 of file SO3Pass.cpp.
◆ GetDiffuseColor()
int SO3::SPass::GetDiffuseColor | ( | ) |
Definition at line 512 of file SO3Pass.cpp.
◆ GetFragmentProgramParameters()
const Ogre::GpuNamedConstants SO3::SPass::GetFragmentProgramParameters | ( | ) |
Definition at line 806 of file SO3Pass.cpp.
◆ GetLightingEnabled()
bool SO3::SPass::GetLightingEnabled | ( | ) |
Definition at line 467 of file SO3Pass.cpp.
◆ GetNumTextureUnitStates()
int SO3::SPass::GetNumTextureUnitStates | ( | ) |
Definition at line 282 of file SO3Pass.cpp.
◆ GetOgrePassPointer()
Ogre::Pass * SO3::SPass::GetOgrePassPointer | ( | ) |
Definition at line 272 of file SO3Pass.cpp.
◆ GetPointSize()
float SO3::SPass::GetPointSize | ( | ) |
Definition at line 1043 of file SO3Pass.cpp.
◆ GetPolygonMode()
SPass::PolygonMode SO3::SPass::GetPolygonMode | ( | ) |
Get point cloud state
Definition at line 1079 of file SO3Pass.cpp.
◆ GetSceneBlendingOperation()
SPass::SceneBlendOperation SO3::SPass::GetSceneBlendingOperation | ( | ) | const |
Definition at line 924 of file SO3Pass.cpp.
◆ GetSceneBlendingOperationAlpha()
SPass::SceneBlendOperation SO3::SPass::GetSceneBlendingOperationAlpha | ( | ) | const |
Definition at line 929 of file SO3Pass.cpp.
◆ GetSelfIlluminationColor()
int SO3::SPass::GetSelfIlluminationColor | ( | ) |
Definition at line 550 of file SO3Pass.cpp.
◆ GetShininess()
float SO3::SPass::GetShininess | ( | ) |
Definition at line 565 of file SO3Pass.cpp.
◆ GetSourceBlendFactor()
SPass::SceneBlendFactor SO3::SPass::GetSourceBlendFactor | ( | ) | const |
Definition at line 886 of file SO3Pass.cpp.
◆ GetSourceBlendFactorAlpha()
SPass::SceneBlendFactor SO3::SPass::GetSourceBlendFactorAlpha | ( | ) | const |
Definition at line 896 of file SO3Pass.cpp.
◆ GetSpecularColor()
int SO3::SPass::GetSpecularColor | ( | ) |
Definition at line 531 of file SO3Pass.cpp.
◆ GetTechnique()
STechnique * SO3::SPass::GetTechnique | ( | ) |
Definition at line 277 of file SO3Pass.cpp.
◆ GetTexture()
STexture * SO3::SPass::GetTexture | ( | const unsigned int & | textureUnit | ) |
Definition at line 645 of file SO3Pass.cpp.
◆ GetTextureFileName()
std::string SO3::SPass::GetTextureFileName | ( | const unsigned int & | textureUnit | ) |
Definition at line 315 of file SO3Pass.cpp.
◆ GetTextureName()
std::string SO3::SPass::GetTextureName | ( | const unsigned int & | textureUnit | ) |
Definition at line 305 of file SO3Pass.cpp.
◆ GetTextureRotate()
const float SO3::SPass::GetTextureRotate | ( | const unsigned int & | textureUnit | ) |
Definition at line 434 of file SO3Pass.cpp.
◆ GetTextureUnitByType()
int SO3::SPass::GetTextureUnitByType | ( | SShaderGenerator::ShaderMapType | type | ) |
Definition at line 661 of file SO3Pass.cpp.
◆ GetTextureUnitColorBlendModeFactor()
float SO3::SPass::GetTextureUnitColorBlendModeFactor | ( | const unsigned int & | textureUnit | ) |
Definition at line 1111 of file SO3Pass.cpp.
◆ GetTextureUnitIndexByName()
int SO3::SPass::GetTextureUnitIndexByName | ( | const std::string & | texname | ) |
Definition at line 300 of file SO3Pass.cpp.
◆ GetTextureUnitName()
std::string SO3::SPass::GetTextureUnitName | ( | const unsigned int & | textureUnit | ) |
Definition at line 287 of file SO3Pass.cpp.
◆ GetTextureUnitNameByType()
std::string SO3::SPass::GetTextureUnitNameByType | ( | SShaderGenerator::ShaderMapType | type | ) |
Definition at line 1280 of file SO3Pass.cpp.
◆ GetTextureUnitType()
|
static |
Definition at line 115 of file SO3Pass.cpp.
◆ GetTextureUnitTypedName()
|
static |
Definition at line 88 of file SO3Pass.cpp.
◆ GetTextureUScale()
float SO3::SPass::GetTextureUScale | ( | const unsigned int & | textureUnit | ) |
Definition at line 390 of file SO3Pass.cpp.
◆ GetTextureUScroll()
float SO3::SPass::GetTextureUScroll | ( | const unsigned int & | textureUnit | ) |
Definition at line 346 of file SO3Pass.cpp.
◆ GetTextureVScale()
float SO3::SPass::GetTextureVScale | ( | const unsigned int & | textureUnit | ) |
Definition at line 412 of file SO3Pass.cpp.
◆ GetTextureVScroll()
float SO3::SPass::GetTextureVScroll | ( | const unsigned int & | textureUnit | ) |
Definition at line 368 of file SO3Pass.cpp.
◆ GetUseVertexColor()
bool SO3::SPass::GetUseVertexColor | ( | ) |
Definition at line 580 of file SO3Pass.cpp.
◆ GetVertexProgramParameters()
const Ogre::GpuNamedConstants SO3::SPass::GetVertexProgramParameters | ( | ) |
Definition at line 726 of file SO3Pass.cpp.
◆ IsPointCloud()
bool SO3::SPass::IsPointCloud | ( | ) |
Get point cloud state
Definition at line 1048 of file SO3Pass.cpp.
◆ IsShaderGenerated()
bool SO3::SPass::IsShaderGenerated | ( | ) |
Definition at line 151 of file SO3Pass.cpp.
◆ OrderTexturesUnitsByType()
void SO3::SPass::OrderTexturesUnitsByType | ( | ) |
Definition at line 1130 of file SO3Pass.cpp.
◆ RemoveTexture()
void SO3::SPass::RemoveTexture | ( | const unsigned int & | textureUnit | ) |
Definition at line 1119 of file SO3Pass.cpp.
◆ SetAlphaRejection()
void SO3::SPass::SetAlphaRejection | ( | CompareFunction | func, |
unsigned char | value, | ||
bool | alphaToCoverageEnabled = false |
||
) |
Sets the way the pass will have use alpha to totally reject pixels from the pipeline.
Definition at line 979 of file SO3Pass.cpp.
◆ SetAmbientColor() [1/2]
void SO3::SPass::SetAmbientColor | ( | const int & | color | ) |
Definition at line 479 of file SO3Pass.cpp.
◆ SetAmbientColor() [2/2]
void SO3::SPass::SetAmbientColor | ( | Ogre::ColourValue | color | ) |
Definition at line 486 of file SO3Pass.cpp.
◆ SetColourWriteEnabled()
void SO3::SPass::SetColourWriteEnabled | ( | bool | state | ) |
Sets whether the pass write the color or not
Definition at line 1001 of file SO3Pass.cpp.
◆ SetCullingMode()
void SO3::SPass::SetCullingMode | ( | const bool | state | ) |
Enable or disable hardware and software culling mode
Definition at line 1013 of file SO3Pass.cpp.
◆ SetDepthCheckEnabled()
void SO3::SPass::SetDepthCheckEnabled | ( | bool | enabled | ) |
Sets whether or not this pass renders with depth-buffer checking on or not.
Definition at line 942 of file SO3Pass.cpp.
◆ SetDepthFunction()
void SO3::SPass::SetDepthFunction | ( | SPass::CompareFunction | func | ) |
Sets the function used to compare depth values when depth checking is on.
Definition at line 967 of file SO3Pass.cpp.
◆ SetDepthWriteEnabled()
void SO3::SPass::SetDepthWriteEnabled | ( | bool | enabled | ) |
Sets whether or not this pass renders with depth-buffer writing on or not.
Definition at line 954 of file SO3Pass.cpp.
◆ SetDiffuseColor() [1/2]
void SO3::SPass::SetDiffuseColor | ( | const int & | color | ) |
Definition at line 498 of file SO3Pass.cpp.
◆ SetDiffuseColor() [2/2]
void SO3::SPass::SetDiffuseColor | ( | Ogre::ColourValue | color | ) |
Definition at line 505 of file SO3Pass.cpp.
◆ SetFragmentProgramAutoParameter()
void SO3::SPass::SetFragmentProgramAutoParameter | ( | const std::string & | paramName, |
const Ogre::GpuProgramParameters::AutoConstantType & | paramType, | ||
const size_t & | paramExtraInfos | ||
) |
Definition at line 831 of file SO3Pass.cpp.
◆ SetFragmentProgramParameter()
void SO3::SPass::SetFragmentProgramParameter | ( | const std::string & | paramName, |
const std::string & | value | ||
) |
Definition at line 841 of file SO3Pass.cpp.
◆ SetLightingEnabled()
void SO3::SPass::SetLightingEnabled | ( | const bool & | state | ) |
Definition at line 472 of file SO3Pass.cpp.
◆ SetPointSize()
void SO3::SPass::SetPointSize | ( | Ogre::Real | size | ) |
Set point cloud size
Definition at line 1031 of file SO3Pass.cpp.
◆ SetPolygonMode()
void SO3::SPass::SetPolygonMode | ( | PolygonMode | mode | ) |
Set point cloud state
Definition at line 1056 of file SO3Pass.cpp.
◆ SetSceneBlending() [1/2]
void SO3::SPass::SetSceneBlending | ( | const SceneBlendFactor | sourceFactor, |
const SceneBlendFactor | destFactor, | ||
const SceneBlendFactor | sourceFactorAlpha, | ||
const SceneBlendFactor | destFactorAlpha | ||
) |
Definition at line 914 of file SO3Pass.cpp.
◆ SetSceneBlending() [2/2]
void SO3::SPass::SetSceneBlending | ( | const SPass::SceneBlendFactor | sourceFactor, |
const SPass::SceneBlendFactor | destFactor | ||
) |
Definition at line 906 of file SO3Pass.cpp.
◆ SetSceneBlendingOperation()
void SO3::SPass::SetSceneBlendingOperation | ( | SPass::SceneBlendOperation | op, |
SPass::SceneBlendOperation | alphaOp | ||
) |
Definition at line 934 of file SO3Pass.cpp.
◆ SetSelfIlluminationColor() [1/2]
void SO3::SPass::SetSelfIlluminationColor | ( | const int & | color | ) |
Definition at line 536 of file SO3Pass.cpp.
◆ SetSelfIlluminationColor() [2/2]
void SO3::SPass::SetSelfIlluminationColor | ( | Ogre::ColourValue | color | ) |
Definition at line 543 of file SO3Pass.cpp.
◆ SetShininess()
void SO3::SPass::SetShininess | ( | const float & | value | ) |
Definition at line 555 of file SO3Pass.cpp.
◆ SetSpecularColor() [1/2]
void SO3::SPass::SetSpecularColor | ( | const int & | color | ) |
Definition at line 517 of file SO3Pass.cpp.
◆ SetSpecularColor() [2/2]
void SO3::SPass::SetSpecularColor | ( | Ogre::ColourValue | color | ) |
Definition at line 524 of file SO3Pass.cpp.
◆ SetTexture()
void SO3::SPass::SetTexture | ( | const unsigned int & | textureUnit, |
STexture * | texture, | ||
std::string | name = "" |
||
) |
Definition at line 585 of file SO3Pass.cpp.
◆ SetTextureByType()
void SO3::SPass::SetTextureByType | ( | STexture * | tex, |
SShaderGenerator::ShaderMapType | type | ||
) |
Definition at line 1244 of file SO3Pass.cpp.
◆ SetTextureRotate()
void SO3::SPass::SetTextureRotate | ( | const unsigned int & | textureUnit, |
const float & | radianAngle | ||
) |
Sets the anticlockwise rotation factor applied to texture coordinates.
Definition at line 423 of file SO3Pass.cpp.
◆ SetTextureRotateAnimation()
void SO3::SPass::SetTextureRotateAnimation | ( | const unsigned int & | textureUnit, |
const float & | speed | ||
) |
Sets up an animated texture rotation for this layer.
Definition at line 456 of file SO3Pass.cpp.
◆ SetTextureScrollAnimation()
void SO3::SPass::SetTextureScrollAnimation | ( | const unsigned int & | textureUnit, |
const float & | uSpeed, | ||
const float & | vSpeed | ||
) |
Sets up an animated scroll for the texture layer.
Definition at line 445 of file SO3Pass.cpp.
◆ SetTextureUnitColorBlendModeFactor()
void SO3::SPass::SetTextureUnitColorBlendModeFactor | ( | const unsigned int & | textureUnit, |
float | factor | ||
) |
Definition at line 1084 of file SO3Pass.cpp.
◆ SetTextureUScale()
void SO3::SPass::SetTextureUScale | ( | const unsigned int & | textureUnit, |
const float & | value | ||
) |
As setTextureScale, but sets only U value.
Definition at line 379 of file SO3Pass.cpp.
◆ SetTextureUScroll()
void SO3::SPass::SetTextureUScroll | ( | const unsigned int & | textureUnit, |
const float & | value | ||
) |
Sets the translation offset of the texture, ie scrolls the texture, for the U value.
Definition at line 335 of file SO3Pass.cpp.
◆ SetTextureVScale()
void SO3::SPass::SetTextureVScale | ( | const unsigned int & | textureUnit, |
const float & | value | ||
) |
As setTextureScale, but sets only V value.
Definition at line 401 of file SO3Pass.cpp.
◆ SetTextureVScroll()
void SO3::SPass::SetTextureVScroll | ( | const unsigned int & | textureUnit, |
const float & | value | ||
) |
As setTextureScrollU, but sets only V value.
Definition at line 357 of file SO3Pass.cpp.
◆ SetUseVertexColor()
void SO3::SPass::SetUseVertexColor | ( | bool | state | ) |
Definition at line 570 of file SO3Pass.cpp.
◆ SetVertexProgramAutoParameter()
void SO3::SPass::SetVertexProgramAutoParameter | ( | const std::string & | paramName, |
const Ogre::GpuProgramParameters::AutoConstantType & | paramType, | ||
const size_t & | paramExtraInfos | ||
) |
Definition at line 751 of file SO3Pass.cpp.
◆ SetVertexProgramParameter()
void SO3::SPass::SetVertexProgramParameter | ( | const std::string & | paramName, |
const std::string & | value | ||
) |
Definition at line 761 of file SO3Pass.cpp.
◆ UpdateGeneratedPass()
void SO3::SPass::UpdateGeneratedPass | ( | bool | full = false | ) |
Definition at line 1323 of file SO3Pass.cpp.
Member Data Documentation
◆ mGeneratedShader
◆ mPointSize
◆ ogrePass
◆ parentTechnique
|
protected |
The documentation for this class was generated from the following files:
- include/SO3Material/SO3Pass.h
- src/SO3Material/SO3Pass.cpp
Generated by 1.9.8