For more details go see ParametersPage
#include "ofxCore.h"
#include "ofxProperty.h"
Go to the source code of this file.
Classes | |
struct | OfxParameterSuiteV1 |
The OFX suite used to define and manipulate user visible parameters. More... | |
Defines | |
#define | kOfxParameterSuite "OfxParameterSuite" |
string value to the kOfxPropType property for all parameters | |
#define | kOfxTypeParameter "OfxTypeParameter" |
string value on the kOfxPropType property for all parameter definitions (ie: the handle returned in describe) | |
#define | kOfxTypeParameterInstance "OfxTypeParameterInstance" |
string value on the kOfxPropType property for all parameter instances | |
#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 | kOfxParamHostPropSupportsCustomAnimation "OfxParamHostPropSupportsCustomAnimation" |
Indicates if the host supports animation of custom parameters. | |
#define | kOfxParamHostPropSupportsStringAnimation "OfxParamHostPropSupportsStringAnimation" |
Indicates if the host supports animation of string params. | |
#define | kOfxParamHostPropSupportsBooleanAnimation "OfxParamHostPropSupportsBooleanAnimation" |
Indicates if the host supports animation of boolean params. | |
#define | kOfxParamHostPropSupportsChoiceAnimation "OfxParamHostPropSupportsChoiceAnimation" |
Indicates if the host supports animation of choice params. | |
#define | kOfxParamHostPropSupportsCustomInteract "OfxParamHostPropSupportsCustomInteract" |
Indicates if the host supports custom interacts for parameters. | |
#define | kOfxParamHostPropMaxParameters "OfxParamHostPropMaxParameters" |
Indicates the maximum numbers of parameters available on the host. | |
#define | kOfxParamHostPropMaxPages "OfxParamHostPropMaxPages" |
Indicates the maximum number of parameter pages. | |
#define | kOfxParamHostPropPageRowColumnCount "OfxParamHostPropPageRowColumnCount" |
This indicates the number of parameter rows and coloumns on a page. | |
#define | kOfxParamPageSkipRow "OfxParamPageSkipRow" |
Pseudo parameter name used to skip a row in a page layout. | |
#define | kOfxParamPageSkipColumn "OfxParamPageSkipColumn" |
Pseudo parameter name used to skip a row in a page layout. | |
#define | kOfxParamPropInteractV1 "OfxParamPropInteractV1" |
Overrides the parameter's standard user interface with the given interact. | |
#define | kOfxParamPropInteractSize "OfxParamPropInteractSize" |
The size of a parameter instance's custom interface in screen pixels. | |
#define | kOfxParamPropInteractSizeAspect "OfxParamPropInteractSizeAspect" |
The prefered aspect ratio of a parameter's custom interface. | |
#define | kOfxParamPropInteractMinimumSize "OfxParamPropInteractMinimumSize" |
The minimum size of a parameter's custom interface, in screen pixels. | |
#define | kOfxParamPropInteractPreferedSize "OfxParamPropInteractPreferedSize" |
The prefered size of a parameter's custom interface. | |
#define | kOfxParamPropType "OfxParamPropType" |
The type of a parameter. | |
#define | kOfxParamPropAnimates "OfxParamPropAnimates" |
Flags whether a parameter can animate. | |
#define | kOfxParamPropCanUndo "OfxParamPropCanUndo" |
Flags whether changes to a parameter should be put on the undo/redo stack. | |
#define | kOfxParamPropIsAnimating "OfxParamPropIsAnimating" |
Flags whether a parameter is currently animating. | |
#define | kOfxParamPropPluginMayWrite "OfxParamPropPluginMayWrite" |
Flags whether the plugin will attempt to set the value of a parameter in some callback or analysis pass. | |
#define | kOfxParamPropPersistant "OfxParamPropPersistant" |
Flags whether the value of a parameter should persist. | |
#define | kOfxParamPropEvaluateOnChange "OfxParamPropEvaluateOnChange" |
Flags whether changing a parameter's value forces an evalution (ie: render),. | |
#define | kOfxParamPropSecret "OfxParamPropSecret" |
Flags whether a parameter should be exposed to a user,. | |
#define | kOfxParamPropScriptName "OfxParamPropScriptName" |
The value to be used as the id of the parameter in a host scripting language. | |
#define | kOfxParamPropCacheInvalidation "OfxParamPropCacheInvalidation" |
Specifies how modifying the value of a param will affect any output of an effect over time. | |
#define | kOfxParamInvalidateValueChange "OfxParamInvalidateValueChange" |
Used as a value for the kOfxParamPropCacheInvalidation property. | |
#define | kOfxParamInvalidateValueChangeToEnd "OfxParamInvalidateValueChangeToEnd" |
Used as a value for the kOfxParamPropCacheInvalidation property. | |
#define | kOfxParamInvalidateAll "OfxParamInvalidateAll" |
Used as a value for the kOfxParamPropCacheInvalidation property. | |
#define | kOfxParamPropHint "OfxParamPropHint" |
A hint to the user as to how the parameter is to be used. | |
#define | kOfxParamPropDefault "OfxParamPropDefault" |
The default value of a parameter. | |
#define | kOfxParamPropDoubleType "OfxParamPropDoubleType" |
Describes how the double parameter should be interpreted by a host. | |
#define | kOfxParamDoubleTypePlain "OfxParamDoubleTypePlain" |
value for the kOfxParamPropDoubleType property, indicating the parameter has no special interpretation and should be interpretted as a raw numeric value. | |
#define | kOfxParamDoubleTypeScale "OfxParamDoubleTypeScale" |
value for the kOfxParamPropDoubleType property, indicating the parameter is to be interpreted as a scale factor. See ParameterPropertiesDoubleTypes. | |
#define | kOfxParamDoubleTypeAngle "OfxParamDoubleTypeAngle" |
value for the kOfxParamDoubleTypeAngle property, indicating the parameter is to be interpreted as an angle. See ParameterPropertiesDoubleTypes. | |
#define | kOfxParamDoubleTypeTime "OfxParamDoubleTypeTime" |
value for the kOfxParamDoubleTypeAngle property, indicating the parameter is to be interpreted as a time. See ParameterPropertiesDoubleTypes. | |
#define | kOfxParamDoubleTypeAbsoluteTime "OfxParamDoubleTypeAbsoluteTime" |
value for the kOfxParamDoubleTypeAngle property, indicating the parameter is to be interpreted as an absolute time from the start of the effect. See ParameterPropertiesDoubleTypes. | |
#define | kOfxParamDoubleTypeNormalisedX "OfxParamDoubleTypeNormalisedX" |
value for the kOfxParamPropDoubleType property, indicating a size normalised to the X dimension. See ParameterPropertiesDoubleTypes. | |
#define | kOfxParamDoubleTypeNormalisedY "OfxParamDoubleTypeNormalisedY" |
value for the kOfxParamPropDoubleType property, indicating a size normalised to the Y dimension. See ParameterPropertiesDoubleTypes. | |
#define | kOfxParamDoubleTypeNormalisedXAbsolute "OfxParamDoubleTypeNormalisedXAbsolute" |
value for the kOfxParamPropDoubleType property, indicating an absolute position normalised to the X dimension. See ParameterPropertiesDoubleTypes. | |
#define | kOfxParamDoubleTypeNormalisedYAbsolute "OfxParamDoubleTypeNormalisedYAbsolute" |
value for the kOfxParamPropDoubleType property, indicating an absolute position normalised to the Y dimension. See ParameterPropertiesDoubleTypes. | |
#define | kOfxParamDoubleTypeNormalisedXY "OfxParamDoubleTypeNormalisedXY" |
value for the kOfxParamPropDoubleType property, indicating normalisation to the X and Y dimension for 2D params. See ParameterPropertiesDoubleTypes. | |
#define | kOfxParamDoubleTypeNormalisedXYAbsolute "OfxParamDoubleTypeNormalisedXYAbsolute" |
value for the kOfxParamPropDoubleType property, indicating normalisation to the X and Y dimension for a 2D param that can be interpretted as an absolute spatial position. See ParameterPropertiesDoubleTypes. | |
#define | kOfxParamPropShowTimeMarker "OfxParamPropShowTimeMarker" |
Enables the display of a time marker on the host's time line to indicate the value of the absolute time param. | |
#define | kOfxPluginPropParamPageOrder "OfxPluginPropParamPageOrder" |
Sets the parameter pages and order of pages. | |
#define | kOfxParamPropPageChild "OfxParamPropPageChild" |
The names of the parameters included in a page parameter. | |
#define | kOfxParamPropParent "OfxParamPropParent" |
The name of a parameter's parent group. | |
#define | kOfxParamPropEnabled "OfxParamPropEnabled" |
Used to enable a parameter in the user interface. | |
#define | kOfxParamPropDataPtr "OfxParamPropDataPtr" |
A private data pointer that the plug-in can store it's own data behind. | |
#define | kOfxParamPropChoiceOption "OfxParamPropChoiceOption" |
Set an option in a choice parameter. | |
#define | kOfxParamPropMin "OfxParamPropMin" |
The minimum value for a numeric parameter. | |
#define | kOfxParamPropMax "OfxParamPropMax" |
The maximum value for a numeric parameter. | |
#define | kOfxParamPropDisplayMin "OfxParamPropDisplayMin" |
The minimum value for a numeric parameter on any user interface. | |
#define | kOfxParamPropDisplayMax "OfxParamPropDisplayMax" |
The maximum value for a numeric parameter on any user interface. | |
#define | kOfxParamPropIncrement "OfxParamPropIncrement" |
The granularity of a slider used to represent a numeric parameter. | |
#define | kOfxParamPropDigits "OfxParamPropDigits" |
How many digits after a decimal point to display for a double param in a GUI. | |
#define | kOfxParamPropDimensionLabel "OfxParamPropDimensionLabel" |
Label for individual dimensions on a multidimensional numeric parameter. | |
#define | kOfxParamPropIsAutoKeying "OfxParamPropIsAutoKeying" |
Will a value change on the parameter add automatic keyframes. | |
#define | kOfxParamPropCustomInterpCallbackV1 "OfxParamPropCustomCallbackV1" |
A pointer to a custom parameter's interpolation function. | |
#define | kOfxParamPropStringMode "OfxParamPropStringMode" |
Used to indicate the type of a string parameter. | |
#define | kOfxParamPropStringFilePathExists "OfxParamPropStringFilePathExists" |
Indicates string parameters of file or directory type need that file to exist already. | |
#define | kOfxParamStringIsSingleLine "OfxParamStringIsSingleLine" |
Used to set a string parameter to be single line, value to be passed to a kOfxParamPropStringMode property. | |
#define | kOfxParamStringIsMultiLine "OfxParamStringIsMultiLine" |
Used to set a string parameter to be multiple line, value to be passed to a kOfxParamPropStringMode property. | |
#define | kOfxParamStringIsFilePath "OfxParamStringIsFilePath" |
Used to set a string parameter to be a file path, value to be passed to a kOfxParamPropStringMode property. | |
#define | kOfxParamStringIsDirectoryPath "OfxParamStringIsDirectoryPath" |
Used to set a string parameter to be a directory path, value to be passed to a kOfxParamPropStringMode property. | |
#define | kOfxParamStringIsLabel "OfxParamStringIsLabel" |
Use to set a string parameter to be a simple label, value to be passed to a kOfxParamPropStringMode property. | |
#define | kOfxParamPropCustomValue "OfxParamPropCustomValue" |
Used by interpolating custom parameters to get and set interpolated values.
| |
#define | kOfxParamPropInterpolationTime "OfxParamPropInterpolationTime" |
Used by interpolating custom parameters to indicate the time a key occurs at. | |
#define | kOfxParamPropInterpolationAmount "OfxParamPropInterpolationAmount" |
Property used by OfxCustomParamInterpFuncV1 to indicate the amount of interpolation to perform. | |
Typedefs | |
typedef struct OfxParamStruct * | OfxParamHandle |
Blind declaration of an OFX param. | |
typedef struct OfxParamSetStruct * | OfxParamSetHandle |
Blind declaration of an OFX parameter set. | |
typedef OfxStatus( | OfxCustomParamInterpFuncV1 )(OfxParamSetHandle instance, OfxPropertySetHandle inArgs, OfxPropertySetHandle outArgs) |
Function prototype for custom parameter interpolation callback functions. |
#define kOfxParameterSuite "OfxParameterSuite" |
string value to the kOfxPropType property for all parameters
#define kOfxTypeParameter "OfxTypeParameter" |
string value on the kOfxPropType property for all parameter definitions (ie: the handle returned in describe)
#define kOfxTypeParameterInstance "OfxTypeParameterInstance" |
string value on the kOfxPropType property for all parameter instances
typedef OfxStatus( OfxCustomParamInterpFuncV1)(OfxParamSetHandle instance, OfxPropertySetHandle inArgs, OfxPropertySetHandle outArgs) |
Function prototype for custom parameter interpolation callback functions.
The plugin needs to parse the two strings encoding keyframes on either side of the time we need a value for. It should then interpolate a new value for it, encode it into a string and set the kOfxParamPropCustomValue property with this on the outArgs handle.
The interp value is a linear interpolation amount, however his may be derived from a cubic (or other) curve.
typedef struct OfxParamStruct* OfxParamHandle |
Blind declaration of an OFX param.
typedef struct OfxParamSetStruct* OfxParamSetHandle |
Blind declaration of an OFX parameter set.