TuttleOFX  1
tuttle::plugin::localmaxima::LocalMaximaPlugin Class Reference

LocalMaxima plugin. More...

#include <LocalMaximaPlugin.hpp>

Inheritance diagram for tuttle::plugin::localmaxima::LocalMaximaPlugin:
Collaboration diagram for tuttle::plugin::localmaxima::LocalMaximaPlugin:

Public Types

typedef float Scalar

Public Member Functions

 LocalMaximaPlugin (OfxImageEffectHandle handle)
LocalMaximaProcessParams< 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
void getClipPreferences (OFX::ClipPreferencesSetter &clipPreferences)
 get the clip preferences
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
void render (const OFX::RenderArguments &args)
 The overridden render function.

Data Fields

OFX::ChoiceParam_paramBorder
OFX::ChoiceParam_paramOutputComponent

Detailed Description

LocalMaxima plugin.

Definition at line 22 of file LocalMaximaPlugin.hpp.


Member Typedef Documentation


Constructor & Destructor Documentation

tuttle::plugin::localmaxima::LocalMaximaPlugin::LocalMaximaPlugin ( OfxImageEffectHandle  handle)

Member Function Documentation

void tuttle::plugin::localmaxima::LocalMaximaPlugin::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 28 of file LocalMaximaPlugin.cpp.

LocalMaximaProcessParams< LocalMaximaPlugin::Scalar > tuttle::plugin::localmaxima::LocalMaximaPlugin::getProcessParams ( const OfxPointD renderScale = OFX::kNoRenderScale) const

Definition at line 19 of file LocalMaximaPlugin.cpp.

References tuttle::plugin::localmaxima::LocalMaximaProcessParams< Scalar >::_border, _paramBorder, and OFX::ChoiceParam::getValue().

Referenced by getRegionOfDefinition().

Here is the call graph for this function:

bool tuttle::plugin::localmaxima::LocalMaximaPlugin::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 61 of file LocalMaximaPlugin.cpp.

References tuttle::plugin::localmaxima::LocalMaximaProcessParams< Scalar >::_border, tuttle::plugin::ImageEffectGilPlugin::_clipSrc, tuttle::plugin::localmaxima::eParamBorderPadded, 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::localmaxima::LocalMaximaPlugin::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 80 of file LocalMaximaPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, OFX::Clip::getCanonicalRod(), OFX::RegionOfInterestSetter::setRegionOfInterest(), OFX::RegionsOfInterestArguments::time, OfxRectD::x1, OfxRectD::x2, OfxRectD::y1, and OfxRectD::y2.

Here is the call graph for this function:

void tuttle::plugin::localmaxima::LocalMaximaPlugin::render ( const OFX::RenderArguments args) [virtual]

The overridden render function.

Parameters:
[in]argsRendering parameters

Implements OFX::ImageEffect.

Definition at line 96 of file LocalMaximaPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipDst, and tuttle::plugin::ImageEffectGilPlugin::_clipSrc.


Field Documentation


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