Ogre2GaussianNoisePass Class Reference

Ogre2 Implementation of a Gaussian noise render pass. More...

#include <Ogre2GaussianNoisePass.hh>

Public Member Functions
	Ogre2GaussianNoisePass ()
	Constructor.
virtual	~Ogre2GaussianNoisePass ()
	Destructor.
void	CreateRenderPass () override
	Create the render pass using ogre compositor.
virtual void	PreRender (const CameraPtr &_camera) override
	See Object::PreRender. This function will call Object::PreRender but with the added bonus that it has access to the camera that is about to render.
Public Member Functions inherited from BaseGaussianNoisePass< Ogre2RenderPass >
virtual	~BaseGaussianNoisePass ()
	Destructor.
double	Bias () const
	Accessor for bias.
double	Mean () const
	Accessor for mean.
void	SetBiasMean (double _biasMean)
	Set the mean of the bias value. Bias is computed based on the bias mean and bias standard deviation.
void	SetBiasStdDev (double _biasStdDev)
	Set the standard deviation of the bias value. Bias is computed based on the bias mean and bias standard deviation.
void	SetMean (double _mean)
	Set mean.
void	SetStdDev (double _stdDev)
	Set stddev.
double	StdDev () const
	Accessor for stddev.
Public Member Functions inherited from GaussianNoisePass
	GaussianNoisePass ()
	Constructor.
virtual	~GaussianNoisePass ()
	Destructor.
Public Member Functions inherited from RenderPass
virtual	~RenderPass ()
	Destructor.
Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.
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.
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.
virtual void	PostRender ()=0
	Post process this object and any of its children after rendering.
virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.
Public Member Functions inherited from Ogre2RenderPass
virtual	~Ogre2RenderPass ()
	Destructor.
void	Destroy () override
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
std::string	OgreCompositorNodeDefinitionName () const
	Get the ogre compositor node definition name for this render pass.
virtual void	WorkspaceAdded (Ogre::CompositorWorkspace *_workspace)
	Notifies Ogre2RenderPass that a new workspace has been created.
virtual void	WorkspaceRemoved (Ogre::CompositorWorkspace *_workspace)
	Notifies Ogre2RenderPass that a workspace will be destroyed.
Public Member Functions inherited from BaseRenderPass< Ogre2Object >
virtual	~BaseRenderPass ()
	Destructor.
virtual bool	IsEnabled () const override
	Get whether or not the render pass is enabled.
virtual void	SetEnabled (bool _enabled) override
	Set to enable or disable the render pass.
void	SetWideAngleCameraAfterStitching (bool _afterStitching) override
	WideAngleCamera renders to 6 faces; then stitches all 6 into a final "fish-eye" lens result.
bool	WideAngleCameraAfterStitching () const override
	See SetWideAngleCameraAfterStitching()
Public Member Functions inherited from Ogre2Object
virtual	~Ogre2Object ()
	Destructor.
virtual ScenePtr	Scene () const override
Public Member Functions inherited from BaseObject
virtual	~BaseObject ()
virtual unsigned int	Id () const override
virtual std::string	Name () const override
virtual void	PostRender () override
virtual void	PreRender () override

Additional Inherited Members
Protected Member Functions inherited from BaseGaussianNoisePass< Ogre2RenderPass >
	BaseGaussianNoisePass ()
	Constructor.
void	SampleBias ()
Protected Member Functions inherited from Ogre2RenderPass
	Ogre2RenderPass ()
	Constructor.
Protected Member Functions inherited from BaseRenderPass< Ogre2Object >
	BaseRenderPass ()
	Constructor.
Protected Member Functions inherited from Ogre2Object
	Ogre2Object ()
	Constructor.
Protected Member Functions inherited from BaseObject
	BaseObject ()
virtual void	Init ()
virtual void	Load ()
Protected Attributes inherited from BaseGaussianNoisePass< Ogre2RenderPass >
double	bias
	Gaussian noise bias.
double	biasMean
	The mean of the Gaussian distribution from which bias values are drawn.
double	biasStdDev
	The standard deviation of the Gaussian distribution from which bias values are drawn.
double	mean
	Gaussian noise mean.
double	stdDev
	Standard deviation of Gaussian noise.
Protected Attributes inherited from Ogre2RenderPass
std::string	ogreCompositorNodeDefName
	Name of the ogre compositor node definition.
Protected Attributes inherited from BaseRenderPass< Ogre2Object >
bool	afterStitching
	Flag tracking the current value of SetWideAngleCameraAfterStitching()
bool	enabled
	Flag to indicate if render pass is enabled or not.
Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr	scene
	Pointer to the ogre scene.
Protected Attributes inherited from BaseObject
unsigned int	id
std::string	name

Detailed Description

Ogre2 Implementation of a Gaussian noise render pass.

Constructor & Destructor Documentation

Ogre2GaussianNoisePass()

Ogre2GaussianNoisePass

(

)

Constructor.

~Ogre2GaussianNoisePass()

virtual ~Ogre2GaussianNoisePass ( )

virtual

Destructor.

Member Function Documentation

CreateRenderPass()

void CreateRenderPass ( )

overridevirtual

Create the render pass using ogre compositor.

Reimplemented from Ogre2RenderPass.

PreRender()

virtual void PreRender ( const CameraPtr &  _camera )

overridevirtual

See Object::PreRender. This function will call Object::PreRender but with the added bonus that it has access to the camera that is about to render.

Parameters

[in]

_camera

Camera that is about to render

Implements RenderPass.

---

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

• Ogre2GaussianNoisePass.hh