OFX::Int2DParam Class Reference

#include <ofxsParam.h>

Inheritance diagram for OFX::Int2DParam:

List of all members.

---

Detailed Description

Wraps up an integer param.

Public Member Functions
void	setDefault (int x, int y)
	set the default value
void	setDefault (const OfxPointI &v)
	set the default value, default is 0
void	setRange (int minX, int minY, int maxX, int maxY)
	set the hard min/max range, default is INT_MIN, INT_MAX
void	setDisplayRange (int minX, int minY, int maxX, int maxY)
	set the display min and max, default is to be the same as the range param
void	getDefault (int &x, int &y)
	het the default value
OfxPointI	getDefault (void)
	get the default value
void	getRange (int &minX, int &minY, int &maxX, int &maxY)
	set the hard min/max range, default is INT_MIN, INT_MAX
void	getDisplayRange (int &minX, int &minY, int &maxX, int &maxY)
	set the display min and max, default is to be the same as the range param
void	getValue (int &x, int &y)
	get value
OfxPointI	getValue (void)
	get the value
void	getValueAtTime (double t, int &x, int &y)
	get the value at a time
OfxPointI	getValueAtTime (double t)
	get the value
void	setValue (int x, int y)
	set value
void	setValue (const OfxPointI &v)
	set the current value
void	setValueAtTime (double t, int x, int y)
	set the value at a time, implicitly adds a keyframe
void	setValueAtTime (double t, const OfxPointI &v)
	set the current value
Protected Member Functions
	mDeclareProtectedAssignAndCC (Int2DParam)
	Int2DParam (void)
	Int2DParam (const ParamSet *paramSet, const std::string &name, OfxParamHandle handle)
	hidden constructor
Friends
class	ParamSet

---

Constructor & Destructor Documentation

OFX::Int2DParam::Int2DParam (  void   )  [inline, protected]

OFX::Int2DParam::Int2DParam (  const ParamSet *  paramSet, const std::string &  name, OfxParamHandle  handle )  [protected]

hidden constructor

---

Member Function Documentation

OfxPointI OFX::Int2DParam::getDefault (  void   )  [inline]

get the default value

void OFX::Int2DParam::getDefault (  int &  x, int &  y )

het the default value

void OFX::Int2DParam::getDisplayRange (  int &  xmin, int &  ymin, int &  xmax, int &  ymax )

set the display min and max, default is to be the same as the range param

void OFX::Int2DParam::getRange (  int &  xmin, int &  ymin, int &  xmax, int &  ymax )

set the hard min/max range, default is INT_MIN, INT_MAX

OfxPointI OFX::Int2DParam::getValue (  void   )  [inline]

get the value

void OFX::Int2DParam::getValue (  int &  x, int &  y )

get value

OfxPointI OFX::Int2DParam::getValueAtTime (  double  t  )  [inline]

get the value

void OFX::Int2DParam::getValueAtTime (  double  t, int &  x, int &  y )

get the value at a time

OFX::Int2DParam::mDeclareProtectedAssignAndCC (  Int2DParam   )  [protected]

void OFX::Int2DParam::setDefault (  const OfxPointI &  v  )  [inline]

set the default value, default is 0

void OFX::Int2DParam::setDefault (  int  x, int  y )

set the default value

void OFX::Int2DParam::setDisplayRange (  int  xmin, int  ymin, int  xmax, int  ymax )

set the display min and max, default is to be the same as the range param

void OFX::Int2DParam::setRange (  int  xmin, int  ymin, int  xmax, int  ymax )

set the hard min/max range, default is INT_MIN, INT_MAX

void OFX::Int2DParam::setValue (  const OfxPointI &  v  )  [inline]

set the current value

void OFX::Int2DParam::setValue (  int  x, int  y )

set value

void OFX::Int2DParam::setValueAtTime (  double  t, const OfxPointI &  v )  [inline]

set the current value

void OFX::Int2DParam::setValueAtTime (  double  t, int  x, int  y )

set the value at a time, implicitly adds a keyframe

---

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::ValueParam.

---

The documentation for this class was generated from the following files:

• ofxsParam.h
• ofxsParams.cpp

---