#include <GeneratorPlugin.hpp>

Inheritance diagram for tuttle::plugin::GeneratorPlugin:

Collaboration diagram for tuttle::plugin::GeneratorPlugin:

Public Member Functions
	GeneratorPlugin (OfxImageEffectHandle handle)
virtual	~GeneratorPlugin ()=0
virtual void	changedParam (const OFX::InstanceChangedArgs &args, const std::string &paramName)
	called when a param has just had its value changed
virtual bool	getRegionOfDefinition (const OFX::RegionOfDefinitionArguments &args, OfxRectD &rod)
	The get RoD action.
virtual void	getClipPreferences (OFX::ClipPreferencesSetter &clipPreferences)
	get the clip preferences
virtual bool	getTimeDomain (OfxRangeD &range)
	what is the time domain of this effect, valid only in the general context
virtual void	render (const OFX::RenderArguments &args)
	client render function, this is one of the few that must be overridden
EParamGeneratorExplicitConversion	getExplicitConversion () const
OFX::EBitDepth	getOfxExplicitConversion () const
Data Fields
OFX::Clip *	_clipSrc
	Input image clip.
OFX::Clip *	_clipDst
user parameters
OFX::ChoiceParam *	_paramExplicitConv
	Explicit conversion.
OFX::ChoiceParam *	_paramComponents
OFX::ChoiceParam *	_paramMode
OFX::ChoiceParam *	_paramFormat
OFX::Int2DParam *	_paramSize
OFX::IntParam *	_paramSizeWidth
OFX::IntParam *	_paramSizeHeight
OFX::BooleanParam *	_paramSizeSpecificRatio
OFX::DoubleParam *	_paramSizeRatioValue
OFX::ChoiceParam *	_paramSizeOrientation
Protected Member Functions
void	updateVisibleTools ()

Detailed Description

Definition at line 12 of file GeneratorPlugin.hpp.

Constructor & Destructor Documentation

tuttle::plugin::GeneratorPlugin::GeneratorPlugin ( OfxImageEffectHandle handle )

Definition at line 9 of file GeneratorPlugin.cpp.

Here is the call graph for this function:

tuttle::plugin::GeneratorPlugin::~GeneratorPlugin ( ) [pure virtual]

Definition at line 37 of file GeneratorPlugin.cpp.

Member Function Documentation

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

called when a param has just had its value changed

Reimplemented from OFX::ImageEffect.

Reimplemented in tuttle::plugin::colorGradient::ColorGradientPlugin, and tuttle::plugin::seExpr::SeExprPlugin.

Definition at line 40 of file GeneratorPlugin.cpp.

References _paramFormat, _paramMode, _paramSize, _paramSizeHeight, _paramSizeOrientation, _paramSizeRatioValue, _paramSizeSpecificRatio, _paramSizeWidth, OFX::eChangeUserEdit, tuttle::plugin::eParamModeFormat, tuttle::plugin::eParamModeSize, tuttle::plugin::eParamSizeOrientationX, tuttle::plugin::eParamSizeOrientationY, tuttle::plugin::getFormatResolution(), OFX::IntParam::getValue(), OFX::Int2DParam::getValue(), OFX::ChoiceParam::getValue(), OFX::BooleanParam::getValue(), height, tuttle::plugin::kParamFormat, tuttle::plugin::kParamMode, tuttle::plugin::kParamSize, tuttle::plugin::kParamSizeHeight, tuttle::plugin::kParamSizeOrientation, tuttle::plugin::kParamSizeSpecificRatio, tuttle::plugin::kParamSizeWidth, OFX::InstanceChangedArgs::reason, OFX::ChoiceParam::setValue(), width, OfxPointI::x, and OfxPointI::y.

Referenced by updateVisibleTools().

Here is the call graph for this function:

void tuttle::plugin::GeneratorPlugin::getClipPreferences ( OFX::ClipPreferencesSetter & clipPreferences ) [virtual]

get the clip preferences

Reimplemented from OFX::ImageEffect.

Reimplemented in tuttle::plugin::text::TextPlugin, tuttle::plugin::colorGradient::ColorGradientPlugin, tuttle::plugin::seExpr::SeExprPlugin, tuttle::plugin::colorCube::ColorCubePlugin, tuttle::plugin::colorWheel::ColorWheelPlugin, tuttle::plugin::colorBars::ColorBarsPlugin, tuttle::plugin::ramp::RampPlugin, tuttle::plugin::checkerboard::CheckerboardPlugin, and tuttle::plugin::constant::ConstantPlugin.

Definition at line 134 of file GeneratorPlugin.cpp.

References _clipDst, _clipSrc, _paramComponents, OFX::eBitDepthCustom, OFX::eBitDepthFloat, OFX::eBitDepthNone, OFX::eBitDepthUByte, OFX::eBitDepthUShort, tuttle::plugin::eParamGeneratorComponentsAlpha, tuttle::plugin::eParamGeneratorComponentsRGB, tuttle::plugin::eParamGeneratorComponentsRGBA, tuttle::plugin::eParamGeneratorExplicitConversionAuto, tuttle::plugin::eParamGeneratorExplicitConversionByte, tuttle::plugin::eParamGeneratorExplicitConversionFloat, tuttle::plugin::eParamGeneratorExplicitConversionShort, OFX::ePixelComponentAlpha, OFX::ePixelComponentRGB, OFX::ePixelComponentRGBA, getExplicitConversion(), OFX::Clip::getPixelAspectRatio(), OFX::Clip::getPixelComponents(), OFX::Clip::getPixelDepth(), OFX::ChoiceParam::getValue(), OFX::Clip::isConnected(), OFX::ClipPreferencesSetter::setClipBitDepth(), OFX::ClipPreferencesSetter::setClipComponents(), OFX::ClipPreferencesSetter::setOutputFrameVarying(), and OFX::ClipPreferencesSetter::setPixelAspectRatio().

Here is the call graph for this function:

EParamGeneratorExplicitConversion tuttle::plugin::GeneratorPlugin::getExplicitConversion ( ) const [inline]

Definition at line 28 of file GeneratorPlugin.hpp.

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

Referenced by getClipPreferences(), and getOfxExplicitConversion().

Here is the call graph for this function:

OFX::EBitDepth tuttle::plugin::GeneratorPlugin::getOfxExplicitConversion ( ) const [inline]

Definition at line 33 of file GeneratorPlugin.hpp.

References OFX::eBitDepthFloat, OFX::eBitDepthNone, OFX::eBitDepthUByte, OFX::eBitDepthUShort, tuttle::plugin::eParamGeneratorExplicitConversionAuto, tuttle::plugin::eParamGeneratorExplicitConversionByte, tuttle::plugin::eParamGeneratorExplicitConversionFloat, tuttle::plugin::eParamGeneratorExplicitConversionShort, and getExplicitConversion().

Here is the call graph for this function:

bool tuttle::plugin::GeneratorPlugin::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 230 of file GeneratorPlugin.cpp.

References _clipSrc, _paramFormat, _paramMode, _paramSize, _paramSizeHeight, _paramSizeOrientation, _paramSizeRatioValue, _paramSizeSpecificRatio, _paramSizeWidth, tuttle::plugin::eParamModeFormat, tuttle::plugin::eParamModeSize, tuttle::plugin::eParamSizeOrientationX, OFX::Clip::getCanonicalRod(), tuttle::plugin::getFormatResolution(), OFX::IntParam::getValue(), OFX::Int2DParam::getValue(), OFX::DoubleParam::getValue(), OFX::ChoiceParam::getValue(), OFX::BooleanParam::getValue(), height, OFX::Clip::isConnected(), OFX::RegionOfDefinitionArguments::time, width, OfxPointI::x, OfxRectD::x1, OfxRectD::x2, OfxPointI::y, OfxRectD::y1, and OfxRectD::y2.