TuttleOFX  1
tuttle::plugin::move2D::Move2DPlugin Class Reference

Move2D plugin. More...

#include <Move2DPlugin.hpp>

Inheritance diagram for tuttle::plugin::move2D::Move2DPlugin:
Collaboration diagram for tuttle::plugin::move2D::Move2DPlugin:

Public Types

typedef float Scalar

Public Member Functions

 Move2DPlugin (OfxImageEffectHandle handle)
Move2DProcessParams< ScalargetProcessParams (const OfxPointD &renderScale=OFX::kNoRenderScale) const
void changedParam (const OFX::InstanceChangedArgs &args, const std::string &paramName)
 called when a param has just had its value changed
bool getRegionOfDefinition (const OFX::RegionOfDefinitionArguments &args, OfxRectD &rod)
 The get RoD action.
void getRegionsOfInterest (const OFX::RegionsOfInterestArguments &args, OFX::RegionOfInterestSetter &rois)
 the get region of interest action
bool isIdentity (const OFX::RenderArguments &args, OFX::Clip *&identityClip, double &identityTime)
 client is identity function, returns the clip and time for the identity function
void render (const OFX::RenderArguments &args)
 The overridden render function.

Data Fields

OFX::Double2DParam_paramTranslation

Detailed Description

Move2D plugin.

Definition at line 21 of file Move2DPlugin.hpp.


Member Typedef Documentation

Definition at line 24 of file Move2DPlugin.hpp.


Constructor & Destructor Documentation

tuttle::plugin::move2D::Move2DPlugin::Move2DPlugin ( OfxImageEffectHandle  handle)

Definition at line 13 of file Move2DPlugin.cpp.

References _paramTranslation, OFX::ParamSet::fetchDouble2DParam(), and tuttle::plugin::move2D::kParamTranslation.

Here is the call graph for this function:


Member Function Documentation

void tuttle::plugin::move2D::Move2DPlugin::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 31 of file Move2DPlugin.cpp.

Move2DProcessParams< Move2DPlugin::Scalar > tuttle::plugin::move2D::Move2DPlugin::getProcessParams ( const OfxPointD renderScale = OFX::kNoRenderScale) const
bool tuttle::plugin::move2D::Move2DPlugin::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 35 of file Move2DPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, tuttle::plugin::move2D::Move2DProcessParams< Scalar >::_translation, OFX::Clip::getCanonicalRod(), getProcessParams(), OFX::RegionOfDefinitionArguments::time, OfxRectD::x1, OfxRectD::x2, OfxRectD::y1, and OfxRectD::y2.

Here is the call graph for this function:

void tuttle::plugin::move2D::Move2DPlugin::getRegionsOfInterest ( const OFX::RegionsOfInterestArguments args,
OFX::RegionOfInterestSetter rois 
) [virtual]

the get region of interest action

the get RoI action

If the effect wants change its region of interest on any input clip from the default values (which is the same as the RoI in the arguments) it should do so by calling the OFX::RegionOfInterestSetter::setRegionOfInterest function on the rois argument.

Note, everything is in cannonical coordinates.

Reimplemented from OFX::ImageEffect.

Definition at line 54 of file Move2DPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, tuttle::plugin::move2D::Move2DProcessParams< Scalar >::_translation, getProcessParams(), OFX::RegionsOfInterestArguments::regionOfInterest, OFX::RegionOfInterestSetter::setRegionOfInterest(), OfxRectD::x1, OfxRectD::x2, OfxRectD::y1, and OfxRectD::y2.

Here is the call graph for this function:

bool tuttle::plugin::move2D::Move2DPlugin::isIdentity ( const OFX::RenderArguments args,
OFX::Clip *&  identityClip,
double &  identityTime 
) [virtual]

client is identity function, returns the clip and time for the identity function

If the effect would do no processing for the given param set and render arguments, then this function should return true and set the identityClip pointer to point to the clip that is the identity and identityTime to be the time at which to access the clip for the identity operation.

Reimplemented from OFX::ImageEffect.

Definition at line 73 of file Move2DPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, tuttle::plugin::move2D::Move2DProcessParams< Scalar >::_translation, getProcessParams(), and OFX::RenderArguments::time.

Here is the call graph for this function:

void tuttle::plugin::move2D::Move2DPlugin::render ( const OFX::RenderArguments args) [virtual]

The overridden render function.

Parameters:
[in]argsRendering parameters

Implements OFX::ImageEffect.

Definition at line 91 of file Move2DPlugin.cpp.


Field Documentation


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