tuttle::host::Host Class Reference

#include <HostDescriptor.hpp>

Inheritance diagram for tuttle::host::Host:

Collaboration diagram for tuttle::host::Host:

Public Member Functions
	Host ()
tuttle::host::ImageEffectNode *	newInstance (tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin &plugin, tuttle::host::ofx::imageEffect::OfxhImageEffectNodeDescriptor &desc, const std::string &context) const
tuttle::host::ofx::imageEffect::OfxhImageEffectNodeDescriptor *	makeDescriptor (tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin &plugin) const
	Override this to create a descriptor, this makes the 'root' descriptor.
tuttle::host::ofx::imageEffect::OfxhImageEffectNodeDescriptor *	makeDescriptor (const tuttle::host::ofx::imageEffect::OfxhImageEffectNodeDescriptor &rootContext, tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin &plug) const
	used to construct a context description, rootContext is the main context
tuttle::host::ofx::imageEffect::OfxhImageEffectNodeDescriptor *	makeDescriptor (const std::string &bundlePath, tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin &plug) const
	used to construct populate the cache
OfxStatus	vmessage (const char *type, const char *id, const char *format, va_list args) const
	vmessage

---

Detailed Description

a host combines several things...

• a factory to create a new instance of your plugin
  • it also gets to filter some calls during in the API to check for validity and perform custom operations (eg: add extra properties).

it provides a description of the host application which is passed back to the plugin.

Todo:

how to support multiple APIs...

Definition at line 20 of file HostDescriptor.hpp.

---

Constructor & Destructor Documentation

tuttle::host::Host::Host

(

)

Todo:

tuttle set host properties correctly...

<

Todo:

tuttle: we hope to do this !

Definition at line 32 of file HostDescriptor.cpp.

References tuttle::host::ofx::OfxhHost::_properties, and kHostPropNameEnvVar.

---

Member Function Documentation

tuttle::host::ofx::imageEffect::OfxhImageEffectNodeDescriptor * tuttle::host::Host::makeDescriptor

(

tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin &

plugin

)

const [virtual]

Override this to create a descriptor, this makes the 'root' descriptor.

Implements tuttle::host::ofx::imageEffect::OfxhImageEffectHost.

Definition at line 79 of file HostDescriptor.cpp.

tuttle::host::ofx::imageEffect::OfxhImageEffectNodeDescriptor * tuttle::host::Host::makeDescriptor	(	const tuttle::host::ofx::imageEffect::OfxhImageEffectNodeDescriptor &	rootContext,
		tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin &	plug
	)		const [virtual]

used to construct a context description, rootContext is the main context

Implements tuttle::host::ofx::imageEffect::OfxhImageEffectHost.

Definition at line 87 of file HostDescriptor.cpp.

tuttle::host::ofx::imageEffect::OfxhImageEffectNodeDescriptor * tuttle::host::Host::makeDescriptor	(	const std::string &	bundlePath,
		tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin &	plug
	)		const [virtual]

used to construct populate the cache

Implements tuttle::host::ofx::imageEffect::OfxhImageEffectHost.

Definition at line 94 of file HostDescriptor.cpp.

tuttle::host::ImageEffectNode * tuttle::host::Host::newInstance	(	tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin &	plugin,
		tuttle::host::ofx::imageEffect::OfxhImageEffectNodeDescriptor &	desc,
		const std::string &	context
	)		const [virtual]

Create a new instance of an image effect plug-in.

It is called by ImageEffectPlugin::createInstance which the client code calls when it wants to make a new instance.

• clientData - the clientData passed into the ImageEffectPlugin::createInstance
• plugin - the plugin being created
• desc - the descriptor for that plugin
• context - the context to be created in

Implements tuttle::host::ofx::imageEffect::OfxhImageEffectHost.

Definition at line 71 of file HostDescriptor.cpp.

Referenced by tuttle::host::ofx::imageEffect::OfxhImageEffectPlugin::createInstance().

OfxStatus tuttle::host::Host::vmessage	(	const char *	type,
		const char *	id,
		const char *	format,
		va_list	args
	)		const [virtual]

vmessage

message

cant do this properly inour example, as we need to raise a dialogue to ask a question, so just return yes

Implements tuttle::host::ofx::OfxhHost.

Definition at line 101 of file HostDescriptor.cpp.

---

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

• TuttleOFX/libraries/tuttle/src/tuttle/host/HostDescriptor.hpp
• TuttleOFX/libraries/tuttle/src/tuttle/host/HostDescriptor.cpp