The OFX suite used to define and manipulate user visible parameters. More...

#include <ofxParam.h>

Data Fields
OfxStatus(*	paramDefine )(OfxParamSetHandle paramSet, const char paramType, const char name, OfxPropertySetHandle *propertySet)
	Defines a new parameter of the given type in a describe action.
OfxStatus(*	paramGetHandle )(OfxParamSetHandle paramSet, const char name, OfxParamHandle param, OfxPropertySetHandle *propertySet)
	Retrieves the handle for a parameter in a given parameter set.
OfxStatus(*	paramSetGetPropertySet )(OfxParamSetHandle paramSet, OfxPropertySetHandle *propHandle)
	Retrieves the property set handle for the given parameter set.
OfxStatus(*	paramGetPropertySet )(OfxParamHandle param, OfxPropertySetHandle *propHandle)
	Retrieves the property set handle for the given parameter.
OfxStatus(*	paramGetValue )(OfxParamHandle paramHandle,...)
	Gets the current value of a parameter,.
OfxStatus(*	paramGetValueAtTime )(OfxParamHandle paramHandle, OfxTime time,...)
	Gets the value of a parameter at a specific time.
OfxStatus(*	paramGetDerivative )(OfxParamHandle paramHandle, OfxTime time,...)
	Gets the derivative of a parameter at a specific time.
OfxStatus(*	paramGetIntegral )(OfxParamHandle paramHandle, OfxTime time1, OfxTime time2,...)
	Gets the integral of a parameter over a specific time range,.
OfxStatus(*	paramSetValue )(OfxParamHandle paramHandle,...)
	Sets the current value of a parameter.
OfxStatus(*	paramSetValueAtTime )(OfxParamHandle paramHandle, OfxTime time,...)
	Keyframes the value of a parameter at a specific time.
OfxStatus(*	paramGetNumKeys )(OfxParamHandle paramHandle, unsigned int *numberOfKeys)
	Returns the number of keyframes in the parameter.
OfxStatus(*	paramGetKeyTime )(OfxParamHandle paramHandle, unsigned int nthKey, OfxTime *time)
	Returns the time of the nth key.
OfxStatus(*	paramGetKeyIndex )(OfxParamHandle paramHandle, OfxTime time, int direction, int *index)
	Finds the index of a keyframe at/before/after a specified time.
OfxStatus(*	paramDeleteKey )(OfxParamHandle paramHandle, OfxTime time)
	Deletes a keyframe if one exists at the given time.
OfxStatus(*	paramDeleteAllKeys )(OfxParamHandle paramHandle)
	Deletes all keyframes from a parameter.
OfxStatus(*	paramCopy )(OfxParamHandle paramTo, OfxParamHandle paramFrom, OfxTime dstOffset, OfxRangeD *frameRange)
	Copies one parameter to another, including any animation etc...
OfxStatus(*	paramEditBegin )(OfxParamSetHandle paramSet, const char *name)
	Used to group any parameter changes for undo/redo purposes.
OfxStatus(*	paramEditEnd )(OfxParamSetHandle paramSet)
	Used to group any parameter changes for undo/redo purposes.

Detailed Description

The OFX suite used to define and manipulate user visible parameters.

Definition at line 872 of file ofxParam.h.

Field Documentation

OfxStatus( * OfxParameterSuiteV1::paramCopy)(OfxParamHandle paramTo, OfxParamHandle paramFrom, OfxTime dstOffset, OfxRangeD *frameRange)

Copies one parameter to another, including any animation etc...

paramTo parameter to set
paramFrom parameter to copy from
dstOffset temporal offset to apply to keys when writing to the paramTo
frameRange if paramFrom has animation, and frameRange is not null, only this range of keys will be copied

This copies the value of paramFrom to paramTo, including any animation it may have. All the previous values in paramTo will be lost.

To choose all animation in paramFrom set frameRange to [0, 0]

This function can be called the kOfxActionInstanceChanged action and during image effect analysis render passes.

Precondition:

Both parameters must be of the same type.

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid

Definition at line 1178 of file ofxParam.h.

OfxStatus( * OfxParameterSuiteV1::paramDefine)(OfxParamSetHandle paramSet, const char *paramType, const char *name, OfxPropertySetHandle *propertySet)

Defines a new parameter of the given type in a describe action.

paramSet handle to the parameter set descriptor that will hold this parameter
paramType type of the parameter to create, one of the kOfxParamType* #defines
name unique name of the parameter
propertySet if not null, a pointer to the parameter descriptor's property set will be placed here.

This function defines a parameter in a parameter set and returns a property set which is used to describe that parameter.

This function does not actually create a parameter, it only says that one should exist in any subsequent instances. To fetch an parameter instance paramGetHandle must be called on an instance.

This function can always be called in one of a plug-in's 'describe' functions which defines the parameter sets common to all instances of a plugin.

Returns:

kOfxStatOK - the parameter was created correctly
kOfxStatErrBadHandle - if the plugin handle was invalid
kOfxStatErrExists - if a parameter of that name exists already in this plugin
kOfxStatErrUnknown - if the type is unknown
kOfxStatErrUnsupported - if the type is known but unsupported

Definition at line 895 of file ofxParam.h.

Referenced by OFX::ParamSetDescriptor::defineRawParam().

OfxStatus( * OfxParameterSuiteV1::paramDeleteAllKeys)(OfxParamHandle paramHandle)

Deletes all keyframes from a parameter.

paramHandle parameter handle to delete the keys from
name parameter to delete the keyframes frome is

This function can be called the kOfxActionInstanceChanged action and during image effect analysis render passes.

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid

Definition at line 1156 of file ofxParam.h.

Referenced by OFX::ValueParam::deleteAllKeys().

OfxStatus( * OfxParameterSuiteV1::paramDeleteKey)(OfxParamHandle paramHandle, OfxTime time)

Deletes a keyframe if one exists at the given time.

paramHandle parameter handle to delete the key from
time time at which a keyframe is

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid
kOfxStatErrBadIndex - no key at the given time

Definition at line 1142 of file ofxParam.h.

Referenced by OFX::ValueParam::deleteKeyAtTime().

OfxStatus( * OfxParameterSuiteV1::paramEditBegin)(OfxParamSetHandle paramSet, const char *name)

Used to group any parameter changes for undo/redo purposes.

paramSet the parameter set in which this is happening
name label to attach to any undo/redo string UTF8

If a plugin calls paramSetValue/paramSetValueAtTime on one or more parameters, either from custom GUI interaction or some analysis of imagery etc.. this is used to indicate the start of a set of a parameter changes that should be considered part of a single undo/redo block.

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the instance handle was invalid

Definition at line 1197 of file ofxParam.h.

Referenced by OFX::ParamSet::beginEditBlock().

OfxStatus( * OfxParameterSuiteV1::paramEditEnd)(OfxParamSetHandle paramSet)

Used to group any parameter changes for undo/redo purposes.

paramSet the parameter set in which this is happening

If a plugin calls paramSetValue/paramSetValueAtTime on one or more parameters, either from custom GUI interaction or some analysis of imagery etc.. this is used to indicate the end of a set of parameter changes that should be considerred part of a single undo/redo block

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the instance handle was invalid

Definition at line 1214 of file ofxParam.h.

Referenced by OFX::ParamSet::endEditBlock().

OfxStatus( * OfxParameterSuiteV1::paramGetDerivative)(OfxParamHandle paramHandle, OfxTime time,...)

Gets the derivative of a parameter at a specific time.

paramHandle parameter handle to fetch value from
time at what point in time to look up the parameter
... one or more pointers to variables of the relevant type to hold the parameter's derivative

This gets the derivative of the parameter at the indicated time.

The varargs needs to be pointer to C variables of the relevant type for this parameter. See OfxParameterSuiteV1::paramGetValue for notes on the varags list.

Only double and colour params can have their derivatives found.

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid

Definition at line 1012 of file ofxParam.h.

Referenced by OFX::DoubleParam::differentiate(), OFX::Double2DParam::differentiate(), and OFX::Double3DParam::differentiate().

OfxStatus( * OfxParameterSuiteV1::paramGetHandle)(OfxParamSetHandle paramSet, const char *name, OfxParamHandle *param, OfxPropertySetHandle *propertySet)

Retrieves the handle for a parameter in a given parameter set.

paramSet instance of the plug-in to fetch the property handle from
name parameter to ask about
param pointer to a param handle, the value is returned here
propertySet if not null, a pointer to the parameter's property set will be placed here.

Parameter handles retrieved from an instance are always distinct in each instance. The paramter handle is valid for the life-time of the instance. Parameter handles in instances are distinct from paramter handles in plugins. You cannot call this in a plugin's describe function, as it needs an instance to work on.

Returns:

kOfxStatOK - the parameter was found and returned
kOfxStatErrBadHandle - if the plugin handle was invalid
kOfxStatErrUnknown - if the type is unknown

Definition at line 914 of file ofxParam.h.

Referenced by OFX::ParamSet::fetchRawParam(), OFX::ParamSet::getParam(), OFX::ParamSet::getParamType(), OFX::ParamSet::paramExists(), and OFX::ParametricParamDescriptor::setParamSet().

OfxStatus( * OfxParameterSuiteV1::paramGetIntegral)(OfxParamHandle paramHandle, OfxTime time1, OfxTime time2,...)

Gets the integral of a parameter over a specific time range,.

paramHandle parameter handle to fetch integral from
time1 where to start evaluating the integral
time2 where to stop evaluating the integral
... one or more pointers to variables of the relevant type to hold the parameter's integral

This gets the integral of the parameter over the specified time range.

The varargs needs to be pointer to C variables of the relevant type for this parameter. See OfxParameterSuiteV1::paramGetValue for notes on the varags list.

Only double and colour params can be integrated.

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid

Definition at line 1035 of file ofxParam.h.

Referenced by OFX::DoubleParam::integrate(), OFX::Double2DParam::integrate(), and OFX::Double3DParam::integrate().

OfxStatus( * OfxParameterSuiteV1::paramGetKeyIndex)(OfxParamHandle paramHandle, OfxTime time, int direction, int *index)

Finds the index of a keyframe at/before/after a specified time.

paramHandle parameter handle to search
time what time to search from
direction
- == 0 indicates search for a key at the indicated time (some small delta)
- > 0 indicates search for the next key after the indicated time
- < 0 indicates search for the previous key before the indicated time
index pointer to an integer which in which the index is returned set to -1 if no key was found

Returns:

kOfxStatOK - all was OK
kOfxStatFailed - if the search failed to find a key
kOfxStatErrBadHandle - if the parameter handle was invalid

Definition at line 1127 of file ofxParam.h.

Referenced by OFX::ValueParam::getKeyIndex().

OfxStatus( * OfxParameterSuiteV1::paramGetKeyTime)(OfxParamHandle paramHandle, unsigned int nthKey, OfxTime *time)

Returns the time of the nth key.

paramHandle parameter handle to interogate
nthKey which key to ask about (0 to paramGetNumKeys -1), ordered by time
time pointer to OfxTime where the return value is placed

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid
kOfxStatErrBadIndex - the nthKey does not exist

Definition at line 1107 of file ofxParam.h.

Referenced by OFX::ValueParam::getKeyTime().

OfxStatus( * OfxParameterSuiteV1::paramGetNumKeys)(OfxParamHandle paramHandle, unsigned int *numberOfKeys)

Returns the number of keyframes in the parameter.

paramHandle parameter handle to interogate
numberOfKeys pointer to integer where the return value is placed

This function can be called the kOfxActionInstanceChanged action and during image effect analysis render passes.

Returns the number of keyframes in the parameter.

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid

Definition at line 1093 of file ofxParam.h.

Referenced by OFX::ValueParam::getNumKeys().

OfxStatus( * OfxParameterSuiteV1::paramGetPropertySet)(OfxParamHandle param, OfxPropertySetHandle *propHandle)

Retrieves the property set handle for the given parameter.

param parameter to get the property set for
propHandle pointer to a the property set handle, value is returedn her

The property handle is valid for the lifetime of the parameter, which is the lifetime of the instance that owns the parameter

Returns:

kOfxStatOK - the property set was found and returned
kOfxStatErrBadHandle - if the paramter handle was invalid
kOfxStatErrUnknown - if the type is unknown

Definition at line 946 of file ofxParam.h.

Referenced by OFX::Param::Param().

OfxStatus( * OfxParameterSuiteV1::paramGetValue)(OfxParamHandle paramHandle,...)

Gets the current value of a parameter,.

paramHandle parameter handle to fetch value from
... one or more pointers to variables of the relevant type to hold the parameter's value

This gets the current value of a parameter. The varargs ... argument needs to be pointer to C variables of the relevant type for this parameter. Note that params with multiple values (eg Colour) take multiple args here. For example...

	 * OfxParamHandle myDoubleParam, *myColourParam;
	 * ofxHost->paramGetHandle(instance, "myDoubleParam", &myDoubleParam);
	 * double myDoubleValue;
	 * ofxHost->paramGetValue(myDoubleParam, &myDoubleValue);
	 * ofxHost->paramGetHandle(instance, "myColourParam", &myColourParam);
	 * double myR, myG, myB;
	 * ofxHost->paramGetValue(myColourParam, &myR, &myG, &myB);
	 *

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid

Definition at line 972 of file ofxParam.h.

Referenced by OFX::StringParam::getPointerValue(), 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(), and OFX::CustomParam::getValue().

OfxStatus( * OfxParameterSuiteV1::paramGetValueAtTime)(OfxParamHandle paramHandle, OfxTime time,...)

Gets the value of a parameter at a specific time.

paramHandle parameter handle to fetch value from
time at what point in time to look up the parameter
... one or more pointers to variables of the relevant type to hold the parameter's value

This gets the current value of a parameter. The varargs needs to be pointer to C variables of the relevant type for this parameter. See OfxParameterSuiteV1::paramGetValue for notes on the varags list

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid

Definition at line 990 of file ofxParam.h.

Referenced by OFX::StringParam::getPointerValueAtTime(), 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(), and OFX::CustomParam::getValueAtTime().

OfxStatus( * OfxParameterSuiteV1::paramSetGetPropertySet)(OfxParamSetHandle paramSet, OfxPropertySetHandle *propHandle)

Retrieves the property set handle for the given parameter set.

paramSet parameter set to get the property set for
propHandle pointer to a the property set handle, value is returedn her

Note:: The property handle belonging to a parameter set is the same as the property handle belonging to the plugin instance.

Returns:

kOfxStatOK - the property set was found and returned
kOfxStatErrBadHandle - if the paramter handle was invalid
kOfxStatErrUnknown - if the type is unknown

Definition at line 931 of file ofxParam.h.

Referenced by OFX::ParamSetDescriptor::setOfxParamSetHandle(), and OFX::ParamSet::setParamSetHandle().

OfxStatus( * OfxParameterSuiteV1::paramSetValue)(OfxParamHandle paramHandle,...)

Sets the current value of a parameter.

paramHandle parameter handle to set value in
... one or more variables of the relevant type to hold the parameter's value

This sets the current value of a parameter. The varargs ... argument needs to be values of the relevant type for this parameter. Note that params with multiple values (eg Colour) take multiple args here. For example...

	 * ofxHost->paramSetValue(instance, "myDoubleParam", double(10));
	 * ofxHost->paramSetValue(instance, "myColourParam", double(pix.r), double(pix.g), double(pix.b));
	 *

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid

Definition at line 1056 of file ofxParam.h.

Referenced by 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(), and OFX::CustomParam::setValue().

OfxStatus( * OfxParameterSuiteV1::paramSetValueAtTime)(OfxParamHandle paramHandle, OfxTime time,...)

Keyframes the value of a parameter at a specific time.

paramHandle parameter handle to set value in
time at what point in time to set the keyframe
... one or more variables of the relevant type to hold the parameter's value

This sets a keyframe in the parameter at the indicated time to have the indicated value. The varargs ... argument needs to be values of the relevant type for this parameter. See the note on OfxParameterSuiteV1::paramSetValue for more detail

This function can be called the kOfxActionInstanceChanged action and during image effect analysis render passes.

Returns:

kOfxStatOK - all was OK
kOfxStatErrBadHandle - if the parameter handle was invalid

Definition at line 1075 of file ofxParam.h.

Referenced by 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(), and OFX::CustomParam::setValueAtTime().

The documentation for this struct was generated from the following file:

libraries/openfxHack/include/ofxParam.h

Data Fields

Detailed Description

Field Documentation