tuttle::plugin::text::TextPlugin Class Reference

Text plugin. More...

#include <TextPlugin.hpp>

Inheritance diagram for tuttle::plugin::text::TextPlugin:

Collaboration diagram for tuttle::plugin::text::TextPlugin:

Public Member Functions
	TextPlugin (OfxImageEffectHandle handle)
TextProcessParams	getProcessParams (const OfxPointD &renderScale=OFX::kNoRenderScale) const
void	getClipPreferences (OFX::ClipPreferencesSetter &clipPreferences)
	get the clip preferences
void	render (const OFX::RenderArguments &args)
	The overridden render function.
Data Fields
OFX::StringParam *	_paramText
	the text to rasterize in the image
OFX::BooleanParam *	_paramIsExpression
OFX::StringParam *	_paramFontPath
OFX::ChoiceParam *	_paramFont
OFX::IntParam *	_paramSize
OFX::DoubleParam *	_paramRatio
OFX::RGBAParam *	_paramColor
OFX::RGBAParam *	_paramBackgroundColor
OFX::Double2DParam *	_paramPosition
OFX::DoubleParam *	_paramLetterSpacing
OFX::ChoiceParam *	_paramVAlign
OFX::ChoiceParam *	_paramHAlign
OFX::BooleanParam *	_paramVerticalFlip
OFX::BooleanParam *	_paramItalic
OFX::BooleanParam *	_paramBold
OFX::ChoiceParam *	_paramMerge
Private Member Functions
template<class View >
void	render (const OFX::RenderArguments &args)
	client render function, this is one of the few that must be overridden
template<class View , template< typename > class Functor>
void	render (const OFX::RenderArguments &args)
	client render function, this is one of the few that must be overridden
template<class View , template< typename > class Functor>
void	render_if (const OFX::RenderArguments &args, boost::mpl::false_)
template<class View , template< typename > class Functor>
void	render_if (const OFX::RenderArguments &args, boost::mpl::true_)

---

Detailed Description

Text plugin.

Definition at line 37 of file TextPlugin.hpp.

---

Constructor & Destructor Documentation

tuttle::plugin::text::TextPlugin::TextPlugin

(

OfxImageEffectHandle

handle

)

Definition at line 19 of file TextPlugin.cpp.

References _paramBackgroundColor, _paramBold, _paramColor, _paramFont, _paramFontPath, _paramHAlign, _paramIsExpression, _paramItalic, _paramLetterSpacing, _paramMerge, _paramPosition, _paramRatio, _paramSize, _paramText, _paramVAlign, _paramVerticalFlip, OFX::ParamSet::fetchBooleanParam(), OFX::ParamSet::fetchChoiceParam(), OFX::ParamSet::fetchDouble2DParam(), OFX::ParamSet::fetchDoubleParam(), OFX::ParamSet::fetchIntParam(), OFX::ParamSet::fetchRGBAParam(), OFX::ParamSet::fetchStringParam(), tuttle::plugin::text::kParamBackgroundColor, tuttle::plugin::text::kParamBold, tuttle::plugin::text::kParamColor, tuttle::plugin::text::kParamFont, tuttle::plugin::text::kParamFontPath, tuttle::plugin::text::kParamFunction, tuttle::plugin::text::kParamHAlign, tuttle::plugin::text::kParamIsExpression, tuttle::plugin::text::kParamItalic, tuttle::plugin::text::kParamLetterSpacing, tuttle::plugin::text::kParamPosition, tuttle::plugin::text::kParamRatio, tuttle::plugin::text::kParamSize, tuttle::plugin::text::kParamText, tuttle::plugin::text::kParamVAlign, and tuttle::plugin::text::kParamVerticalFlip.

Here is the call graph for this function:

---

Member Function Documentation

void tuttle::plugin::text::TextPlugin::getClipPreferences

(

OFX::ClipPreferencesSetter &

clipPreferences

)

[virtual]

get the clip preferences

Reimplemented from tuttle::plugin::GeneratorPlugin.

Definition at line 68 of file TextPlugin.cpp.

TextProcessParams tuttle::plugin::text::TextPlugin::getProcessParams

(

const OfxPointD &

renderScale = OFX::kNoRenderScale

)

const

Definition at line 43 of file TextPlugin.cpp.

References tuttle::plugin::text::TextProcessParams::_backgroundColor, tuttle::plugin::text::TextProcessParams::_bold, tuttle::plugin::text::TextProcessParams::_font, tuttle::plugin::text::TextProcessParams::_fontColor, tuttle::plugin::text::TextProcessParams::_fontPath, tuttle::plugin::text::TextProcessParams::_fontX, tuttle::plugin::text::TextProcessParams::_fontY, tuttle::plugin::text::TextProcessParams::_hAlign, tuttle::plugin::text::TextProcessParams::_isExpression, tuttle::plugin::text::TextProcessParams::_italic, tuttle::plugin::text::TextProcessParams::_letterSpacing, _paramBackgroundColor, _paramBold, _paramColor, _paramFont, _paramFontPath, _paramHAlign, _paramIsExpression, _paramItalic, _paramLetterSpacing, _paramPosition, _paramRatio, _paramSize, _paramText, _paramVAlign, _paramVerticalFlip, tuttle::plugin::text::TextProcessParams::_position, tuttle::plugin::text::TextProcessParams::_text, tuttle::plugin::text::TextProcessParams::_vAlign, tuttle::plugin::text::TextProcessParams::_verticalFlip, OFX::IntParam::getValue(), OFX::DoubleParam::getValue(), OFX::Double2DParam::getValue(), OFX::RGBAParam::getValue(), OFX::StringParam::getValue(), OFX::ChoiceParam::getValue(), OFX::BooleanParam::getValue(), tuttle::plugin::ofxToGil(), OfxPointD::x, and OfxPointD::y.

Here is the call graph for this function:

void tuttle::plugin::text::TextPlugin::render

(

const OFX::RenderArguments &

args

)

[virtual]

The overridden render function.

Parameters:

[in]

args

Rendering parameters

Reimplemented from tuttle::plugin::GeneratorPlugin.

Definition at line 77 of file TextPlugin.cpp.

References tuttle::plugin::GeneratorPlugin::_clipDst, OFX::eBitDepthCustom, OFX::eBitDepthFloat, OFX::eBitDepthNone, OFX::eBitDepthUByte, OFX::eBitDepthUShort, OFX::ePixelComponentAlpha, OFX::ePixelComponentCustom, OFX::ePixelComponentNone, OFX::ePixelComponentRGB, OFX::ePixelComponentRGBA, OFX::Clip::getPixelComponents(), OFX::Clip::getPixelDepth(), OFX::mapBitDepthEnumToString(), and OFX::mapPixelComponentEnumToString().

Here is the call graph for this function:

template<class View >

void tuttle::plugin::text::TextPlugin::render

(

const OFX::RenderArguments &

args

)

[private, virtual]

client render function, this is one of the few that must be overridden

Reimplemented from tuttle::plugin::GeneratorPlugin.

template<class View , template< typename > class Functor>

void tuttle::plugin::text::TextPlugin::render

(

const OFX::RenderArguments &

args

)

[private, virtual]

client render function, this is one of the few that must be overridden

Reimplemented from tuttle::plugin::GeneratorPlugin.

template<class View , template< typename > class Functor>

void tuttle::plugin::text::TextPlugin::render_if	(	const OFX::RenderArguments &	args,
		boost::mpl::false_
	)		[private]

Definition at line 376 of file TextPlugin.cpp.

template<class View , template< typename > class Functor>

void tuttle::plugin::text::TextPlugin::render_if	(	const OFX::RenderArguments &	args,
		boost::mpl::true_
	)		[private]

Definition at line 368 of file TextPlugin.cpp.

References tuttle::plugin::ImageProcessor::setupAndProcess().

Here is the call graph for this function:

---

Field Documentation

OFX::RGBAParam* tuttle::plugin::text::TextPlugin::_paramBackgroundColor

Definition at line 70 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::BooleanParam* tuttle::plugin::text::TextPlugin::_paramBold

Definition at line 77 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::RGBAParam* tuttle::plugin::text::TextPlugin::_paramColor

Definition at line 69 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::ChoiceParam* tuttle::plugin::text::TextPlugin::_paramFont

Definition at line 65 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::StringParam* tuttle::plugin::text::TextPlugin::_paramFontPath

Definition at line 63 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::ChoiceParam* tuttle::plugin::text::TextPlugin::_paramHAlign

Definition at line 74 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::BooleanParam* tuttle::plugin::text::TextPlugin::_paramIsExpression

Definition at line 61 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::BooleanParam* tuttle::plugin::text::TextPlugin::_paramItalic

Definition at line 76 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::DoubleParam* tuttle::plugin::text::TextPlugin::_paramLetterSpacing

Definition at line 72 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::ChoiceParam* tuttle::plugin::text::TextPlugin::_paramMerge

Definition at line 79 of file TextPlugin.hpp.

Referenced by TextPlugin().

OFX::Double2DParam* tuttle::plugin::text::TextPlugin::_paramPosition

Definition at line 71 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::DoubleParam* tuttle::plugin::text::TextPlugin::_paramRatio

Definition at line 68 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::IntParam* tuttle::plugin::text::TextPlugin::_paramSize

Reimplemented from tuttle::plugin::GeneratorPlugin.

Definition at line 67 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::StringParam* tuttle::plugin::text::TextPlugin::_paramText

the text to rasterize in the image

Definition at line 60 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::ChoiceParam* tuttle::plugin::text::TextPlugin::_paramVAlign

Definition at line 73 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

OFX::BooleanParam* tuttle::plugin::text::TextPlugin::_paramVerticalFlip

Definition at line 75 of file TextPlugin.hpp.

Referenced by getProcessParams(), and TextPlugin().

---

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

• plugins/image/generator/Text/src/TextPlugin.hpp
• plugins/image/generator/Text/src/TextPlugin.cpp