LensFlare Class Reference

Camera lens flare compositor. More...

#include <rendering/rendering.hh>

Public Member Functions

 LensFlare ()
 Constructor. More...
 
virtual ~LensFlare ()
 Destructor. More...
 
void SetCamera (CameraPtr _camera)
 Set the camera which lensFlare will be applied to. More...
 
void SetColor (const ignition::math::Vector3d &_color)
 Set the color of lens flare. More...
 
void SetCompositorName (const std::string &_name)
 Set the name of the lens flare compositor to use the next time SetCamera is called. More...
 
void SetScale (const double _scale)
 Set the scale of lens flare. More...
 

Protected Member Functions

void SetCameraImpl (CameraPtr _camera)
 Set camera stored in LensFlarePrivate. More...
 
void SetLensFlareCompositorListener (std::shared_ptr< LensFlareCompositorListener > _listener)
 Set lensFlareCompositorListener stored in LensFlarePrivate. More...
 
void SetLensFlareInstance (Ogre::CompositorInstance *_instance)
 Set lensFlareInstance stored in LensFlarePrivate. More...
 
void Update ()
 Update function to search light source. More...
 

Detailed Description

Camera lens flare compositor.

This lens flare effect does not perform any depth checking so if the directional light is occluded by an object in the scene, lens flare will pass through the object. The lens flare's color is set by the shaders and not exposed through an API in this class.

Constructor & Destructor Documentation

◆ LensFlare()

LensFlare ( )

Constructor.

◆ ~LensFlare()

virtual ~LensFlare ( )
virtual

Destructor.

Member Function Documentation

◆ SetCamera()

void SetCamera ( CameraPtr  _camera)

Set the camera which lensFlare will be applied to.

Parameters
[in]_cameraCamera to be distorted

◆ SetCameraImpl()

void SetCameraImpl ( CameraPtr  _camera)
protected

Set camera stored in LensFlarePrivate.

Parameters
[in]_cameraCamera to use in sensor.

◆ SetColor()

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

Set the color of lens flare.

Parameters
[in]_colorColor of lens flare

◆ SetCompositorName()

void SetCompositorName ( const std::string &  _name)

Set the name of the lens flare compositor to use the next time SetCamera is called.

Parameters
[in]_nameName of the compositor to use

◆ SetLensFlareCompositorListener()

void SetLensFlareCompositorListener ( std::shared_ptr< LensFlareCompositorListener _listener)
protected

Set lensFlareCompositorListener stored in LensFlarePrivate.

Parameters
[in]_listenerShared pointer to object to be set.

◆ SetLensFlareInstance()

void SetLensFlareInstance ( Ogre::CompositorInstance *  _instance)
protected

Set lensFlareInstance stored in LensFlarePrivate.

Parameters
[in]_instanceCompositorInstance to set

◆ SetScale()

void SetScale ( const double  _scale)

Set the scale of lens flare.

Must be greater than 0.

Parameters
[in]_scaleScale of lens flare

◆ Update()

void Update ( )
protected

Update function to search light source.


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