ofxsParam.h File Reference

#include "ofxsCore.h"

Go to the source code of this file.

Namespaces
namespace	OFX
Classes
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::CustomParamDescriptor
	Wraps up a custom param, haven't added animation support yet. More...
class	OFX::ParamSetDescriptor
	Describes a set of properties. More...
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::ParamSet
	A set of parameters in a plugin instance. More...
Defines
#define	mDeclareProtectedAssignAndCC(CLASS)
	Nasty macro used to define empty protected copy ctors and assign ops.
Enumerations
enum	ParamTypeEnum {   eDummyParam, eStringParam, eIntParam, eInt2DParam,   eInt3DParam, eDoubleParam, eDouble2DParam, eDouble3DParam,   eRGBParam, eRGBAParam, eBooleanParam, eChoiceParam,   eCustomParam, eGroupParam, ePageParam, ePushButtonParam }
	Enumerates the different types of parameter. More...
enum	CacheInvalidationEnum { eCacheInvalidateValueChange, eCacheInvalidateValueChangeToEnd, eCacheInvalidateValueAll }
	Enumerates the different types of cache invalidation. More...
enum	KeySearchEnum { eKeySearchBackwards, eKeySearchNear, eKeySearchForwards }
	Enumerates how we search for keys in an animating parameter. More...
enum	StringTypeEnum {   eStringTypeSingleLine, eStringTypeMultiLine, eStringTypeFilePath, eStringTypeDirectoryPath,   eStringTypeLabel }
	Enumerates the differing types of string params. More...
enum	DoubleTypeEnum {   eDoubleTypePlain, eDoubleTypeAngle, eDoubleTypeScale, eDoubleTypeTime,   eDoubleTypeAbsoluteTime, eDoubleTypeNormalisedX, eDoubleTypeNormalisedY, eDoubleTypeNormalisedXAbsolute,   eDoubleTypeNormalisedYAbsolute, eDoubleTypeNormalisedXY, eDoubleTypeNormalisedXYAbsolute }
	Enumerates the differing types of double params. More...
Functions
const char *	mapParamTypeEnumToString (ParamTypeEnum v)
	turns a ParamTypeEnum into the char * that raw OFX uses

---

Define Documentation

#define mDeclareProtectedAssignAndCC (  CLASS   )

Value: CLASS &operator=(const CLASS &v1) {assert(false); return *this;} \ CLASS(const CLASS &v) {assert(false); } Nasty macro used to define empty protected copy ctors and assign ops.

---

Enumeration Type Documentation

enum CacheInvalidationEnum

Enumerates the different types of cache invalidation. Enumeration values: eCacheInvalidateValueChange  eCacheInvalidateValueChangeToEnd  eCacheInvalidateValueAll

enum DoubleTypeEnum

Enumerates the differing types of double params. Enumeration values: eDoubleTypePlain  eDoubleTypeAngle  eDoubleTypeScale  eDoubleTypeTime  eDoubleTypeAbsoluteTime  eDoubleTypeNormalisedX  eDoubleTypeNormalisedY  eDoubleTypeNormalisedXAbsolute  eDoubleTypeNormalisedYAbsolute  eDoubleTypeNormalisedXY  eDoubleTypeNormalisedXYAbsolute

enum KeySearchEnum

Enumerates how we search for keys in an animating parameter. Enumeration values: eKeySearchBackwards  eKeySearchNear  eKeySearchForwards

enum ParamTypeEnum

Enumerates the different types of parameter. Enumeration values: eDummyParam  eStringParam  eIntParam  eInt2DParam  eInt3DParam  eDoubleParam  eDouble2DParam  eDouble3DParam  eRGBParam  eRGBAParam  eBooleanParam  eChoiceParam  eCustomParam  eGroupParam  ePageParam  ePushButtonParam

enum StringTypeEnum

Enumerates the differing types of string params. Enumeration values: eStringTypeSingleLine  eStringTypeMultiLine  eStringTypeFilePath  eStringTypeDirectoryPath  eStringTypeLabel

---

Function Documentation

const char * OFX::mapParamTypeEnumToString (  ParamTypeEnum  v  )

turns a ParamTypeEnum into the char * that raw OFX uses

---