Parameter Property Definitions
[Ofx Properties]


Detailed Description

These are the list of properties used by the parameters suite.


Defines

#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.
  • Type - C string X 1 or 2.

#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.


Define Documentation

#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 kOfxParamDoubleTypeAngle   "OfxParamDoubleTypeAngle"

value for the kOfxParamDoubleTypeAngle property, indicating the parameter is to be interpreted as an angle. See ParameterPropertiesDoubleTypes.

#define kOfxParamDoubleTypeNormalisedX   "OfxParamDoubleTypeNormalisedX"

value for the kOfxParamPropDoubleType property, indicating a size normalised to the X dimension. See ParameterPropertiesDoubleTypes.

#define kOfxParamDoubleTypeNormalisedXAbsolute   "OfxParamDoubleTypeNormalisedXAbsolute"

value for the kOfxParamPropDoubleType property, indicating an absolute position normalised to the X 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 kOfxParamDoubleTypeNormalisedY   "OfxParamDoubleTypeNormalisedY"

value for the kOfxParamPropDoubleType property, indicating a size normalised to the Y dimension. See ParameterPropertiesDoubleTypes.

#define kOfxParamDoubleTypeNormalisedYAbsolute   "OfxParamDoubleTypeNormalisedYAbsolute"

value for the kOfxParamPropDoubleType property, indicating an absolute position normalised to the Y dimension. See ParameterPropertiesDoubleTypes.

#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 kOfxParamDoubleTypeTime   "OfxParamDoubleTypeTime"

value for the kOfxParamDoubleTypeAngle property, indicating the parameter is to be interpreted as a time. See ParameterPropertiesDoubleTypes.

#define kOfxParamHostPropMaxPages   "OfxParamHostPropMaxPages"

Indicates the maximum number of parameter pages.

  • Type - int X 1
  • Property Set - host descriptor (read only)

If there is no limit to the number of pages on a host, set this to -1.

Hosts that do not support paged parameter layout should set this to zero.

#define kOfxParamHostPropMaxParameters   "OfxParamHostPropMaxParameters"

Indicates the maximum numbers of parameters available on the host.

  • Type - int X 1
  • Property Set - host descriptor (read only)

If set to -1 it implies unlimited number of parameters.

#define kOfxParamHostPropPageRowColumnCount   "OfxParamHostPropPageRowColumnCount"

This indicates the number of parameter rows and coloumns on a page.

  • Type - int X 2
  • Property Set - host descriptor (read only)

If the host has supports paged parameter layout, used dimension 0 as the number of columns per page and dimension 2 as the number of rows per page.

#define kOfxParamHostPropSupportsBooleanAnimation   "OfxParamHostPropSupportsBooleanAnimation"

Indicates if the host supports animation of boolean params.

  • Type - int X 1
  • Property Set - host descriptor (read only)
  • Valid Values - 0 or 1

#define kOfxParamHostPropSupportsChoiceAnimation   "OfxParamHostPropSupportsChoiceAnimation"

Indicates if the host supports animation of choice params.

  • Type - int X 1
  • Property Set - host descriptor (read only)
  • Valid Values - 0 or 1

#define kOfxParamHostPropSupportsCustomAnimation   "OfxParamHostPropSupportsCustomAnimation"

Indicates if the host supports animation of custom parameters.

  • Type - int X 1
  • Property Set - host descriptor (read only)
  • Value Values - 0 or 1

#define kOfxParamHostPropSupportsCustomInteract   "OfxParamHostPropSupportsCustomInteract"

Indicates if the host supports custom interacts for parameters.

  • Type - int X 1
  • Property Set - host descriptor (read only)
  • Valid Values - 0 or 1

#define kOfxParamHostPropSupportsStringAnimation   "OfxParamHostPropSupportsStringAnimation"

Indicates if the host supports animation of string params.

  • Type - int X 1
  • Property Set - host descriptor (read only)
  • Valid Values - 0 or 1

#define kOfxParamInvalidateAll   "OfxParamInvalidateAll"

Used as a value for the kOfxParamPropCacheInvalidation property.

#define kOfxParamInvalidateValueChange   "OfxParamInvalidateValueChange"

Used as a value for the kOfxParamPropCacheInvalidation property.

#define kOfxParamInvalidateValueChangeToEnd   "OfxParamInvalidateValueChangeToEnd"

Used as a value for the kOfxParamPropCacheInvalidation property.

#define kOfxParamPageSkipColumn   "OfxParamPageSkipColumn"

Pseudo parameter name used to skip a row in a page layout.

Passed as a value to the kOfxParamPropPageChild property.

See ParametersInterfacesPagedLayouts for more details.

#define kOfxParamPageSkipRow   "OfxParamPageSkipRow"

Pseudo parameter name used to skip a row in a page layout.

Passed as a value to the kOfxParamPropPageChild property.

See ParametersInterfacesPagedLayouts for more details.

#define kOfxParamPropAnimates   "OfxParamPropAnimates"

Flags whether a parameter can animate.

  • Type - int x 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read only)
  • Default - 1
  • Valid Values - 0 or 1

A plug-in uses this property to indicate if a parameter is able to animate.

#define kOfxParamPropCacheInvalidation   "OfxParamPropCacheInvalidation"

Specifies how modifying the value of a param will affect any output of an effect over time.

Imagine an effect with an animating parameter in a host that caches rendered output. Think of the what happens when you add a new key frame. -If the parameter represents something like an absolute position, the cache will only need to be invalidated for the range of frames that keyframe affects.

  • If the parameter represents something like a speed which is integrated, the cache will be invalidated from the keyframe until the end of the clip.
  • There are potentially other situations where the entire cache will need to be invalidated (though I can't think of one off the top of my head).

#define kOfxParamPropCanUndo   "OfxParamPropCanUndo"

Flags whether changes to a parameter should be put on the undo/redo stack.

  • Type - int x 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read only)
  • Default - 1
  • Valid Values - 0 or 1

#define kOfxParamPropChoiceOption   "OfxParamPropChoiceOption"

Set an option in a choice parameter.

  • Type - UTF8 C string X N
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write),
  • Default - the property is empty with no options set.

This property contains the set of options that will be presented to a user from a choice parameter. See ParametersChoice for more details.

#define kOfxParamPropCustomInterpCallbackV1   "OfxParamPropCustomCallbackV1"

A pointer to a custom parameter's interpolation function.

  • Type - pointer X 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read only),
  • Default - NULL
  • Valid Values - must point to a OfxCustomParamInterpFuncV1

It is an error not to set this property in a custom parameter during a plugin's define call if the custom parameter declares itself to be an animating parameter.

#define kOfxParamPropCustomValue   "OfxParamPropCustomValue"

Used by interpolating custom parameters to get and set interpolated values.

  • Type - C string X 1 or 2.

This property is on the inArgs property and outArgs property of a OfxCustomParamInterpFuncV1 and in both cases contains the encoded value of a custom parameter. As an inArgs property it will have two values, being the two keyframes to interpolate. As an outArgs property it will have a single value and the plugin should fill this with the encoded interpolated value of the parameter.

#define kOfxParamPropDataPtr   "OfxParamPropDataPtr"

A private data pointer that the plug-in can store it's own data behind.

  • Type - pointer X 1
  • Property Set - plugin parameter instance (read/write),
  • Default - NULL

This data pointer is unique to each parameter instance, so two instances of the same parameter do not share the same data pointer. Use it to hang any needed private data structures.

#define kOfxParamPropDefault   "OfxParamPropDefault"

The default value of a parameter.

  • Type - The type is dependant on the parameter type as is the dimension.
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write only),
  • Default - 0 cast to the relevant type (or "" for strings and custom parameters)

The exact type and dimension is dependant on the type of the parameter. These are....

#define kOfxParamPropDigits   "OfxParamPropDigits"

How many digits after a decimal point to display for a double param in a GUI.

  • Type - int X 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write),
  • Default - 2
  • Valid Values - any greater than 0.

This applies to double params of any dimension.

#define kOfxParamPropDimensionLabel   "OfxParamPropDimensionLabel"

Label for individual dimensions on a multidimensional numeric parameter.

  • Type - UTF8 C string X 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read only),
  • Default - "x", "y" and "z"
  • Valid Values - any

Use this on 2D and 3D double and integer parameters to change the label on an individual dimension in any GUI for that parameter.

#define kOfxParamPropDisplayMax   "OfxParamPropDisplayMax"

The maximum value for a numeric parameter on any user interface.

  • Type - int or double X N
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write),
  • Default - the largest possible value corresponding to the parameter type (eg: INT_MIN for an integer, -DBL_MAX for a double parameter)

If a user interface represents a parameter with a slider or similar, this should be the maximum bound on that slider.

#define kOfxParamPropDisplayMin   "OfxParamPropDisplayMin"

The minimum value for a numeric parameter on any user interface.

  • Type - int or double X N
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write),
  • Default - the smallest possible value corresponding to the parameter type (eg: INT_MIN for an integer, -DBL_MAX for a double parameter)

If a user interface represents a parameter with a slider or similar, this should be the minumum bound on that slider.

#define kOfxParamPropDoubleType   "OfxParamPropDoubleType"

Describes how the double parameter should be interpreted by a host.

Double parameters can be interpreted in several different ways, this property tells the host how to do so and thus gives hints as to the interface of the parameter.

#define kOfxParamPropEnabled   "OfxParamPropEnabled"

Used to enable a parameter in the user interface.

  • Type - int X 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write),
  • Default - 1
  • Valid Values - 0 or 1

When set to 0 a user should not be able to modify the value of the parameter. Note that the plug-in itself can still change the value of a disabled parameter.

#define kOfxParamPropEvaluateOnChange   "OfxParamPropEvaluateOnChange"

Flags whether changing a parameter's value forces an evalution (ie: render),.

  • Type - int x 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write only)
  • Default - 1
  • Valid Values - 0 or 1

This is used to indicate if the value of a parameter has any affect on an effect's output, eg: the parameter may be purely for GUI purposes, and so changing it's value should not trigger a re-render.

#define kOfxParamPropHint   "OfxParamPropHint"

A hint to the user as to how the parameter is to be used.

  • Type - UTF8 C string X 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write),
  • Default - ""

#define kOfxParamPropIncrement   "OfxParamPropIncrement"

The granularity of a slider used to represent a numeric parameter.

  • Type - double X 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write),
  • Default - 1
  • Valid Values - any greater than 0.

This value is always in cannonical coordinates for double parameters that are normalised.

#define kOfxParamPropInteractMinimumSize   "OfxParamPropInteractMinimumSize"

The minimum size of a parameter's custom interface, in screen pixels.

  • Type - int x 2
  • Property Set - plugin parameter descriptor (read/write) and instance (read only)
  • Default - 10,10
  • Valid Values - greater than (0, 0)

Any custom interface will not be less than this size.

#define kOfxParamPropInteractPreferedSize   "OfxParamPropInteractPreferedSize"

The prefered size of a parameter's custom interface.

  • Type - int x 2
  • Property Set - plugin parameter descriptor (read/write) and instance (read only)
  • Default - 10,10
  • Valid Values - greater than (0, 0)

A host should attempt to set a parameter's custom interface on a parameter to be this size if possible, otherwise it will be of kOfxParamPropInteractSizeAspect aspect but larger than kOfxParamPropInteractMinimumSize.

#define kOfxParamPropInteractSize   "OfxParamPropInteractSize"

The size of a parameter instance's custom interface in screen pixels.

  • Type - double x 2
  • Property Set - plugin parameter instance (read only)

This is set by a host to indicate the current size of a custom interface if the plug-in has one. If not this is set to (0,0).

#define kOfxParamPropInteractSizeAspect   "OfxParamPropInteractSizeAspect"

The prefered aspect ratio of a parameter's custom interface.

  • Type - double x 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read only)
  • Default - 1.0
  • Valid Values - greater than or equal to 0.0

If set to anything other than 0.0, the custom interface for this parameter will be of a size with this aspect ratio (x size/y size).

#define kOfxParamPropInteractV1   "OfxParamPropInteractV1"

Overrides the parameter's standard user interface with the given interact.

  • Type - pointer X 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read only)
  • Default - NULL
  • Valid Values - must point to a OfxInteractClientApiV1

If set, the parameter's normal interface is replaced completely by the interact gui.

#define kOfxParamPropInterpolationAmount   "OfxParamPropInterpolationAmount"

Property used by OfxCustomParamInterpFuncV1 to indicate the amount of interpolation to perform.

This property indicates how far between the two kOfxParamPropCustomValue keys to interpolate.

#define kOfxParamPropInterpolationTime   "OfxParamPropInterpolationTime"

Used by interpolating custom parameters to indicate the time a key occurs at.

The two values indicate the absolute times the surrounding keyframes occur at. The keyframes are encoded in a kOfxParamPropCustomValue property.

#define kOfxParamPropIsAnimating   "OfxParamPropIsAnimating"

Flags whether a parameter is currently animating.

  • Type - int x 1
  • Property Set - plugin parameter instance (read only)
  • Valid Values - 0 or 1

Set by a host on a parameter instance to indicate if the parameter is currently animating or not.

#define kOfxParamPropIsAutoKeying   "OfxParamPropIsAutoKeying"

Will a value change on the parameter add automatic keyframes.

  • Type - int X 1
  • Property Set - plugin parameter instance (read only),
  • Valid Values - 0 or 1

This is set by the host simply to indicate the state of the property.

#define kOfxParamPropMax   "OfxParamPropMax"

The maximum value for a numeric parameter.

  • Type - int or double X N
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write),
  • Default - the largest possible value corresponding to the parameter type (eg: INT_MAX for an integer, DBL_MAX for a double parameter)

Setting this will also reset :;kOfxParamPropDisplayMax.

#define kOfxParamPropMin   "OfxParamPropMin"

The minimum value for a numeric parameter.

  • Type - int or double X N
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write),
  • Default - the smallest possible value corresponding to the parameter type (eg: INT_MIN for an integer, -DBL_MAX for a double parameter)

Setting this will also reset kOfxParamPropDisplayMin.

#define kOfxParamPropPageChild   "OfxParamPropPageChild"

The names of the parameters included in a page parameter.

  • Type - C string X N
  • Property Set - plugin parameter descriptor (read/write) and instance (read only)
  • Default - ""
  • Valid Values - the names of any parameter that is not a group or page, as well as kOfxParamPageSkipRow and kOfxParamPageSkipColumn

This is a property on parameters of type kOfxParamTypePage, and tells the page what parameters it contains. The parameters are added to the page from the top left, filling in columns as we go. The two pseudo param names kOfxParamPageSkipRow and kOfxParamPageSkipColumn are used to control layout.

Note parameters can appear in more than one page.

#define kOfxParamPropParent   "OfxParamPropParent"

The name of a parameter's parent group.

  • Type - C string X 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read only),
  • Default - "", which implies the "root" of the hierarchy,
  • Valid Values - the name of a parameter with type of kOfxParamTypeGroup

Hosts that have hierarchical layouts of their params use this to recursively group parameter.

By default parameters are added in order of declaration to the 'root' hierarchy. This property is used to reparent params to a predefined param of type kOfxParamTypeGroup.

#define kOfxParamPropPersistant   "OfxParamPropPersistant"

Flags whether the value of a parameter should persist.

  • Type - int x 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read only)
  • Default - 1
  • Valid Values - 0 or 1

This is used to tell the host whether the value of the parameter is important and should be save in any description of the plug-in.

#define kOfxParamPropPluginMayWrite   "OfxParamPropPluginMayWrite"

Flags whether the plugin will attempt to set the value of a parameter in some callback or analysis pass.

  • Type - int x 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read only)
  • Default - 0
  • Valid Values - 0 or 1

This is used to tell the host whether the plug-in is going to attempt to set the value of the parameter.

#define kOfxParamPropScriptName   "OfxParamPropScriptName"

The value to be used as the id of the parameter in a host scripting language.

  • Type - ASCII C string X 1,
  • Property Set - plugin parameter descriptor (read/write) and instance (read only),
  • Default - the unique name the parameter was created with.
  • Valid Values - ASCII string unique to all parameters in the plug-in.

Many hosts have a scripting language that they use to set values of parameters and more. If so, this is the name of a parameter in such scripts.

#define kOfxParamPropSecret   "OfxParamPropSecret"

Flags whether a parameter should be exposed to a user,.

  • Type - int x 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write)
  • Default - 0
  • Valid Values - 0 or 1

If secret, a parameter is not exposed to a user in any interface, but should otherwise behave as a normal parameter.

Secret params are typically used to hide important state detail that would otherwise be unintelligible to a user, for example the result of a statical analysis that might need many parameters to store.

#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.

  • Type - int x 1
  • Property Set - plugin parameter descriptor (read/write) and instance (read/write)
  • Default - 0
  • Valid Values - 0 or 1

If a double parameter is has kOfxParamPropDoubleType set to kOfxParamDoubleTypeAbsoluteTime, then this indicates whether any marker should be made visible on the host's time line.

#define kOfxParamPropStringFilePathExists   "OfxParamPropStringFilePathExists"

Indicates string parameters of file or directory type need that file to exist already.

  • Type - int X 1
  • Property Set - plugin string parameter descriptor (read/write) and instance (read only),
  • Default - 1
  • Valid Values - 0 or 1

If set to 0, it implies the user can specify a new file name, not just a pre-existing one.

#define kOfxParamPropStringMode   "OfxParamPropStringMode"

Used to indicate the type of a string parameter.

#define kOfxParamPropType   "OfxParamPropType"

The type of a parameter.

  • Type - C string X 1
  • Property Set - plugin parameter descriptor (read only) and instance (read only)

This string will be set to the type that the parameter was create with.

#define kOfxParamStringIsDirectoryPath   "OfxParamStringIsDirectoryPath"

Used to set a string parameter to be a directory path, 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 kOfxParamStringIsLabel   "OfxParamStringIsLabel"

Use to set a string parameter to be a simple label, 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 kOfxParamStringIsSingleLine   "OfxParamStringIsSingleLine"

Used to set a string parameter to be single line, value to be passed to a kOfxParamPropStringMode property.

#define kOfxPluginPropParamPageOrder   "OfxPluginPropParamPageOrder"

Sets the parameter pages and order of pages.

  • Type - C string X N
  • Property Set - plugin parameter descriptor (read/write) and instance (read only)
  • Default - ""
  • Valid Values - the names of any page param in the plugin

This property sets the prefered order of parameter pages on a host. If this is never set, the prefered order is the order the parameters were declared in.


Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:
  1. Redistributions of the document must retain the above copyright notice and this list of conditions.
  2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Automatic documentation generated by DOxygen.