Ignition Rendering

API Reference

5.0.0
OgreGaussianNoisePass Class Reference

Ogre implementation of the GaussianNoisePass class. More...

#include <OgreGaussianNoisePass.hh>

Public Member Functions

 OgreGaussianNoisePass ()
 Constructor. More...
 
virtual ~OgreGaussianNoisePass ()
 Destructor. More...
 
void CreateRenderPass () override
 Create the render pass using ogre compositor. More...
 
void Destroy () override
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
 
void PreRender () override
 Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...
 
- Public Member Functions inherited from BaseGaussianNoisePass< OgreRenderPass >
virtual ~BaseGaussianNoisePass ()
 Destructor. More...
 
double Bias () const
 Accessor for bias. More...
 
double Mean () const
 Accessor for mean. More...
 
void SetBiasMean (double _biasMean)
 Set the mean of the bias value. Bias is computed based on the bias mean and bias standard deviation. More...
 
void SetBiasStdDev (double _biasStdDev)
 Set the standard deviation of the bias value. Bias is computed based on the bias mean and bias standard deviation. More...
 
void SetMean (double _mean)
 Set mean. More...
 
void SetStdDev (double _stdDev)
 Set stddev. More...
 
double StdDev () const
 Accessor for stddev. More...
 
- Public Member Functions inherited from GaussianNoisePass
 GaussianNoisePass ()
 Constructor. More...
 
virtual ~GaussianNoisePass ()
 Destructor. More...
 
- Public Member Functions inherited from RenderPass
virtual ~RenderPass ()
 Destructor. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
virtual unsigned int Id () const =0
 Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual std::string Name () const =0
 Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual void PostRender ()=0
 Post process this object and any of its children after rendering. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from OgreRenderPass
virtual ~OgreRenderPass ()
 Destructor. More...
 
void Destroy () override
 
virtual void SetCamera (Ogre::Camera *_camera)
 Set the ogre camera that the render pass applies to. More...
 
- Public Member Functions inherited from BaseRenderPass< OgreObject >
virtual ~BaseRenderPass ()
 Destructor. More...
 
virtual bool IsEnabled () const override
 Get whether or not the render pass is enabled. More...
 
virtual void SetEnabled (bool _enabled) override
 Set to enable or disable the render pass. More...
 
- Public Member Functions inherited from OgreObject
virtual ~OgreObject ()
 
virtual ScenePtr Scene () const
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual unsigned int Id () const override
 
virtual std::string Name () const override
 
virtual void PostRender () override
 

Public Attributes

std::shared_ptr< GaussianNoiseCompositorListener > gaussianNoiseCompositorListener
 Gaussian noise compositor listener. More...
 
Ogre::CompositorInstance * gaussianNoiseInstance = nullptr
 Gaussian noise compositor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from BaseGaussianNoisePass< OgreRenderPass >
 BaseGaussianNoisePass ()
 Constructor. More...
 
void SampleBias ()
 
- Protected Member Functions inherited from OgreRenderPass
 OgreRenderPass ()
 Constructor. More...
 
- Protected Member Functions inherited from BaseRenderPass< OgreObject >
 BaseRenderPass ()
 Constructor. More...
 
- Protected Member Functions inherited from OgreObject
 OgreObject ()
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Init ()
 
virtual void Load ()
 
- Protected Attributes inherited from BaseGaussianNoisePass< OgreRenderPass >
double bias
 Gaussian noise bias. More...
 
double biasMean
 The mean of the Gaussian distribution from which bias values are drawn. More...
 
double biasStdDev
 The standard deviation of the Gaussian distribution from which bias values are drawn. More...
 
double mean
 Gaussian noise mean. More...
 
double stdDev
 Standard deviation of Gaussian noise. More...
 
- Protected Attributes inherited from OgreRenderPass
Ogre::Camera * ogreCamera = nullptr
 Pointer to the ogre camera. More...
 
- Protected Attributes inherited from BaseRenderPass< OgreObject >
bool enabled
 Flag to indicate if render pass is enabled or not. More...
 
- Protected Attributes inherited from OgreObject
OgreScenePtr scene
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Detailed Description

Ogre implementation of the GaussianNoisePass class.

Constructor & Destructor Documentation

◆ OgreGaussianNoisePass()

Constructor.

◆ ~OgreGaussianNoisePass()

virtual ~OgreGaussianNoisePass ( )
virtual

Destructor.

Member Function Documentation

◆ CreateRenderPass()

void CreateRenderPass ( )
overridevirtual

Create the render pass using ogre compositor.

Reimplemented from OgreRenderPass.

◆ Destroy()

void Destroy ( )
overridevirtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Implements Object.

◆ PreRender()

void PreRender ( )
overridevirtual

Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender.

Implements Object.

Member Data Documentation

◆ gaussianNoiseCompositorListener

std::shared_ptr<GaussianNoiseCompositorListener> gaussianNoiseCompositorListener

Gaussian noise compositor listener.

◆ gaussianNoiseInstance

Ogre::CompositorInstance* gaussianNoiseInstance = nullptr

Gaussian noise compositor.


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