Rigs of Rods 2026.01
Soft-body Physics Simulation
Loading...
Searching...
No Matches
Data Structures | Public Types | Public Member Functions | Private Member Functions | Private Attributes
Hydrax::MaterialManager Class Reference

Description

Material/Shader manager class.

Definition at line 44 of file MaterialManager.h.

Data Structures

struct  Options
 
class  UnderwaterCompositorListener
 

Public Types

enum  MaterialType
 
enum  CompositorType
 
enum  GpuProgram
 
enum  ShaderMode
 
enum  NormalMode
 

Public Member Functions

 MaterialManager (Hydrax *h)
 
 ~MaterialManager ()
 
bool createMaterials (const HydraxComponent &Components, const Options &Options)
 
void removeMaterials ()
 
void removeCompositor ()
 
void reload (const MaterialType &Material)
 
bool fillGpuProgramsToPass (Ogre::Pass *Pass, const Ogre::String GpuProgramNames[2], const ShaderMode &SM, const Ogre::String EntryPoints[2], const Ogre::String Data[2])
 
bool createGpuProgram (const Ogre::String &Name, const ShaderMode &SM, const GpuProgram &GPUP, const Ogre::String &EntryPoint, const Ogre::String &Data)
 
const bool & isCreated () const
 
Ogre::MaterialPtr & getMaterial (const MaterialType &Material)
 
Ogre::CompositorPtr & getCompositor (const CompositorType &Compositor)
 
const bool & isCompositorEnable (const CompositorType &Compositor) const
 
void setCompositorEnable (const CompositorType &Compositor, const bool &Enable)
 
const Options & getLastOptions () const
 
void addDepthTechnique (Ogre::Technique *Technique, const bool &AutoUpdate=true)
 
void addDepthTextureTechnique (Ogre::Technique *Technique, const Ogre::String &TextureName, const Ogre::String &AlphaChannel="w", const bool &AutoUpdate=true)
 
std::vector< Ogre::Technique * > & getDepthTechniques ()
 
void setGpuProgramParameter (const GpuProgram &GpuP, const MaterialType &MType, const Ogre::String &Name, const Ogre::Real &Value)
 
void setGpuProgramParameter (const GpuProgram &GpuP, const MaterialType &MType, const Ogre::String &Name, const Ogre::Vector2 &Value)
 
void setGpuProgramParameter (const GpuProgram &GpuP, const MaterialType &MType, const Ogre::String &Name, const Ogre::Vector3 &Value)
 
void updateAnimatedTextures (float dt)
 

Private Member Functions

bool _isComponent (const HydraxComponent &List, const HydraxComponent &ToCheck) const
 
bool _createWaterMaterial (const HydraxComponent &Components, const Options &Options)
 
bool _createDepthMaterial (const HydraxComponent &Components, const Options &Options)
 
bool _createDepthTextureGPUPrograms (const HydraxComponent &Components, const Options &Options, const Ogre::String &AlphaChannel)
 
bool _createUnderwaterMaterial (const HydraxComponent &Components, const Options &Options)
 
bool _createUnderwaterCompositor (const HydraxComponent &Components, const Options &Options)
 
bool _createSimpleColorMaterial (const Ogre::ColourValue &MaterialColor, const MaterialType &MT, const Ogre::String &MaterialName, const bool &DepthCheck=true, const bool &DepthWrite=true)
 

Private Attributes

bool mCreated
 
Ogre::MaterialPtr mMaterials [6]
 
Ogre::CompositorPtr mCompositors [1]
 
bool mCompositorsNeedToBeReloaded [1]
 
bool mCompositorsEnable [1]
 
std::vector< Ogre::Technique * > mDepthTechniques
 
HydraxComponent mComponents
 
Options mOptions
 
UnderwaterCompositorListener mUnderwaterCompositorListener
 
Hydrax * mHydrax
 
std::vector< Ogre::TextureUnitState * > mCausticsAnimTexVec
 
unsigned int mCausticsAnimCurrentFrame = 0
 
float mCausticsAnimCurrentFrameElapsedTime = 0.f
 

Member Enumeration Documentation

◆ CompositorType

enum Hydrax::MaterialManager::CompositorType

Compositor type enum.

Remarks
Use in getCompositor(CompositorType)
Enumerator
COMP_UNDERWATER 

Definition at line 69 of file MaterialManager.h.

◆ GpuProgram

enum Hydrax::MaterialManager::GpuProgram

Gpu program enum.

Remarks
Use in setGpuProgramParameter()
Enumerator
GPUP_VERTEX 
GPUP_FRAGMENT 

Definition at line 78 of file MaterialManager.h.

◆ MaterialType

enum Hydrax::MaterialManager::MaterialType

Material type enum.

Remarks
Use in getMaterial(MaterialType)
Enumerator
MAT_WATER 
MAT_DEPTH 
MAT_UNDERWATER 
MAT_UNDERWATER_COMPOSITOR 
MAT_SIMPLE_RED 
MAT_SIMPLE_BLACK 

Definition at line 50 of file MaterialManager.h.

◆ NormalMode

enum Hydrax::MaterialManager::NormalMode

Normal generation mode.

Enumerator
NM_TEXTURE 
NM_VERTEX 
NM_RTT 

Definition at line 100 of file MaterialManager.h.

◆ ShaderMode

enum Hydrax::MaterialManager::ShaderMode

Shader mode.

Enumerator
SM_HLSL 
SM_CG 
SM_GLSL 

Definition at line 88 of file MaterialManager.h.

Constructor & Destructor Documentation

◆ MaterialManager()

Hydrax::MaterialManager::MaterialManager ( Hydrax *  h)

Constructor.

Parameters
hHydrax pointer

Definition at line 62 of file MaterialManager.cpp.

◆ ~MaterialManager()

Hydrax::MaterialManager::~MaterialManager ( )

Destructor.

Definition at line 81 of file MaterialManager.cpp.

Member Function Documentation

◆ _createDepthMaterial()

bool Hydrax::MaterialManager::_createDepthMaterial ( const HydraxComponent &  Components,
const Options &  Options 
)
private

Create depth material.

Parameters
ComponentsComponents of the shader
OptionsMaterial options

Definition at line 1202 of file MaterialManager.cpp.

◆ _createDepthTextureGPUPrograms()

bool Hydrax::MaterialManager::_createDepthTextureGPUPrograms ( const HydraxComponent &  Components,
const Options &  Options,
const Ogre::String &  AlphaChannel 
)
private

Create depth texture gpu programs.

Parameters
ComponentsComponents of the sahder
OptionsMaterial options
AlphaChannel"x","y","z","w" or "r","g","b","a" (Channel where alpha information is stored)
Returns
true if no problems had happend, false if yes

Definition at line 1569 of file MaterialManager.cpp.

◆ _createSimpleColorMaterial()

bool Hydrax::MaterialManager::_createSimpleColorMaterial ( const Ogre::ColourValue &  MaterialColor,
const MaterialType &  MT,
const Ogre::String &  MaterialName,
const bool &  DepthCheck = true,
const bool &  DepthWrite = true 
)
private

Definition at line 3150 of file MaterialManager.cpp.

◆ _createUnderwaterCompositor()

bool Hydrax::MaterialManager::_createUnderwaterCompositor ( const HydraxComponent &  Components,
const Options &  Options 
)
private

Create underwater compositor.

Parameters
ComponentsComponents of the shader
OptionsMaterial options

Definition at line 2767 of file MaterialManager.cpp.

◆ _createUnderwaterMaterial()

bool Hydrax::MaterialManager::_createUnderwaterMaterial ( const HydraxComponent &  Components,
const Options &  Options 
)
private

Create underwater material.

Parameters
ComponentsComponents of the shader
OptionsMaterial options

Definition at line 1808 of file MaterialManager.cpp.

◆ _createWaterMaterial()

bool Hydrax::MaterialManager::_createWaterMaterial ( const HydraxComponent &  Components,
const Options &  Options 
)
private

Create water material.

Parameters
ComponentsComponents of the shader
OptionsMaterial options

Definition at line 349 of file MaterialManager.cpp.

◆ _isComponent()

bool Hydrax::MaterialManager::_isComponent ( const HydraxComponent &  List,
const HydraxComponent &  ToCheck 
) const
private

Is component in the given list?

Parameters
ListComponents list
ToCheckComponent to check
Returns
true if the component is in the given list.

Definition at line 3538 of file MaterialManager.cpp.

◆ addDepthTechnique()

void Hydrax::MaterialManager::addDepthTechnique ( Ogre::Technique *  Technique,
const bool &  AutoUpdate = true 
)

Add depth technique to an especified material.

Parameters
TechniqueTechnique where depth technique will be added
AutoUpdateThe technique will be automatically updated when water parameters change
Remarks
Call it after Hydrax::create()/Hydrax::setComponents(...) 
     The technique will be automatically updated when water parameters change if parameter AutoUpdate == true
     Add depth technique when a material is not an Ogre::Entity, such terrains, PLSM2 materials, etc.
     This depth technique will be added with "HydraxDepth" scheme in ordeto can use it in the Depth RTT.

Definition at line 3398 of file MaterialManager.cpp.

◆ addDepthTextureTechnique()

void Hydrax::MaterialManager::addDepthTextureTechnique ( Ogre::Technique *  Technique,
const Ogre::String &  TextureName,
const Ogre::String &  AlphaChannel = "w",
const bool &  AutoUpdate = true 
)

Add depth texture technique to an especified material.

Parameters
TechniqueTechnique where depth technique will be added
TextureNameTexture name
AlphaChannel"x","y","z","w" or "r","g","b","a" (Channel where alpha information is stored)
AutoUpdateThe technique will be automatically updated when water parameters change
Remarks
Call it after Hydrax::create()/Hydrax::setComponents(...) 
     The technique will be automatically updated when water parameters change if parameter AutoUpdate == true
     Add depth technique when a material is not an Ogre::Entity, such terrains, PLSM2 materials, etc.
     This depth technique will be added with "HydraxDepth" scheme in ordeto can use it in the Depth RTT.

Definition at line 3453 of file MaterialManager.cpp.

◆ createGpuProgram()

bool Hydrax::MaterialManager::createGpuProgram ( const Ogre::String &  Name,
const ShaderMode &  SM,
const GpuProgram &  GPUP,
const Ogre::String &  EntryPoint,
const Ogre::String &  Data 
)

Create GPU program.

Parameters
NameHighLevelGpuProgram name
SMShader mode
GPUPGpuProgram type
EntryPointEntry point
Data

Definition at line 261 of file MaterialManager.cpp.

◆ createMaterials()

bool Hydrax::MaterialManager::createMaterials ( const HydraxComponent &  Components,
const Options &  Options 
)

Create materials.

Parameters
ComponentsComponents of the shader
OptionsMaterial options

Definition at line 163 of file MaterialManager.cpp.

◆ fillGpuProgramsToPass()

bool Hydrax::MaterialManager::fillGpuProgramsToPass ( Ogre::Pass *  Pass,
const Ogre::String  GpuProgramNames[2],
const ShaderMode &  SM,
const Ogre::String  EntryPoints[2],
const Ogre::String  Data[2] 
)

Fill GPU vertex and fragment program to a pass.

Parameters
PassPass to fill Gpu programs
GpuProgramNames[0]: Vertex program name, [1]: Fragment program name
SMShader mode, note: Provided data strings will correspong with selected shader mode
EntryPoints[0]: Vertex program entry point, [1]: Fragment program entry point
Data[0] Vertex program data, [1]: Fragment program data

Definition at line 239 of file MaterialManager.cpp.

◆ getCompositor()

Ogre::CompositorPtr & Hydrax::MaterialManager::getCompositor ( const CompositorType &  Compositor)
inline

Get compositor.

Parameters
Compositorto get
Returns
Compositor to get

Definition at line 230 of file MaterialManager.h.

◆ getDepthTechniques()

std::vector< Ogre::Technique * > & Hydrax::MaterialManager::getDepthTechniques ( )
inline

Get external depth techniques.

Returns
std::vector of external depth techniques

Definition at line 285 of file MaterialManager.h.

◆ getLastOptions()

const Options & Hydrax::MaterialManager::getLastOptions ( ) const
inline

Get the last MaterialManager::Options used in a material generation.

Returns
Last MaterialManager::Options used in a material generation

Definition at line 253 of file MaterialManager.h.

◆ getMaterial()

Ogre::MaterialPtr & Hydrax::MaterialManager::getMaterial ( const MaterialType &  Material)
inline

Get material.

Parameters
MaterialMaterial to get
Returns
Material to get

Definition at line 221 of file MaterialManager.h.

◆ isCompositorEnable()

const bool & Hydrax::MaterialManager::isCompositorEnable ( const CompositorType &  Compositor) const
inline

Is the compositor enable?

Parameters
Compositorcompositor to check
Returns
true if it's enabled

Definition at line 239 of file MaterialManager.h.

◆ isCreated()

const bool & Hydrax::MaterialManager::isCreated ( ) const
inline

Is createMaterials() already called?

Returns
true If yes

Definition at line 212 of file MaterialManager.h.

◆ reload()

void Hydrax::MaterialManager::reload ( const MaterialType &  Material)

Reload material.

Parameters
MaterialMaterial to reload

Definition at line 3170 of file MaterialManager.cpp.

◆ removeCompositor()

void Hydrax::MaterialManager::removeCompositor ( )

Remove compositor.

Definition at line 147 of file MaterialManager.cpp.

◆ removeMaterials()

void Hydrax::MaterialManager::removeMaterials ( )

Remove materials.

Remarks
removeCompositor() is called too.

Definition at line 86 of file MaterialManager.cpp.

◆ setCompositorEnable()

void Hydrax::MaterialManager::setCompositorEnable ( const CompositorType &  Compositor,
const bool &  Enable 
)

Set a compositor enable/disable.

Parameters
Compositorcompositor to change
Enabletrue to enable, false to disable

Definition at line 3523 of file MaterialManager.cpp.

◆ setGpuProgramParameter() [1/3]

void Hydrax::MaterialManager::setGpuProgramParameter ( const GpuProgram &  GpuP,
const MaterialType &  MType,
const Ogre::String &  Name,
const Ogre::Real &  Value 
)

Set gpu program Ogre::Real parameter.

Parameters
GpuPGpu program type (Vertex/Fragment)
MTypeWater/Depth material
Nameparam name
Valuevalue

Definition at line 3558 of file MaterialManager.cpp.

◆ setGpuProgramParameter() [2/3]

void Hydrax::MaterialManager::setGpuProgramParameter ( const GpuProgram &  GpuP,
const MaterialType &  MType,
const Ogre::String &  Name,
const Ogre::Vector2 &  Value 
)

Set gpu program Ogre::Vector2 parameter.

Parameters
GpuPGpu program type (Vertex/Fragment)
MTypeWater/Depth material
Nameparam name
Valuevalue

Definition at line 3616 of file MaterialManager.cpp.

◆ setGpuProgramParameter() [3/3]

void Hydrax::MaterialManager::setGpuProgramParameter ( const GpuProgram &  GpuP,
const MaterialType &  MType,
const Ogre::String &  Name,
const Ogre::Vector3 &  Value 
)

Set gpu program Ogre::Vector3 parameter.

Parameters
GpuPGpu program type (Vertex/Fragment)
MTypeWater/Depth material
Nameparam name
Valuevalue

Definition at line 3674 of file MaterialManager.cpp.

◆ updateAnimatedTextures()

void Hydrax::MaterialManager::updateAnimatedTextures ( float  dt)

Animated textures must be updated manually to account for variable simulation time.

Definition at line 1547 of file MaterialManager.cpp.

Field Documentation

◆ mCausticsAnimCurrentFrame

unsigned int Hydrax::MaterialManager::mCausticsAnimCurrentFrame = 0
private

Definition at line 382 of file MaterialManager.h.

◆ mCausticsAnimCurrentFrameElapsedTime

float Hydrax::MaterialManager::mCausticsAnimCurrentFrameElapsedTime = 0.f
private

Time spent on current animation frame, cumulative.

Definition at line 384 of file MaterialManager.h.

◆ mCausticsAnimTexVec

std::vector<Ogre::TextureUnitState*> Hydrax::MaterialManager::mCausticsAnimTexVec
private

Caustics animated texture, for manual updating.

Definition at line 381 of file MaterialManager.h.

◆ mComponents

HydraxComponent Hydrax::MaterialManager::mComponents
private

Actual material components.

Definition at line 373 of file MaterialManager.h.

◆ mCompositors

Ogre::CompositorPtr Hydrax::MaterialManager::mCompositors[1]
private

Hydrax compositors vector.

Definition at line 365 of file MaterialManager.h.

◆ mCompositorsEnable

bool Hydrax::MaterialManager::mCompositorsEnable[1]
private

Hydrax compostor enable vector.

Definition at line 369 of file MaterialManager.h.

◆ mCompositorsNeedToBeReloaded

bool Hydrax::MaterialManager::mCompositorsNeedToBeReloaded[1]
private

Hydrax compositors boolean: Need to be reloaded?

Definition at line 367 of file MaterialManager.h.

◆ mCreated

bool Hydrax::MaterialManager::mCreated
private

Is createMaterials() already called?

Definition at line 361 of file MaterialManager.h.

◆ mDepthTechniques

std::vector<Ogre::Technique*> Hydrax::MaterialManager::mDepthTechniques
private

Technique vector for addDepthTechnique(...)

Definition at line 371 of file MaterialManager.h.

◆ mHydrax

Hydrax* Hydrax::MaterialManager::mHydrax
private

Hydrax main pointer.

Definition at line 379 of file MaterialManager.h.

◆ mMaterials

Ogre::MaterialPtr Hydrax::MaterialManager::mMaterials[6]
private

Hydrax materials vector.

Definition at line 363 of file MaterialManager.h.

◆ mOptions

Options Hydrax::MaterialManager::mOptions
private

Actual material options.

Definition at line 375 of file MaterialManager.h.

◆ mUnderwaterCompositorListener

UnderwaterCompositorListener Hydrax::MaterialManager::mUnderwaterCompositorListener
private

Underwater compositor listener.

Definition at line 377 of file MaterialManager.h.

The documentation for this class was generated from the following files:
Generated on Sun Oct 18 2026 08:40:12 for Rigs of Rods by doxygen 1.9.8