TuttleOFX  1
Parameter Type definitions

Defines

#define kOfxAttributeTypeParam   "OfxAttributeTypeParam"
 String to identify an attribute as a parameter.
#define kOfxAttributeTypeClip   "OfxAttributeTypeClip"
 String to identify an attribute as a clip.
#define kOfxOutputAttributeName   "Output"
 String that is the name of the standard OFX output attribute.
#define kOfxSimpleSourceAttributeName   "Source"
 String that is the name of the standard OFX single source input attribute.
#define kOfxParamTypeInteger   "OfxParamTypeInteger"
 String to identify a param as a single valued integer.
#define kOfxParamTypeDouble   "OfxParamTypeDouble"
 String to identify a param as a Single valued floating point parameter.
#define kOfxParamTypeBoolean   "OfxParamTypeBoolean"
 String to identify a param as a Single valued boolean parameter.
#define kOfxParamTypeChoice   "OfxParamTypeChoice"
 String to identify a param as a Single valued, 'one-of-many' parameter.
#define kOfxParamTypeRGBA   "OfxParamTypeRGBA"
 String to identify a param as a Red, Green, Blue and Alpha colour parameter.
#define kOfxParamTypeRGB   "OfxParamTypeRGB"
 String to identify a param as a Red, Green and Blue colour parameter.
#define kOfxParamTypeDouble2D   "OfxParamTypeDouble2D"
 String to identify a param as a Two dimensional floating point parameter.
#define kOfxParamTypeInteger2D   "OfxParamTypeInteger2D"
 String to identify a param as a Two dimensional integer point parameter.
#define kOfxParamTypeDouble3D   "OfxParamTypeDouble3D"
 String to identify a param as a Three dimensional floating point parameter.
#define kOfxParamTypeInteger3D   "OfxParamTypeInteger3D"
 String to identify a param as a Three dimensional integer parameter.
#define kOfxParamTypeString   "OfxParamTypeString"
 String to identify a param as a String (UTF8) parameter.
#define kOfxParamTypeCustom   "OfxParamTypeCustom"
 String to identify a param as a Plug-in defined parameter.
#define kOfxParamTypeGroup   "OfxParamTypeGroup"
 String to identify a param as a Grouping parameter.
#define kOfxParamTypePage   "OfxParamTypePage"
 String to identify a param as a page parameter.
#define kOfxParamTypePushButton   "OfxParamTypePushButton"
 String to identify a param as a PushButton parameter.
#define kOfxParamTypeParametric   "OfxParamTypeParametric"
 String to identify a param as a single valued integer.

Detailed Description

These strings are used to identify the type of the attribute.

These strings are used to identify the type of the parameter when it is defined, they are also on the kOfxParamPropType in any parameter instance.


Define Documentation

#define kOfxAttributeTypeClip   "OfxAttributeTypeClip"

String to identify an attribute as a clip.

Definition at line 68 of file ofxAttribute.h.

#define kOfxAttributeTypeParam   "OfxAttributeTypeParam"

String to identify an attribute as a parameter.

Definition at line 66 of file ofxAttribute.h.

#define kOfxParamTypeBoolean   "OfxParamTypeBoolean"

String to identify a param as a Single valued boolean parameter.

Definition at line 72 of file ofxParam.h.

Referenced by OFX::mapParamTypeEnumToString(), OFX::mapParamTypeStringToEnum(), and tuttle::host::ImageEffectNode::newParam().

#define kOfxParamTypeChoice   "OfxParamTypeChoice"
#define kOfxParamTypeCustom   "OfxParamTypeCustom"
#define kOfxParamTypeDouble   "OfxParamTypeDouble"

String to identify a param as a Single valued floating point parameter.

Definition at line 70 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::isDoubleParam(), OFX::mapParamTypeEnumToString(), OFX::mapParamTypeStringToEnum(), and tuttle::host::ImageEffectNode::newParam().

#define kOfxParamTypeDouble2D   "OfxParamTypeDouble2D"

String to identify a param as a Two dimensional floating point parameter.

Definition at line 80 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::isDoubleParam(), OFX::mapParamTypeEnumToString(), OFX::mapParamTypeStringToEnum(), and tuttle::host::ImageEffectNode::newParam().

#define kOfxParamTypeDouble3D   "OfxParamTypeDouble3D"

String to identify a param as a Three dimensional floating point parameter.

Definition at line 84 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::isDoubleParam(), OFX::mapParamTypeEnumToString(), OFX::mapParamTypeStringToEnum(), and tuttle::host::ImageEffectNode::newParam().

#define kOfxParamTypeGroup   "OfxParamTypeGroup"
#define kOfxParamTypeInteger   "OfxParamTypeInteger"

String to identify a param as a single valued integer.

Definition at line 68 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::isIntParam(), OFX::mapParamTypeEnumToString(), OFX::mapParamTypeStringToEnum(), and tuttle::host::ImageEffectNode::newParam().

#define kOfxParamTypeInteger2D   "OfxParamTypeInteger2D"

String to identify a param as a Two dimensional integer point parameter.

Definition at line 82 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::isIntParam(), OFX::mapParamTypeEnumToString(), OFX::mapParamTypeStringToEnum(), and tuttle::host::ImageEffectNode::newParam().

#define kOfxParamTypeInteger3D   "OfxParamTypeInteger3D"

String to identify a param as a Three dimensional integer parameter.

Definition at line 86 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::isIntParam(), OFX::mapParamTypeEnumToString(), OFX::mapParamTypeStringToEnum(), and tuttle::host::ImageEffectNode::newParam().

#define kOfxParamTypePage   "OfxParamTypePage"
#define kOfxParamTypeParametric   "OfxParamTypeParametric"

String to identify a param as a single valued integer.

Definition at line 58 of file ofxParametricParam.h.

Referenced by OFX::mapParamTypeEnumToString(), and OFX::mapParamTypeStringToEnum().

#define kOfxParamTypePushButton   "OfxParamTypePushButton"

String to identify a param as a PushButton parameter.

Definition at line 96 of file ofxParam.h.

Referenced by sam::coutParameterWithDetails(), OFX::mapParamTypeEnumToString(), OFX::mapParamTypeStringToEnum(), and tuttle::host::ImageEffectNode::newParam().

#define kOfxParamTypeRGB   "OfxParamTypeRGB"

String to identify a param as a Red, Green and Blue colour parameter.

Definition at line 78 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::isColourParam(), OFX::mapParamTypeEnumToString(), OFX::mapParamTypeStringToEnum(), and tuttle::host::ImageEffectNode::newParam().

#define kOfxParamTypeRGBA   "OfxParamTypeRGBA"

String to identify a param as a Red, Green, Blue and Alpha colour parameter.

Definition at line 76 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::isColourParam(), OFX::mapParamTypeEnumToString(), OFX::mapParamTypeStringToEnum(), and tuttle::host::ImageEffectNode::newParam().

#define kOfxParamTypeString   "OfxParamTypeString"
#define kOfxSimpleSourceAttributeName   "Source"

String that is the name of the standard OFX single source input attribute.

Definition at line 74 of file ofxAttribute.h.

Referenced by tuttle::host::ImageEffectNode::getSingleInputAttribute().