TuttleOFX  1
Public Member Functions | Protected Member Functions | Private Member Functions | Friends
OFX::IntParam Class Reference

Wraps up an integer param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::IntParam:
Inheritance graph
[legend]
Collaboration diagram for OFX::IntParam:
Collaboration graph
[legend]

Public Member Functions

void setDefault (int v)
 set the default value
void setRange (int min, int max)
 set the hard min/max range, default is INT_MIN, INT_MAX
void setDisplayRange (int min, int max)
 set the display min and max, default is to be the same as the range param
void getDefault (int &v) const
 het the default value
int getDefault (void) const
 het the default value
void getRange (int &min, int &max) const
 set the hard min/max range, default is INT_MIN, INT_MAX
void getDisplayRange (int &min, int &max) const
 set the display min and max, default is to be the same as the range param
void getValue (int &v) const
 get value
int getValue (void) const
 and a nicer one
void getValueAtTime (double t, int &v) const
 get the value at a time
int getValueAtTime (double t) const
 and a nicer one
void setValue (int v)
 set value
void setValueAtTime (double t, int v)
 set the value at a time, implicitly adds a keyframe

Protected Member Functions

 IntParam (const ParamSet *paramSet, const std::string &name, OfxParamHandle handle)
 hidden constructor

Private Member Functions

 mDeclareProtectedAssignAndCC (IntParam)
 IntParam (void)

Friends

class ParamSet

Detailed Description

Wraps up an integer param.

Definition at line 1010 of file ofxsParam.h.

Constructor & Destructor Documentation

OFX::IntParam::IntParam ( void  ) [inline, private]

Definition at line 1014 of file ofxsParam.h.

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

hidden constructor

Definition at line 1255 of file ofxsParams.cpp.

Member Function Documentation

void OFX::IntParam::getDefault ( int &  v) const

het the default value

Definition at line 1280 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDefault, and OFX::PropertySet::propGetInt().

Here is the call graph for this function:

int OFX::IntParam::getDefault ( void  ) const [inline]

het the default value

Definition at line 1036 of file ofxsParam.h.

References getDefault().

Referenced by getDefault().

Here is the call graph for this function:

void OFX::IntParam::getDisplayRange ( int &  min,
int &  max 
) const

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

Definition at line 1293 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDisplayMax, kOfxParamPropDisplayMin, and OFX::PropertySet::propGetInt().

Here is the call graph for this function:

void OFX::IntParam::getRange ( int &  min,
int &  max 
) const

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

Definition at line 1286 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropMax, kOfxParamPropMin, and OFX::PropertySet::propGetInt().

Here is the call graph for this function:

void OFX::IntParam::getValue ( int &  v) const

get value

Definition at line 1300 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetValue, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::histogram::HistogramPlugin::addRefOverlayData(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::addRefOverlayData(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::changedClip(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::changedClip(), tuttle::plugin::GeneratorPlugin::changedParam(), tuttle::plugin::WriterPlugin::changedParam(), tuttle::plugin::idKeyer::IdKeyerPlugin::changedParam(), tuttle::plugin::basicKeyer::BasicKeyerPlugin::changedParam(), tuttle::plugin::swscale::SwscalePlugin::changedParam(), tuttle::plugin::resize::ResizePlugin::changedParam(), tuttle::plugin::colorGradient::ColorGradientPlugin::changedParam(), tuttle::plugin::warp::WarpPlugin::changedParam(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::changedParam(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::changedParam(), tuttle::plugin::histogram::HistogramPlugin::changedParam(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::changedParam(), tuttle::plugin::warp::WarpOverlayInteract::draw(), tuttle::plugin::crop::CropPlugin::getCropRegionValue(), tuttle::plugin::nlmDenoiser::NLMDenoiserPlugin::getFramesNeeded(), tuttle::plugin::imagemagick::writer::ImageMagickWriterPlugin::getProcessParams(), tuttle::plugin::jpeg::writer::JpegWriterPlugin::getProcessParams(), tuttle::plugin::turboJpeg::writer::TurboJpegWriterPlugin::getProcessParams(), tuttle::plugin::idKeyer::IdKeyerPlugin::getProcessParams(), tuttle::plugin::openImageIO::writer::OpenImageIOWriterPlugin::getProcessParams(), tuttle::plugin::print::PrintPlugin::getProcessParams(), tuttle::plugin::basicKeyer::BasicKeyerPlugin::getProcessParams(), tuttle::plugin::text::TextPlugin::getProcessParams(), tuttle::plugin::colorGradient::ColorGradientPlugin::getProcessParams(), tuttle::plugin::warp::WarpPlugin::getProcessParams(), tuttle::plugin::GeneratorPlugin::getRegionOfDefinition(), tuttle::plugin::swscale::SwscalePlugin::getRegionOfDefinition(), tuttle::plugin::resize::ResizePlugin::getRegionOfDefinition(), tuttle::plugin::nlmDenoiser::NLMDenoiserPlugin::getRegionsOfInterest(), tuttle::plugin::warp::WarpOverlayInteract::penDown(), tuttle::plugin::warp::WarpOverlayInteract::penMotion(), tuttle::plugin::warp::WarpOverlayInteract::penUp(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::render(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::render(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::updateGeodesicForms(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::updateGeodesicForms(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::updateProcessGeodesicForms(), and tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::updateProcessGeodesicForms().

Here is the call graph for this function:

int OFX::IntParam::getValue ( void  ) const [inline]

and a nicer one

Definition at line 1048 of file ofxsParam.h.

References getValue().

Referenced by getValue().

Here is the call graph for this function:

void OFX::IntParam::getValueAtTime ( double  t,
int &  v 
) const

get the value at a time

Definition at line 1308 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetValueAtTime, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::inputBuffer::InputBufferPlugin::getProcessParams().

Here is the call graph for this function:

int OFX::IntParam::getValueAtTime ( double  t) const [inline]

and a nicer one

Definition at line 1054 of file ofxsParam.h.

References getValueAtTime().

Referenced by getValueAtTime().

Here is the call graph for this function:

OFX::IntParam::mDeclareProtectedAssignAndCC ( IntParam  ) [private]
void OFX::IntParam::setDefault ( int  v)

set the default value

Definition at line 1260 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDefault, and OFX::PropertySet::propSetInt().

Here is the call graph for this function:

void OFX::IntParam::setDisplayRange ( int  min,
int  max 
)

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

Definition at line 1273 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDisplayMax, kOfxParamPropDisplayMin, and OFX::PropertySet::propSetInt().

Here is the call graph for this function:

void OFX::IntParam::setRange ( int  min,
int  max 
)

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

Definition at line 1266 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropMax, kOfxParamPropMin, and OFX::PropertySet::propSetInt().

Here is the call graph for this function:

void OFX::IntParam::setValue ( int  v)

set value

Definition at line 1316 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetValue, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::WriterPlugin::changedParam(), tuttle::plugin::crop::CropPlugin::changedParam(), tuttle::plugin::warp::WarpPlugin::changedParam(), tuttle::plugin::warp::WarpOverlayInteract::penDown(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters(), and tuttle::plugin::raw::reader::RawReaderPlugin::updateInfos().

Here is the call graph for this function:

void OFX::IntParam::setValueAtTime ( double  t,
int  v 
)

set the value at a time, implicitly adds a keyframe

Definition at line 1324 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetValueAtTime, OFX::throwHostMissingSuiteException(), and OFX::throwSuiteStatusException().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::ValueParam.

Definition at line 1020 of file ofxsParam.h.

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