TuttleOFX  1
tuttle::plugin::flip::FlipPlugin Class Reference

#include <FlipPlugin.hpp>

Inheritance diagram for tuttle::plugin::flip::FlipPlugin:
Collaboration diagram for tuttle::plugin::flip::FlipPlugin:

Public Member Functions

 FlipPlugin (OfxImageEffectHandle handle)
FlipProcessParams getProcessParams (const OfxTime time, const OfxPointD &renderScale=OFX::kNoRenderScale) const
OfxRectI getFlipRegionValue () const
OfxRectI computeFlipRegion (const OfxTime time, const bool fromRatio=false) const
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.

Private Attributes

OFX::BooleanParam_paramFlip
OFX::BooleanParam_paramFlop

Detailed Description

Definition at line 23 of file FlipPlugin.hpp.


Constructor & Destructor Documentation

tuttle::plugin::flip::FlipPlugin::FlipPlugin ( OfxImageEffectHandle  handle)

Definition at line 17 of file FlipPlugin.cpp.

References _paramFlip, _paramFlop, OFX::ParamSet::fetchBooleanParam(), tuttle::plugin::flip::kParamFlip, and tuttle::plugin::flip::kParamFlop.

Here is the call graph for this function:


Member Function Documentation

OfxRectI tuttle::plugin::flip::FlipPlugin::computeFlipRegion ( const OfxTime  time,
const bool  fromRatio = false 
) const

Definition at line 24 of file FlipPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, and OFX::Clip::getPixelRod().

Here is the call graph for this function:

OfxRectI tuttle::plugin::flip::FlipPlugin::getFlipRegionValue ( ) const
FlipProcessParams tuttle::plugin::flip::FlipPlugin::getProcessParams ( const OfxTime  time,
const OfxPointD renderScale = OFX::kNoRenderScale 
) const

Definition at line 30 of file FlipPlugin.cpp.

References _paramFlip, _paramFlop, tuttle::plugin::flip::FlipProcessParams::flip, tuttle::plugin::flip::FlipProcessParams::flop, and OFX::BooleanParam::getValue().

Referenced by isIdentity().

Here is the call graph for this function:

void tuttle::plugin::flip::FlipPlugin::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 40 of file FlipPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, OFX::Clip::getCanonicalRod(), OFX::RegionOfInterestSetter::setRegionOfInterest(), and OFX::RegionsOfInterestArguments::time.

Here is the call graph for this function:

bool tuttle::plugin::flip::FlipPlugin::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 55 of file FlipPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, tuttle::plugin::flip::FlipProcessParams::flip, tuttle::plugin::flip::FlipProcessParams::flop, getProcessParams(), OFX::RenderArguments::renderScale, and OFX::RenderArguments::time.

Here is the call graph for this function:

void tuttle::plugin::flip::FlipPlugin::render ( const OFX::RenderArguments args) [virtual]

The overridden render function.

Parameters:
[in]argsRendering parameters

Implements OFX::ImageEffect.

Definition at line 70 of file FlipPlugin.cpp.


Field Documentation


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