OFX::Private Namespace Reference

OFX::Private namespace, for things private to the support library code here generally calls image effect class members. More...

Typedefs
typedef std::map< EContext, ImageEffectDescriptor * >	EffectContextMap
	the set of descriptors, one per context used by kOfxActionDescribeInContext, 'eContextNone' is the one used by the kOfxActionDescribe
typedef std::map< std::string, EffectContextMap >	EffectDescriptorMap
Functions
OfxStatus	mainEntryStr (const char *actionRaw, const void *handleRaw, OfxPropertySetHandle inArgsRaw, OfxPropertySetHandle outArgsRaw, const char *plugname)
	The main entry point for the plugin.
OfxStatus	interactMainEntry (const char *actionRaw, const void *handleRaw, OfxPropertySetHandle inArgsRaw, OfxPropertySetHandle outArgsRaw, InteractDescriptor &desc)
	The main entry for image effect overlays.
void	fetchHostDescription (OfxHost *host)
	Creates the global host description and sets its properties.
OFX::PropertySet	fetchEffectProps (OfxImageEffectHandle handle)
	fetch the effect property set from the ImageEffectHandle
void	loadAction (void)
	Library side load action, this fetches all the suite pointers.
void	unloadAction (const char *id)
	Library side unload action, this fetches all the suite pointers.
ImageEffect *	retrieveImageEffectPointer (OfxImageEffectHandle handle)
	fetches our pointer out of the props on the handle
void	checkMainHandles (const std::string &action, const void *handle, OfxPropertySetHandle inArgsHandle, OfxPropertySetHandle outArgsHandle, bool handleCanBeNull, bool inArgsCanBeNull, bool outArgsCanBeNull)
	Checks the handles passed into the plugin's main entry point.
void	getRenderActionArguments (RenderArguments &args, OFX::PropertySet inArgs)
	Fetches the arguments used in a render action 'inargs' property set into a POD struct.
void	renderAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side render action, fetches relevant properties and calls the client code.
void	beginSequenceRenderAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side render begin sequence render action, fetches relevant properties and calls the client code.
void	endSequenceRenderAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side render begin sequence render action, fetches relevant properties and calls the client code.
bool	isIdentityAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs, OFX::PropertySet &outArgs)
	Library side render begin sequence render action, fetches relevant properties and calls the client code.
bool	regionOfDefinitionAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs, OFX::PropertySet &outArgs)
	Library side get region of definition function.
bool	regionsOfInterestAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs, OFX::PropertySet &outArgs, const char *plugname)
	Library side get regions of interest function.
bool	framesNeededAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs, OFX::PropertySet &outArgs, const char *plugname)
	Library side frames needed action.
bool	getTimeDomainAction (OfxImageEffectHandle handle, OFX::PropertySet &outArgs)
	Library side get regions of interest function.
bool	clipPreferencesAction (OfxImageEffectHandle handle, OFX::PropertySet &outArgs, const char *plugname)
	Library side get regions of interest function.
void	beginInstanceChangedAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side begin instance changed action.
void	instanceChangedAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side instance changed action.
void	endInstanceChangedAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side end instance changed action.
void	setHost (OfxHost *host)
	The plugin function that gets passed the host structure.
OfxPlugInfo	generatePlugInfo (PluginFactory *factory)
Interact *	retrieveInteractPointer (OfxInteractHandle handle)
	fetches our pointer out of the props on the handle
OfxStatus	interactMainEntry (const std::string &action, OfxInteractHandle handle, PropertySet inArgs, PropertySet outArgs)
	The common entry point used by all interacts.
void	unloadAction (void)
	Support lib function called on an ofx unload action.
Variables
OfxPlugInfoMap	plugInfoMap
OfxPluginArray	ofxPlugs
ImageEffectHostDescription	gHostDescription
	the global host description
bool	gHostDescriptionHasInit = false
int	gLoadCount = 0
	Keeps count of how many times load/unload have been called.
bool	gHasInit = false
OfxHost *	gHost = NULL
	Pointer to the host.
OfxImageEffectSuiteV1 *	gEffectSuite = NULL
	Pointer to the effect suite.
OfxPropertySuiteV1 *	gPropSuite = NULL
	Pointer to the property suite.
OfxInteractSuiteV1 *	gInteractSuite = NULL
	Pointer to the interact suite.
OfxParameterSuiteV1 *	gParamSuite = NULL
	Pointer to the parameter suite.
OfxMemorySuiteV1 *	gMemorySuite = NULL
	Pointer to the general memory suite.
OfxMultiThreadSuiteV1 *	gThreadSuite = NULL
	Pointer to the threading suite.
OfxMessageSuiteV1 *	gMessageSuite = NULL
	Pointer to the message suite.
OfxProgressSuiteV1 *	gProgressSuite = NULL
	Pointer to the optional progress suite.
OfxTimeLineSuiteV1 *	gTimeLineSuite = NULL
	Pointer to the optional progress suite.
OfxParametricParameterSuiteV1 *	gParametricParameterSuite = NULL
	Pointer to the parametric parameter suite.
NukeOfxCameraSuiteV1 *	gCameraParameterSuite = NULL
	Pointer to the camera parameter suite (nuke ofx extension)
EffectDescriptorMap	gEffectDescriptors

---

Detailed Description

OFX::Private namespace, for things private to the support library code here generally calls image effect class members.

---

Typedef Documentation

typedef std::map<EContext, ImageEffectDescriptor*> OFX::Private::EffectContextMap

the set of descriptors, one per context used by kOfxActionDescribeInContext, 'eContextNone' is the one used by the kOfxActionDescribe

Definition at line 112 of file ofxsSupportPrivate.h.

typedef std::map<std::string, EffectContextMap> OFX::Private::EffectDescriptorMap

Definition at line 113 of file ofxsSupportPrivate.h.

---

Function Documentation

void OFX::Private::beginInstanceChangedAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet	inArgs
	)

Library side begin instance changed action.

Definition at line 2309 of file ofxsImageEffect.cpp.

References OFX::ImageEffect::beginChanged(), kOfxPropChangeReason, OFX::mapInstanceChangedReasonStringToEnum(), OFX::PropertySet::propGetString(), and retrieveImageEffectPointer().

Referenced by mainEntryStr().

Here is the call graph for this function:

void OFX::Private::beginSequenceRenderAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet	inArgs
	)

Library side render begin sequence render action, fetches relevant properties and calls the client code.

Definition at line 2017 of file ofxsImageEffect.cpp.

References OFX::ImageEffect::beginSequenceRender(), OFX::BeginSequenceRenderArguments::frameRange, OFX::BeginSequenceRenderArguments::frameStep, OFX::BeginSequenceRenderArguments::isInteractive, kOfxImageEffectPropFrameRange, kOfxImageEffectPropFrameStep, kOfxImageEffectPropRenderScale, kOfxPropIsInteractive, OfxRangeD::max, OfxRangeD::min, OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetInt(), OFX::BeginSequenceRenderArguments::renderScale, retrieveImageEffectPointer(), OfxPointD::x, and OfxPointD::y.

Referenced by tuttle::host::ImageEffectNode::beginSequenceRenderAction(), and mainEntryStr().

Here is the call graph for this function:

void OFX::Private::checkMainHandles	(	const std::string &	action,
		const void *	handle,
		OfxPropertySetHandle	inArgsHandle,
		OfxPropertySetHandle	outArgsHandle,
		bool	handleCanBeNull,
		bool	inArgsCanBeNull,
		bool	outArgsCanBeNull
	)

Checks the handles passed into the plugin's main entry point.

Definition at line 1945 of file ofxsImageEffect.cpp.

References OFX::Log::error(), kOfxStatErrBadHandle, OFX::throwSuiteStatusException(), OFX::Validation::validateActionArgumentsProperties(), and OFX::Log::warning().

Referenced by mainEntryStr().

Here is the call graph for this function:

bool OFX::Private::clipPreferencesAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet &	outArgs,
		const char *	plugname
	)

Library side get regions of interest function.

Definition at line 2290 of file ofxsImageEffect.cpp.

References gEffectDescriptors, OFX::ImageEffectDescriptor::getClipComponentPropNames(), OFX::ImageEffectDescriptor::getClipDepthPropNames(), OFX::ImageEffectDescriptor::getClipPARPropNames(), OFX::ImageEffect::getClipPreferences(), OFX::ImageEffect::getContext(), and retrieveImageEffectPointer().

Referenced by mainEntryStr().

Here is the call graph for this function:

void OFX::Private::endInstanceChangedAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet	inArgs
	)

Library side end instance changed action.

Definition at line 2356 of file ofxsImageEffect.cpp.

References OFX::ImageEffect::endChanged(), kOfxPropChangeReason, OFX::mapInstanceChangedReasonStringToEnum(), OFX::PropertySet::propGetString(), and retrieveImageEffectPointer().

Referenced by mainEntryStr().

Here is the call graph for this function:

void OFX::Private::endSequenceRenderAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet	inArgs
	)

Library side render begin sequence render action, fetches relevant properties and calls the client code.

Definition at line 2038 of file ofxsImageEffect.cpp.

References OFX::ImageEffect::endSequenceRender(), OFX::EndSequenceRenderArguments::isInteractive, kOfxImageEffectPropRenderScale, kOfxPropIsInteractive, OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetInt(), OFX::EndSequenceRenderArguments::renderScale, retrieveImageEffectPointer(), OfxPointD::x, and OfxPointD::y.

Referenced by mainEntryStr().

Here is the call graph for this function:

OFX::PropertySet OFX::Private::fetchEffectProps

(

OfxImageEffectHandle

handle

)

fetch the effect property set from the ImageEffectHandle

fetch the prop set from the effect handle

Definition at line 1810 of file ofxsImageEffect.cpp.

References gEffectSuite, OfxImageEffectSuiteV1::getPropertySet, and OFX::throwSuiteStatusException().

Referenced by OFX::ImageEffect::ImageEffect(), and mainEntryStr().

Here is the call graph for this function:

void OFX::Private::fetchHostDescription

(

OfxHost *

host

)

Creates the global host description and sets its properties.

Definition at line 1763 of file ofxsImageEffect.cpp.

References OFX::ImageEffectHostDescription::_supportedComponents, OFX::ImageEffectHostDescription::_supportedContexts, OFX::ImageEffectHostDescription::_supportedPixelDepths, OFX::Log::error(), gCameraParameterSuite, gHostDescription, gHostDescriptionHasInit, gParametricParameterSuite, OfxHost::host, OFX::ImageEffectHostDescription::hostIsBackground, OFX::ImageEffectHostDescription::hostLabel, OFX::ImageEffectHostDescription::hostName, kOfxImageEffectHostPropIsBackground, kOfxImageEffectPropSetableFielding, kOfxImageEffectPropSetableFrameRate, kOfxImageEffectPropSupportedComponents, kOfxImageEffectPropSupportedContexts, kOfxImageEffectPropSupportedPixelDepths, kOfxImageEffectPropSupportsMultipleClipDepths, kOfxImageEffectPropSupportsMultipleClipPARs, kOfxImageEffectPropSupportsMultiResolution, kOfxImageEffectPropSupportsOverlays, kOfxImageEffectPropSupportsTiles, kOfxImageEffectPropTemporalClipAccess, kOfxParamHostPropMaxPages, kOfxParamHostPropMaxParameters, kOfxParamHostPropPageRowColumnCount, kOfxParamHostPropSupportsBooleanAnimation, kOfxParamHostPropSupportsChoiceAnimation, kOfxParamHostPropSupportsCustomAnimation, kOfxParamHostPropSupportsCustomInteract, kOfxParamHostPropSupportsStringAnimation, kOfxPropLabel, kOfxPropName, OFX::mapBitDepthStringToEnum(), OFX::mapContextStringToEnum(), OFX::mapPixelComponentStringToEnum(), OFX::ImageEffectHostDescription::maxPages, OFX::ImageEffectHostDescription::maxParameters, OFX::ImageEffectHostDescription::pageColumnCount, OFX::ImageEffectHostDescription::pageRowCount, OFX::PropertySet::propGetDimension(), OFX::PropertySet::propGetInt(), OFX::PropertySet::propGetString(), OFX::ImageEffectHostDescription::supportsBooleanAnimation, OFX::ImageEffectHostDescription::supportsCameraParameter, OFX::ImageEffectHostDescription::supportsChoiceAnimation, OFX::ImageEffectHostDescription::supportsCustomAnimation, OFX::ImageEffectHostDescription::supportsCustomInteract, OFX::ImageEffectHostDescription::supportsMultipleClipDepths, OFX::ImageEffectHostDescription::supportsMultipleClipPARs, OFX::ImageEffectHostDescription::supportsMultiResolution, OFX::ImageEffectHostDescription::supportsOverlays, OFX::ImageEffectHostDescription::supportsParametricParameter, OFX::ImageEffectHostDescription::supportsSetableFielding, OFX::ImageEffectHostDescription::supportsSetableFrameRate, OFX::ImageEffectHostDescription::supportsStringAnimation, OFX::ImageEffectHostDescription::supportsTiles, and OFX::ImageEffectHostDescription::temporalClipAccess.

Referenced by loadAction().

Here is the call graph for this function:

bool OFX::Private::framesNeededAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet	inArgs,
		OFX::PropertySet &	outArgs,
		const char *	plugname
	)

Library side frames needed action.

local class to set the frames needed from a clip

<property set to set values in

<map holding a bunch of frame ranges, one for each clip

ctor

set the RoI of the clip

write frameRanges_ back to the property set

Definition at line 2178 of file ofxsImageEffect.cpp.

References gEffectDescriptors, OFX::ImageEffect::getContext(), OFX::ImageEffect::getFramesNeeded(), kOfxImageEffectOutputClipName, kOfxPropTime, OFX::Clip::name(), OFX::PropertySet::propGetDouble(), retrieveImageEffectPointer(), and OFX::FramesNeededArguments::time.

Referenced by mainEntryStr().

Here is the call graph for this function:

OfxPlugInfo OFX::Private::generatePlugInfo

(

PluginFactory *

factory

)

Definition at line 2754 of file ofxsImageEffect.cpp.

References OFX::PluginFactory::getID(), OFX::PluginFactory::getMainEntry(), OFX::PluginFactory::getMajorVersion(), OFX::PluginFactory::getMinorVersion(), kOfxImageEffectPluginApi, kOfxImageEffectPluginApiVersion, and setHost().

Referenced by init().

Here is the call graph for this function:

void OFX::Private::getRenderActionArguments	(	RenderArguments &	args,
		OFX::PropertySet	inArgs
	)

Fetches the arguments used in a render action 'inargs' property set into a POD struct.

Definition at line 1977 of file ofxsImageEffect.cpp.

References OFX::Log::error(), OFX::RenderArguments::fieldToRender, kOfxImageEffectPropFieldToRender, kOfxImageEffectPropRenderScale, kOfxImageEffectPropRenderWindow, kOfxPropTime, OFX::mapFieldStringToEnum(), OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetInt(), OFX::PropertySet::propGetString(), OFX::RenderArguments::renderScale, OFX::RenderArguments::renderWindow, OFX::RenderArguments::time, OfxPointD::x, OfxRectI::x1, OfxRectI::x2, OfxPointD::y, OfxRectI::y1, and OfxRectI::y2.

Referenced by isIdentityAction(), and renderAction().

Here is the call graph for this function:

bool OFX::Private::getTimeDomainAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet &	outArgs
	)

Library side get regions of interest function.

Definition at line 2260 of file ofxsImageEffect.cpp.

References OFX::eContextGeneral, OFX::eContextGenerator, OFX::eContextReader, OFX::Log::error(), OFX::ImageEffect::getContext(), OFX::ImageEffect::getTimeDomain(), kOfxImageEffectPropFrameRange, OfxRangeD::min, OFX::PropertySet::propGetDouble(), OFX::PropertySet::propSetDouble(), and retrieveImageEffectPointer().

Referenced by mainEntryStr().

Here is the call graph for this function:

void OFX::Private::instanceChangedAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet	inArgs
	)

Library side instance changed action.

Definition at line 2321 of file ofxsImageEffect.cpp.

References OFX::ImageEffect::changedClip(), OFX::ImageEffect::changedParam(), OFX::Log::error(), kOfxImageEffectPropRenderScale, kOfxPropChangeReason, kOfxPropName, kOfxPropTime, kOfxPropType, kOfxTypeClip, kOfxTypeParameter, OFX::mapInstanceChangedReasonStringToEnum(), OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetString(), OFX::InstanceChangedArgs::reason, OFX::InstanceChangedArgs::renderScale, retrieveImageEffectPointer(), OFX::InstanceChangedArgs::time, OfxPointD::x, and OfxPointD::y.

Referenced by mainEntryStr().

Here is the call graph for this function:

OfxStatus OFX::Private::interactMainEntry	(	const char *	actionRaw,
		const void *	handleRaw,
		OfxPropertySetHandle	inArgsRaw,
		OfxPropertySetHandle	outArgsRaw,
		InteractDescriptor &	desc
	)

The main entry for image effect overlays.

Definition at line 501 of file ofxsInteract.cpp.

References OFX::InteractDescriptor::createInstance(), OFX::InteractDescriptor::describe(), tuttle::common::Color::get(), gInteractSuite, OFX::Log::indent(), OfxInteractSuiteV1::interactGetPropertySet, kOfxActionCreateInstance, kOfxActionDescribe, kOfxStatFailed, kOfxStatOK, kOfxStatReplyDefault, OFX::Log::outdent(), OFX::Log::print(), OFX::retrieveEffectFromInteractHandle(), OFX::InteractDescriptor::setPropertySet(), OFX::Exception::Suite::status(), OFX::throwSuiteStatusException(), and boost::stack_trace::trace().

Referenced by OFX::InteractMainEntry< DESC >::overlayInteractMainEntry().

Here is the call graph for this function:

OfxStatus OFX::Private::interactMainEntry	(	const std::string &	action,
		OfxInteractHandle	handle,
		PropertySet	inArgs,
		PropertySet	outArgs
	)

The common entry point used by all interacts.

Definition at line 409 of file ofxsInteract.cpp.

References OFX::InteractI::draw(), OFX::InteractI::gainFocus(), OFX::InteractI::keyDown(), OFX::InteractI::keyRepeat(), OFX::InteractI::keyUp(), kOfxActionDestroyInstance, kOfxInteractActionDraw, kOfxInteractActionGainFocus, kOfxInteractActionKeyDown, kOfxInteractActionKeyRepeat, kOfxInteractActionKeyUp, kOfxInteractActionPenDown, kOfxInteractActionPenMotion, kOfxInteractActionPenUp, kOfxStatErrBadHandle, kOfxStatOK, kOfxStatReplyDefault, OFX::InteractI::loseFocus(), OFX::InteractI::penDown(), OFX::InteractI::penMotion(), OFX::InteractI::penUp(), retrieveInteractPointer(), and OFX::Interact::verifyMagic().

Here is the call graph for this function:

bool OFX::Private::isIdentityAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet	inArgs,
		OFX::PropertySet &	outArgs
	)

Library side render begin sequence render action, fetches relevant properties and calls the client code.

Definition at line 2054 of file ofxsImageEffect.cpp.

References getRenderActionArguments(), OFX::ImageEffect::isIdentity(), kOfxPropName, kOfxPropTime, OFX::Clip::name(), OFX::PropertySet::propSetDouble(), OFX::PropertySet::propSetString(), retrieveImageEffectPointer(), and OFX::RenderArguments::time.

Referenced by mainEntryStr().

Here is the call graph for this function:

void OFX::Private::loadAction

(

void

)

Library side load action, this fetches all the suite pointers.

Support lib function called on an ofx load action.

and set some dendent flags

Definition at line 1821 of file ofxsImageEffect.cpp.

References OFX::Log::error(), fetchHostDescription(), OFX::fetchSuite(), gCameraParameterSuite, gEffectSuite, gHost, gHostDescription, gInteractSuite, gLoadCount, gMemorySuite, gMessageSuite, gParametricParameterSuite, gParamSuite, gProgressSuite, gPropSuite, gThreadSuite, gTimeLineSuite, OFX::Validation::initialise(), kNukeOfxCameraSuite, kOfxImageEffectSuite, kOfxInteractSuite, kOfxMemorySuite, kOfxMessageSuite, kOfxMultiThreadSuite, kOfxParameterSuite, kOfxParametricParameterSuite, kOfxProgressSuite, kOfxPropertySuite, kOfxStatErrBadHandle, kOfxTimeLineSuite, OFX::ImageEffectHostDescription::supportsProgressSuite, OFX::ImageEffectHostDescription::supportsTimeLineSuite, and OFX::Validation::validateHostProperties().

Referenced by mainEntryStr().

Here is the call graph for this function:

OfxStatus OFX::Private::mainEntryStr	(	const char *	actionRaw,
		const void *	handleRaw,
		OfxPropertySetHandle	inArgsRaw,
		OfxPropertySetHandle	outArgsRaw,
		const char *	plugname
	)

The main entry point for the plugin.

Todo:

there is an assert in boost::get_error_info here. Why?

Todo:

there is an assert in boost::get_error_info here. Why?

Definition at line 2369 of file ofxsImageEffect.cpp.

References OFX::ImageEffect::beginEdit(), beginInstanceChangedAction(), beginSequenceRenderAction(), checkMainHandles(), clipPreferencesAction(), OFX::PluginFactory::createInstance(), OFX::PluginFactory::describe(), OFX::PluginFactory::describeInContext(), OFX::eContextNone, OFX::ImageEffect::endEdit(), endInstanceChangedAction(), endSequenceRenderAction(), OFX::Log::error(), fetchEffectProps(), framesNeededAction(), gEffectDescriptors, tuttle::common::Color::get(), getTimeDomainAction(), OFX::Log::indent(), instanceChangedAction(), isIdentityAction(), kOfxActionBeginInstanceChanged, kOfxActionBeginInstanceEdit, kOfxActionCreateInstance, kOfxActionDescribe, kOfxActionDestroyInstance, kOfxActionEndInstanceChanged, kOfxActionEndInstanceEdit, kOfxActionInstanceChanged, kOfxActionLoad, kOfxActionPurgeCaches, kOfxActionSyncPrivateData, kOfxActionUnload, kOfxImageEffectActionBeginSequenceRender, kOfxImageEffectActionDescribeInContext, kOfxImageEffectActionEndSequenceRender, kOfxImageEffectActionGetClipPreferences, kOfxImageEffectActionGetFramesNeeded, kOfxImageEffectActionGetRegionOfDefinition, kOfxImageEffectActionGetRegionsOfInterest, kOfxImageEffectActionGetTimeDomain, kOfxImageEffectActionIsIdentity, kOfxImageEffectActionRender, kOfxImageEffectPropContext, kOfxStatErrMemory, kOfxStatErrMissingHostFeature, kOfxStatFailed, kOfxStatOK, kOfxStatReplyDefault, OFX::PluginFactory::load(), loadAction(), OFX::mapContextStringToEnum(), OFX::Log::outdent(), plugInfoMap, OFX::Log::print(), OFX::PropertySet::propGetString(), OFX::ImageEffect::purgeCaches(), regionOfDefinitionAction(), regionsOfInterestAction(), renderAction(), retrieveImageEffectPointer(), OFX::Exception::Suite::status(), OFX::ImageEffect::syncPrivateData(), boost::stack_trace::trace(), OFX::PluginFactory::unload(), unloadAction(), OFX::Validation::validatePluginDescriptorProperties(), and OFX::Validation::validatePluginInstanceProperties().

Referenced by OFX::FactoryMainEntryHelper< FACTORY >::mainEntry().

Here is the call graph for this function:

bool OFX::Private::regionOfDefinitionAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet	inArgs,
		OFX::PropertySet &	outArgs
	)

Library side get region of definition function.

Definition at line 2077 of file ofxsImageEffect.cpp.

References OFX::ImageEffect::getRegionOfDefinition(), kOfxImageEffectPropRegionOfDefinition, kOfxImageEffectPropRenderScale, kOfxPropTime, OFX::PropertySet::propGetDouble(), OFX::PropertySet::propSetDouble(), OFX::RegionOfDefinitionArguments::renderScale, retrieveImageEffectPointer(), OFX::RegionOfDefinitionArguments::time, OfxPointD::x, OfxRectD::x1, OfxRectD::x2, OfxPointD::y, OfxRectD::y1, and OfxRectD::y2.

Referenced by mainEntryStr().

Here is the call graph for this function:

bool OFX::Private::regionsOfInterestAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet	inArgs,
		OFX::PropertySet &	outArgs,
		const char *	plugname
	)

Library side get regions of interest function.

local class to set the roi of a clip

ctor

did we set something ?

set the RoI of the clip

Definition at line 2107 of file ofxsImageEffect.cpp.

References gEffectDescriptors, OFX::ImageEffect::getContext(), OFX::ImageEffect::getRegionsOfInterest(), kOfxImageEffectPropRegionOfInterest, kOfxImageEffectPropRenderScale, kOfxPropTime, OFX::Clip::name(), OFX::PropertySet::propGetDouble(), OFX::RegionsOfInterestArguments::regionOfInterest, OFX::RegionsOfInterestArguments::renderScale, retrieveImageEffectPointer(), OFX::RegionsOfInterestArguments::time, OfxPointD::x, OfxRectD::x1, OfxRectD::x2, OfxPointD::y, OfxRectD::y1, and OfxRectD::y2.

Referenced by mainEntryStr().

Here is the call graph for this function:

void OFX::Private::renderAction	(	OfxImageEffectHandle	handle,
		OFX::PropertySet	inArgs
	)

Library side render action, fetches relevant properties and calls the client code.

Definition at line 2004 of file ofxsImageEffect.cpp.

References getRenderActionArguments(), OFX::ImageEffect::render(), and retrieveImageEffectPointer().

Referenced by mainEntryStr().

Here is the call graph for this function:

ImageEffect * OFX::Private::retrieveImageEffectPointer

(

OfxImageEffectHandle

handle

)

fetches our pointer out of the props on the handle

Definition at line 1918 of file ofxsImageEffect.cpp.

References OFX::Log::error(), gEffectSuite, OfxImageEffectSuiteV1::getPropertySet, kOfxPropInstanceData, kOfxStatErrBadHandle, OFX::PropertySet::propGetPointer(), and OFX::throwSuiteStatusException().

Referenced by beginInstanceChangedAction(), beginSequenceRenderAction(), clipPreferencesAction(), endInstanceChangedAction(), endSequenceRenderAction(), framesNeededAction(), getTimeDomainAction(), instanceChangedAction(), isIdentityAction(), mainEntryStr(), regionOfDefinitionAction(), regionsOfInterestAction(), renderAction(), and OFX::retrieveEffectFromInteractHandle().

Here is the call graph for this function:

Interact* OFX::Private::retrieveInteractPointer

(

OfxInteractHandle

handle

)

fetches our pointer out of the props on the handle

Definition at line 384 of file ofxsInteract.cpp.

References OFX::Log::error(), gInteractSuite, OfxInteractSuiteV1::interactGetPropertySet, kOfxPropInstanceData, OFX::PropertySet::propGetPointer(), and OFX::throwSuiteStatusException().

Referenced by interactMainEntry().

Here is the call graph for this function:

void OFX::Private::setHost

(

OfxHost *

host

)

The plugin function that gets passed the host structure.

Definition at line 2749 of file ofxsImageEffect.cpp.

References gHost.

Referenced by generatePlugInfo().

void OFX::Private::unloadAction

(

void

)

Support lib function called on an ofx unload action.

void OFX::Private::unloadAction

(

const char *

id

)

Library side unload action, this fetches all the suite pointers.

Definition at line 1866 of file ofxsImageEffect.cpp.

References gCameraParameterSuite, gEffectDescriptors, gEffectSuite, gHasInit, gInteractSuite, gLoadCount, gMemorySuite, gMessageSuite, gParametricParameterSuite, gParamSuite, gPropSuite, gThreadSuite, kOfxStatErrBadIndex, ofxPlugs, and plugInfoMap.

Referenced by mainEntryStr().

---

Variable Documentation

NukeOfxCameraSuiteV1 * OFX::Private::gCameraParameterSuite = NULL

Pointer to the camera parameter suite (nuke ofx extension)

Definition at line 107 of file ofxsImageEffect.cpp.

Referenced by fetchHostDescription(), OFX::ParamSet::fetchRawCameraParam(), loadAction(), and unloadAction().

EffectDescriptorMap OFX::Private::gEffectDescriptors

Definition at line 111 of file ofxsImageEffect.cpp.

Referenced by clipPreferencesAction(), framesNeededAction(), mainEntryStr(), regionsOfInterestAction(), and unloadAction().

OfxImageEffectSuiteV1 * OFX::Private::gEffectSuite = NULL

Pointer to the effect suite.

Definition at line 97 of file ofxsImageEffect.cpp.

Referenced by OFX::ImageEffect::abort(), OFX::ImageMemory::alloc(), OFX::ImageEffectDescriptor::defineClip(), OFX::ImageEffect::fetchClip(), fetchEffectProps(), OFX::Clip::fetchImage(), OFX::Clip::getCanonicalRod(), OFX::ImageEffect::ImageEffect(), OFX::ImageEffectDescriptor::ImageEffectDescriptor(), loadAction(), OFX::ImageMemory::lock(), retrieveImageEffectPointer(), unloadAction(), OFX::ImageMemory::unlock(), OFX::Image::~Image(), and OFX::ImageMemory::~ImageMemory().

bool OFX::Private::gHasInit = false

Definition at line 93 of file ofxsImageEffect.cpp.

Referenced by init(), and unloadAction().

OfxHost * OFX::Private::gHost = NULL

Pointer to the host.

Definition at line 96 of file ofxsImageEffect.cpp.

Referenced by OFX::fetchSuite(), loadAction(), and setHost().

ImageEffectHostDescription OFX::Private::gHostDescription

the global host description

Definition at line 87 of file ofxsImageEffect.cpp.

Referenced by OFX::ImageEffectDescriptor::addSupportedExtension(), OFX::ImageEffectDescriptor::addSupportedExtensions(), fetchHostDescription(), OFX::getImageEffectHostDescription(), loadAction(), and OFX::ImageEffectDescriptor::setOverlayInteractDescriptor().

bool OFX::Private::gHostDescriptionHasInit = false

Definition at line 88 of file ofxsImageEffect.cpp.

Referenced by fetchHostDescription(), and OFX::getImageEffectHostDescription().

OfxInteractSuiteV1 * OFX::Private::gInteractSuite = NULL

Pointer to the interact suite.

Definition at line 99 of file ofxsImageEffect.cpp.

Referenced by OFX::Interact::Interact(), interactMainEntry(), loadAction(), OFX::Interact::requestRedraw(), OFX::retrieveEffectFromInteractHandle(), retrieveInteractPointer(), OFX::Interact::swapBuffers(), and unloadAction().

int OFX::Private::gLoadCount = 0

Keeps count of how many times load/unload have been called.

Definition at line 92 of file ofxsImageEffect.cpp.

Referenced by loadAction(), and unloadAction().

OfxMemorySuiteV1 * OFX::Private::gMemorySuite = NULL

Pointer to the general memory suite.

Definition at line 101 of file ofxsImageEffect.cpp.

Referenced by OFX::memory::allocate(), OFX::memory::free(), loadAction(), and unloadAction().

OfxMessageSuiteV1 * OFX::Private::gMessageSuite = NULL

Pointer to the message suite.

Definition at line 103 of file ofxsImageEffect.cpp.

Referenced by tuttle::host::ofx::getMessageSuite(), loadAction(), OFX::ImageEffect::sendMessage(), and unloadAction().

OfxParametricParameterSuiteV1 * OFX::Private::gParametricParameterSuite = NULL

Pointer to the parametric parameter suite.

Definition at line 106 of file ofxsImageEffect.cpp.

Referenced by OFX::ParametricParamDescriptor::addControlPoint(), OFX::ParametricParam::addControlPoint(), OFX::ParametricParam::deleteControlPoint(), fetchHostDescription(), OFX::ParametricParam::getNControlPoints(), OFX::ParametricParam::getNthControlPoints(), OFX::ParametricParam::getValue(), loadAction(), OFX::ParametricParam::setNthControlPoints(), and unloadAction().

OfxParameterSuiteV1 * OFX::Private::gParamSuite = NULL

Pointer to the parameter suite.

Definition at line 100 of file ofxsImageEffect.cpp.

Referenced by OFX::ParamSet::beginEditBlock(), OFX::ParamSetDescriptor::defineRawParam(), OFX::ValueParam::deleteAllKeys(), OFX::ValueParam::deleteKeyAtTime(), OFX::DoubleParam::differentiate(), OFX::Double2DParam::differentiate(), OFX::Double3DParam::differentiate(), OFX::ParamSet::endEditBlock(), OFX::ParamSet::fetchRawParam(), OFX::ValueParam::getKeyIndex(), OFX::ValueParam::getKeyTime(), OFX::ValueParam::getNumKeys(), OFX::ParamSet::getParam(), OFX::ParamSet::getParamType(), OFX::StringParam::getPointerValue(), OFX::StringParam::getPointerValueAtTime(), OFX::IntParam::getValue(), OFX::Int2DParam::getValue(), OFX::Int3DParam::getValue(), OFX::DoubleParam::getValue(), OFX::Double2DParam::getValue(), OFX::Double3DParam::getValue(), OFX::RGBParam::getValue(), OFX::RGBAParam::getValue(), OFX::ChoiceParam::getValue(), OFX::BooleanParam::getValue(), OFX::CustomParam::getValue(), OFX::IntParam::getValueAtTime(), OFX::Int2DParam::getValueAtTime(), OFX::Int3DParam::getValueAtTime(), OFX::DoubleParam::getValueAtTime(), OFX::Double2DParam::getValueAtTime(), OFX::Double3DParam::getValueAtTime(), OFX::RGBParam::getValueAtTime(), OFX::RGBAParam::getValueAtTime(), OFX::ChoiceParam::getValueAtTime(), OFX::BooleanParam::getValueAtTime(), OFX::CustomParam::getValueAtTime(), OFX::DoubleParam::integrate(), OFX::Double2DParam::integrate(), OFX::Double3DParam::integrate(), loadAction(), OFX::Param::Param(), OFX::ParamSet::paramExists(), OFX::ParamSetDescriptor::setOfxParamSetHandle(), OFX::ParametricParamDescriptor::setParamSet(), OFX::ParamSet::setParamSetHandle(), OFX::IntParam::setValue(), OFX::Int2DParam::setValue(), OFX::Int3DParam::setValue(), OFX::DoubleParam::setValue(), OFX::Double2DParam::setValue(), OFX::Double3DParam::setValue(), OFX::RGBParam::setValue(), OFX::RGBAParam::setValue(), OFX::StringParam::setValue(), OFX::ChoiceParam::setValue(), OFX::BooleanParam::setValue(), OFX::CustomParam::setValue(), OFX::IntParam::setValueAtTime(), OFX::Int2DParam::setValueAtTime(), OFX::Int3DParam::setValueAtTime(), OFX::DoubleParam::setValueAtTime(), OFX::Double2DParam::setValueAtTime(), OFX::Double3DParam::setValueAtTime(), OFX::RGBParam::setValueAtTime(), OFX::RGBAParam::setValueAtTime(), OFX::StringParam::setValueAtTime(), OFX::ChoiceParam::setValueAtTime(), OFX::BooleanParam::setValueAtTime(), OFX::CustomParam::setValueAtTime(), and unloadAction().

OfxProgressSuiteV1 * OFX::Private::gProgressSuite = NULL

Pointer to the optional progress suite.

Definition at line 104 of file ofxsImageEffect.cpp.

Referenced by tuttle::host::ofx::getProgressSuite(), loadAction(), OFX::ImageEffect::progressEnd(), OFX::ImageEffect::progressStart(), and OFX::ImageEffect::progressUpdate().

OfxPropertySuiteV1 * OFX::Private::gPropSuite = NULL

Pointer to the property suite.

Definition at line 98 of file ofxsImageEffect.cpp.

Referenced by loadAction(), OFX::PropertySet::propGetDimension(), OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetInt(), OFX::PropertySet::propGetPointer(), OFX::PropertySet::propGetString(), OFX::PropertySet::propReset(), OFX::PropertySet::propSetDouble(), OFX::PropertySet::propSetInt(), OFX::PropertySet::propSetPointer(), OFX::PropertySet::propSetString(), and unloadAction().

OfxMultiThreadSuiteV1 * OFX::Private::gThreadSuite = NULL

Pointer to the threading suite.

Definition at line 102 of file ofxsImageEffect.cpp.

Referenced by OFX::MultiThread::getNumCPUs(), OFX::MultiThread::getThreadIndex(), OFX::MultiThread::isSpawnedThread(), loadAction(), OFX::MultiThread::Mutex::lock(), OFX::MultiThread::Processor::multiThread(), OFX::MultiThread::Mutex::Mutex(), OFX::MultiThread::Mutex::tryLock(), unloadAction(), OFX::MultiThread::Mutex::unlock(), and OFX::MultiThread::Mutex::~Mutex().

OfxTimeLineSuiteV1 * OFX::Private::gTimeLineSuite = NULL

Pointer to the optional progress suite.

Definition at line 105 of file ofxsImageEffect.cpp.

Referenced by loadAction(), OFX::ImageEffect::timeLineGetBounds(), OFX::ImageEffect::timeLineGetTime(), and OFX::ImageEffect::timeLineGotoTime().

OfxPluginArray OFX::Private::ofxPlugs

Definition at line 84 of file ofxsImageEffect.cpp.

Referenced by init(), OfxGetPlugin(), and unloadAction().

OfxPlugInfoMap OFX::Private::plugInfoMap

Definition at line 83 of file ofxsImageEffect.cpp.

Referenced by init(), mainEntryStr(), OfxGetPlugin(), and unloadAction().