TuttleOFX  1
ofxsParam.h File Reference
#include "ofxsCore.h"
#include "ofxsInteract.h"
#include "ofxsUtilities.h"
#include <extensions/nuke/camera.h>
#include <extensions/nuke/fnPublicOfxExtensions.h>
#include <boost/throw_exception.hpp>
#include <boost/assert.hpp>
#include <memory>
#include <iostream>
Include dependency graph for ofxsParam.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

class  OFX::ParamDescriptor
 Base class for all param descriptors. More...
class  OFX::DummyParamDescriptor
 Used to implement dummy parameters for page positioning commands. More...
class  OFX::ValueParamDescriptor
 Wraps up a value holding param. More...
class  OFX::StringParamDescriptor
 Wraps up a string param. More...
class  OFX::IntParamDescriptor
 Wraps up an integer param. More...
class  OFX::Int2DParamDescriptor
 Wraps up an 2d integer param. More...
class  OFX::Int3DParamDescriptor
 Wraps up an 3d integer param. More...
class  OFX::BaseDoubleParamDescriptor
 Common base to all double param types. More...
class  OFX::DoubleParamDescriptor
 Wraps up a double param. More...
class  OFX::Double2DParamDescriptor
 Wraps up a 2D double param. More...
class  OFX::Double3DParamDescriptor
 Wraps up a 3D double param. More...
class  OFX::RGBParamDescriptor
 Wraps up an RGB colour param. More...
class  OFX::RGBAParamDescriptor
 Wraps up an RGBA colour param. More...
class  OFX::BooleanParamDescriptor
 Wraps up a boolean param. More...
class  OFX::ChoiceParamDescriptor
 Wraps up a choice param. More...
class  OFX::GroupParamDescriptor
 Wraps up a group param, not much to it really. More...
class  OFX::PageParamDescriptor
 Wraps up a page param, not much to it really. More...
class  OFX::PushButtonParamDescriptor
 Wraps up a push button param, not much to it at all. More...
class  OFX::ParametricParamDescriptor
 Wraps up a push button param, not much to it at all. More...
class  OFX::CustomParamDescriptor
 Wraps up a custom param, haven't added animation support yet. More...
class  OFX::ParamSetDescriptor
 Describes a set of properties. More...
class  OFX::Attribute
class  OFX::Param
 Base class for all param instances. More...
class  OFX::ValueParam
 Wraps up a value holding param. More...
class  OFX::IntParam
 Wraps up an integer param. More...
class  OFX::Int2DParam
 Wraps up an integer param. More...
class  OFX::Int3DParam
 Wraps up an integer param. More...
class  OFX::BaseDoubleParam
 Common base to all double param types. More...
class  OFX::DoubleParam
 Wraps up an doubleeger param. More...
class  OFX::Double2DParam
 Wraps up an doubleeger param. More...
class  OFX::Double3DParam
 Wraps up an doubleeger param. More...
class  OFX::RGBParam
 Wraps up an RGB param. More...
class  OFX::RGBAParam
 Wraps up an RGB param. More...
class  OFX::StringParam
 Wraps up a string param. More...
class  OFX::ChoiceParam
 Wraps up a choice param. More...
class  OFX::BooleanParam
 Wraps up a boolean param. More...
class  OFX::GroupParam
 Wraps up a group param. More...
class  OFX::PageParam
 Wraps up a group param. More...
class  OFX::CustomParam
 Wraps up a custom param, not animation support yet. More...
class  OFX::PushButtonParam
 Wraps up a push button param, not much to it at all. More...
class  OFX::ParametricParam
 Wraps up a parametric param. More...
class  OFX::CameraParam
 Wraps up a camera param. More...
class  OFX::ParamSet
 A set of parameters in a plugin instance. More...

Namespaces

namespace  OFX
 

The core 'OFX Support' namespace, used by plugin implementations. All code for these are defined in the common support libraries.


Defines

#define mDeclareProtectedAssignAndCC(CLASS)
 Nasty macro used to define empty protected copy ctors and assign ops.

Enumerations

enum  OFX::ParamTypeEnum {
  OFX::eDummyParam, OFX::eStringParam, OFX::eIntParam, OFX::eInt2DParam,
  OFX::eInt3DParam, OFX::eDoubleParam, OFX::eDouble2DParam, OFX::eDouble3DParam,
  OFX::eRGBParam, OFX::eRGBAParam, OFX::eBooleanParam, OFX::eChoiceParam,
  OFX::eCustomParam, OFX::eGroupParam, OFX::ePageParam, OFX::ePushButtonParam,
  OFX::eParametricParam, OFX::eCameraParam
}
 Enumerates the different types of parameter. More...
enum  OFX::CacheInvalidationEnum { OFX::eCacheInvalidateValueChange, OFX::eCacheInvalidateValueChangeToEnd, OFX::eCacheInvalidateValueAll }
 Enumerates the different types of cache invalidation. More...
enum  OFX::KeySearchEnum { OFX::eKeySearchBackwards, OFX::eKeySearchNear, OFX::eKeySearchForwards }
 Enumerates how we search for keys in an animating parameter. More...
enum  OFX::StringTypeEnum {
  OFX::eStringTypeSingleLine, OFX::eStringTypeMultiLine, OFX::eStringTypeFilePath, OFX::eStringTypeDirectoryPath,
  OFX::eStringTypeLabel
}
 Enumerates the differing types of string params. More...
enum  OFX::DoubleTypeEnum {
  OFX::eDoubleTypePlain, OFX::eDoubleTypeAngle, OFX::eDoubleTypeScale, OFX::eDoubleTypeTime,
  OFX::eDoubleTypeAbsoluteTime, OFX::eDoubleTypeNormalisedX, OFX::eDoubleTypeNormalisedY, OFX::eDoubleTypeNormalisedXAbsolute,
  OFX::eDoubleTypeNormalisedYAbsolute, OFX::eDoubleTypeNormalisedXY, OFX::eDoubleTypeNormalisedXYAbsolute
}
 Enumerates the differing types of double params. More...
enum  OFX::ELayoutHint { OFX::eLayoutHintNormal = kOfxParamPropLayoutHintNormal, OFX::eLayoutHintDivider = kOfxParamPropLayoutHintDivider, OFX::eLayoutHintNoNewLine = kOfxParamPropLayoutHintNoNewLine }

Functions

const char * OFX::mapParamTypeEnumToString (ParamTypeEnum v)
 turns a ParamTypeEnum into the char * that raw OFX uses
template<class ParamType >
ParamTypeEnum OFX::mapParamTypeToEnum ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< StringParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< IntParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< Int2DParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< Int3DParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< DoubleParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< Double2DParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< Double3DParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< RGBParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< RGBAParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< BooleanParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< ChoiceParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< CustomParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< GroupParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< PageParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< PushButtonParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< ParametricParam > ()
template<>
ParamTypeEnum OFX::mapParamTypeToEnum< CameraParam > ()
template<class ParamType >
ParamTypeEnum OFX::mapParamTypeToEnumFrom (const ParamType &)
template<class ParamType >
ParamTypeEnum OFX::mapParamTypeToEnumFrom (const ParamType *)

Define Documentation

#define mDeclareProtectedAssignAndCC (   CLASS)
Value:
CLASS& operator=( const CLASS& ) { assert( false ); return *this; }    \
    CLASS( const CLASS & ) { assert( false ); }

Nasty macro used to define empty protected copy ctors and assign ops.

Definition at line 67 of file ofxsParam.h.