Ignition Rendering

API Reference

6.3.1
BaseDistortionPass< T > Class Template Reference

Base distortion render pass. More...

#include <BaseDistortionPass.hh>

Public Member Functions

virtual ~BaseDistortionPass ()
 Destructor. More...
 
math::Vector2d Center () const
 Get the distortion center. More...
 
double K1 () const
 Get the radial distortion coefficient k1. More...
 
double K2 () const
 Get the radial distortion coefficient k2. More...
 
double K3 () const
 Get the radial distortion coefficient k3. More...
 
double P1 () const
 Get the tangential distortion coefficient p1. More...
 
double P2 () const
 Get the tangential distortion coefficient p2. More...
 
void SetCenter (const math::Vector2d &_center)
 Set the distortion center. More...
 
void SetK1 (double _k1)
 Set the radial distortion coefficient k1. More...
 
void SetK2 (double _k2)
 Set the radial distortion coefficient k2. More...
 
void SetK3 (double _k3)
 Set the radial distortion coefficient k3. More...
 
void SetP1 (double _p1)
 Set the tangential distortion coefficient p1. More...
 
void SetP2 (double _p2)
 Set the tangential distortion coefficient p2. More...
 
- Public Member Functions inherited from DistortionPass
 DistortionPass ()
 Constructor. More...
 
virtual ~DistortionPass ()
 Destructor. More...
 
- Public Member Functions inherited from RenderPass
virtual ~RenderPass ()
 Destructor. More...
 
virtual bool IsEnabled () const =0
 Get whether or not the render pass is enabled. More...
 
virtual void SetEnabled (bool _enabled)=0
 Set to enable or disable the render pass. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
virtual void Destroy ()=0
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. 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 void PreRender ()=0
 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...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 

Public Attributes

double k1 = 0
 Radial distortion coefficient k1. More...
 
double k2 = 0
 Radial distortion coefficient k2. More...
 
double k3 = 0
 Radial distortion coefficient k3. More...
 
math::Vector2d lensCenter = {0.5, 0.5}
 Lens center used for distortion. More...
 
double p1 = 0
 Tangential distortion coefficient p1. More...
 
double p2 = 0
 Tangential distortion coefficient p2. More...
 

Protected Member Functions

 BaseDistortionPass ()
 Constructor. More...
 

Detailed Description

template<class T>
class ignition::rendering::BaseDistortionPass< T >

Base distortion render pass.

Constructor & Destructor Documentation

◆ BaseDistortionPass()

BaseDistortionPass ( )
protected

Constructor.

◆ ~BaseDistortionPass()

~BaseDistortionPass ( )
virtual

Destructor.

Member Function Documentation

◆ Center()

math::Vector2d Center ( ) const
virtual

Get the distortion center.

Returns
Distortion center.

Implements DistortionPass.

◆ K1()

double K1 ( ) const
virtual

Get the radial distortion coefficient k1.

Returns
Distortion coefficient k1.

Implements DistortionPass.

◆ K2()

double K2 ( ) const
virtual

Get the radial distortion coefficient k2.

Returns
Distortion coefficient k2.

Implements DistortionPass.

◆ K3()

double K3 ( ) const
virtual

Get the radial distortion coefficient k3.

Returns
Distortion coefficient k3.

Implements DistortionPass.

◆ P1()

double P1 ( ) const
virtual

Get the tangential distortion coefficient p1.

Returns
Distortion coefficient p1.

Implements DistortionPass.

◆ P2()

double P2 ( ) const
virtual

Get the tangential distortion coefficient p2.

Returns
Distortion coefficient p2.

Implements DistortionPass.

◆ SetCenter()

void SetCenter ( const math::Vector2d _center)
virtual

Set the distortion center.

Parameters
[in]_centerDistortion center.

Implements DistortionPass.

◆ SetK1()

void SetK1 ( double  _k1)
virtual

Set the radial distortion coefficient k1.

Parameters
[in]_k1Distortion coefficient k1.

Implements DistortionPass.

◆ SetK2()

void SetK2 ( double  _k2)
virtual

Set the radial distortion coefficient k2.

Parameters
[in]_k2Distortion coefficient k1.

Implements DistortionPass.

◆ SetK3()

void SetK3 ( double  _k3)
virtual

Set the radial distortion coefficient k3.

Parameters
[in]_k3Distortion coefficient k1.

Implements DistortionPass.

◆ SetP1()

void SetP1 ( double  _p1)
virtual

Set the tangential distortion coefficient p1.

Parameters
[in]_p1Distortion coefficient k1.

Implements DistortionPass.

◆ SetP2()

void SetP2 ( double  _p2)
virtual

Set the tangential distortion coefficient p2.

Parameters
[in]_p2Distortion coefficient k1.

Implements DistortionPass.

Member Data Documentation

◆ k1

double k1 = 0

◆ k2

double k2 = 0

◆ k3

double k3 = 0

◆ lensCenter

math::Vector2d lensCenter = {0.5, 0.5}

◆ p1

double p1 = 0

Tangential distortion coefficient p1.

Referenced by BaseDistortionPass< OgreRenderPass >::P1(), and BaseDistortionPass< OgreRenderPass >::SetP1().

◆ p2

double p2 = 0

Tangential distortion coefficient p2.

Referenced by BaseDistortionPass< OgreRenderPass >::P2(), and BaseDistortionPass< OgreRenderPass >::SetP2().


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