ofxParam.h

Go to the documentation of this file.

#ifndef _ofxParam_h_
#define _ofxParam_h_

/*
Software License :

Copyright (c) 2003-2004, The Foundry Visionmongers Ltd. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name The Foundry Visionmongers Ltd, nor the names of its 
      contributors may be used to endorse or promote products derived from this
      software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#include "ofxCore.h"
#include "ofxProperty.h"

#ifdef __cplusplus
extern "C" {
#endif

#define kOfxParameterSuite "OfxParameterSuite"

#define kOfxTypeParameter "OfxTypeParameter"

#define kOfxTypeParameterInstance "OfxTypeParameterInstance"

typedef struct OfxParamStruct *OfxParamHandle;

typedef struct OfxParamSetStruct *OfxParamSetHandle;



#define kOfxParamTypeInteger "OfxParamTypeInteger"

#define kOfxParamTypeDouble "OfxParamTypeDouble"

#define kOfxParamTypeBoolean "OfxParamTypeBoolean"

#define kOfxParamTypeChoice "OfxParamTypeChoice"

#define kOfxParamTypeRGBA "OfxParamTypeRGBA"

#define kOfxParamTypeRGB "OfxParamTypeRGB"

#define kOfxParamTypeDouble2D "OfxParamTypeDouble2D"

#define kOfxParamTypeInteger2D "OfxParamTypeInteger2D"

#define kOfxParamTypeDouble3D "OfxParamTypeDouble3D"

#define kOfxParamTypeInteger3D "OfxParamTypeInteger3D"

#define kOfxParamTypeString "OfxParamTypeString"

#define kOfxParamTypeCustom "OfxParamTypeCustom"

#define kOfxParamTypeGroup "OfxParamTypeGroup"

#define kOfxParamTypePage "OfxParamTypePage"

#define kOfxParamTypePushButton "OfxParamTypePushButton"


#define kOfxParamHostPropSupportsCustomAnimation "OfxParamHostPropSupportsCustomAnimation"

#define kOfxParamHostPropSupportsStringAnimation "OfxParamHostPropSupportsStringAnimation"

#define kOfxParamHostPropSupportsBooleanAnimation "OfxParamHostPropSupportsBooleanAnimation"

#define kOfxParamHostPropSupportsChoiceAnimation "OfxParamHostPropSupportsChoiceAnimation"

#define kOfxParamHostPropSupportsCustomInteract "OfxParamHostPropSupportsCustomInteract"

#define kOfxParamHostPropMaxParameters "OfxParamHostPropMaxParameters"

#define kOfxParamHostPropMaxPages "OfxParamHostPropMaxPages"

#define kOfxParamHostPropPageRowColumnCount "OfxParamHostPropPageRowColumnCount"

#define kOfxParamPageSkipRow "OfxParamPageSkipRow"

#define kOfxParamPageSkipColumn "OfxParamPageSkipColumn"

#define kOfxParamPropInteractV1 "OfxParamPropInteractV1"

#define kOfxParamPropInteractSize "OfxParamPropInteractSize"

#define kOfxParamPropInteractSizeAspect "OfxParamPropInteractSizeAspect"

#define kOfxParamPropInteractMinimumSize "OfxParamPropInteractMinimumSize"

#define kOfxParamPropInteractPreferedSize "OfxParamPropInteractPreferedSize"

#define kOfxParamPropType "OfxParamPropType"

#define kOfxParamPropAnimates "OfxParamPropAnimates"

#define kOfxParamPropCanUndo "OfxParamPropCanUndo"

#define kOfxParamPropIsAnimating "OfxParamPropIsAnimating"

#define kOfxParamPropPluginMayWrite "OfxParamPropPluginMayWrite"

#define kOfxParamPropPersistant "OfxParamPropPersistant"

#define kOfxParamPropEvaluateOnChange "OfxParamPropEvaluateOnChange"

#define kOfxParamPropSecret "OfxParamPropSecret"

#define kOfxParamPropScriptName "OfxParamPropScriptName"

#define kOfxParamPropCacheInvalidation "OfxParamPropCacheInvalidation"

#define kOfxParamInvalidateValueChange "OfxParamInvalidateValueChange"

#define kOfxParamInvalidateValueChangeToEnd "OfxParamInvalidateValueChangeToEnd"

#define kOfxParamInvalidateAll "OfxParamInvalidateAll"

#define kOfxParamPropHint "OfxParamPropHint"

#define kOfxParamPropDefault "OfxParamPropDefault"

#define kOfxParamPropDoubleType "OfxParamPropDoubleType"

#define kOfxParamDoubleTypePlain "OfxParamDoubleTypePlain"

#define kOfxParamDoubleTypeScale "OfxParamDoubleTypeScale"

#define kOfxParamDoubleTypeAngle "OfxParamDoubleTypeAngle"

#define kOfxParamDoubleTypeTime "OfxParamDoubleTypeTime"

#define kOfxParamDoubleTypeAbsoluteTime "OfxParamDoubleTypeAbsoluteTime"

#define kOfxParamDoubleTypeNormalisedX  "OfxParamDoubleTypeNormalisedX"

#define kOfxParamDoubleTypeNormalisedY  "OfxParamDoubleTypeNormalisedY"

#define kOfxParamDoubleTypeNormalisedXAbsolute  "OfxParamDoubleTypeNormalisedXAbsolute"

#define kOfxParamDoubleTypeNormalisedYAbsolute  "OfxParamDoubleTypeNormalisedYAbsolute"

#define kOfxParamDoubleTypeNormalisedXY  "OfxParamDoubleTypeNormalisedXY"

#define kOfxParamDoubleTypeNormalisedXYAbsolute  "OfxParamDoubleTypeNormalisedXYAbsolute"

#define kOfxParamPropShowTimeMarker "OfxParamPropShowTimeMarker"

#define kOfxPluginPropParamPageOrder "OfxPluginPropParamPageOrder"

#define kOfxParamPropPageChild "OfxParamPropPageChild"

#define kOfxParamPropParent "OfxParamPropParent"

#define kOfxParamPropEnabled "OfxParamPropEnabled"

#define kOfxParamPropDataPtr "OfxParamPropDataPtr"

#define kOfxParamPropChoiceOption "OfxParamPropChoiceOption"

#define kOfxParamPropMin "OfxParamPropMin"

#define kOfxParamPropMax "OfxParamPropMax"

#define kOfxParamPropDisplayMin "OfxParamPropDisplayMin"

#define kOfxParamPropDisplayMax "OfxParamPropDisplayMax"

#define kOfxParamPropIncrement "OfxParamPropIncrement"

#define kOfxParamPropDigits "OfxParamPropDigits"

#define kOfxParamPropDimensionLabel "OfxParamPropDimensionLabel"

#define kOfxParamPropIsAutoKeying "OfxParamPropIsAutoKeying"

#define kOfxParamPropCustomInterpCallbackV1 "OfxParamPropCustomCallbackV1"

#define kOfxParamPropStringMode "OfxParamPropStringMode"

#define kOfxParamPropStringFilePathExists    "OfxParamPropStringFilePathExists"

#define kOfxParamStringIsSingleLine    "OfxParamStringIsSingleLine"

#define kOfxParamStringIsMultiLine     "OfxParamStringIsMultiLine"

#define kOfxParamStringIsFilePath      "OfxParamStringIsFilePath"

#define kOfxParamStringIsDirectoryPath "OfxParamStringIsDirectoryPath"

#define kOfxParamStringIsLabel         "OfxParamStringIsLabel"


#define kOfxParamPropCustomValue "OfxParamPropCustomValue"

#define kOfxParamPropInterpolationTime "OfxParamPropInterpolationTime"

#define kOfxParamPropInterpolationAmount "OfxParamPropInterpolationAmount"


typedef OfxStatus (OfxCustomParamInterpFuncV1)(OfxParamSetHandle instance,
                                               OfxPropertySetHandle inArgs,
                                               OfxPropertySetHandle outArgs);


typedef struct OfxParameterSuiteV1 {
  OfxStatus (*paramDefine)(OfxParamSetHandle paramSet,
                           const char *paramType,
                           const char *name,
                           OfxPropertySetHandle *propertySet);

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

  OfxStatus (*paramSetGetPropertySet)(OfxParamSetHandle paramSet,
                                      OfxPropertySetHandle *propHandle);

  OfxStatus (*paramGetPropertySet)(OfxParamHandle param,
                                   OfxPropertySetHandle *propHandle);

  OfxStatus (*paramGetValue)(OfxParamHandle  paramHandle,
                             ...);


  OfxStatus (*paramGetValueAtTime)(OfxParamHandle  paramHandle,
                                   OfxTime time,
                                   ...);

  OfxStatus (*paramGetDerivative)(OfxParamHandle  paramHandle,
                                  OfxTime time,
                                  ...);

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

  OfxStatus (*paramSetValue)(OfxParamHandle  paramHandle,
                             ...);

  OfxStatus (*paramSetValueAtTime)(OfxParamHandle  paramHandle,
                                   OfxTime time,  // time in frames
                                   ...);


  OfxStatus (*paramGetNumKeys)(OfxParamHandle  paramHandle,
                               unsigned int  *numberOfKeys);

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


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

  OfxStatus (*paramDeleteKey)(OfxParamHandle  paramHandle,
                              OfxTime time);

  OfxStatus (*paramDeleteAllKeys)(OfxParamHandle  paramHandle);

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


  OfxStatus (*paramEditBegin)(OfxParamSetHandle paramSet, const char *name); 

  OfxStatus (*paramEditEnd)(OfxParamSetHandle paramSet);
 } OfxParameterSuiteV1;

#ifdef __cplusplus
}
#endif


#endif

---

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.