tuttle::plugin::basicKeyer::BasicKeyerPlugin Class Reference

BasicKeyer plugin. More...

#include <BasicKeyerPlugin.hpp>

Inheritance diagram for tuttle::plugin::basicKeyer::BasicKeyerPlugin:

Collaboration diagram for tuttle::plugin::basicKeyer::BasicKeyerPlugin:

Public Types
typedef boost::gil::point2 < double >	Point2
typedef std::vector < OFX::Double2DParam * >	Double2DParamVector
typedef std::vector < OFX::RGBAParam * >	RGBAParamVector
Public Member Functions
	BasicKeyerPlugin (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
template<class View >
BasicKeyerProcessParams< View >	getProcessParams () const
Data Fields
Double2DParamVector	_paramPoints
RGBAParamVector	_paramColors
OFX::ChoiceParam *	_paramMode
OFX::IntParam *	_paramNbPoints
Private Attributes
OFX::InstanceChangedArgs	_instanceChangedArgs

---

Detailed Description

BasicKeyer plugin.

Definition at line 26 of file BasicKeyerPlugin.hpp.

---

Member Typedef Documentation

typedef std::vector<OFX::Double2DParam*> tuttle::plugin::basicKeyer::BasicKeyerPlugin::Double2DParamVector

Definition at line 42 of file BasicKeyerPlugin.hpp.

typedef boost::gil::point2<double> tuttle::plugin::basicKeyer::BasicKeyerPlugin::Point2

Definition at line 29 of file BasicKeyerPlugin.hpp.

typedef std::vector<OFX::RGBAParam*> tuttle::plugin::basicKeyer::BasicKeyerPlugin::RGBAParamVector

Definition at line 43 of file BasicKeyerPlugin.hpp.

---

Constructor & Destructor Documentation

tuttle::plugin::basicKeyer::BasicKeyerPlugin::BasicKeyerPlugin

(

OfxImageEffectHandle

handle

)

Definition at line 20 of file BasicKeyerPlugin.cpp.

References _instanceChangedArgs, _paramColors, _paramMode, _paramNbPoints, _paramPoints, changedParam(), OFX::ParamSet::fetchChoiceParam(), OFX::ParamSet::fetchDouble2DParam(), OFX::ParamSet::fetchIntParam(), OFX::ParamSet::fetchRGBAParam(), tuttle::plugin::basicKeyer::getColorParamName(), tuttle::plugin::basicKeyer::getPointParamName(), tuttle::plugin::basicKeyer::kMaxNbPoints, tuttle::plugin::basicKeyer::kParamMode, and tuttle::plugin::basicKeyer::kParamNbPoints.

Here is the call graph for this function:

---

Member Function Documentation

void tuttle::plugin::basicKeyer::BasicKeyerPlugin::changedParam	(	const OFX::InstanceChangedArgs &	args,
		const std::string &	paramName
	)		[virtual]

called when a param has just had its value changed

Reimplemented from OFX::ImageEffect.

Definition at line 145 of file BasicKeyerPlugin.cpp.

References _instanceChangedArgs, _paramColors, _paramMode, _paramNbPoints, _paramPoints, tuttle::plugin::basicKeyer::eParamModeColor, tuttle::plugin::basicKeyer::eParamModePosition, OFX::IntParam::getValue(), OFX::ChoiceParam::getValue(), tuttle::plugin::basicKeyer::kMaxNbPoints, tuttle::plugin::basicKeyer::kParamMode, and tuttle::plugin::basicKeyer::kParamNbPoints.

Referenced by BasicKeyerPlugin().

Here is the call graph for this function:

template<class View >

BasicKeyerProcessParams< View > tuttle::plugin::basicKeyer::BasicKeyerPlugin::getProcessParams

(

)

const

Definition at line 38 of file BasicKeyerPlugin.cpp.

References tuttle::plugin::basicKeyer::BasicKeyerProcessParams< View >::_colors, _paramColors, _paramNbPoints, _paramPoints, tuttle::plugin::basicKeyer::BasicKeyerProcessParams< View >::_points, OfxRGBAColourD::a, OfxRGBAColourD::b, OfxRGBAColourD::g, OFX::IntParam::getValue(), OfxRGBAColourD::r, OfxPointD::x, and OfxPointD::y.

Here is the call graph for this function:

void tuttle::plugin::basicKeyer::BasicKeyerPlugin::render

(

const OFX::RenderArguments &

args

)

[virtual]

The overridden render function.

Parameters:

[in]

args

Rendering parameters

Implements OFX::ImageEffect.

Definition at line 120 of file BasicKeyerPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipDst, OFX::ePixelComponentAlpha, OFX::ePixelComponentCustom, OFX::ePixelComponentNone, OFX::ePixelComponentRGB, OFX::ePixelComponentRGBA, OFX::Clip::getPixelComponents(), OFX::Clip::getPixelDepth(), and OFX::mapPixelComponentEnumToString().

Here is the call graph for this function:

---

Field Documentation

OFX::InstanceChangedArgs tuttle::plugin::basicKeyer::BasicKeyerPlugin::_instanceChangedArgs [private]

Definition at line 51 of file BasicKeyerPlugin.hpp.

Referenced by BasicKeyerPlugin(), and changedParam().

RGBAParamVector tuttle::plugin::basicKeyer::BasicKeyerPlugin::_paramColors

Definition at line 46 of file BasicKeyerPlugin.hpp.

Referenced by BasicKeyerPlugin(), changedParam(), and getProcessParams().

OFX::ChoiceParam* tuttle::plugin::basicKeyer::BasicKeyerPlugin::_paramMode

Definition at line 47 of file BasicKeyerPlugin.hpp.

Referenced by BasicKeyerPlugin(), and changedParam().

OFX::IntParam* tuttle::plugin::basicKeyer::BasicKeyerPlugin::_paramNbPoints

Definition at line 48 of file BasicKeyerPlugin.hpp.

Referenced by BasicKeyerPlugin(), changedParam(), and getProcessParams().

Double2DParamVector tuttle::plugin::basicKeyer::BasicKeyerPlugin::_paramPoints

Definition at line 45 of file BasicKeyerPlugin.hpp.

Referenced by BasicKeyerPlugin(), changedParam(), and getProcessParams().

---

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

• plugins/image/process/color/BasicKeyer/src/BasicKeyerPlugin.hpp
• plugins/image/process/color/BasicKeyer/src/BasicKeyerPlugin.cpp