DistortionPass Class Reference

A render pass that applies distortion to the render target. More...

#include <DistortionPass.hh>

Public Member Functions
	DistortionPass ()
	Constructor.
virtual	~DistortionPass ()
	Destructor.
virtual math::Vector2d	Center () const =0
	Get the distortion center.
virtual double	K1 () const =0
	Get the radial distortion coefficient k1.
virtual double	K2 () const =0
	Get the radial distortion coefficient k2.
virtual double	K3 () const =0
	Get the radial distortion coefficient k3.
virtual double	P1 () const =0
	Get the tangential distortion coefficient p1.
virtual double	P2 () const =0
	Get the tangential distortion coefficient p2.
virtual void	SetCenter (const math::Vector2d &_center)=0
	Set the distortion center.
virtual void	SetK1 (double _k1)=0
	Set the radial distortion coefficient k1.
virtual void	SetK2 (double _k2)=0
	Set the radial distortion coefficient k2.
virtual void	SetK3 (double _k3)=0
	Set the radial distortion coefficient k3.
virtual void	SetP1 (double _p1)=0
	Set the tangential distortion coefficient p1.
virtual void	SetP2 (double _p2)=0
	Set the tangential distortion coefficient p2.
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 distortion to the render target.

Constructor & Destructor Documentation

DistortionPass()

DistortionPass

(

)

Constructor.

~DistortionPass()

virtual ~DistortionPass ( )

virtual

Destructor.

Member Function Documentation

Center()

virtual math::Vector2d Center ( ) const

pure virtual

Get the distortion center.

Returns

Distortion center.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

K1()

virtual double K1 ( ) const

pure virtual

Get the radial distortion coefficient k1.

Returns

Distortion coefficient k1.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

K2()

virtual double K2 ( ) const

pure virtual

Get the radial distortion coefficient k2.

Returns

Distortion coefficient k2.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

K3()

virtual double K3 ( ) const

pure virtual

Get the radial distortion coefficient k3.

Returns

Distortion coefficient k3.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

P1()

virtual double P1 ( ) const

pure virtual

Get the tangential distortion coefficient p1.

Returns

Distortion coefficient p1.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

P2()

virtual double P2 ( ) const

pure virtual

Get the tangential distortion coefficient p2.

Returns

Distortion coefficient p2.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

SetCenter()

virtual void SetCenter ( const math::Vector2d &  _center )

pure virtual

Set the distortion center.

Parameters

[in]

_center

Distortion center.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

SetK1()

virtual void SetK1 ( double  _k1 )

pure virtual

Set the radial distortion coefficient k1.

Parameters

[in]

_k1

Distortion coefficient k1.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

SetK2()

virtual void SetK2 ( double  _k2 )

pure virtual

Set the radial distortion coefficient k2.

Parameters

[in]

_k2

Distortion coefficient k1.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

SetK3()

virtual void SetK3 ( double  _k3 )

pure virtual

Set the radial distortion coefficient k3.

Parameters

[in]

_k3

Distortion coefficient k1.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

SetP1()

virtual void SetP1 ( double  _p1 )

pure virtual

Set the tangential distortion coefficient p1.

Parameters

[in]

_p1

Distortion coefficient k1.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

SetP2()

virtual void SetP2 ( double  _p2 )

pure virtual

Set the tangential distortion coefficient p2.

Parameters

[in]

_p2

Distortion coefficient k1.

Implemented in BaseDistortionPass< T >, and BaseDistortionPass< OgreRenderPass >.

---

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

• DistortionPass.hh