TuttleOFX  1
tuttle::plugin::timeShift::TimeShiftPlugin Class Reference

TimeShift plugin. More...

#include <TimeShiftPlugin.hpp>

Inheritance diagram for tuttle::plugin::timeShift::TimeShiftPlugin:
Collaboration diagram for tuttle::plugin::timeShift::TimeShiftPlugin:

Public Types

typedef float Scalar

Public Member Functions

 TimeShiftPlugin (OfxImageEffectHandle handle)
TimeShiftProcessParams< ScalargetProcessParams () const
bool getTimeDomain (OfxRangeD &range)
 what is the time domain of this effect, valid only in the general context
void getFramesNeeded (const OFX::FramesNeededArguments &args, OFX::FramesNeededSetter &frames)
 the get frames needed 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::DoubleParam_offset
 Time offset.

Detailed Description

TimeShift plugin.

Definition at line 19 of file TimeShiftPlugin.hpp.


Member Typedef Documentation


Constructor & Destructor Documentation

tuttle::plugin::timeShift::TimeShiftPlugin::TimeShiftPlugin ( OfxImageEffectHandle  handle)

Member Function Documentation

void tuttle::plugin::timeShift::TimeShiftPlugin::getFramesNeeded ( const OFX::FramesNeededArguments args,
OFX::FramesNeededSetter frames 
) [virtual]

the get frames needed action

If the effect wants change the frames needed on an input clip from the default values (which is the same as the frame to be renderred) it should do so by calling the OFX::FramesNeededSetter::setFramesNeeded function on the frames argument.

Reimplemented from OFX::ImageEffect.

Definition at line 51 of file TimeShiftPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, tuttle::plugin::timeShift::TimeShiftProcessParams< Scalar >::_offset, getProcessParams(), OFX::FramesNeededSetter::setFramesNeeded(), OFX::FramesNeededArguments::time, TUTTLE_INFO, TUTTLE_TLOG, and TUTTLE_TLOG_VAR.

Here is the call graph for this function:

TimeShiftProcessParams< TimeShiftPlugin::Scalar > tuttle::plugin::timeShift::TimeShiftPlugin::getProcessParams ( ) const

Definition at line 25 of file TimeShiftPlugin.cpp.

References tuttle::plugin::timeShift::TimeShiftProcessParams< Scalar >::_offset, _offset, and OFX::DoubleParam::getValue().

Referenced by getFramesNeeded(), and getTimeDomain().

Here is the call graph for this function:

bool tuttle::plugin::timeShift::TimeShiftPlugin::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 32 of file TimeShiftPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, tuttle::plugin::timeShift::TimeShiftProcessParams< Scalar >::_offset, OFX::Clip::getFrameRange(), getProcessParams(), OfxRangeD::max, OfxRangeD::min, TUTTLE_INFO, TUTTLE_TLOG, TUTTLE_TLOG_VAR, and TUTTLE_TLOG_VAR2.

Here is the call graph for this function:

bool tuttle::plugin::timeShift::TimeShiftPlugin::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 64 of file TimeShiftPlugin.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, _offset, OFX::DoubleParam::getValue(), OFX::RenderArguments::time, TUTTLE_INFO, TUTTLE_TLOG, and TUTTLE_TLOG_VAR.

Here is the call graph for this function:

void tuttle::plugin::timeShift::TimeShiftPlugin::render ( const OFX::RenderArguments args) [virtual]

The overridden render function.

Parameters:
[in]argsRendering parameters

Implements OFX::ImageEffect.

Definition at line 82 of file TimeShiftPlugin.cpp.


Field Documentation


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