tuttle::plugin::idKeyer::IdKeyerPlugin Class Reference

IdKeyer plugin. More...

#include <IdKeyerPlugin.hpp>

Inheritance diagram for tuttle::plugin::idKeyer::IdKeyerPlugin:

Collaboration diagram for tuttle::plugin::idKeyer::IdKeyerPlugin:

Public Types
typedef std::vector < OFX::RGBAParam * >	RGBAParamVector
Public Member Functions
	IdKeyerPlugin (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 >
IdKeyerProcessParams< View >	getProcessParams () const
Data Fields
RGBAParamVector	_paramColors
OFX::IntParam *	_paramNbPoints
OFX::BooleanParam *	_paramUseAlpha
OFX::DoubleParam *	_paramTolerance
Private Attributes
OFX::InstanceChangedArgs	_instanceChangedArgs

---

Detailed Description

IdKeyer plugin.

Definition at line 24 of file IdKeyerPlugin.hpp.

---

Member Typedef Documentation

typedef std::vector<OFX::RGBAParam*> tuttle::plugin::idKeyer::IdKeyerPlugin::RGBAParamVector

Definition at line 37 of file IdKeyerPlugin.hpp.

---

Constructor & Destructor Documentation

tuttle::plugin::idKeyer::IdKeyerPlugin::IdKeyerPlugin

(

OfxImageEffectHandle

handle

)

Definition at line 19 of file IdKeyerPlugin.cpp.

References _instanceChangedArgs, _paramColors, _paramNbPoints, _paramTolerance, _paramUseAlpha, changedParam(), OFX::ParamSet::fetchBooleanParam(), OFX::ParamSet::fetchDoubleParam(), OFX::ParamSet::fetchIntParam(), OFX::ParamSet::fetchRGBAParam(), tuttle::plugin::idKeyer::getColorParamName(), tuttle::plugin::idKeyer::kMaxNbPoints, tuttle::plugin::idKeyer::kParamNbPoints, tuttle::plugin::idKeyer::kParamTolerance, and tuttle::plugin::idKeyer::kParamUseAlpha.

Here is the call graph for this function:

---

Member Function Documentation

void tuttle::plugin::idKeyer::IdKeyerPlugin::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 86 of file IdKeyerPlugin.cpp.

References _paramColors, _paramNbPoints, OFX::IntParam::getValue(), tuttle::plugin::idKeyer::kMaxNbPoints, and tuttle::plugin::idKeyer::kParamNbPoints.

Referenced by IdKeyerPlugin().

Here is the call graph for this function:

template<class View >

IdKeyerProcessParams< View > tuttle::plugin::idKeyer::IdKeyerPlugin::getProcessParams

(

)

const

Definition at line 36 of file IdKeyerPlugin.cpp.

References tuttle::plugin::idKeyer::IdKeyerProcessParams< View >::_colors, _paramColors, _paramNbPoints, _paramTolerance, _paramUseAlpha, tuttle::plugin::idKeyer::IdKeyerProcessParams< View >::_tolerance, tuttle::plugin::idKeyer::IdKeyerProcessParams< View >::_useAlpha, OfxRGBAColourD::a, OfxRGBAColourD::b, OfxRGBAColourD::g, OFX::IntParam::getValue(), OFX::DoubleParam::getValue(), OFX::BooleanParam::getValue(), and OfxRGBAColourD::r.

Here is the call graph for this function:

void tuttle::plugin::idKeyer::IdKeyerPlugin::render

(

const OFX::RenderArguments &

args

)

[virtual]

The overridden render function.

Parameters:

[in]

args

Rendering parameters

Implements OFX::ImageEffect.

Definition at line 61 of file IdKeyerPlugin.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::idKeyer::IdKeyerPlugin::_instanceChangedArgs [private]

Definition at line 45 of file IdKeyerPlugin.hpp.

Referenced by IdKeyerPlugin().

RGBAParamVector tuttle::plugin::idKeyer::IdKeyerPlugin::_paramColors

Definition at line 39 of file IdKeyerPlugin.hpp.

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

OFX::IntParam* tuttle::plugin::idKeyer::IdKeyerPlugin::_paramNbPoints

Definition at line 40 of file IdKeyerPlugin.hpp.

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

OFX::DoubleParam* tuttle::plugin::idKeyer::IdKeyerPlugin::_paramTolerance

Definition at line 42 of file IdKeyerPlugin.hpp.

Referenced by getProcessParams(), and IdKeyerPlugin().

OFX::BooleanParam* tuttle::plugin::idKeyer::IdKeyerPlugin::_paramUseAlpha

Definition at line 41 of file IdKeyerPlugin.hpp.

Referenced by getProcessParams(), and IdKeyerPlugin().

---

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

• plugins/image/process/color/IdKeyer/src/IdKeyerPlugin.hpp
• plugins/image/process/color/IdKeyer/src/IdKeyerPlugin.cpp