Wraps up a clip. More...

#include <ofxsImageEffect.h>

Collaboration diagram for OFX::ClipDescriptor:

Public Member Functions
const PropertySet &	getPropertySet () const
PropertySet &	getPropertySet ()
void	setLabels (const std::string &label, const std::string &shortLabel, const std::string &longLabel)
	set the label properties
void	setLabel (const std::string &label)
void	setFieldExtraction (EFieldExtraction v)
	set how fielded images are extracted from the clip defaults to eFieldExtractDoubled
void	addSupportedComponent (EPixelComponent v)
	set which components are supported, defaults to none set, this must be called at least once!
void	addSupportedComponent (const std::string &comp)
	set which components are supported. This version adds by the raw C-string label, allowing you to add custom component types
void	setTemporalClipAccess (bool v)
	say whether we are going to do random temporal access on this clip, defaults to false
void	setOptional (bool v)
	say whether if the clip is optional, defaults to false
void	setSupportsTiles (bool v)
	say whether this clip supports tiling, defaults to true
void	setIsMask (bool v)
	say whether this clip is a 'mask', so the host can know to replace with a roto or similar, defaults to false
Protected Member Functions
	mDeclareProtectedAssignAndCC (ClipDescriptor)
	ClipDescriptor (void)
	ClipDescriptor (const std::string &name, OfxPropertySetHandle props)
	hidden constructor
Protected Attributes
std::string	_clipName
	name of the clip
PropertySet	_clipProps
	properties for this clip
Friends
class	ImageEffectDescriptor

Detailed Description

Wraps up a clip.

Definition at line 324 of file ofxsImageEffect.h.

Constructor & Destructor Documentation

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

Definition at line 328 of file ofxsImageEffect.h.

OFX::ClipDescriptor::ClipDescriptor	(	const std::string &	name,
		OfxPropertySetHandle	props
	)		`[protected]`

hidden constructor

Definition at line 402 of file ofxsImageEffect.cpp.

References OFX::Validation::validateClipDescriptorProperties().

Here is the call graph for this function:

Member Function Documentation

void OFX::ClipDescriptor::addSupportedComponent ( EPixelComponent v )

set which components are supported, defaults to none set, this must be called at least once!

Definition at line 437 of file ofxsImageEffect.cpp.

References _clipProps, OFX::ePixelComponentAlpha, OFX::ePixelComponentCustom, OFX::ePixelComponentNone, OFX::ePixelComponentRGB, OFX::ePixelComponentRGBA, kOfxImageComponentAlpha, kOfxImageComponentNone, kOfxImageComponentRGB, kOfxImageComponentRGBA, kOfxImageEffectPropSupportedComponents, OFX::PropertySet::propGetDimension(), and OFX::PropertySet::propSetString().

Referenced by tuttle::plugin::describeGeneratorParamsInContext().

Here is the call graph for this function:

void OFX::ClipDescriptor::addSupportedComponent ( const std::string & comp )

set which components are supported. This version adds by the raw C-string label, allowing you to add custom component types

set which components are supported, defaults to none set, this must be called at least once!

Definition at line 461 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageEffectPropSupportedComponents, OFX::PropertySet::propGetDimension(), and OFX::PropertySet::propSetString().

Here is the call graph for this function:

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

Definition at line 344 of file ofxsImageEffect.h.

References _clipProps.

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

Definition at line 346 of file ofxsImageEffect.h.

References _clipProps.

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

void OFX::ClipDescriptor::setFieldExtraction ( EFieldExtraction v )

set how fielded images are extracted from the clip defaults to eFieldExtractDoubled

Definition at line 418 of file ofxsImageEffect.cpp.

References _clipProps, OFX::eFieldExtractBoth, OFX::eFieldExtractDoubled, OFX::eFieldExtractSingle, kOfxImageClipPropFieldExtraction, kOfxImageFieldBoth, kOfxImageFieldDoubled, kOfxImageFieldSingle, and OFX::PropertySet::propSetString().

Here is the call graph for this function:

void OFX::ClipDescriptor::setIsMask ( bool v )

say whether this clip is a 'mask', so the host can know to replace with a roto or similar, defaults to false

Definition at line 488 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageClipPropIsMask, and OFX::PropertySet::propSetInt().

Here is the call graph for this function:

void OFX::ClipDescriptor::setLabel ( const std::string & label ) [inline]

Definition at line 350 of file ofxsImageEffect.h.

References setLabels().

Here is the call graph for this function:

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

set the label properties

Definition at line 410 of file ofxsImageEffect.cpp.

References _clipProps, kOfxPropLabel, kOfxPropLongLabel, kOfxPropShortLabel, and OFX::PropertySet::propSetString().

Referenced by setLabel().

Here is the call graph for this function:

void OFX::ClipDescriptor::setOptional ( bool v )

say whether if the clip is optional, defaults to false

Definition at line 476 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageClipPropOptional, and OFX::PropertySet::propSetInt().

Referenced by tuttle::plugin::describeGeneratorParamsInContext().

Here is the call graph for this function:

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

say whether this clip supports tiling, defaults to true

Definition at line 482 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageEffectPropSupportsTiles, and OFX::PropertySet::propSetInt().

Referenced by tuttle::plugin::describeGeneratorParamsInContext().

Here is the call graph for this function:

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

say whether we are going to do random temporal access on this clip, defaults to false

Definition at line 470 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageEffectPropTemporalClipAccess, and OFX::PropertySet::propSetInt().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ImageEffectDescriptor [friend]

Definition at line 341 of file ofxsImageEffect.h.

Field Documentation

std::string OFX::ClipDescriptor::_clipName [protected]

name of the clip

Definition at line 332 of file ofxsImageEffect.h.

PropertySet OFX::ClipDescriptor::_clipProps [protected]

properties for this clip

Definition at line 335 of file ofxsImageEffect.h.

Referenced by addSupportedComponent(), getPropertySet(), setFieldExtraction(), setIsMask(), setLabels(), setOptional(), setSupportsTiles(), and setTemporalClipAccess().

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

libraries/openfxHack/Support/include/ofxsImageEffect.h
libraries/openfxHack/Support/Library/ofxsImageEffect.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation