Ogre Implementation of a Lens Flare render pass. More...

#include <OgreLensFlarePass.hh>

Public Member Functions
	OgreLensFlarePass ()
	Constructor.

	~OgreLensFlarePass () override
	Destructor.

const math::Vector3d &	Color () const override
	Returns the color set in SetColor()

void	CreateRenderPass () override
	Create the render pass using ogre compositor.

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

void	Init (ScenePtr _scene) override
	Initializes the Lens Flare Pass with given scene.

uint32_t	OcclusionSteps () const override
	Returns the number of steps set in SetOcclusionSteps()

void	PostRender () override
	Post process this object and any of its children after rendering.

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.

double	Scale () const override
	Returns the scale set in SetScale()

void	SetColor (const math::Vector3d &_color) override
	Set the color of lens flare.

void	SetOcclusionSteps (uint32_t _occlusionSteps) override
	Set the number of steps to take in each direction when checking for occlusions.

void	SetScale (double _scale) override
	Set the scale of lens flare.

Public Member Functions inherited from BaseLensFlarePass< OgreRenderPass >
virtual	~BaseLensFlarePass () override
	Destructor.

void	SetLight (LightPtr _light) override
	Set the light that generates lens flare.

Public Member Functions inherited from LensFlarePass
	LensFlarePass ()
	Constructor.

virtual	~LensFlarePass ()
	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 ScenePtr	Scene () const =0
	Get the Scene that created this object.

Public Member Functions inherited from OgreRenderPass
virtual	~OgreRenderPass ()
	Destructor.

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

virtual void	SetCamera (Ogre::Camera *_camera)
	Set the ogre camera that the render pass applies to.

virtual void	SetCameras (Ogre::Camera *_cameras[kMaxOgreRenderPassCameras])
	Set all ogre cameras that the render pass applies to at once.

Public Member Functions inherited from BaseRenderPass< OgreObject >
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 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	PreRender () override

Additional Inherited Members
Protected Member Functions inherited from BaseLensFlarePass< OgreRenderPass >
	BaseLensFlarePass ()
	Constructor.

Protected Member Functions inherited from OgreRenderPass
	OgreRenderPass ()
	Constructor.

Protected Member Functions inherited from BaseRenderPass< OgreObject >
	BaseRenderPass ()
	Constructor.

Protected Member Functions inherited from OgreObject
	OgreObject ()

Protected Member Functions inherited from BaseObject
	BaseObject ()

virtual void	Init ()

virtual void	Load ()

Protected Attributes inherited from BaseLensFlarePass< OgreRenderPass >
LightPtr	light
	Light that generates the lens flare.

Protected Attributes inherited from OgreRenderPass
Ogre::Camera *	ogreCamera [kMaxOgreRenderPassCameras] = {}
	Pointer to the ogre camera May have more than one. Must check for nullptr on all of them. Not all RenderPasses support multiple cameras.

Protected Attributes inherited from BaseRenderPass< OgreObject >
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 OgreObject
OgreScenePtr	scene

Protected Attributes inherited from BaseObject
unsigned int	id

std::string	name

Detailed Description

Ogre Implementation of a Lens Flare render pass.

Constructor & Destructor Documentation

◆ OgreLensFlarePass()

OgreLensFlarePass ( )

Constructor.

◆ ~OgreLensFlarePass()

~OgreLensFlarePass ( )

override

Destructor.

Member Function Documentation

◆ Color()

const math::Vector3d & Color ( ) const

overridevirtual

Returns the color set in SetColor()

Returns: Color of lens flare

Implements LensFlarePass.

◆ 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.

◆ Init()

void Init ( ScenePtr _scene )

overridevirtual

Initializes the Lens Flare Pass with given scene.

Parameters

[in] _scene Pointer to scene

Implements LensFlarePass.

◆ OcclusionSteps()

uint32_t OcclusionSteps ( ) const

overridevirtual

Returns the number of steps set in SetOcclusionSteps()

Returns: Number of occlusion steps

Implements LensFlarePass.

◆ PostRender()

void PostRender ( )

overridevirtual

Post process this object and any of its children after rendering.

Implements Object.

◆ PreRender()

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.

◆ Scale()

double Scale ( ) const

overridevirtual

Returns the scale set in SetScale()

Returns: Scale of lens flare

Implements LensFlarePass.

◆ SetColor()

void SetColor ( const math::Vector3d & _color )

overridevirtual

Set the color of lens flare.

Parameters

[in] _color Color of lens flare

Implements LensFlarePass.

◆ SetOcclusionSteps()

void SetOcclusionSteps ( uint32_t _occlusionSteps )

overridevirtual

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.

Implements LensFlarePass.

◆ SetScale()

void SetScale ( double _scale )

overridevirtual

Set the scale of lens flare.

Parameters

[in] _scale Scale of lens flare

Implements LensFlarePass.

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

OgreLensFlarePass.hh

Gazebo Rendering

API Reference

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OgreLensFlarePass()

◆ ~OgreLensFlarePass()

Member Function Documentation

◆ Color()

◆ CreateRenderPass()

◆ Destroy()

◆ Init()

◆ OcclusionSteps()

◆ PostRender()

◆ PreRender()

◆ Scale()

◆ SetColor()

◆ SetOcclusionSteps()

◆ SetScale()