ofxParametricParam.h File Reference

#include "ofxParam.h"

Include dependency graph for ofxParametricParam.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	OfxParametricParameterSuiteV1
	The OFX suite used to define and manipulate 'parametric' parameters. More...
Defines
#define	kOfxParametricParameterSuite   "OfxParametricParameterSuite"
	string value to the kOfxPropType property for all parameters
#define	kOfxParamTypeParametric   "OfxParamTypeParametric"
	String to identify a param as a single valued integer.
#define	kOfxParamPropParametricDimension   "OfxParamPropParametricDimension"
	The dimension of a parametric param.
#define	kOfxParamPropParametricUIColour   "OfxParamPropParametricUIColour"
	The colour of parametric param curve interface in any UI.
#define	kOfxParamPropParametricInteractBackground   "OfxParamPropParametricInteractBackground"
	Interact entry point to draw the background of a parametric parameter.
#define	kOfxParamHostPropSupportsParametricAnimation   "OfxParamHostPropSupportsParametricAnimation"
	Property on the host to indicate support for parametric parameter animation.
#define	kOfxParamPropParametricRange   "OfxParamPropParametricRange"
	Property to indicate the min and max range of the parametric input value.
Typedefs
typedef struct OfxParametricParameterSuiteV1	OfxParametricParameterSuiteV1
	The OFX suite used to define and manipulate 'parametric' parameters.

---

Detailed Description

This header file defines the optional OFX extension to define and manipulate parametric parameters.

Definition in file ofxParametricParam.h.

---

Define Documentation

#define kOfxParametricParameterSuite   "OfxParametricParameterSuite"

string value to the kOfxPropType property for all parameters

Definition at line 47 of file ofxParametricParam.h.

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

---

Typedef Documentation

typedef struct OfxParametricParameterSuiteV1 OfxParametricParameterSuiteV1

The OFX suite used to define and manipulate 'parametric' parameters.

This is an optional suite.

Parametric parameters are in effect 'functions' a plug-in can ask a host to arbitrarily evaluate for some value 'x'. A classic use case would be for constructing look-up tables, a plug-in would ask the host to evaluate one at multiple values from 0 to 1 and use that to fill an array.

A host would probably represent this to a user as a cubic curve in a standard curve editor interface, or possibly through scripting. The user would then use this to define the 'shape' of the parameter.

The evaluation of such params is not the same as animation, they are returning values based on some arbitrary argument orthogonal to time, so to evaluate such a param, you need to pass a parametric position and time.

Often, you would want such a parametric parameter to be multi-dimensional, for example, a colour look-up table might want three values, one for red, green and blue. Rather than declare three separate parametric parameters, it would be better to have one such parameter with multiple values in it.

The major complication with these parameters is how to allow a plug-in to set values, and defaults. The default default value of a parametric curve is to be an identity lookup. If a plugin wishes to set a different default value for a curve, it can use the suite to set key/value pairs on the descriptor of the param. When a new instance is made, it will have these curve values as a default.