OFX::ImageEffectDescriptor Class Reference

#include <ofxsImageEffect.h>

Inheritance diagram for OFX::ImageEffectDescriptor:

List of all members.

---

Detailed Description

Wraps up an effect descriptor, used in the describe actions.

Public Member Functions
	ImageEffectDescriptor (OfxImageEffectHandle handle)
	effect descriptor ctor
	~ImageEffectDescriptor ()
	dtor
const PropertySet &	getPropertySet () const
PropertySet &	getPropertySet ()
void	setLabels (const std::string &label, const std::string &shortLabel, const std::string &longLabel)
	, set the label properties in a plugin
void	setPluginGrouping (const std::string &group)
	Set the plugin grouping.
void	addSupportedContext (ContextEnum v)
	Add a context to those supported.
void	addSupportedBitDepth (BitDepthEnum v)
	Add a pixel depth to those supported.
void	setSingleInstance (bool v)
	Is the plugin single instance only ?
void	setHostFrameThreading (bool v)
	Does the plugin expect the host to perform per frame SMP threading.
void	setSupportsMultiResolution (bool v)
	Does the plugin support multi resolution images.
void	setSupportsTiles (bool v)
	Does the plugin support image tiling.
void	setTemporalClipAccess (bool v)
	Does the plugin perform temporal clip access.
void	setRenderTwiceAlways (bool v)
	Does the plugin want to have render called twice per frame in all circumanstances for fielded images ?
void	setSupportsMultipleClipDepths (bool v)
	Does the plugin support inputs and output clips of differing depths.
void	setSupportsMultipleClipPARs (bool v)
	Does the plugin support inputs and output clips of pixel aspect ratios.
void	setRenderThreadSafety (RenderSafetyEnum v)
	What kind of thread safety does the plugin have.
void	addClipPreferencesSlaveParam (ParamDescriptor &p)
	If the slave param changes the clip preferences need to be re-evaluated.
ClipDescriptor *	defineClip (const std::string &name)
	Create a clip, only callable from describe in context.
const std::map< std::string, std::string > &	getClipComponentPropNames () const
	Access to the string maps needed for runtime properties. Because the char array must persist after the call, we need these to be stored in the descriptor, which is only deleted on unload.
const std::map< std::string, std::string > &	getClipDepthPropNames () const
const std::map< std::string, std::string > &	getClipPARPropNames () const
const std::map< std::string, std::string > &	getClipROIPropNames () const
const std::map< std::string, std::string > &	getClipFrameRangePropNames () const
virtual void	setOverlayInteractDescriptor (EffectOverlayDescriptor *desc)
	override this to create an interact for the effect
Protected Member Functions
	mDeclareProtectedAssignAndCC (ImageEffectDescriptor)
	ImageEffectDescriptor (void)
Protected Attributes
OfxImageEffectHandle	_effectHandle
	The effect handle.
PropertySet	_effectProps
	properties for this clip
std::map< std::string, ClipDescriptor * >	_definedClips
	Set of all previously defined parameters, defined on demand.
std::map< std::string, std::string >	_clipComponentsPropNames
	Set of strings for clip preferences action (stored in here so the array persists and can be used in a property name).
std::map< std::string, std::string >	_clipDepthPropNames
std::map< std::string, std::string >	_clipPARPropNames
std::map< std::string, std::string >	_clipROIPropNames
std::map< std::string, std::string >	_clipFrameRangePropNames
std::auto_ptr< EffectOverlayDescriptor >	_overlayDescriptor

---

Constructor & Destructor Documentation

OFX::ImageEffectDescriptor::ImageEffectDescriptor (  void   )  [inline, protected]

OFX::ImageEffectDescriptor::ImageEffectDescriptor (  OfxImageEffectHandle  handle  )

effect descriptor ctor

OFX::ImageEffectDescriptor::~ImageEffectDescriptor (   )

dtor

---

Member Function Documentation

void OFX::ImageEffectDescriptor::addClipPreferencesSlaveParam (  ParamDescriptor &  p  )

If the slave param changes the clip preferences need to be re-evaluated.

void OFX::ImageEffectDescriptor::addSupportedBitDepth (  BitDepthEnum  v  )

Add a pixel depth to those supported.

void OFX::ImageEffectDescriptor::addSupportedContext (  ContextEnum  v  )

Add a context to those supported.

ClipDescriptor * OFX::ImageEffectDescriptor::defineClip (  const std::string &  name  )

Create a clip, only callable from describe in context. The returned clip must not be deleted by the client code. This is all managed by the ImageEffectDescriptor itself.

const std::map<std::string, std::string>& OFX::ImageEffectDescriptor::getClipComponentPropNames (   )  const [inline]

Access to the string maps needed for runtime properties. Because the char array must persist after the call, we need these to be stored in the descriptor, which is only deleted on unload.

const std::map<std::string, std::string>& OFX::ImageEffectDescriptor::getClipDepthPropNames (   )  const [inline]

const std::map<std::string, std::string>& OFX::ImageEffectDescriptor::getClipFrameRangePropNames (   )  const [inline]

const std::map<std::string, std::string>& OFX::ImageEffectDescriptor::getClipPARPropNames (   )  const [inline]

const std::map<std::string, std::string>& OFX::ImageEffectDescriptor::getClipROIPropNames (   )  const [inline]

PropertySet& OFX::ImageEffectDescriptor::getPropertySet (   )  [inline]

const PropertySet& OFX::ImageEffectDescriptor::getPropertySet (   )  const [inline]

OFX::ImageEffectDescriptor::mDeclareProtectedAssignAndCC (  ImageEffectDescriptor   )  [protected]

void OFX::ImageEffectDescriptor::setHostFrameThreading (  bool  v  )

Does the plugin expect the host to perform per frame SMP threading.

void OFX::ImageEffectDescriptor::setLabels (  const std::string &  label, const std::string &  shortLabel, const std::string &  longLabel )

, set the label properties in a plugin

void OFX::ImageEffectDescriptor::setOverlayInteractDescriptor (  EffectOverlayDescriptor *  desc  )  [virtual]

override this to create an interact for the effect

void OFX::ImageEffectDescriptor::setPluginGrouping (  const std::string &  group  )

Set the plugin grouping.

void OFX::ImageEffectDescriptor::setRenderThreadSafety (  RenderSafetyEnum  v  )

What kind of thread safety does the plugin have.

void OFX::ImageEffectDescriptor::setRenderTwiceAlways (  bool  v  )

Does the plugin want to have render called twice per frame in all circumanstances for fielded images ?

void OFX::ImageEffectDescriptor::setSingleInstance (  bool  v  )

Is the plugin single instance only ?

void OFX::ImageEffectDescriptor::setSupportsMultipleClipDepths (  bool  v  )

Does the plugin support inputs and output clips of differing depths.

void OFX::ImageEffectDescriptor::setSupportsMultipleClipPARs (  bool  v  )

Does the plugin support inputs and output clips of pixel aspect ratios.

void OFX::ImageEffectDescriptor::setSupportsMultiResolution (  bool  v  )

Does the plugin support multi resolution images.

void OFX::ImageEffectDescriptor::setSupportsTiles (  bool  v  )

Does the plugin support image tiling.

void OFX::ImageEffectDescriptor::setTemporalClipAccess (  bool  v  )

Does the plugin perform temporal clip access.

---

Member Data Documentation

std::map<std::string, std::string> OFX::ImageEffectDescriptor::_clipComponentsPropNames [protected]

Set of strings for clip preferences action (stored in here so the array persists and can be used in a property name).

std::map<std::string, std::string> OFX::ImageEffectDescriptor::_clipDepthPropNames [protected]

std::map<std::string, std::string> OFX::ImageEffectDescriptor::_clipFrameRangePropNames [protected]

std::map<std::string, std::string> OFX::ImageEffectDescriptor::_clipPARPropNames [protected]

std::map<std::string, std::string> OFX::ImageEffectDescriptor::_clipROIPropNames [protected]

std::map<std::string, ClipDescriptor *> OFX::ImageEffectDescriptor::_definedClips [protected]

Set of all previously defined parameters, defined on demand.

OfxImageEffectHandle OFX::ImageEffectDescriptor::_effectHandle [protected]

The effect handle.

PropertySet OFX::ImageEffectDescriptor::_effectProps [protected]

properties for this clip

std::auto_ptr<EffectOverlayDescriptor> OFX::ImageEffectDescriptor::_overlayDescriptor [protected]

---

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

• ofxsImageEffect.h
• ofxsImageEffect.cpp

---