LensFlarePass Class Reference

A render pass that applies Lens Flare to the render target. More...

#include <LensFlarePass.hh>

Public Member Functions
	LensFlarePass ()
	Constructor.
virtual	~LensFlarePass ()
	Destructor.
virtual const math::Vector3d &	Color () const =0
	Returns the color set in SetColor()
virtual void	Init (ScenePtr _scene)=0
	Initializes the Lens Flare Pass with given scene.
virtual uint32_t	OcclusionSteps () const =0
	Returns the number of steps set in SetOcclusionSteps()
virtual double	Scale () const =0
	Returns the scale set in SetScale()
virtual void	SetColor (const math::Vector3d &_color)=0
	Set the color of lens flare.
virtual void	SetLight (LightPtr _light)=0
	Set the light that generates lens flare.
virtual void	SetOcclusionSteps (uint32_t _occlusionSteps)=0
	Set the number of steps to take in each direction when checking for occlusions.
virtual void	SetScale (double _scale)=0
	Set the scale of lens flare.
Public Member Functions inherited from RenderPass
virtual	~RenderPass ()
	Destructor.
virtual bool	IsEnabled () const =0
	Get whether or not the render pass is enabled.
virtual void	PreRender (const CameraPtr &_camera)=0
	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.
virtual void	SetEnabled (bool _enabled)=0
	Set to enable or disable the render pass.
virtual void	SetWideAngleCameraAfterStitching (bool _afterStitching)=0
	WideAngleCamera renders to 6 faces; then stitches all 6 into a final "fish-eye" lens result.
virtual bool	WideAngleCameraAfterStitching () const =0
	See SetWideAngleCameraAfterStitching()
Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.
virtual void	Destroy ()=0
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
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.

Detailed Description

A render pass that applies Lens Flare to the render target.

Constructor & Destructor Documentation

LensFlarePass()

LensFlarePass

(

)

Constructor.

~LensFlarePass()

virtual ~LensFlarePass ( )

virtual

Destructor.

Member Function Documentation

Color()

virtual const math::Vector3d & Color ( ) const

pure virtual

Returns the color set in SetColor()

Returns

Color of lens flare

Implemented in OgreLensFlarePass, and Ogre2LensFlarePass.

Init()

virtual void Init ( ScenePtr  _scene )

pure virtual

Initializes the Lens Flare Pass with given scene.

Parameters

[in]

_scene

Pointer to scene

Implemented in OgreLensFlarePass, and Ogre2LensFlarePass.

OcclusionSteps()

virtual uint32_t OcclusionSteps ( ) const

pure virtual

Returns the number of steps set in SetOcclusionSteps()

Returns

Number of occlusion steps

Implemented in OgreLensFlarePass, and Ogre2LensFlarePass.

Scale()

virtual double Scale ( ) const

pure virtual

Returns the scale set in SetScale()

Returns

Scale of lens flare

Implemented in OgreLensFlarePass, and Ogre2LensFlarePass.

SetColor()

virtual void SetColor ( const math::Vector3d &  _color )

pure virtual

Set the color of lens flare.

Parameters

[in]

_color

Color of lens flare

Implemented in OgreLensFlarePass, and Ogre2LensFlarePass.

SetLight()

virtual void SetLight ( LightPtr  _light )

pure virtual

Set the light that generates lens flare.

Parameters

[in]

_light

Pointer to light

Implemented in BaseLensFlarePass< T >, BaseLensFlarePass< Ogre2RenderPass >, and BaseLensFlarePass< OgreRenderPass >.

SetOcclusionSteps()

virtual void SetOcclusionSteps ( uint32_t  _occlusionSteps )

pure virtual

Set the number of steps to take in each direction when checking for occlusions.

Parameters

[in]

_occlusionSteps

number of steps to take in each direction when checking for occlusion. A value of 0 disables occlusion.

Implemented in OgreLensFlarePass, and Ogre2LensFlarePass.

SetScale()

virtual void SetScale ( double  _scale )

pure virtual

Set the scale of lens flare.

Parameters

[in]

_scale

Scale of lens flare

Implemented in OgreLensFlarePass, and Ogre2LensFlarePass.

---

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

• LensFlarePass.hh