TuttleOFX  1
tuttle::plugin::GeneratorPlugin Class Reference

#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 ( ) [pure virtual]

Definition at line 37 of file GeneratorPlugin.cpp.


Member Function Documentation

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:

bool tuttle::plugin::GeneratorPlugin::getRegionOfDefinition ( const OFX::RegionOfDefinitionArguments args,
OfxRectD rod 
) [virtual]
bool tuttle::plugin::GeneratorPlugin::getTimeDomain ( OfxRangeD range) [virtual]

what is the time domain of this effect, valid only in the general context

get the time domain

return true if range was set, otherwise the default (the union of the time domain of all input clips) is used

Reimplemented from OFX::ImageEffect.

Definition at line 223 of file GeneratorPlugin.cpp.

References kOfxFlagInfiniteMax, kOfxFlagInfiniteMin, OfxRangeD::max, and OfxRangeD::min.

void tuttle::plugin::GeneratorPlugin::updateVisibleTools ( ) [protected]

Definition at line 29 of file GeneratorPlugin.cpp.

References changedParam(), tuttle::plugin::kParamMode, tuttle::plugin::kParamSizeOrientation, and OFX::ImageEffect::timeLineGetTime().

Referenced by GeneratorPlugin().

Here is the call graph for this function:


Field Documentation


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