TuttleOFX  1
Public Member Functions | Protected Member Functions | Private Attributes
tuttle::plugin::WriterPlugin Class Reference

#include <WriterPlugin.hpp>

Inheritance diagram for tuttle::plugin::WriterPlugin:
Inheritance graph
[legend]
Collaboration diagram for tuttle::plugin::WriterPlugin:
Collaboration graph
[legend]

Public Member Functions

 WriterPlugin (OfxImageEffectHandle handle)
virtual ~WriterPlugin ()=0
virtual void changedParam (const OFX::InstanceChangedArgs &args, const std::string &paramName)
virtual void getClipPreferences (OFX::ClipPreferencesSetter &clipPreferences)
virtual bool isIdentity (const OFX::RenderArguments &args, OFX::Clip *&identityClip, double &identityTime)
virtual void beginSequenceRender (const OFX::BeginSequenceRenderArguments &args)
virtual void render (const OFX::RenderArguments &args)
std::string getAbsoluteFilenameAt (const OfxTime time) const
std::string getAbsoluteDirectory () const
std::string getAbsoluteFirstFilename () const
OfxTime getFirstTime () const
OfxTime getLastTime () const

Data Fields

OFX::Clip * _clipSrc
 Input image clip.
OFX::Clip * _clipDst
 Ouput image clip.
OFX::PushButtonParam * _paramRenderButton
 Render push button.
OFX::StringParam * _paramFilepath
 Target file path.
OFX::BooleanParam * _paramRenderAlways
OFX::BooleanParam * _paramCopyToOutput
 Copy the image buffer to the output clip.
OFX::ChoiceParam * _paramBitDepth
OFX::BooleanParam * _paramPremult
OFX::ChoiceParam * _paramExistingFile
OFX::IntParam * _paramForceNewRender

Protected Member Functions

bool varyOnTime () const

Private Attributes

bool _isSequence
sequenceParser::Sequence _filePattern
 Filename pattern manager.
bool _oneRender
OfxTime _oneRenderAtTime

Detailed Description

Definition at line 24 of file WriterPlugin.hpp.

Constructor & Destructor Documentation

tuttle::plugin::WriterPlugin::WriterPlugin ( OfxImageEffectHandle  handle)

Definition at line 15 of file WriterPlugin.cpp.

References _clipDst, _clipSrc, _filePattern, _isSequence, _paramBitDepth, _paramCopyToOutput, _paramExistingFile, _paramFilepath, _paramForceNewRender, _paramPremult, _paramRenderAlways, _paramRenderButton, tuttle::plugin::kParamPremultiplied, tuttle::plugin::kParamWriterCopyToOutput, tuttle::plugin::kParamWriterExistingFile, tuttle::plugin::kParamWriterForceNewRender, tuttle::plugin::kParamWriterRender, tuttle::plugin::kParamWriterRenderAlways, tuttle::plugin::kTuttlePluginBitDepth, and tuttle::plugin::kTuttlePluginFilename.

tuttle::plugin::WriterPlugin::~WriterPlugin ( ) [pure virtual]

Definition at line 33 of file WriterPlugin.cpp.

Member Function Documentation

void tuttle::plugin::WriterPlugin::beginSequenceRender ( const OFX::BeginSequenceRenderArguments &  args) [virtual]

Definition at line 115 of file WriterPlugin.cpp.

References getAbsoluteDirectory().

Here is the call graph for this function:

void tuttle::plugin::WriterPlugin::changedParam ( const OFX::InstanceChangedArgs &  args,
const std::string &  paramName 
) [virtual]

Definition at line 37 of file WriterPlugin.cpp.

References _filePattern, _isSequence, _oneRender, _oneRenderAtTime, _paramFilepath, _paramForceNewRender, tuttle::plugin::kParamWriterRender, and tuttle::plugin::kTuttlePluginFilename.

std::string tuttle::plugin::WriterPlugin::getAbsoluteDirectory ( ) const [inline]

Definition at line 57 of file WriterPlugin.hpp.

References _filePattern, _isSequence, and _paramFilepath.

Referenced by beginSequenceRender().

std::string tuttle::plugin::WriterPlugin::getAbsoluteFilenameAt ( const OfxTime  time) const [inline]

Definition at line 49 of file WriterPlugin.hpp.

References _filePattern, _isSequence, and _paramFilepath.

Referenced by isIdentity(), and render().

std::string tuttle::plugin::WriterPlugin::getAbsoluteFirstFilename ( ) const [inline]

Definition at line 71 of file WriterPlugin.hpp.

References _filePattern, _isSequence, and _paramFilepath.

void tuttle::plugin::WriterPlugin::getClipPreferences ( OFX::ClipPreferencesSetter &  clipPreferences) [virtual]

Definition at line 52 of file WriterPlugin.cpp.

References varyOnTime().

Here is the call graph for this function:

OfxTime tuttle::plugin::WriterPlugin::getFirstTime ( ) const [inline]

Definition at line 79 of file WriterPlugin.hpp.

References _filePattern, and _isSequence.

OfxTime tuttle::plugin::WriterPlugin::getLastTime ( ) const [inline]

Definition at line 87 of file WriterPlugin.hpp.

References _filePattern, and _isSequence.

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

Definition at line 58 of file WriterPlugin.cpp.

References _clipSrc, _oneRender, _oneRenderAtTime, _paramExistingFile, _paramRenderAlways, tuttle::plugin::eParamWriterExistingFile_error, tuttle::plugin::eParamWriterExistingFile_overwrite, tuttle::plugin::eParamWriterExistingFile_reader, tuttle::plugin::eParamWriterExistingFile_skip, getAbsoluteFilenameAt(), and TUTTLE_TLOG_TRACE.

Here is the call graph for this function:

void tuttle::plugin::WriterPlugin::render ( const OFX::RenderArguments &  args) [virtual]

Definition at line 124 of file WriterPlugin.cpp.

References _clipDst, _clipSrc, _oneRender, _paramCopyToOutput, getAbsoluteFilenameAt(), TUTTLE_LOG_INFO, TUTTLE_TLOG, TUTTLE_TLOG_VAR, and TUTTLE_TRACE.

Here is the call graph for this function:

bool tuttle::plugin::WriterPlugin::varyOnTime ( ) const [inline, protected]

Definition at line 39 of file WriterPlugin.hpp.

References _isSequence.

Referenced by getClipPreferences().

Field Documentation

OFX::Clip* tuttle::plugin::WriterPlugin::_clipDst

Ouput image clip.

Reimplemented from tuttle::plugin::ImageEffectGilPlugin.

Definition at line 99 of file WriterPlugin.hpp.

Referenced by render(), and WriterPlugin().

OFX::Clip* tuttle::plugin::WriterPlugin::_clipSrc

Input image clip.

Attributes

Reimplemented from tuttle::plugin::ImageEffectGilPlugin.

Definition at line 98 of file WriterPlugin.hpp.

Referenced by isIdentity(), render(), and WriterPlugin().

sequenceParser::Sequence tuttle::plugin::WriterPlugin::_filePattern [private]

Filename pattern manager.

Definition at line 43 of file WriterPlugin.hpp.

Referenced by changedParam(), getAbsoluteDirectory(), getAbsoluteFilenameAt(), getAbsoluteFirstFilename(), getFirstTime(), getLastTime(), and WriterPlugin().

bool tuttle::plugin::WriterPlugin::_isSequence [private]

Definition at line 42 of file WriterPlugin.hpp.

Referenced by changedParam(), getAbsoluteDirectory(), getAbsoluteFilenameAt(), getAbsoluteFirstFilename(), getFirstTime(), getLastTime(), varyOnTime(), and WriterPlugin().

bool tuttle::plugin::WriterPlugin::_oneRender [private]

Definition at line 45 of file WriterPlugin.hpp.

Referenced by changedParam(), isIdentity(), and render().

OfxTime tuttle::plugin::WriterPlugin::_oneRenderAtTime [private]

Definition at line 46 of file WriterPlugin.hpp.

Referenced by changedParam(), and isIdentity().

OFX::ChoiceParam* tuttle::plugin::WriterPlugin::_paramBitDepth

Definition at line 105 of file WriterPlugin.hpp.

Referenced by WriterPlugin().

OFX::BooleanParam* tuttle::plugin::WriterPlugin::_paramCopyToOutput

Copy the image buffer to the output clip.

Definition at line 104 of file WriterPlugin.hpp.

Referenced by render(), and WriterPlugin().

OFX::ChoiceParam* tuttle::plugin::WriterPlugin::_paramExistingFile

Definition at line 107 of file WriterPlugin.hpp.

Referenced by isIdentity(), and WriterPlugin().

OFX::StringParam* tuttle::plugin::WriterPlugin::_paramFilepath

Target file path.

Definition at line 102 of file WriterPlugin.hpp.

Referenced by changedParam(), getAbsoluteDirectory(), getAbsoluteFilenameAt(), getAbsoluteFirstFilename(), and WriterPlugin().

OFX::IntParam* tuttle::plugin::WriterPlugin::_paramForceNewRender

Hack parameter, to force a new rendering

Definition at line 108 of file WriterPlugin.hpp.

Referenced by changedParam(), and WriterPlugin().

OFX::BooleanParam* tuttle::plugin::WriterPlugin::_paramPremult

Definition at line 106 of file WriterPlugin.hpp.

Referenced by WriterPlugin().

OFX::BooleanParam* tuttle::plugin::WriterPlugin::_paramRenderAlways

Definition at line 103 of file WriterPlugin.hpp.

Referenced by isIdentity(), and WriterPlugin().

OFX::PushButtonParam* tuttle::plugin::WriterPlugin::_paramRenderButton

Render push button.

Definition at line 101 of file WriterPlugin.hpp.

Referenced by WriterPlugin().

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