TuttleOFX  1
Defines
Parameter Property Definitions
Ofx Properties
Collaboration diagram for Parameter Property Definitions:

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 preferred 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 preferred 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 kOfxPropParamSetNeedsSyncing   "OfxPropParamSetNeedsSyncing"
 States whether the plugin needs to resync its private data.
#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 kOfxParamDoubleTypeX   "OfxParamDoubleTypeX"
 value for the kOfxParamPropDoubleType property, indicating a size in canonical coords in the X dimension. See ParameterPropertiesDoubleTypes.
#define kOfxParamDoubleTypeY   "OfxParamDoubleTypeY"
 value for the kOfxParamPropDoubleType property, indicating a size in canonical coords in the Y dimension. See ParameterPropertiesDoubleTypes.
#define kOfxParamDoubleTypeXAbsolute   "OfxParamDoubleTypeXAbsolute"
 value for the kOfxParamPropDoubleType property, indicating an absolute position in canonical coords in the X dimension. See ParameterPropertiesDoubleTypes.
#define kOfxParamDoubleTypeYAbsolute   "OfxParamDoubleTypeYAbsolute"
 value for the kOfxParamPropDoubleType property, indicating an absolute position in canonical coords in the Y dimension. See ParameterPropertiesDoubleTypes.
#define kOfxParamDoubleTypeXY   "OfxParamDoubleTypeXY"
 value for the kOfxParamPropDoubleType property, indicating a 2D size in canonical coords. See ParameterPropertiesDoubleTypes.
#define kOfxParamDoubleTypeXYAbsolute   "OfxParamDoubleTypeXYAbsolute"
 value for the kOfxParamPropDoubleType property, indicating a 2D position in canonical coords. See ParameterPropertiesDoubleTypes.
#define kOfxParamPropDefaultCoordinateSystem   "OfxParamPropDefaultCoordinateSystem"
 Describes in which coordinate system a spatial double parameter's default value is specified.
#define kOfxParamCoordinatesCanonical   "OfxParamCoordinatesCanonical"
 Define the canonical coordinate system.
#define kOfxParamCoordinatesNormalised   "OfxParamCoordinatesNormalised"
 Define the normalised coordinate system.
#define kOfxParamPropHasHostOverlayHandle   "OfxParamPropHasHostOverlayHandle"
 A flag to indicate if there is a host overlay UI handle for the given parameter.
#define kOfxParamPropUseHostOverlayHandle   "kOfxParamPropUseHostOverlayHandle"
 A flag to indicate that the host should use a native UI overlay handle for the given parameter.
#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 kOfxParamPropGroupOpen   "OfxParamPropGroupOpen"
 Whether the initial state of a group is open or closed in a hierarchical layout.
#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 its 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.
#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.

Detailed Description

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

Define Documentation

#define kOfxParamCoordinatesCanonical   "OfxParamCoordinatesCanonical"

Define the canonical coordinate system.

Definition at line 553 of file ofxParam.h.

#define kOfxParamCoordinatesNormalised   "OfxParamCoordinatesNormalised"

Define the normalised coordinate system.

Definition at line 556 of file ofxParam.h.

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

Definition at line 475 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

#define kOfxParamDoubleTypeAngle   "OfxParamDoubleTypeAngle"

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

Definition at line 469 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

#define kOfxParamDoubleTypeNormalisedX   "OfxParamDoubleTypeNormalisedX"

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

Deprecated in favour of ::OfxParamDoubleTypeX

Definition at line 481 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

#define kOfxParamDoubleTypeNormalisedXAbsolute   "OfxParamDoubleTypeNormalisedXAbsolute"

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

Deprecated in favour of ::OfxParamDoubleTypeXAbsolute

Definition at line 493 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

#define kOfxParamDoubleTypeNormalisedXY   "OfxParamDoubleTypeNormalisedXY"

value for the kOfxParamPropDoubleType property, indicating normalisation to the X and Y dimension for 2D params. See ParameterPropertiesDoubleTypes.

Deprecated in favour of ::OfxParamDoubleTypeXY

Definition at line 505 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

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

Deprecated in favour of kOfxParamDoubleTypeXYAbsolute

Definition at line 511 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

#define kOfxParamDoubleTypeNormalisedY   "OfxParamDoubleTypeNormalisedY"

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

Deprecated in favour of ::OfxParamDoubleTypeY

Definition at line 487 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

#define kOfxParamDoubleTypeNormalisedYAbsolute   "OfxParamDoubleTypeNormalisedYAbsolute"

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

Deprecated in favour of ::OfxParamDoubleTypeYAbsolute

Definition at line 499 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

#define kOfxParamDoubleTypePlain   "OfxParamDoubleTypePlain"

value for the kOfxParamPropDoubleType property, indicating the parameter has no special interpretation and should be interpretted as a raw numeric value.

Definition at line 463 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNumericParamProps(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

#define kOfxParamDoubleTypeScale   "OfxParamDoubleTypeScale"

value for the kOfxParamPropDoubleType property, indicating the parameter is to be interpreted as a scale factor. See ParameterPropertiesDoubleTypes.

Definition at line 466 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

#define kOfxParamDoubleTypeTime   "OfxParamDoubleTypeTime"

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

Definition at line 472 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDoubleType(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

#define kOfxParamDoubleTypeX   "OfxParamDoubleTypeX"

value for the kOfxParamPropDoubleType property, indicating a size in canonical coords in the X dimension. See ParameterPropertiesDoubleTypes.

Definition at line 516 of file ofxParam.h.

#define kOfxParamDoubleTypeXAbsolute   "OfxParamDoubleTypeXAbsolute"

value for the kOfxParamPropDoubleType property, indicating an absolute position in canonical coords in the X dimension. See ParameterPropertiesDoubleTypes.

Definition at line 522 of file ofxParam.h.

#define kOfxParamDoubleTypeXY   "OfxParamDoubleTypeXY"

value for the kOfxParamPropDoubleType property, indicating a 2D size in canonical coords. See ParameterPropertiesDoubleTypes.

Definition at line 528 of file ofxParam.h.

#define kOfxParamDoubleTypeXYAbsolute   "OfxParamDoubleTypeXYAbsolute"

value for the kOfxParamPropDoubleType property, indicating a 2D position in canonical coords. See ParameterPropertiesDoubleTypes.

Definition at line 531 of file ofxParam.h.

#define kOfxParamDoubleTypeY   "OfxParamDoubleTypeY"

value for the kOfxParamPropDoubleType property, indicating a size in canonical coords in the Y dimension. See ParameterPropertiesDoubleTypes.

Definition at line 519 of file ofxParam.h.

#define kOfxParamDoubleTypeYAbsolute   "OfxParamDoubleTypeYAbsolute"

value for the kOfxParamPropDoubleType property, indicating an absolute position in canonical coords in the Y dimension. See ParameterPropertiesDoubleTypes.

Definition at line 525 of file ofxParam.h.

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

Definition at line 168 of file ofxParam.h.

Referenced by OFX::Private::fetchHostDescription(), and tuttle::host::Host::Host().

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

Definition at line 157 of file ofxParam.h.

Referenced by OFX::Private::fetchHostDescription(), and tuttle::host::Host::Host().

#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 1 as the number of rows per page.

Definition at line 177 of file ofxParam.h.

Referenced by OFX::Private::fetchHostDescription(), and tuttle::host::Host::Host().

#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

Definition at line 132 of file ofxParam.h.

Referenced by OFX::Private::fetchHostDescription(), and tuttle::host::Host::Host().

#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

Definition at line 140 of file ofxParam.h.

Referenced by OFX::Private::fetchHostDescription(), and tuttle::host::Host::Host().

#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

Definition at line 116 of file ofxParam.h.

Referenced by OFX::Private::fetchHostDescription(), and tuttle::host::Host::Host().

#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

Definition at line 148 of file ofxParam.h.

Referenced by OFX::Private::fetchHostDescription(), and tuttle::host::Host::Host().

#define kOfxParamHostPropSupportsParametricAnimation   "OfxParamHostPropSupportsParametricAnimation"

Property on the host to indicate support for parametric parameter animation.

  • Type - int X 1
  • Property Set - host descriptor (read only)
  • Valid Values
    • 0 indicating the host does not support animation of parmetric params,
    • 1 indicating the host does support animation of parmetric params,

Definition at line 122 of file ofxParametricParam.h.

#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

Definition at line 124 of file ofxParam.h.

Referenced by OFX::Private::fetchHostDescription(), and tuttle::host::Host::Host().

#define kOfxParamInvalidateAll   "OfxParamInvalidateAll"

Used as a value for the kOfxParamPropCacheInvalidation property.

Definition at line 396 of file ofxParam.h.

Referenced by tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getHashAtTime(), and OFX::ValueParamDescriptor::setCacheInvalidation().

#define kOfxParamInvalidateValueChange   "OfxParamInvalidateValueChange"

Used as a value for the kOfxParamPropCacheInvalidation property.

Definition at line 390 of file ofxParam.h.

Referenced by OFX::ValueParam::getCacheInvalidation(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getHashAtTime(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initValueParamProps(), and OFX::ValueParamDescriptor::setCacheInvalidation().

#define kOfxParamInvalidateValueChangeToEnd   "OfxParamInvalidateValueChangeToEnd"

Used as a value for the kOfxParamPropCacheInvalidation property.

Definition at line 393 of file ofxParam.h.

Referenced by OFX::ValueParam::getCacheInvalidation(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getHashAtTime(), and OFX::ValueParamDescriptor::setCacheInvalidation().

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

Definition at line 193 of file ofxParam.h.

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

Definition at line 185 of file ofxParam.h.

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

Definition at line 266 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamAccessor::getCanAnimate(), OFX::Validation::initialise(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNoValueParamProps(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initValueParamProps(), and OFX::ValueParamDescriptor::setAnimates().

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

Definition at line 387 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamAccessor::getCacheInvalidation(), OFX::ValueParam::getCacheInvalidation(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNoValueParamProps(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initValueParamProps(), and OFX::ValueParamDescriptor::setCacheInvalidation().

#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

Definition at line 275 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamAccessor::getCanUndo(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNoValueParamProps(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initValueParamProps(), and OFX::ValueParamDescriptor::setCanUndo().

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

Definition at line 671 of file ofxParam.h.

Referenced by OFX::ChoiceParamDescriptor::appendOption(), OFX::ChoiceParam::appendOption(), sam::coutParameterValues(), sam::coutParameterWithDetails(), tuttle::host::ofx::attribute::OfxhParamChoice::getChoiceKeys(), OFX::ChoiceParamDescriptor::getNOptions(), OFX::ChoiceParam::getNOptions(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initStandardParamProps(), OFX::ChoiceParamDescriptor::resetOptions(), and OFX::ChoiceParam::resetOptions().

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

Definition at line 765 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::initStandardParamProps().

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

Definition at line 819 of file ofxParam.h.

#define kOfxParamPropDataPtr   "OfxParamPropDataPtr"

A private data pointer that the plug-in can store its 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.

Definition at line 661 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::OfxhParamDescriptor().

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

Definition at line 429 of file ofxParam.h.

Referenced by sam::coutParameterValues(), sam::coutParameterWithDetails(), tuttle::host::attribute::ParamDouble::getDefault(), tuttle::host::attribute::ParamInteger::getDefault(), tuttle::host::attribute::ParamChoice::getDefault(), tuttle::host::attribute::ParamBoolean::getDefault(), tuttle::host::attribute::ParamCustom::getDefault(), tuttle::host::attribute::ParamString::getDefault(), OFX::IntParam::getDefault(), OFX::Int2DParam::getDefault(), OFX::Int3DParam::getDefault(), OFX::DoubleParam::getDefault(), OFX::Double2DParam::getDefault(), OFX::Double3DParam::getDefault(), OFX::RGBParam::getDefault(), OFX::RGBAParam::getDefault(), OFX::StringParam::getDefault(), OFX::ChoiceParam::getDefault(), OFX::BooleanParam::getDefault(), OFX::CustomParam::getDefault(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initValueParamProps(), main(), OFX::StringParamDescriptor::setDefault(), OFX::IntParamDescriptor::setDefault(), OFX::Int2DParamDescriptor::setDefault(), OFX::Int3DParamDescriptor::setDefault(), OFX::DoubleParamDescriptor::setDefault(), OFX::Double2DParamDescriptor::setDefault(), OFX::Double3DParamDescriptor::setDefault(), OFX::RGBParamDescriptor::setDefault(), OFX::RGBAParamDescriptor::setDefault(), OFX::BooleanParamDescriptor::setDefault(), OFX::ChoiceParamDescriptor::setDefault(), OFX::CustomParamDescriptor::setDefault(), OFX::IntParam::setDefault(), OFX::Int2DParam::setDefault(), OFX::Int3DParam::setDefault(), OFX::DoubleParam::setDefault(), OFX::Double2DParam::setDefault(), OFX::Double3DParam::setDefault(), OFX::RGBParam::setDefault(), OFX::RGBAParam::setDefault(), OFX::StringParam::setDefault(), OFX::ChoiceParam::setDefault(), OFX::BooleanParam::setDefault(), and OFX::CustomParam::setDefault().

#define kOfxParamPropDefaultCoordinateSystem   "OfxParamPropDefaultCoordinateSystem"

Describes in which coordinate system a spatial double parameter's default value is specified.

  • Type - C string X 1
  • Default - kOfxParamCoordinatesCanonical
  • Property Set - Non normalised spatial double parameters, ie: any double param who's kOfxParamPropDoubleType is set to one of...
    • kOfxParamDoubleTypeX
    • kOfxParamDoubleTypeXAbsolute
    • kOfxParamDoubleTypeY
    • kOfxParamDoubleTypeYAbsolute
    • kOfxParamDoubleTypeXY
    • kOfxParamDoubleTypeXYAbsolute
  • Valid Values - This must be one of
    • kOfxParamCoordinatesCanonical - the default is in canonical coords
    • kOfxParamCoordinatesNormalised - the default is in normalised coordinates

This allows a spatial param to specify what its default is, so by saying normalised and "0.5" it would be in the 'middle', by saying canonical and 100 it would be at value 100 independent of the size of the image being applied to.

Definition at line 550 of file ofxParam.h.

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

Definition at line 733 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getDigits(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNumericParamProps(), OFX::BaseDoubleParamDescriptor::setDigits(), and OFX::BaseDoubleParam::setDigits().

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

Definition at line 744 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::initNumericParamProps(), OFX::ParametricParamDescriptor::setDimensionLabel(), OFX::Int2DParamDescriptor::setDimensionLabels(), OFX::Int3DParamDescriptor::setDimensionLabels(), OFX::Double2DParamDescriptor::setDimensionLabels(), and OFX::Double3DParamDescriptor::setDimensionLabels().

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

Definition at line 711 of file ofxParam.h.

Referenced by sam::coutParameterValues(), sam::coutParameterWithDetails(), OFX::IntParam::getDisplayRange(), OFX::Int2DParam::getDisplayRange(), OFX::Int3DParam::getDisplayRange(), OFX::DoubleParam::getDisplayRange(), OFX::Double2DParam::getDisplayRange(), OFX::Double3DParam::getDisplayRange(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNumericParamProps(), tuttle::host::ofx::attribute::OfxhParam::notify(), tuttle::host::ofx::attribute::OfxhParamDouble::OfxhParamDouble(), tuttle::host::ofx::attribute::OfxhParamInteger::OfxhParamInteger(), OFX::IntParamDescriptor::setDisplayRange(), OFX::Int2DParamDescriptor::setDisplayRange(), OFX::Int3DParamDescriptor::setDisplayRange(), OFX::DoubleParamDescriptor::setDisplayRange(), OFX::Double2DParamDescriptor::setDisplayRange(), OFX::Double3DParamDescriptor::setDisplayRange(), OFX::IntParam::setDisplayRange(), OFX::Int2DParam::setDisplayRange(), OFX::Int3DParam::setDisplayRange(), OFX::DoubleParam::setDisplayRange(), OFX::Double2DParam::setDisplayRange(), and OFX::Double3DParam::setDisplayRange().

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

Definition at line 701 of file ofxParam.h.

Referenced by sam::coutParameterValues(), sam::coutParameterWithDetails(), OFX::IntParam::getDisplayRange(), OFX::Int2DParam::getDisplayRange(), OFX::Int3DParam::getDisplayRange(), OFX::DoubleParam::getDisplayRange(), OFX::Double2DParam::getDisplayRange(), OFX::Double3DParam::getDisplayRange(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNumericParamProps(), tuttle::host::ofx::attribute::OfxhParam::notify(), tuttle::host::ofx::attribute::OfxhParamDouble::OfxhParamDouble(), tuttle::host::ofx::attribute::OfxhParamInteger::OfxhParamInteger(), OFX::IntParamDescriptor::setDisplayRange(), OFX::Int2DParamDescriptor::setDisplayRange(), OFX::Int3DParamDescriptor::setDisplayRange(), OFX::DoubleParamDescriptor::setDisplayRange(), OFX::Double2DParamDescriptor::setDisplayRange(), OFX::Double3DParamDescriptor::setDisplayRange(), OFX::IntParam::setDisplayRange(), OFX::Int2DParam::setDisplayRange(), OFX::Int3DParam::setDisplayRange(), OFX::DoubleParam::setDisplayRange(), OFX::Double2DParam::setDisplayRange(), and OFX::Double3DParam::setDisplayRange().

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

Definition at line 460 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamAccessor::getDoubleType(), OFX::BaseDoubleParam::getDoubleType(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNumericParamProps(), and OFX::BaseDoubleParamDescriptor::setDoubleType().

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

Definition at line 651 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamAccessor::getEnabled(), OFX::Param::getIsEnable(), tuttle::host::ofx::attribute::OfxhParam::notify(), tuttle::host::ofx::attribute::OfxhParam::OfxhParam(), tuttle::host::ofx::attribute::OfxhParamDescriptor::OfxhParamDescriptor(), OFX::ParamDescriptor::setEnabled(), and OFX::Param::setEnabled().

#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 its value should not trigger a re-render.

Definition at line 345 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamAccessor::getEvaluateOnChange(), OFX::ValueParam::getEvaluateOnChange(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNoValueParamProps(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initValueParamProps(), OFX::ValueParamDescriptor::setEvaluateOnChange(), and OFX::ValueParam::setEvaluateOnChange().

#define kOfxParamPropGroupOpen   "OfxParamPropGroupOpen"

Whether the initial state of a group is open or closed in a hierarchical layout.

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

This is a property on parameters of type kOfxParamTypeGroup, and tells the group whether it should be open or closed by default.

Definition at line 640 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::initStandardParamProps(), and OFX::GroupParamDescriptor::setOpen().

#define kOfxParamPropHasHostOverlayHandle   "OfxParamPropHasHostOverlayHandle"

A flag to indicate if there is a host overlay UI handle for the given parameter.

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

If set to 1, then the host is flagging that there is some sort of native user overlay interface handle available for the given parameter.

Definition at line 566 of file ofxParam.h.

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

Definition at line 404 of file ofxParam.h.

Referenced by sam::coutParameterWithDetails(), tuttle::host::ofx::attribute::OfxhParamAccessor::getHint(), OFX::Param::getHint(), tuttle::host::ofx::attribute::OfxhParamDescriptor::OfxhParamDescriptor(), OFX::ParamDescriptor::setHint(), and OFX::Param::setHint().

#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 canonical coordinates for double parameters that are normalised.

Definition at line 722 of file ofxParam.h.

Referenced by OFX::BaseDoubleParam::getIncrement(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNumericParamProps(), OFX::BaseDoubleParamDescriptor::setIncrement(), and OFX::BaseDoubleParam::setIncrement().

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

Definition at line 235 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::initInteractParamProps(), and OFX::ParamInteractDescriptor::setInteractMinimumSize().

#define kOfxParamPropInteractPreferedSize   "OfxParamPropInteractPreferedSize"

The preferred 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.

Definition at line 246 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::initInteractParamProps(), and OFX::ParamInteractDescriptor::setInteractPreferredSize().

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

Definition at line 213 of file ofxParam.h.

Referenced by OFX::ParamInteract::getInteractSize(), and tuttle::host::ofx::attribute::OfxhParamDescriptor::initInteractParamProps().

#define kOfxParamPropInteractSizeAspect   "OfxParamPropInteractSizeAspect"

The preferred 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).

Definition at line 224 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::initInteractParamProps(), and OFX::ParamInteractDescriptor::setInteractSizeAspect().

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

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

Definition at line 204 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::initInteractParamProps(), and OFX::ValueParamDescriptor::setInteractDescriptor().

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

Definition at line 839 of file ofxParam.h.

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

Definition at line 829 of file ofxParam.h.

#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 has a non-constant value set on it. This can be as a consequence of animation or of scripting modifying the value.

Definition at line 312 of file ofxParam.h.

Referenced by OFX::ValueParam::getIsAnimating(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNoValueParamProps(), and tuttle::host::ofx::attribute::OfxhParamDescriptor::initValueParamProps().

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

Definition at line 754 of file ofxParam.h.

Referenced by OFX::ValueParam::getIsAutoKeying(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNoValueParamProps(), and tuttle::host::ofx::attribute::OfxhParamDescriptor::initValueParamProps().

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

Definition at line 691 of file ofxParam.h.

Referenced by OFX::IntParam::getRange(), OFX::Int2DParam::getRange(), OFX::Int3DParam::getRange(), OFX::DoubleParam::getRange(), OFX::Double2DParam::getRange(), OFX::Double3DParam::getRange(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNumericParamProps(), OFX::IntParamDescriptor::setRange(), OFX::Int2DParamDescriptor::setRange(), OFX::Int3DParamDescriptor::setRange(), OFX::DoubleParamDescriptor::setRange(), OFX::Double2DParamDescriptor::setRange(), OFX::Double3DParamDescriptor::setRange(), OFX::IntParam::setRange(), OFX::Int2DParam::setRange(), OFX::Int3DParam::setRange(), OFX::DoubleParam::setRange(), OFX::Double2DParam::setRange(), and OFX::Double3DParam::setRange().

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

Definition at line 681 of file ofxParam.h.

Referenced by OFX::IntParam::getRange(), OFX::Int2DParam::getRange(), OFX::Int3DParam::getRange(), OFX::DoubleParam::getRange(), OFX::Double2DParam::getRange(), OFX::Double3DParam::getRange(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNumericParamProps(), OFX::IntParamDescriptor::setRange(), OFX::Int2DParamDescriptor::setRange(), OFX::Int3DParamDescriptor::setRange(), OFX::DoubleParamDescriptor::setRange(), OFX::Double2DParamDescriptor::setRange(), OFX::Double3DParamDescriptor::setRange(), OFX::IntParam::setRange(), OFX::Int2DParam::setRange(), OFX::Int3DParam::setRange(), OFX::DoubleParam::setRange(), OFX::Double2DParam::setRange(), and OFX::Double3DParam::setRange().

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

Definition at line 615 of file ofxParam.h.

Referenced by OFX::PageParamDescriptor::addChild(), tuttle::host::ofx::attribute::OfxhParamPage::getChildren(), and tuttle::host::ofx::attribute::OfxhParamDescriptor::initStandardParamProps().

#define kOfxParamPropParametricDimension   "OfxParamPropParametricDimension"

The dimension of a parametric param.

  • Type - int X 1
  • Property Set - parametric param descriptor (read/write) and instance (read only)
  • default - 1
  • Value Values - greater than 0

This indicates the dimension of the parametric param.

Definition at line 82 of file ofxParametricParam.h.

Referenced by OFX::ParametricParamDescriptor::setDimension(), and OFX::ParametricParamDescriptor::setIdentity().

#define kOfxParamPropParametricInteractBackground   "OfxParamPropParametricInteractBackground"

Interact entry point to draw the background of a parametric parameter.

  • Type - pointer X 1
  • Property Set - plug-in parametric parameter descriptor (read/write) and instance (read only),
  • Default - NULL, which implies the host should draw its default background.

Defines a pointer to an interact which will be used to draw the background of a parametric parameter's user interface. None of the pen or keyboard actions can ever be called on the interact.

The openGL transform will be set so that it is an orthographic transform that maps directly to the 'parametric' space, so that 'x' represents the parametric position and 'y' represents the evaluated value.

Definition at line 112 of file ofxParametricParam.h.

Referenced by OFX::ParametricParamDescriptor::setInteractDescriptor().

#define kOfxParamPropParametricRange   "OfxParamPropParametricRange"

Property to indicate the min and max range of the parametric input value.

  • Type - double X 2
  • Property Set - parameter descriptor (read/write only), and instance (read only)
  • Default Value - (0, 1)
  • Valid Values - any pair of numbers so that the first is less than the second.

This controls the min and max values that the parameter will be evaluated at.

Definition at line 133 of file ofxParametricParam.h.

Referenced by OFX::ParametricParamDescriptor::setRange().

#define kOfxParamPropParametricUIColour   "OfxParamPropParametricUIColour"

The colour of parametric param curve interface in any UI.

  • Type - double X N
  • Property Set - parametric param descriptor (read/write) and instance (read only)
  • default - unset,
  • Value Values - three values for each dimension (see kOfxParamPropParametricDimension) being interpretted as R, G and B of the colour for each curve drawn in the UI.

This sets the colour of a parametric param curve drawn a host user interface. A colour triple is needed for each dimension of the oparametric param.

If not set, the host should generally draw these in white.

Definition at line 97 of file ofxParametricParam.h.

Referenced by OFX::ParametricParamDescriptor::setUIColour().

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

Definition at line 628 of file ofxParam.h.

Referenced by OFX::Param::getParent(), tuttle::host::ofx::attribute::OfxhParamAccessor::getParentName(), tuttle::host::ofx::attribute::OfxhParamDescriptor::OfxhParamDescriptor(), and OFX::ParamDescriptor::setParent().

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

Definition at line 334 of file ofxParam.h.

Referenced by OFX::ValueParam::getIsPersistant(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initNoValueParamProps(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initValueParamProps(), and OFX::ValueParamDescriptor::setIsPersistant().

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

Definition at line 323 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::initNoValueParamProps(), and tuttle::host::ofx::attribute::OfxhParamDescriptor::initValueParamProps().

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

Definition at line 369 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamAccessor::getScriptName(), OFX::Param::getScriptName(), tuttle::host::ofx::attribute::OfxhParamDescriptor::OfxhParamDescriptor(), and OFX::ParamDescriptor::setScriptName().

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

Definition at line 358 of file ofxParam.h.

Referenced by OFX::Param::getIsSecret(), tuttle::host::ofx::attribute::OfxhParamAccessor::getSecret(), tuttle::host::ofx::attribute::OfxhParam::notify(), tuttle::host::ofx::attribute::OfxhParam::OfxhParam(), tuttle::host::ofx::attribute::OfxhParamDescriptor::OfxhParamDescriptor(), OFX::ParamDescriptor::setIsSecret(), and OFX::Param::setIsSecret().

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

Definition at line 591 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::initNumericParamProps().

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

Definition at line 791 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamDescriptor::initStandardParamProps(), and OFX::StringParamDescriptor::setFilePathExists().

#define kOfxParamPropStringMode   "OfxParamPropStringMode"

Used to indicate the type of a string parameter.

Definition at line 780 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamString::getStringMode(), OFX::StringParam::getStringType(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initStandardParamProps(), and OFX::StringParamDescriptor::setStringType().

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

Definition at line 255 of file ofxParam.h.

Referenced by OFX::ParamSet::fetchRawParam(), OFX::ParamSet::getParam(), tuttle::host::ofx::attribute::OfxhParamAccessor::getParamType(), OFX::ParamSet::getParamType(), and tuttle::host::ofx::attribute::OfxhParamDescriptor::OfxhParamDescriptor().

#define kOfxParamPropUseHostOverlayHandle   "kOfxParamPropUseHostOverlayHandle"

A flag to indicate that the host should use a native UI overlay handle for the given parameter.

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

If set to 1, then a plugin is flaging to the host that the host should use a native UI overlay handle for the given parameter. A plugin can use this to keep a native look and feel for parameter handles. A plugin can use kOfxParamPropHasHostOverlayHandle to see if handles are available on the given parameter.

Definition at line 577 of file ofxParam.h.

#define kOfxParamStringIsDirectoryPath   "OfxParamStringIsDirectoryPath"

Used to set a string parameter to be a directory path, value to be passed to a kOfxParamPropStringMode property.

Definition at line 807 of file ofxParam.h.

Referenced by OFX::StringParam::getStringType(), and OFX::StringParamDescriptor::setStringType().

#define kOfxParamStringIsFilePath   "OfxParamStringIsFilePath"

Used to set a string parameter to be a file path, value to be passed to a kOfxParamPropStringMode property.

Definition at line 803 of file ofxParam.h.

Referenced by tuttle::host::ofx::attribute::OfxhParamString::getHashAtTime(), OFX::StringParam::getStringType(), and OFX::StringParamDescriptor::setStringType().

#define kOfxParamStringIsLabel   "OfxParamStringIsLabel"

Use to set a string parameter to be a simple label, value to be passed to a kOfxParamPropStringMode property.

Definition at line 811 of file ofxParam.h.

Referenced by OFX::StringParamDescriptor::setStringType().

#define kOfxParamStringIsMultiLine   "OfxParamStringIsMultiLine"

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

Definition at line 799 of file ofxParam.h.

Referenced by OFX::StringParam::getStringType(), and OFX::StringParamDescriptor::setStringType().

#define kOfxParamStringIsSingleLine   "OfxParamStringIsSingleLine"

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

Definition at line 795 of file ofxParam.h.

Referenced by OFX::StringParam::getStringType(), tuttle::host::ofx::attribute::OfxhParamDescriptor::initStandardParamProps(), and OFX::StringParamDescriptor::setStringType().

#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 preferred order of parameter pages on a host. If this is never set, the preferred order is the order the parameters were declared in.

Definition at line 602 of file ofxParam.h.

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

#define kOfxPropParamSetNeedsSyncing   "OfxPropParamSetNeedsSyncing"

States whether the plugin needs to resync its private data.

  • Type - int X 1
  • Property Set - param set instance (read/write)
  • Default - 0
  • Valid Values -
    • 0 - no need to sync
    • 1 - paramset is not synced

The plugin should set this flag to true whenever any internal state has not been flushed to the set of params.

The host will examine this property each time it does a copy or save operation on the instance. * If it is set to 1, the host will call SyncPrivateData and then set it to zero before doing the copy/save. * If it is set to 0, the host will assume that the param data correctly represents the private state, and will not call SyncPrivateData before copying/saving. * If this property is not set, the host will always call SyncPrivateData before copying or saving the effect (as if the property were set to 1 -- but the host will not create or modify the property).

Definition at line 301 of file ofxParam.h.