Main class of the lens distortion. More...

#include <LensDistortPlugin.hpp>

Inheritance diagram for tuttle::plugin::lens::LensDistortPlugin:

Collaboration diagram for tuttle::plugin::lens::LensDistortPlugin:

Public Types
typedef double	Scalar
typedef boost::gil::point2 < double >	Point2
Public Member Functions
	LensDistortPlugin (OfxImageEffectHandle handle)
void	render (const OFX::RenderArguments &args)
	The overridden render function.
void	changedParam (const OFX::InstanceChangedArgs &args, const std::string &paramName)
	called when a param has just had its value changed
bool	isIdentity (const OFX::RenderArguments &args, OFX::Clip *&identityClip, double &identityTime)
	client is identity function, returns the clip and time for the identity function
bool	getRegionOfDefinition (const OFX::RegionOfDefinitionArguments &args, OfxRectD &rod)
	The get RoD action.
void	getRegionsOfInterest (const OFX::RegionsOfInterestArguments &args, OFX::RegionOfInterestSetter &rois)
	the get region of interest action
LensDistortProcessParams< Scalar >	getProcessParams (const OfxRectD &inputRod, const OfxRectD &outputRod, const OfxRectD &optionalInputRod, const double pixelAspectRatio, const bool reverse=false) const
LensDistortProcessParams< Scalar >	getProcessParams (const OfxRectD &inputRod, const OfxRectD &outputRod, const double pixelAspectRatio, const bool reverse=false) const
LensDistortParams	getProcessParams () const
const EParamLensType	getLensType () const
const EParamCenterType	getCenterType () const
const EParamResizeRod	getResizeRod () const
Data Fields

OFX::Clip *	_srcRefClip

OFX::BooleanParam *	_reverse
	reverse the effect
OFX::BooleanParam *	_displaySource
	do nothing (so host displays input)
OFX::ChoiceParam *	_lensType
	choice to select lens type
OFX::DoubleParam *	_coef1
	distortion coeffiscient
OFX::DoubleParam *	_coef2
	distortion coeffiscient for fish-eye lens
OFX::DoubleParam *	_squeeze
	squeeze coefficient horizontally/vertically (not implemented yet)
OFX::Double2DParam *	_asymmetric
	lens distortion is asymmetric horizontally/vertically (not implemented yet)
OFX::Double2DParam *	_center
	center coordonnates
OFX::BooleanParam *	_centerOverlay
	lens center overlay
OFX::ChoiceParam *	_centerType
	centered the lens distortion on source RoD or image size (not implemented yet)
OFX::DoubleParam *	_postScale
	scale after applying the lens distortion
OFX::DoubleParam *	_preScale
	scale before applying the lens distortion
OFX::ChoiceParam *	_resizeRod
	Choice how to resize the RoD (default 'no' resize)
OFX::DoubleParam *	_resizeRodManualScale
	scale the output RoD
OFX::GroupParam *	_groupDisplayParams
	group of all overlay options (don't modify the output image)
OFX::BooleanParam *	_gridOverlay
	grid overlay
OFX::Double2DParam *	_gridCenter
	grid center
OFX::BooleanParam *	_gridCenterOverlay
	grid center overlay
OFX::Double2DParam *	_gridScale
	grid scale
OFX::BooleanParam *	_debugDisplayRoi
	debug display options
Static Public Attributes

static OfxRectD	_dstRoi = { 0, 0, 0, 0 }
static OfxRectD	_srcRoi = { 0, 0, 0, 0 }
static OfxRectD	_srcRealRoi = { 0, 0, 0, 0 }
Private Member Functions
void	initParamsProps ()

Detailed Description

Main class of the lens distortion.

Definition at line 28 of file LensDistortPlugin.hpp.

Member Typedef Documentation

typedef boost::gil::point2<double> tuttle::plugin::lens::LensDistortPlugin::Point2

Definition at line 32 of file LensDistortPlugin.hpp.

typedef double tuttle::plugin::lens::LensDistortPlugin::Scalar

Definition at line 31 of file LensDistortPlugin.hpp.

Constructor & Destructor Documentation

tuttle::plugin::lens::LensDistortPlugin::LensDistortPlugin ( OfxImageEffectHandle handle )

Definition at line 20 of file LensDistortPlugin.cpp.

Here is the call graph for this function:

Member Function Documentation

void tuttle::plugin::lens::LensDistortPlugin::changedParam	(	const OFX::InstanceChangedArgs &	args,
		const std::string &	paramName
	)		`[virtual]`

called when a param has just had its value changed

Reimplemented from tuttle::plugin::SamplerPlugin.

Definition at line 67 of file LensDistortPlugin.cpp.

References _asymmetric, _coef2, _lensType, _resizeRod, _resizeRodManualScale, _squeeze, tuttle::plugin::lens::eParamResizeRodManual, OFX::ChoiceParam::getValue(), tuttle::plugin::lens::kParamGridCenter(), tuttle::plugin::lens::kParamGridOverlay(), tuttle::plugin::lens::kParamGridScale(), tuttle::plugin::lens::kParamLensType(), tuttle::plugin::lens::kParamResizeRod(), OFX::ImageEffect::redrawOverlays(), and OFX::Param::setIsSecret().

Referenced by initParamsProps().

Here is the call graph for this function:

const EParamCenterType tuttle::plugin::lens::LensDistortPlugin::getCenterType ( ) const [inline]

Definition at line 97 of file LensDistortPlugin.hpp.

References _centerType, and OFX::ChoiceParam::getValue().

Referenced by getProcessParams().

Here is the call graph for this function:

const EParamLensType tuttle::plugin::lens::LensDistortPlugin::getLensType ( ) const [inline]

Definition at line 96 of file LensDistortPlugin.hpp.

References _lensType, and OFX::ChoiceParam::getValue().

Referenced by tuttle::plugin::lens::LensDistortOverlayInteract::draw(), getRegionOfDefinition(), and getRegionsOfInterest().

Here is the call graph for this function:

LensDistortProcessParams< LensDistortPlugin::Scalar > tuttle::plugin::lens::LensDistortPlugin::getProcessParams	(	const OfxRectD &	inputRod,
		const OfxRectD &	outputRod,
		const OfxRectD &	optionalInputRod,
		const double	pixelAspectRatio,
		const bool	reverse = `false`
	)		const

Todo:: pixelRatio !

Definition at line 327 of file LensDistortPlugin.cpp.

Referenced by tuttle::plugin::lens::LensDistortOverlayInteract::draw().

Here is the call graph for this function:

LensDistortProcessParams<Scalar> tuttle::plugin::lens::LensDistortPlugin::getProcessParams	(	const OfxRectD &	inputRod,
		const OfxRectD &	outputRod,
		const double	pixelAspectRatio,
		const bool	reverse = `false`
	)		const `[inline]`

Definition at line 87 of file LensDistortPlugin.hpp.

References getProcessParams().

Here is the call graph for this function:

LensDistortParams tuttle::plugin::lens::LensDistortPlugin::getProcessParams ( ) const

Definition at line 393 of file LensDistortPlugin.cpp.

References tuttle::plugin::lens::LensDistortParams::_centerType, _centerType, tuttle::plugin::lens::LensDistortParams::_lensType, _lensType, tuttle::plugin::lens::LensDistortParams::_samplerProcessParams, and tuttle::plugin::SamplerPlugin::fillProcessParams().

Referenced by getProcessParams(), getRegionOfDefinition(), and getRegionsOfInterest().

Here is the call graph for this function:

bool tuttle::plugin::lens::LensDistortPlugin::getRegionOfDefinition	(	const OFX::RegionOfDefinitionArguments &	args,
		OfxRectD &	rod
	)		`[virtual]`

The get RoD action.

If the effect wants change the rod from the default value (which is the union of RoD's of all input clips) it should set the rod argument and return true.

This is all in cannonical coordinates.

Reimplemented from OFX::ImageEffect.

Definition at line 150 of file LensDistortPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipDst, tuttle::plugin::ImageEffectGilPlugin::_clipSrc, tuttle::plugin::lens::NormalLensDistortParams< F >::_lensCenterSrc, _resizeRod, _resizeRodManualScale, _srcRefClip, tuttle::plugin::lens::eParamResizeRodManual, tuttle::plugin::lens::eParamResizeRodMax, tuttle::plugin::lens::eParamResizeRodMin, tuttle::plugin::lens::eParamResizeRodNo, tuttle::plugin::lens::eParamResizeRodSourceRef, OFX::Clip::getCanonicalRod(), getLensType(), OFX::Clip::getPixelAspectRatio(), getProcessParams(), OFX::DoubleParam::getValue(), OFX::ChoiceParam::getValue(), OFX::Clip::isConnected(), tuttle::max(), tuttle::min(), tuttle::plugin::viewer::scale, OFX::RegionOfDefinitionArguments::time, tuttle::plugin::lens::transformValues(), OfxRectD::x1, OfxRectD::x2, OfxRectD::y1, and OfxRectD::y2.

Here is the call graph for this function:

void tuttle::plugin::lens::LensDistortPlugin::getRegionsOfInterest	(	const OFX::RegionsOfInterestArguments &	args,
		OFX::RegionOfInterestSetter &	rois
	)		`[virtual]`

the get region of interest action

the get RoI action

If the effect wants change its region of interest on any input clip from the default values (which is the same as the RoI in the arguments) it should do so by calling the OFX::RegionOfInterestSetter::setRegionOfInterest function on the rois argument.

Note, everything is in cannonical coordinates.

Reimplemented from OFX::ImageEffect.

Definition at line 241 of file LensDistortPlugin.cpp.

Here is the call graph for this function:

const EParamResizeRod tuttle::plugin::lens::LensDistortPlugin::getResizeRod ( ) const [inline]

Definition at line 98 of file LensDistortPlugin.hpp.

References _resizeRod, and OFX::ChoiceParam::getValue().

Here is the call graph for this function:

void tuttle::plugin::lens::LensDistortPlugin::initParamsProps ( ) [private]

Definition at line 49 of file LensDistortPlugin.cpp.

References changedParam(), tuttle::plugin::kParamFilter, tuttle::plugin::lens::kParamLensType(), and tuttle::plugin::lens::kParamResizeRod().

Referenced by LensDistortPlugin().

Here is the call graph for this function:

bool tuttle::plugin::lens::LensDistortPlugin::isIdentity	(	const OFX::RenderArguments &	args,
		OFX::Clip *&	identityClip,
		double &	identityTime
	)		`[virtual]`

client is identity function, returns the clip and time for the identity function

If the effect would do no processing for the given param set and render arguments, then this function should return true and set the identityClip pointer to point to the clip that is the identity and identityTime to be the time at which to access the clip for the identity operation.

Reimplemented from OFX::ImageEffect.

Definition at line 124 of file LensDistortPlugin.cpp.

References _asymmetric, tuttle::plugin::ImageEffectGilPlugin::_clipSrc, _coef1, _coef2, _displaySource, _postScale, _preScale, _squeeze, OFX::DoubleParam::getDefault(), OFX::Double2DParam::getDefault(), OFX::Param::getIsEnable(), OFX::DoubleParam::getValue(), OFX::Double2DParam::getValue(), OFX::BooleanParam::getValue(), and OFX::RenderArguments::time.