TuttleOFX
1
|
#include <OfxhImageEffectPlugin.hpp>
Public Types | |
typedef OfxhImageEffectPlugin | This |
typedef boost::ptr_map < std::string, OfxhImageEffectNodeDescriptor > | ContextMap |
typedef std::set< std::string > | ContextSet |
Public Member Functions | |
OfxhImageEffectPlugin (OfxhImageEffectPluginCache &pc, OfxhPluginBinary &pb, int pi, OfxPlugin &pl) | |
OfxhImageEffectPlugin (OfxhImageEffectPluginCache &pc, OfxhPluginBinary &pb, int pi, const std::string &api, int apiVersion, const std::string &pluginId, const std::string &rawId, int pluginMajorVersion, int pluginMinorVersion) | |
~OfxhImageEffectPlugin () | |
bool | operator== (const OfxhImageEffectPlugin &other) const |
bool | operator!= (const OfxhImageEffectPlugin &other) const |
void | setApiHandler (OfxhImageEffectPluginCache &api) |
void | setApiHandler (APICache::OfxhPluginAPICacheI &api) |
APICache::OfxhPluginAPICacheI & | getApiHandler () |
const APICache::OfxhPluginAPICacheI & | getApiHandler () const |
OfxhImageEffectNodeDescriptor & | getDescriptor () |
get the base image effect descriptor | |
const OfxhImageEffectNodeDescriptor & | getDescriptor () const |
get the base image effect descriptor, const version | |
OfxhImageEffectNodeDescriptor & | getDescriptorInContext (const std::string &context) |
get the image effect descriptor for the context | |
void | addContext (const std::string &context) |
void | addContext (const std::string &context, OfxhImageEffectNodeDescriptor *ied) |
void | initContexts () |
const ContextSet & | getContexts () const |
bool | supportsContext (const std::string &context) const |
OfxhPluginHandle * | getPluginHandle () |
const OfxhPluginHandle * | getPluginHandle () const |
void | loadAndDescribeActions () |
void | unloadAction () |
imageEffect::OfxhImageEffectNode * | createInstance (const std::string &context) |
this is called to make an instance of the effect the client data ptr is what is passed back to the client creation function | |
Private Member Functions | |
OfxhImageEffectPlugin () | |
OfxhImageEffectNodeDescriptor & | describeInContextAction (const std::string &context) |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
Private Attributes | |
OfxhImageEffectPluginCache * | _pc |
ContextMap | _contexts |
map to store contexts in | |
ContextSet | _knownContexts |
boost::scoped_ptr < OfxhPluginHandle > | _pluginHandle |
boost::scoped_ptr < OfxhImageEffectNodeDescriptor > | _baseDescriptor |
NEEDS TO BE MADE WITH A FACTORY FUNCTION ON THE HOST!!!!!! | |
Friends | |
class | boost::serialization::access |
subclass of Plugin representing an ImageEffect plugin. used to store API-specific data
Definition at line 66 of file OfxhImageEffectPlugin.hpp.
typedef boost::ptr_map<std::string, OfxhImageEffectNodeDescriptor> tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::ContextMap |
Definition at line 70 of file OfxhImageEffectPlugin.hpp.
typedef std::set<std::string> tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::ContextSet |
Definition at line 71 of file OfxhImageEffectPlugin.hpp.
Reimplemented from tuttle::host::ofx::OfxhPlugin.
Definition at line 69 of file OfxhImageEffectPlugin.hpp.
tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::OfxhImageEffectPlugin | ( | ) | [private] |
Definition at line 64 of file OfxhImageEffectPlugin.cpp.
tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::OfxhImageEffectPlugin | ( | OfxhImageEffectPluginCache & | pc, |
OfxhPluginBinary & | pb, | ||
int | pi, | ||
OfxPlugin & | pl | ||
) |
Definition at line 73 of file OfxhImageEffectPlugin.cpp.
tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::OfxhImageEffectPlugin | ( | OfxhImageEffectPluginCache & | pc, |
OfxhPluginBinary & | pb, | ||
int | pi, | ||
const std::string & | api, | ||
int | apiVersion, | ||
const std::string & | pluginId, | ||
const std::string & | rawId, | ||
int | pluginMajorVersion, | ||
int | pluginMinorVersion | ||
) |
Definition at line 82 of file OfxhImageEffectPlugin.cpp.
tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::~OfxhImageEffectPlugin | ( | ) |
Definition at line 103 of file OfxhImageEffectPlugin.cpp.
References tuttle::host::ofx::OfxhPluginHandle::getOfxPlugin(), getPluginHandle(), kOfxActionUnload, and OfxPlugin::mainEntry.
void tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::addContext | ( | const std::string & | context | ) |
Definition at line 154 of file OfxhImageEffectPlugin.cpp.
References _knownContexts.
Referenced by initContexts(), and tuttle::host::ofx::imageEffect::OfxhImageEffectPluginCache::loadFromPlugin().
void tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::addContext | ( | const std::string & | context, |
OfxhImageEffectNodeDescriptor * | ied | ||
) |
Definition at line 146 of file OfxhImageEffectPlugin.cpp.
References _contexts, and _knownContexts.
imageEffect::OfxhImageEffectNode * tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::createInstance | ( | const std::string & | context | ) |
this is called to make an instance of the effect the client data ptr is what is passed back to the client creation function
Definition at line 278 of file OfxhImageEffectPlugin.cpp.
References tuttle::host::core(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::createInstanceAction(), getDescriptorInContext(), tuttle::host::Core::getHost(), getPluginHandle(), loadAndDescribeActions(), and tuttle::host::Host::newInstance().
Referenced by tuttle::host::createNode().
OfxhImageEffectNodeDescriptor & tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::describeInContextAction | ( | const std::string & | context | ) | [private] |
Definition at line 253 of file OfxhImageEffectPlugin.cpp.
References _contexts, tuttle::host::core(), tuttle::host::ofx::property::ePropTypeString, getDescriptor(), tuttle::host::ofx::property::OfxhSet::getHandle(), tuttle::host::ofx::OfxhPluginHandle::getOfxPlugin(), getPluginHandle(), kOfxImageEffectActionDescribeInContext, kOfxImageEffectPropContext, kOfxStatFailed, kOfxStatOK, kOfxStatReplyDefault, and OfxPlugin::mainEntry.
Referenced by getDescriptorInContext().
APICache::OfxhPluginAPICacheI & tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::getApiHandler | ( | ) | [virtual] |
Implements tuttle::host::ofx::OfxhPlugin.
Definition at line 124 of file OfxhImageEffectPlugin.cpp.
References _pc.
Referenced by loadAndDescribeActions().
const APICache::OfxhPluginAPICacheI & tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::getApiHandler | ( | ) | const [virtual] |
Implements tuttle::host::ofx::OfxhPlugin.
Definition at line 129 of file OfxhImageEffectPlugin.cpp.
References _pc.
const std::set< std::string > & tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::getContexts | ( | ) | const |
Definition at line 160 of file OfxhImageEffectPlugin.cpp.
References _knownContexts.
Referenced by sam::samdo::Dummy::foundAssociateSpecificDummyNode().
OfxhImageEffectNodeDescriptor & tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::getDescriptor | ( | ) |
get the base image effect descriptor
get the image effect descriptor
Definition at line 135 of file OfxhImageEffectPlugin.cpp.
References _baseDescriptor.
Referenced by describeInContextAction(), tuttle::host::ofx::imageEffect::OfxhImageEffectPluginCache::getPluginByLabel(), initContexts(), loadAndDescribeActions(), and tuttle::host::ofx::imageEffect::OfxhImageEffectPluginCache::loadFromPlugin().
const OfxhImageEffectNodeDescriptor & tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::getDescriptor | ( | ) | const |
get the base image effect descriptor, const version
get the image effect descriptor const version
Definition at line 141 of file OfxhImageEffectPlugin.cpp.
References _baseDescriptor.
OfxhImageEffectNodeDescriptor & tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::getDescriptorInContext | ( | const std::string & | context | ) |
get the image effect descriptor for the context
Definition at line 233 of file OfxhImageEffectPlugin.cpp.
References _contexts, _knownContexts, and describeInContextAction().
Referenced by createInstance(), and sam::samdo::Dummy::foundAssociateSpecificDummyNode().
OfxhPluginHandle* tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::getPluginHandle | ( | ) | [inline] |
Definition at line 132 of file OfxhImageEffectPlugin.hpp.
References _pluginHandle.
Referenced by createInstance(), describeInContextAction(), loadAndDescribeActions(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::mainEntry(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::OfxhImageEffectNode(), unloadAction(), and ~OfxhImageEffectPlugin().
const OfxhPluginHandle* tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::getPluginHandle | ( | ) | const [inline] |
Definition at line 133 of file OfxhImageEffectPlugin.hpp.
References _pluginHandle.
void tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::initContexts | ( | ) |
Definition at line 180 of file OfxhImageEffectPlugin.cpp.
References addContext(), getDescriptor(), tuttle::host::ofx::property::OfxhSet::getDimension(), tuttle::host::ofx::imageEffect::OfxhImageEffectNodeBase::getProperties(), tuttle::host::ofx::property::OfxhSet::getStringProperty(), and kOfxImageEffectPropSupportedContexts.
Referenced by loadAndDescribeActions().
void tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::loadAndDescribeActions | ( | ) |
Definition at line 192 of file OfxhImageEffectPlugin.cpp.
References _pluginHandle, getApiHandler(), getDescriptor(), getPluginHandle(), initContexts(), kOfxActionDescribe, kOfxActionLoad, kOfxStatOK, kOfxStatReplyDefault, and OfxPlugin::mainEntry.
Referenced by createInstance(), tuttle::host::createNode(), and sam::samdo::Dummy::foundAssociateSpecificDummyNode().
bool tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::operator!= | ( | const OfxhImageEffectPlugin & | other | ) | const [inline] |
Definition at line 105 of file OfxhImageEffectPlugin.hpp.
References operator==().
bool tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::operator== | ( | const OfxhImageEffectPlugin & | other | ) | const |
Definition at line 111 of file OfxhImageEffectPlugin.cpp.
References _baseDescriptor.
Referenced by operator!=().
void tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::serialize | ( | Archive & | ar, |
const unsigned int | version | ||
) | [inline, private] |
Reimplemented from tuttle::host::ofx::OfxhPlugin.
Definition at line 151 of file OfxhImageEffectPlugin.hpp.
References _baseDescriptor, and _contexts.
void tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::setApiHandler | ( | OfxhImageEffectPluginCache & | api | ) | [inline] |
Definition at line 107 of file OfxhImageEffectPlugin.hpp.
References _pc.
void tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::setApiHandler | ( | APICache::OfxhPluginAPICacheI & | api | ) | [virtual] |
Implements tuttle::host::ofx::OfxhPlugin.
Definition at line 119 of file OfxhImageEffectPlugin.cpp.
References _pc.
bool tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::supportsContext | ( | const std::string & | context | ) | const |
Definition at line 165 of file OfxhImageEffectPlugin.cpp.
References _knownContexts.
Referenced by tuttle::host::createNode().
void tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::unloadAction | ( | ) |
Definition at line 296 of file OfxhImageEffectPlugin.cpp.
References getPluginHandle(), and kOfxActionUnload.
friend class boost::serialization::access [friend] |
Reimplemented from tuttle::host::ofx::OfxhPlugin.
Definition at line 149 of file OfxhImageEffectPlugin.hpp.
boost::scoped_ptr<OfxhImageEffectNodeDescriptor> tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::_baseDescriptor [private] |
NEEDS TO BE MADE WITH A FACTORY FUNCTION ON THE HOST!!!!!!
Definition at line 84 of file OfxhImageEffectPlugin.hpp.
Referenced by getDescriptor(), operator==(), and serialize().
map to store contexts in
Definition at line 77 of file OfxhImageEffectPlugin.hpp.
Referenced by addContext(), describeInContextAction(), getDescriptorInContext(), and serialize().
Definition at line 78 of file OfxhImageEffectPlugin.hpp.
Referenced by addContext(), getContexts(), getDescriptorInContext(), and supportsContext().
Definition at line 74 of file OfxhImageEffectPlugin.hpp.
Referenced by getApiHandler(), and setApiHandler().
boost::scoped_ptr<OfxhPluginHandle> tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::_pluginHandle [private] |
Definition at line 79 of file OfxhImageEffectPlugin.hpp.
Referenced by getPluginHandle(), and loadAndDescribeActions().