TuttleOFX  1
tuttle::plugin::fade::FadePlugin Class Reference

Fade plugin. More...

#include <FadePlugin.hpp>

Inheritance diagram for tuttle::plugin::fade::FadePlugin:
Collaboration diagram for tuttle::plugin::fade::FadePlugin:

Public Types

typedef float Scalar

Public Member Functions

 FadePlugin (OfxImageEffectHandle handle)
FadeProcessParams getProcessParams () const
void changedParam (const OFX::InstanceChangedArgs &args, const std::string &paramName)
 called when a param has just had its value changed
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::Clip_clipDst
 Destination image clip.
OFX::Clip_clipSrcFrom
 Source image clip.
OFX::Clip_clipSrcTo
 Source image clip.
OFX::DoubleParam_paramTransition
 Source image clip.
OFX::ChoiceParam_paramRod
OFX::RGBAParam_paramColor

Detailed Description

Fade plugin.

Definition at line 22 of file FadePlugin.hpp.


Member Typedef Documentation

Definition at line 25 of file FadePlugin.hpp.


Constructor & Destructor Documentation


Member Function Documentation

void tuttle::plugin::fade::FadePlugin::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 33 of file FadePlugin.cpp.

bool tuttle::plugin::fade::FadePlugin::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 62 of file FadePlugin.cpp.

References _clipSrcFrom, _clipSrcTo, tuttle::plugin::fade::FadeProcessParams::_transition, getProcessParams(), OFX::Clip::isConnected(), and OFX::RenderArguments::time.

Here is the call graph for this function:

void tuttle::plugin::fade::FadePlugin::render ( const OFX::RenderArguments args) [virtual]

The overridden render function.

Parameters:
[in]argsRendering parameters

Implements OFX::ImageEffect.

Definition at line 84 of file FadePlugin.cpp.


Field Documentation

Destination image clip.

Definition at line 40 of file FadePlugin.hpp.

Referenced by FadePlugin().

Source image clip.

Definition at line 41 of file FadePlugin.hpp.

Referenced by FadePlugin(), and isIdentity().

Source image clip.

Definition at line 42 of file FadePlugin.hpp.

Referenced by FadePlugin(), and isIdentity().

Source image clip.

Definition at line 44 of file FadePlugin.hpp.

Referenced by FadePlugin(), and getProcessParams().


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