The validation code has its own namespace. More...

Data Structures
struct	ValueHolder
	This is uses to hold a property value, used by the property checking classes. More...
class	PropertyDescription
	class to describe properties, check their default and set their values More...
class	PropertySetDescription
	Describes a set of properties. More...
Enumerations
enum	DescriptionTag { eDescDefault, eDescFinished }
	Enum used in the varargs list of the PropertyDescription constructor. More...
Functions
static void	setVectorFromVarArgs (OFX::PropertyTypeEnum ilk, int dimension, va_list &argp, std::vector< ValueHolder > &vec)
	Set the vector by getting dimension things specified by ilk from the argp list, used by PropertyDescription ctor.
void	validateHostProperties (OfxHost *host)
	Validates the host structure and property handle.
void	validatePluginDescriptorProperties (PropertySet props)
	Validates the effect descriptor properties.
void	validatePluginInstanceProperties (PropertySet props)
	Validates the effect instance properties.
void	validateClipDescriptorProperties (PropertySet props)
	validates a clip descriptor
void	validateClipInstanceProperties (PropertySet props)
	validates a clip instance
void	validateImageProperties (PropertySet props)
	validates a clip descriptor
void	validateActionArgumentsProperties (const std::string &action, PropertySet inArgs, PropertySet outArgs)
	Validates action in/out arguments.
void	validateParameterProperties (ParamTypeEnum paramType, OFX::PropertySet &paramProps, bool checkDefaults)
	Validates parameter properties.
void	initialise (void)
	Initialises validation stuff that needs to be done once we know how the host behaves, called during the onload action.
Variables
static PropertyDescription	gHostProps []
	A list of properties that all hosts must have, and will be validated against. None of these has a default, but they must exist.
static PropertySetDescription	gHostPropSet ("Host Property", gHostProps, sizeof(gHostProps)/sizeof(PropertyDescription), NULLPTR)
	the property set for the global host pointer
static PropertyDescription	gPluginDescriptorProps []
	A list of properties to validate the effect descriptor against.
static PropertySetDescription	gPluginDescriptorPropSet ("Plugin Descriptor", gPluginDescriptorProps, sizeof(gPluginDescriptorProps)/sizeof(PropertyDescription), NULLPTR)
	the property set for the global plugin descriptor
static PropertyDescription	gPluginInstanceProps []
	A list of properties to validate the plugin instance.
static PropertySetDescription	gPluginInstancePropSet ("Plugin Instance", gPluginInstanceProps, sizeof(gPluginInstanceProps)/sizeof(PropertyDescription), NULLPTR)
	the property set for a plugin instance
static PropertyDescription	gClipDescriptorProps []
	A list of properties to validate a clip descriptor.
static PropertySetDescription	gClipDescriptorPropSet ("Clip Descriptor", gClipDescriptorProps, sizeof(gClipDescriptorProps)/sizeof(PropertyDescription), NULLPTR)
	the property set for a clip descriptor
static PropertyDescription	gClipInstanceProps []
	A list of properties to validate a clip instance.
static PropertySetDescription	gClipInstancePropSet ("Clip Instance", gClipInstanceProps, sizeof(gClipInstanceProps)/sizeof(PropertyDescription), NULLPTR)
	the property set for a clip instance
static PropertyDescription	gImageInstanceProps []
	List of properties to validate an image instance.
static PropertySetDescription	gImageInstancePropSet ("Image Instance", gImageInstanceProps, sizeof(gImageInstanceProps)/sizeof(PropertyDescription), NULLPTR)
	the property set for an image instance
static PropertyDescription	gDescribeInContextActionInArgProps []
	kOfxImageEffectActionDescribeInContext actions's inargs properties
static PropertySetDescription	gDescribeInContextActionInArgPropSet (kOfxImageEffectActionDescribeInContext" in argument", gDescribeInContextActionInArgProps, sizeof(gDescribeInContextActionInArgProps)/sizeof(PropertyDescription), NULLPTR)
	the property set for describe in context action
static PropertyDescription	gRenderActionInArgProps []
	kOfxImageEffectActionRender action's inargs properties
static PropertySetDescription	gRenderActionInArgPropSet (kOfxImageEffectActionRender" in argument", gRenderActionInArgProps, sizeof(gRenderActionInArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionRender property set
static PropertyDescription	gBeginSequenceRenderActionInArgProps []
	kOfxImageEffectActionBeginSequenceRender action's inargs properties
static PropertySetDescription	gBeginSequenceRenderActionInArgPropSet (kOfxImageEffectActionBeginSequenceRender" in argument", gBeginSequenceRenderActionInArgProps, sizeof(gBeginSequenceRenderActionInArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionBeginSequenceRender property set
static PropertyDescription	gEndSequenceRenderActionInArgProps []
	kOfxImageEffectActionEndSequenceRender action's inargs properties
static PropertySetDescription	gEndSequenceRenderActionInArgPropSet (kOfxImageEffectActionEndSequenceRender" in argument", gEndSequenceRenderActionInArgProps, sizeof(gEndSequenceRenderActionInArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionEndSequenceRender property set
static PropertyDescription	gIsIdentityActionInArgProps []
	kOfxImageEffectActionIsIdentity action's inargs properties
static PropertySetDescription	gIsIdentityActionInArgPropSet (kOfxImageEffectActionIsIdentity" in argument", gIsIdentityActionInArgProps, sizeof(gIsIdentityActionInArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionIsIdentity property set
static PropertyDescription	gIsIdentityActionOutArgProps []
	kOfxImageEffectActionIsIdentity action's outargs properties
static PropertySetDescription	gIsIdentityActionOutArgPropSet (kOfxImageEffectActionIsIdentity" out argument", gIsIdentityActionOutArgProps, sizeof(gIsIdentityActionOutArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionIsIdentity property set
static PropertyDescription	gGetRegionOfDefinitionInArgProps []
	kOfxImageEffectActionGetRegionOfDefinition action's inargs properties
static PropertySetDescription	gGetRegionOfDefinitionInArgPropSet (kOfxImageEffectActionGetRegionOfDefinition" in argument", gGetRegionOfDefinitionInArgProps, sizeof(gGetRegionOfDefinitionInArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionGetRegionOfDefinition property set
static PropertyDescription	gGetRegionOfDefinitionOutArgProps []
	kOfxImageEffectActionGetRegionOfDefinition action's outargs properties
static PropertySetDescription	gGetRegionOfDefinitionOutArgPropSet (kOfxImageEffectActionGetRegionOfDefinition" out argument", gGetRegionOfDefinitionOutArgProps, sizeof(gGetRegionOfDefinitionOutArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionGetRegionOfDefinition property set
static PropertyDescription	gGetRegionOfInterestInArgProps []
	kOfxImageEffectActionGetRegionsOfInterest action's inargs properties
static PropertySetDescription	gGetRegionOfInterestInArgPropSet (kOfxImageEffectActionGetRegionsOfInterest"in argument", gGetRegionOfInterestInArgProps, sizeof(gGetRegionOfInterestInArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionGetRegionsOfInterest property set
static PropertyDescription	gGetTimeDomainOutArgProps []
	kOfxImageEffectActionGetTimeDomain action's outargs properties
static PropertySetDescription	gGetTimeDomainOutArgPropSet (kOfxImageEffectActionGetTimeDomain" out argument", gGetTimeDomainOutArgProps, sizeof(gGetTimeDomainOutArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionGetTimeDomain property set
static PropertyDescription	gGetFramesNeededInArgProps []
	kOfxImageEffectActionGetFramesNeeded action's inargs properties
static PropertySetDescription	gGetFramesNeededInArgPropSet (kOfxImageEffectActionGetFramesNeeded" in argument", gGetFramesNeededInArgProps, sizeof(gGetFramesNeededInArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionGetFramesNeeded property set
static PropertyDescription	gGetClipPreferencesOutArgProps []
	kOfxImageEffectActionGetClipPreferences action's outargs properties
static PropertySetDescription	gGetClipPreferencesOutArgPropSet (kOfxImageEffectActionGetClipPreferences" out argument", gGetClipPreferencesOutArgProps, sizeof(gGetClipPreferencesOutArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxImageEffectActionGetClipPreferences property set
static PropertyDescription	gInstanceChangedInArgProps []
	kOfxActionInstanceChanged action's inargs properties
static PropertySetDescription	gInstanceChangedInArgPropSet (kOfxActionInstanceChanged" in argument", gInstanceChangedInArgProps, sizeof(gInstanceChangedInArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxActionInstanceChanged property set
static PropertyDescription	gBeginEndInstanceChangedInArgProps []
	kOfxActionBeginInstanceChanged and kOfxActionEndInstanceChanged actions' inargs properties
static PropertySetDescription	gBeginInstanceChangedInArgPropSet (kOfxActionBeginInstanceChanged" in argument", gBeginEndInstanceChangedInArgProps, sizeof(gBeginEndInstanceChangedInArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxActionBeginInstanceChanged property set
static PropertySetDescription	gEndInstanceChangedInArgPropSet (kOfxActionEndInstanceChanged" in argument", gBeginEndInstanceChangedInArgProps, sizeof(gBeginEndInstanceChangedInArgProps)/sizeof(PropertyDescription), NULLPTR)
	kOfxActionEndInstanceChanged property set
static PropertyDescription	gBasicParamProps []
	Basic parameter descriptor properties.
static PropertyDescription	gInteractOverideParamProps []
	Props for params that can have an interact override their UI.
static PropertyDescription	gValueHolderParamProps []
	Props for params that can hold values.
static PropertyDescription	gStringParamProps []
	values for a string param
static PropertyDescription	gCustomParamProps []
	values for a string param
static PropertyDescription	gRGBColourParamProps []
	properties for an RGB colour param
static PropertyDescription	gRGBAColourParamProps []
	properties for an RGBA colour param
static PropertyDescription	gBooleanParamProps []
	properties for a boolean param
static PropertyDescription	gChoiceParamProps []
	properties for a boolean param
static PropertyDescription	gInt1DParamProps []
	properties for a 1D integer param
static PropertyDescription	gInt2DParamProps []
	properties for a 2D integer param
static PropertyDescription	gInt3DParamProps []
	properties for a 3D integer param
static PropertyDescription	gDoubleParamProps []
	Properties common to all double params.
static PropertyDescription	gDouble1DParamProps []
	properties for a 1D double param
static PropertyDescription	gDouble2DParamProps []
	properties for a 2D double param
static PropertyDescription	gDouble3DParamProps []
	properties for a 3D double param
static PropertyDescription	gGroupParamProps []
	properties for a group param
static PropertyDescription	gPageParamProps []
	properties for a page param
static PropertyDescription	gParametricParamProps []
	properties for a parametric param
static PropertyDescription	gCameraParamProps []
	properties for a camera param
static PropertySetDescription	gInt1DParamPropSet ("1D Integer parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gInt1DParamProps), NULLPTR)
	Property set for 1D ints.
static PropertySetDescription	gInt2DParamPropSet ("2D Integer parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gInt2DParamProps), NULLPTR)
	Property set for 2D ints.
static PropertySetDescription	gInt3DParamPropSet ("3D Integer parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gInt3DParamProps), NULLPTR)
	Property set for 3D ints.
static PropertySetDescription	gDouble1DParamPropSet ("1D Double parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gDoubleParamProps), mPropDescriptionArg(gDouble1DParamProps), NULLPTR)
	Property set for 1D doubles.
static PropertySetDescription	gDouble2DParamPropSet ("2D Double parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gDoubleParamProps), mPropDescriptionArg(gDouble2DParamProps), NULLPTR)
	Property set for 2D doubles.
static PropertySetDescription	gDouble3DParamPropSet ("3D Double parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gDoubleParamProps), mPropDescriptionArg(gDouble3DParamProps), NULLPTR)
	Property set for 3D doubles.
static PropertySetDescription	gRGBParamPropSet ("RGB Colour parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gRGBColourParamProps), NULLPTR)
	Property set for RGB colour params.
static PropertySetDescription	gRGBAParamPropSet ("RGB Colour parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gRGBAColourParamProps), NULLPTR)
	Property set for RGB colour params.
static PropertySetDescription	gStringParamPropSet ("String parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gStringParamProps), NULLPTR)
	Property set for string params.
static PropertySetDescription	gCustomParamPropSet ("Custom parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gCustomParamProps), NULLPTR)
	Property set for string params.
static PropertySetDescription	gBooleanParamPropSet ("Boolean parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gBooleanParamProps), NULLPTR)
	Property set for boolean params.
static PropertySetDescription	gChoiceParamPropSet ("Choice parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gChoiceParamProps), NULLPTR)
	Property set for choice params.
static PropertySetDescription	gPushButtonParamPropSet ("PushButton parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), NULLPTR)
	Property set for push button params.
static PropertySetDescription	gGroupParamPropSet ("Group Parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gGroupParamProps), NULLPTR)
	Property set for push button params.
static PropertySetDescription	gPageParamPropSet ("Page Parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gPageParamProps), NULLPTR)
	Property set for push button params.
static PropertySetDescription	gParametricParamPropSet ("Parametric Parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gParametricParamProps), NULLPTR)
static PropertySetDescription	gCameraParamPropSet ("Camera Parameter", mPropDescriptionArg(gCameraParamProps), NULLPTR)

Detailed Description

The validation code has its own namespace.

Enumeration Type Documentation

enum OFX::Validation::DescriptionTag

Enum used in the varargs list of the PropertyDescription constructor.

Enumerator:

eDescDefault

eDescFinished

following values are the default to check against

we have finished the description

Definition at line 152 of file ofxsSupportPrivate.h.

Function Documentation

void OFX::Validation::initialise ( void )

Initialises validation stuff that needs to be done once we know how the host behaves, called during the onload action.

initialises the validation code, call this in on load

Definition at line 1225 of file ofxsPropertyValidation.cpp.

References OFX::Validation::PropertySetDescription::addProperty(), eDescDefault, eDescFinished, OFX::eInt, gBooleanParamPropSet, gChoiceParamPropSet, gCustomParamPropSet, OFX::getImageEffectHostDescription(), gStringParamPropSet, and kOfxParamPropAnimates.

Referenced by OFX::Private::loadAction().

Here is the call graph for this function:

static void OFX::Validation::setVectorFromVarArgs	(	OFX::PropertyTypeEnum	ilk,
		int	dimension,
		va_list &	argp,
		std::vector< ValueHolder > &	vec
	)		`[static]`

Set the vector by getting dimension things specified by ilk from the argp list, used by PropertyDescription ctor.

Definition at line 67 of file ofxsPropertyValidation.cpp.

References OFX::eDouble, OFX::eInt, OFX::ePointer, and OFX::eString.

Referenced by OFX::Validation::PropertyDescription::PropertyDescription().

void OFX::Validation::validateActionArgumentsProperties	(	const std::string &	action,
		PropertySet	inArgs,
		PropertySet	outArgs
	)

Validates action in/out arguments.

Definition at line 1094 of file ofxsPropertyValidation.cpp.

Referenced by OFX::Private::checkMainHandles().

Here is the call graph for this function:

void OFX::Validation::validateClipDescriptorProperties ( PropertySet props )

validates a clip descriptor

Definition at line 1070 of file ofxsPropertyValidation.cpp.

References gClipDescriptorPropSet, and OFX::Validation::PropertySetDescription::validate().

Referenced by OFX::ClipDescriptor::ClipDescriptor().

Here is the call graph for this function:

void OFX::Validation::validateClipInstanceProperties ( PropertySet props )

validates a clip instance

Definition at line 1078 of file ofxsPropertyValidation.cpp.

References gClipInstancePropSet, and OFX::Validation::PropertySetDescription::validate().

Referenced by OFX::Clip::Clip().

Here is the call graph for this function:

void OFX::Validation::validateHostProperties ( OfxHost * host )

Validates the host structure and property handle.

Definition at line 1044 of file ofxsPropertyValidation.cpp.

References gHostPropSet, OfxHost::host, and OFX::Validation::PropertySetDescription::validate().

Referenced by OFX::Private::loadAction().

Here is the call graph for this function:

void OFX::Validation::validateImageProperties ( PropertySet props )

validates a clip descriptor

Definition at line 1086 of file ofxsPropertyValidation.cpp.

References gImageInstancePropSet, and OFX::Validation::PropertySetDescription::validate().

Referenced by OFX::Image::Image().

Here is the call graph for this function:

void OFX::Validation::validateParameterProperties	(	ParamTypeEnum	paramType,
		OFX::PropertySet &	paramProps,
		bool	checkDefaults
	)

Validates parameter properties.

Definition at line 1155 of file ofxsPropertyValidation.cpp.

References OFX::eBooleanParam, OFX::eCameraParam, OFX::eChoiceParam, OFX::eCustomParam, OFX::eDouble2DParam, OFX::eDouble3DParam, OFX::eDoubleParam, OFX::eDummyParam, OFX::eGroupParam, OFX::eInt2DParam, OFX::eInt3DParam, OFX::eIntParam, OFX::ePageParam, OFX::eParametricParam, OFX::ePushButtonParam, OFX::eRGBAParam, OFX::eRGBParam, OFX::eStringParam, gBooleanParamPropSet, gCameraParamPropSet, gChoiceParamPropSet, gCustomParamPropSet, gDouble1DParamPropSet, gDouble2DParamPropSet, gDouble3DParamPropSet, gGroupParamPropSet, gInt1DParamPropSet, gInt2DParamPropSet, gInt3DParamPropSet, gPageParamPropSet, gParametricParamPropSet, gPushButtonParamPropSet, gRGBAParamPropSet, gRGBParamPropSet, gStringParamPropSet, and OFX::Validation::PropertySetDescription::validate().

Referenced by OFX::Param::Param(), and OFX::ParamDescriptor::ParamDescriptor().

Here is the call graph for this function:

void OFX::Validation::validatePluginDescriptorProperties ( PropertySet props )

Validates the effect descriptor properties.

Definition at line 1054 of file ofxsPropertyValidation.cpp.

References gPluginDescriptorPropSet, and OFX::Validation::PropertySetDescription::validate().

Referenced by OFX::ImageEffectDescriptor::ImageEffectDescriptor(), and OFX::Private::mainEntryStr().

Here is the call graph for this function:

void OFX::Validation::validatePluginInstanceProperties ( PropertySet props )

Validates the effect instance properties.

Definition at line 1062 of file ofxsPropertyValidation.cpp.

References gPluginInstancePropSet, and OFX::Validation::PropertySetDescription::validate().

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

Here is the call graph for this function:

Variable Documentation

PropertyDescription OFX::Validation::gBasicParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxPropType,                   OFX::eString, 1, eDescDefault, kOfxTypeParameter, eDescFinished ),
    PropertyDescription( kOfxPropName,                   OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxPropLabel,                  OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxPropShortLabel,             OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxPropLongLabel,              OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropType,              OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropSecret,            OFX::eInt,    1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxParamPropCanUndo,           OFX::eInt,    1, eDescDefault, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropHint,              OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropScriptName,        OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropParent,            OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropEnabled,           OFX::eInt,    1, eDescDefault, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropDataPtr,           OFX::ePointer, 1, eDescDefault, ( void* )( 0 ), eDescFinished ),
}

Basic parameter descriptor properties.

Definition at line 720 of file ofxsPropertyValidation.cpp.

PropertyDescription OFX::Validation::gBeginEndInstanceChangedInArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxPropChangeReason,           OFX::eString, 1, eDescFinished ),
}

kOfxActionBeginInstanceChanged and kOfxActionEndInstanceChanged actions' inargs properties

Definition at line 701 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gBeginInstanceChangedInArgPropSet(kOfxActionBeginInstanceChanged" in argument", gBeginEndInstanceChangedInArgProps, sizeof(gBeginEndInstanceChangedInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxActionBeginInstanceChanged property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gBeginSequenceRenderActionInArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxImageEffectPropFrameRange,  OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropFrameStep,   OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropRenderScale, OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxPropIsInteractive,          OFX::eInt, 1, eDescFinished ),
}

kOfxImageEffectActionBeginSequenceRender action's inargs properties

Definition at line 561 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gBeginSequenceRenderActionInArgPropSet(kOfxImageEffectActionBeginSequenceRender" in argument", gBeginSequenceRenderActionInArgProps, sizeof(gBeginSequenceRenderActionInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionBeginSequenceRender property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gBooleanParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eInt, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropAnimates,             OFX::eInt, 1, eDescDefault, 0, eDescFinished ),
}

properties for a boolean param

Definition at line 789 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gBooleanParamPropSet("Boolean parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gBooleanParamProps), NULLPTR) [static]

Property set for boolean params.

Referenced by initialise(), and validateParameterProperties().

PropertyDescription OFX::Validation::gCameraParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxPropType,                             OFX::eString, 1, eDescDefault, "NukeCamera", eDescFinished ),
    PropertyDescription( kOfxPropName,                           OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxPropLabel,                          OFX::eString, 1,  eDescFinished ),
    PropertyDescription( kOfxPropShortLabel,                     OFX::eString, 1,  eDescFinished ),
    PropertyDescription( kOfxPropLongLabel,                      OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxImageClipPropOptional,              OFX::eInt, 1, eDescDefault, 0, eDescFinished ),
}

properties for a camera param

Definition at line 904 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gCameraParamPropSet("Camera Parameter", mPropDescriptionArg(gCameraParamProps), NULLPTR) [static]

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gChoiceParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eInt,     1, eDescFinished ),
    PropertyDescription( kOfxParamPropAnimates,             OFX::eInt,     1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxParamPropChoiceOption,         OFX::eString, -1, eDescFinished ),
}

properties for a boolean param

Definition at line 796 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gChoiceParamPropSet("Choice parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gChoiceParamProps), NULLPTR) [static]

Property set for choice params.

Referenced by initialise(), and validateParameterProperties().

PropertyDescription OFX::Validation::gClipDescriptorProps[] [static]

Initial value:

{
    
    PropertyDescription( kOfxPropType,                           OFX::eString, 1, eDescDefault, kOfxTypeClip, eDescFinished ),
    PropertyDescription( kOfxImageClipPropFieldExtraction,       OFX::eString, 1, eDescDefault, kOfxImageFieldDoubled, eDescFinished ),

    
    PropertyDescription( kOfxImageEffectPropSupportedComponents, OFX::eString, -1, eDescFinished ),
    PropertyDescription( kOfxPropName,                           OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxPropLabel,                          OFX::eString, 1,  eDescFinished ),
    PropertyDescription( kOfxPropShortLabel,                     OFX::eString, 1,  eDescFinished ),
    PropertyDescription( kOfxPropLongLabel,                      OFX::eString, 1, eDescFinished ),

    
    PropertyDescription( kOfxImageEffectPropTemporalClipAccess,  OFX::eInt, 1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxImageClipPropOptional,              OFX::eInt, 1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxImageClipPropIsMask,                OFX::eInt, 1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropSupportsTiles,       OFX::eInt, 1, eDescDefault, 1, eDescFinished ),
}

A list of properties to validate a clip descriptor.

Definition at line 435 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gClipDescriptorPropSet("Clip Descriptor", gClipDescriptorProps, sizeof(gClipDescriptorProps)/sizeof(PropertyDescription), NULLPTR) [static]

the property set for a clip descriptor

Referenced by validateClipDescriptorProperties().

PropertyDescription OFX::Validation::gClipInstanceProps[] [static]

A list of properties to validate a clip instance.

Definition at line 461 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gClipInstancePropSet("Clip Instance", gClipInstanceProps, sizeof(gClipInstanceProps)/sizeof(PropertyDescription), NULLPTR) [static]

the property set for a clip instance

Referenced by validateClipInstanceProperties().

PropertyDescription OFX::Validation::gCustomParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,                OFX::eString,  1, eDescFinished ),
    PropertyDescription( kOfxParamPropCustomInterpCallbackV1, OFX::ePointer, 1, eDescDefault, NULLPTR, eDescFinished ),
}

values for a string param

Definition at line 768 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gCustomParamPropSet("Custom parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gCustomParamProps), NULLPTR) [static]

Property set for string params.

Referenced by initialise(), and validateParameterProperties().

PropertyDescription OFX::Validation::gDescribeInContextActionInArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxImageEffectPropContext,   OFX::eString, 1, eDescFinished ),
}

kOfxImageEffectActionDescribeInContext actions's inargs properties

Definition at line 536 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gDescribeInContextActionInArgPropSet(kOfxImageEffectActionDescribeInContext" in argument", gDescribeInContextActionInArgProps, sizeof(gDescribeInContextActionInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

the property set for describe in context action

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gDouble1DParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropMin,                  OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropMax,                  OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMin,           OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMax,           OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropShowTimeMarker,       OFX::eInt,    1, eDescDefault, 0, eDescFinished ),
}

properties for a 1D double param

Definition at line 848 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gDouble1DParamPropSet("1D Double parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gDoubleParamProps), mPropDescriptionArg(gDouble1DParamProps), NULLPTR) [static]

Property set for 1D doubles.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gDouble2DParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropMin,                  OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropMax,                  OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMin,           OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMax,           OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropDimensionLabel,       OFX::eString, 2, eDescDefault, "x", "y", eDescFinished ),
}

properties for a 2D double param

Definition at line 859 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gDouble2DParamPropSet("2D Double parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gDoubleParamProps), mPropDescriptionArg(gDouble2DParamProps), NULLPTR) [static]

Property set for 2D doubles.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gDouble3DParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eDouble, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropMin,                  OFX::eDouble, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropMax,                  OFX::eDouble, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMin,           OFX::eDouble, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMax,           OFX::eDouble, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropDimensionLabel,       OFX::eString, 3, eDescDefault, "x", "y", "z", eDescFinished ),
}

properties for a 3D double param

Definition at line 870 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gDouble3DParamPropSet("3D Double parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gDoubleParamProps), mPropDescriptionArg(gDouble3DParamProps), NULLPTR) [static]

Property set for 3D doubles.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gDoubleParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropAnimates,             OFX::eInt,    1, eDescDefault, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropIncrement,            OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropDigits,               OFX::eInt,    1, eDescFinished ),
    PropertyDescription( kOfxParamPropDoubleType,           OFX::eString, 1, eDescDefault, kOfxParamDoubleTypePlain, eDescFinished ),
}

Properties common to all double params.

Definition at line 839 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gEndInstanceChangedInArgPropSet(kOfxActionEndInstanceChanged" in argument", gBeginEndInstanceChangedInArgProps, sizeof(gBeginEndInstanceChangedInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxActionEndInstanceChanged property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gEndSequenceRenderActionInArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxImageEffectPropRenderScale, OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxPropIsInteractive,          OFX::eInt, 1, eDescFinished ),
}

kOfxImageEffectActionEndSequenceRender action's inargs properties

Definition at line 575 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gEndSequenceRenderActionInArgPropSet(kOfxImageEffectActionEndSequenceRender" in argument", gEndSequenceRenderActionInArgProps, sizeof(gEndSequenceRenderActionInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionEndSequenceRender property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gGetClipPreferencesOutArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxImageEffectPropFrameRate,         OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxImagePropPixelAspectRatio,        OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxImageClipPropContinuousSamples,   OFX::eInt, 1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxImageEffectFrameVarying,          OFX::eInt, 1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropPreMultiplication, OFX::eString, 1, eDescFinished ),
}

kOfxImageEffectActionGetClipPreferences action's outargs properties

Definition at line 671 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gGetClipPreferencesOutArgPropSet(kOfxImageEffectActionGetClipPreferences" out argument", gGetClipPreferencesOutArgProps, sizeof(gGetClipPreferencesOutArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionGetClipPreferences property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gGetFramesNeededInArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxPropTime,                     OFX::eDouble, 1, eDescFinished ),
}

kOfxImageEffectActionGetFramesNeeded action's inargs properties

Definition at line 660 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gGetFramesNeededInArgPropSet(kOfxImageEffectActionGetFramesNeeded" in argument", gGetFramesNeededInArgProps, sizeof(gGetFramesNeededInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionGetFramesNeeded property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gGetRegionOfDefinitionInArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxPropTime,                     OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropRenderScale,   OFX::eDouble, 2, eDescFinished ),
}

kOfxImageEffectActionGetRegionOfDefinition action's inargs properties

Definition at line 613 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gGetRegionOfDefinitionInArgPropSet(kOfxImageEffectActionGetRegionOfDefinition" in argument", gGetRegionOfDefinitionInArgProps, sizeof(gGetRegionOfDefinitionInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionGetRegionOfDefinition property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gGetRegionOfDefinitionOutArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxImageEffectPropRegionOfDefinition,   OFX::eDouble, 4, eDescFinished ),
}

kOfxImageEffectActionGetRegionOfDefinition action's outargs properties

Definition at line 625 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gGetRegionOfDefinitionOutArgPropSet(kOfxImageEffectActionGetRegionOfDefinition" out argument", gGetRegionOfDefinitionOutArgProps, sizeof(gGetRegionOfDefinitionOutArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionGetRegionOfDefinition property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gGetRegionOfInterestInArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxPropTime,                          OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropRenderScale,        OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropRegionOfInterest,   OFX::eDouble, 4, eDescFinished ),
}

kOfxImageEffectActionGetRegionsOfInterest action's inargs properties

Definition at line 636 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gGetRegionOfInterestInArgPropSet(kOfxImageEffectActionGetRegionsOfInterest"in argument", gGetRegionOfInterestInArgProps, sizeof(gGetRegionOfInterestInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionGetRegionsOfInterest property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gGetTimeDomainOutArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxImageEffectPropFrameRange,   OFX::eDouble, 2, eDescFinished ),
}

kOfxImageEffectActionGetTimeDomain action's outargs properties

Definition at line 649 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gGetTimeDomainOutArgPropSet(kOfxImageEffectActionGetTimeDomain" out argument", gGetTimeDomainOutArgProps, sizeof(gGetTimeDomainOutArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionGetTimeDomain property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gGroupParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropGroupOpen,            OFX::eInt, 2, eDescFinished ),
}

properties for a group param

Definition at line 881 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gGroupParamPropSet("Group Parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gGroupParamProps), NULLPTR) [static]

Property set for push button params.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gHostProps[] [static]

A list of properties that all hosts must have, and will be validated against. None of these has a default, but they must exist.

Definition at line 323 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gHostPropSet("Host Property", gHostProps, sizeof(gHostProps)/sizeof(PropertyDescription), NULLPTR) [static]

the property set for the global host pointer

Referenced by validateHostProperties().

PropertyDescription OFX::Validation::gImageInstanceProps[] [static]

Initial value:

{
    
    PropertyDescription( kOfxPropType,                         OFX::eString, 1, eDescDefault, kOfxTypeImage, eDescFinished ),

    
    PropertyDescription( kOfxImageEffectPropPixelDepth,        OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropComponents,        OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropPreMultiplication, OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxImagePropField,                   OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxImagePropUniqueIdentifier,        OFX::eString, 1, eDescFinished ),

    
    PropertyDescription( kOfxImageEffectPropRenderScale,       OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxImagePropPixelAspectRatio,        OFX::eDouble, 1, eDescFinished ),

    
    PropertyDescription( kOfxImagePropData,                    OFX::ePointer, 1, eDescFinished ),

    
    PropertyDescription( kOfxImagePropBounds,                  OFX::eInt, 4, eDescFinished ),
    PropertyDescription( kOfxImagePropRegionOfDefinition,      OFX::eInt, 4, eDescFinished ),
    PropertyDescription( kOfxImagePropRowBytes,                OFX::eInt, 1, eDescFinished ),
}

List of properties to validate an image instance.

Definition at line 501 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gImageInstancePropSet("Image Instance", gImageInstanceProps, sizeof(gImageInstanceProps)/sizeof(PropertyDescription), NULLPTR) [static]

the property set for an image instance

Referenced by validateImageProperties().

PropertyDescription OFX::Validation::gInstanceChangedInArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxPropType,                   OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxPropName,                   OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxPropChangeReason,           OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxPropTime,                   OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropRenderScale, OFX::eDouble, 2, eDescFinished ),
}

kOfxActionInstanceChanged action's inargs properties

Definition at line 686 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gInstanceChangedInArgPropSet(kOfxActionInstanceChanged" in argument", gInstanceChangedInArgProps, sizeof(gInstanceChangedInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxActionInstanceChanged property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gInt1DParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eInt, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropMin,                  OFX::eInt, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropMax,                  OFX::eInt, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMin,           OFX::eInt, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMax,           OFX::eInt, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropAnimates,             OFX::eInt, 1, eDescDefault, 0, eDescFinished ),
}

properties for a 1D integer param

Definition at line 804 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gInt1DParamPropSet("1D Integer parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gInt1DParamProps), NULLPTR) [static]

Property set for 1D ints.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gInt2DParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eInt, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropMin,                  OFX::eInt, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropMax,                  OFX::eInt, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMin,           OFX::eInt, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMax,           OFX::eInt, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropAnimates,             OFX::eInt, 1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxParamPropDimensionLabel,       OFX::eString, 2, eDescDefault, "x", "y", eDescFinished ),
}

properties for a 2D integer param

Definition at line 815 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gInt2DParamPropSet("2D Integer parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gInt2DParamProps), NULLPTR) [static]

Property set for 2D ints.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gInt3DParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eInt, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropMin,                  OFX::eInt, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropMax,                  OFX::eInt, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMin,           OFX::eInt, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropDisplayMax,           OFX::eInt, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropAnimates,             OFX::eInt, 1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxParamPropDimensionLabel,       OFX::eString, 3, eDescDefault, "x", "y", "z", eDescFinished ),
}

properties for a 3D integer param

Definition at line 827 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gInt3DParamPropSet("3D Integer parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gInt3DParamProps), NULLPTR) [static]

Property set for 3D ints.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gInteractOverideParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropInteractV1,           OFX::ePointer, 1, eDescDefault, ( void* )( 0 ), eDescFinished ),
    PropertyDescription( kOfxParamPropInteractSize,         OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxParamPropInteractSizeAspect,   OFX::eDouble, 1, eDescDefault, 1.0, eDescFinished ),
    PropertyDescription( kOfxParamPropInteractMinimumSize,  OFX::eInt,    2, eDescDefault, 10, 10, eDescFinished ),
    PropertyDescription( kOfxParamPropInteractPreferedSize, OFX::eInt,    2, eDescDefault, 10, 10, eDescFinished ),
}

Props for params that can have an interact override their UI.

Definition at line 738 of file ofxsPropertyValidation.cpp.

PropertyDescription OFX::Validation::gIsIdentityActionInArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxPropTime,                     OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropRenderScale,   OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropRenderWindow,  OFX::eInt,    4, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropFieldToRender, OFX::eString, 1, eDescFinished ),
}

kOfxImageEffectActionIsIdentity action's inargs properties

Definition at line 587 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gIsIdentityActionInArgPropSet(kOfxImageEffectActionIsIdentity" in argument", gIsIdentityActionInArgProps, sizeof(gIsIdentityActionInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionIsIdentity property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gIsIdentityActionOutArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxPropTime, OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxPropName, OFX::eString, 1, eDescFinished ),
}

kOfxImageEffectActionIsIdentity action's outargs properties

Definition at line 601 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gIsIdentityActionOutArgPropSet(kOfxImageEffectActionIsIdentity" out argument", gIsIdentityActionOutArgProps, sizeof(gIsIdentityActionOutArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionIsIdentity property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gPageParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropPageChild,            OFX::eString, -1, eDescFinished ),
}

properties for a page param

Definition at line 887 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gPageParamPropSet("Page Parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gPageParamProps), NULLPTR) [static]

Property set for push button params.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gParametricParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropAnimates,                     OFX::eInt,     1, eDescDefault, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropCanUndo,                      OFX::eInt,     1, eDescDefault, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropParametricDimension,          OFX::eInt,     1, eDescDefault, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropParametricUIColour,           OFX::eDouble, -1, eDescFinished ),
    PropertyDescription( kOfxParamPropParametricInteractBackground, OFX::ePointer, 1, eDescDefault, ( void* )( 0 ), eDescFinished ),
    PropertyDescription( kOfxParamPropParametricRange,              OFX::eDouble,  2, eDescDefault, 0.0, 1.0, eDescFinished ),
}

properties for a parametric param

Definition at line 893 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gParametricParamPropSet("Parametric Parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gParametricParamProps), NULLPTR) [static]

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gPluginDescriptorProps[] [static]

A list of properties to validate the effect descriptor against.

Definition at line 362 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gPluginDescriptorPropSet("Plugin Descriptor", gPluginDescriptorProps, sizeof(gPluginDescriptorProps)/sizeof(PropertyDescription), NULLPTR) [static]

the property set for the global plugin descriptor

Referenced by validatePluginDescriptorProperties().

PropertyDescription OFX::Validation::gPluginInstanceProps[] [static]

Initial value:

{
    
    PropertyDescription( kOfxPropType,                                OFX::eString,  1, eDescDefault, kOfxTypeImageEffectInstance, eDescFinished ),

    
    PropertyDescription( kOfxImageEffectInstancePropSequentialRender, OFX::eInt,     1, eDescDefault, 0, eDescFinished ),

    
    PropertyDescription( kOfxPropInstanceData,                        OFX::ePointer, 1, eDescDefault, ( void* )( 0 ), eDescFinished ),
    PropertyDescription( kOfxImageEffectPropPluginHandle,             OFX::ePointer, eDescFinished ),

    
    PropertyDescription( kOfxImageEffectPropContext,                  OFX::eString,  1, eDescFinished ),

    
    PropertyDescription( kOfxPropIsInteractive,                       OFX::eInt,     1, eDescFinished ),

    
    PropertyDescription( kOfxImageEffectPropProjectSize,              OFX::eDouble,  2, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropProjectExtent,            OFX::eDouble,  2, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropProjectOffset,            OFX::eDouble,  2, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropProjectPixelAspectRatio,  OFX::eDouble,  1, eDescFinished ),
    PropertyDescription( kOfxImageEffectInstancePropEffectDuration,   OFX::eDouble,  1, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropFrameRate,                OFX::eDouble,  1, eDescFinished ),
}

A list of properties to validate the plugin instance.

Definition at line 402 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gPluginInstancePropSet("Plugin Instance", gPluginInstanceProps, sizeof(gPluginInstanceProps)/sizeof(PropertyDescription), NULLPTR) [static]

the property set for a plugin instance

Referenced by validatePluginInstanceProperties().

PropertySetDescription OFX::Validation::gPushButtonParamPropSet("PushButton parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), NULLPTR) [static]

Property set for push button params.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gRenderActionInArgProps[] [static]

Initial value:

{
    PropertyDescription( kOfxPropTime,                     OFX::eDouble, 1, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropRenderScale,   OFX::eDouble, 2, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropRenderWindow,  OFX::eInt,    4, eDescFinished ),
    PropertyDescription( kOfxImageEffectPropFieldToRender, OFX::eString, 1, eDescFinished ),
}

kOfxImageEffectActionRender action's inargs properties

Definition at line 547 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gRenderActionInArgPropSet(kOfxImageEffectActionRender" in argument", gRenderActionInArgProps, sizeof(gRenderActionInArgProps)/sizeof(PropertyDescription), NULLPTR) [static]

kOfxImageEffectActionRender property set

Referenced by validateActionArgumentsProperties().

PropertyDescription OFX::Validation::gRGBAColourParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eDouble, 4, eDescFinished ),
    PropertyDescription( kOfxParamPropAnimates,             OFX::eInt,    1, eDescDefault, 1, eDescFinished ),
}

properties for an RGBA colour param

Definition at line 782 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gRGBAParamPropSet("RGB Colour parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gRGBAColourParamProps), NULLPTR) [static]

Property set for RGB colour params.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gRGBColourParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eDouble, 3, eDescFinished ),
    PropertyDescription( kOfxParamPropAnimates,             OFX::eInt,    1, eDescDefault, 1, eDescFinished ),
}

properties for an RGB colour param

Definition at line 775 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gRGBParamPropSet("RGB Colour parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gRGBColourParamProps), NULLPTR) [static]

Property set for RGB colour params.

Referenced by validateParameterProperties().

PropertyDescription OFX::Validation::gStringParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropDefault,              OFX::eString, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropAnimates,             OFX::eInt,    1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxParamPropStringMode,           OFX::eString, 1, eDescDefault, kOfxParamStringIsSingleLine, eDescFinished ),
    PropertyDescription( kOfxParamPropStringFilePathExists, OFX::eInt,    1, eDescDefault, 1, eDescFinished ),
}

values for a string param

Definition at line 759 of file ofxsPropertyValidation.cpp.

PropertySetDescription OFX::Validation::gStringParamPropSet("String parameter", mPropDescriptionArg(gBasicParamProps), mPropDescriptionArg(gInteractOverideParamProps), mPropDescriptionArg(gValueHolderParamProps), mPropDescriptionArg(gStringParamProps), NULLPTR) [static]

Property set for string params.

Referenced by initialise(), and validateParameterProperties().

PropertyDescription OFX::Validation::gValueHolderParamProps[] [static]

Initial value:

{
    PropertyDescription( kOfxParamPropIsAnimating,               OFX::eInt,    1, eDescFinished ),
    PropertyDescription( kOfxParamPropIsAutoKeying,              OFX::eInt,    1, eDescFinished ),
    PropertyDescription( kOfxParamPropPersistant,                OFX::eInt,    1, eDescDefault, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropEvaluateOnChange,          OFX::eInt,    1, eDescDefault, 1, eDescFinished ),
    PropertyDescription( kOfxParamPropPluginMayWrite,            OFX::eInt,    1, eDescDefault, 0, eDescFinished ),
    PropertyDescription( kOfxParamPropCacheInvalidation,         OFX::eString, 1, eDescDefault, kOfxParamInvalidateValueChange, eDescFinished ),
}

Props for params that can hold values.

Definition at line 748 of file ofxsPropertyValidation.cpp.

Data Structures

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

Function Documentation

Variable Documentation