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

Wraps up a choice param. More...

#include <ofxsParam.h>

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

Public Member Functions

void setDefault (int v)
 set the default value
void getDefault (int &v) const
 get the default value
int getNOptions (void) const
 how many options do we have
void appendOption (const std::string &shortName, const std::string &label="")
 append an option, default is to have not there
void resetOptions (void)
 clear all the options so as to add some new ones in
void getValue (int &v) const
 get value
int getValue () const
 get value
void getValueAtTime (double t, int &v) const
 get the value at a time
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

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

Private Member Functions

 mDeclareProtectedAssignAndCC (ChoiceParam)
 ChoiceParam (void)

Friends

class ParamSet

Detailed Description

Wraps up a choice param.

Definition at line 1539 of file ofxsParam.h.

Constructor & Destructor Documentation

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

Definition at line 1543 of file ofxsParam.h.

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

hidden constructor

Definition at line 2194 of file ofxsParams.cpp.

Member Function Documentation

void OFX::ChoiceParam::appendOption ( const std::string &  shortName,
const std::string &  label = "" 
)

append an option, default is to have not there

set the default value

Definition at line 2251 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropChoiceLabelOption, kOfxParamPropChoiceOption, OFX::PropertySet::propGetDimension(), and OFX::PropertySet::propSetString().

Referenced by tuttle::plugin::av::writer::AVWriterPlugin::updatePixelFormat().

Here is the call graph for this function:

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

get the default value

het the default value

Definition at line 2205 of file ofxsParams.cpp.

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

Here is the call graph for this function:

int OFX::ChoiceParam::getNOptions ( void  ) const

how many options do we have

Definition at line 2244 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropChoiceOption, and OFX::PropertySet::propGetDimension().

Here is the call graph for this function:

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

get value

Definition at line 2211 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::interact::IsActiveChoiceParamFunctor< negate >::active(), tuttle::plugin::av::writer::AVWriterPlugin::AVWriterPlugin(), tuttle::plugin::GeneratorPlugin::changedParam(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::changedParam(), tuttle::plugin::jpeg2000::writer::Jpeg2000WriterPlugin::changedParam(), tuttle::plugin::SamplerPlugin::changedParam(), tuttle::plugin::ctl::CTLPlugin::changedParam(), tuttle::plugin::exr::reader::EXRReaderPlugin::changedParam(), tuttle::plugin::seExpr::SeExprPlugin::changedParam(), tuttle::plugin::basicKeyer::BasicKeyerPlugin::changedParam(), tuttle::plugin::swscale::SwscalePlugin::changedParam(), tuttle::plugin::crop::CropPlugin::changedParam(), tuttle::plugin::resize::ResizePlugin::changedParam(), tuttle::plugin::normalize::NormalizePlugin::changedParam(), tuttle::plugin::colorGradation::ColorGradationPlugin::changedParam(), tuttle::plugin::av::writer::AVWriterPlugin::changedParam(), tuttle::plugin::inputBuffer::InputBufferPlugin::changedParam(), tuttle::plugin::pinning::PinningPlugin::changedParam(), tuttle::plugin::warp::WarpPlugin::changedParam(), tuttle::plugin::lens::LensDistortPlugin::changedParam(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::changedParam(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::changedParam(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::ColorCubeViewerPlugin(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::ColorSpaceKeyerPlugin(), tuttle::plugin::crop::CropPlugin::computeCropRegion(), tuttle::plugin::histogram::HSLOverlay::draw(), tuttle::plugin::histogramKeyer::HSLOverlay::draw(), tuttle::plugin::histogram::RGBOverlay::draw(), tuttle::plugin::histogramKeyer::RGBOverlay::draw(), tuttle::plugin::lens::LensDistortPlugin::getCenterType(), tuttle::plugin::bitDepth::BitDepthPlugin::getClipPreferences(), tuttle::plugin::GeneratorPlugin::getClipPreferences(), tuttle::plugin::component::ComponentPlugin::getClipPreferences(), tuttle::plugin::localmaxima::LocalMaximaPlugin::getClipPreferences(), tuttle::plugin::sobel::SobelPlugin::getClipPreferences(), tuttle::plugin::ReaderPlugin::getExplicitBitDepthConversion(), tuttle::plugin::ReaderPlugin::getExplicitChannelConversion(), tuttle::plugin::GeneratorPlugin::getExplicitConversion(), tuttle::plugin::gamma::GammaPlugin::getGammaType(), tuttle::plugin::ocio::lut::OCIOLutPlugin::getInterpolationType(), tuttle::plugin::lens::LensDistortPlugin::getLensType(), tuttle::plugin::mathOperator::MathOperatorPlugin::getMathOperatorType(), tuttle::plugin::colorSuppress::ColorSuppressPlugin::getOutputType(), tuttle::plugin::colorBars::ColorBarsPlugin::getProcessParams(), tuttle::plugin::quality::DiffPlugin::getProcessParams(), tuttle::plugin::colorWheel::ColorWheelPlugin::getProcessParams(), tuttle::plugin::colorCube::ColorCubePlugin::getProcessParams(), tuttle::plugin::png::writer::PngWriterPlugin::getProcessParams(), tuttle::plugin::jpeg2000::writer::Jpeg2000WriterPlugin::getProcessParams(), tuttle::plugin::thinning::ThinningPlugin::getProcessParams(), tuttle::plugin::turboJpeg::reader::TurboJpegReaderPlugin::getProcessParams(), tuttle::plugin::exr::writer::EXRWriterPlugin::getProcessParams(), tuttle::plugin::localmaxima::LocalMaximaPlugin::getProcessParams(), tuttle::plugin::fade::FadePlugin::getProcessParams(), tuttle::plugin::colorTransfer::ColorTransferPlugin::getProcessParams(), tuttle::plugin::exr::reader::EXRReaderPlugin::getProcessParams(), tuttle::plugin::turboJpeg::writer::TurboJpegWriterPlugin::getProcessParams(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::getProcessParams(), tuttle::plugin::ctl::CTLPlugin::getProcessParams(), tuttle::plugin::crop::CropPlugin::getProcessParams(), tuttle::plugin::floodFill::FloodFillPlugin::getProcessParams(), tuttle::plugin::seExpr::SeExprPlugin::getProcessParams(), tuttle::plugin::openImageIO::writer::OpenImageIOWriterPlugin::getProcessParams(), tuttle::plugin::gamma::GammaPlugin::getProcessParams(), tuttle::plugin::print::PrintPlugin::getProcessParams(), tuttle::plugin::colorSuppress::ColorSuppressPlugin::getProcessParams(), tuttle::plugin::mathOperator::MathOperatorPlugin::getProcessParams(), tuttle::plugin::blur::BlurPlugin::getProcessParams(), tuttle::plugin::ocio::lut::OCIOLutPlugin::getProcessParams(), tuttle::plugin::normalize::NormalizePlugin::getProcessParams(), tuttle::plugin::dpx::writer::DPXWriterPlugin::getProcessParams(), tuttle::plugin::merge::MergePlugin::getProcessParams(), tuttle::plugin::av::writer::AVWriterPlugin::getProcessParams(), tuttle::plugin::colorGradation::ColorGradationPlugin::getProcessParams(), tuttle::plugin::text::TextPlugin::getProcessParams(), tuttle::plugin::pushPixel::PushPixelPlugin::getProcessParams(), tuttle::plugin::ocio::colorspace::OCIOColorSpacePlugin::getProcessParams(), tuttle::plugin::inputBuffer::InputBufferPlugin::getProcessParams(), tuttle::plugin::pinning::PinningPlugin::getProcessParams(), tuttle::plugin::colorspace::ColorSpacePlugin::getProcessParams(), tuttle::plugin::sobel::SobelPlugin::getProcessParams(), tuttle::plugin::convolution::ConvolutionPlugin::getProcessParams(), tuttle::plugin::raw::reader::RawReaderPlugin::getProcessParams(), tuttle::plugin::warp::WarpPlugin::getProcessParams(), tuttle::plugin::GeneratorPlugin::getRegionOfDefinition(), tuttle::plugin::exr::reader::EXRReaderPlugin::getRegionOfDefinition(), tuttle::plugin::swscale::SwscalePlugin::getRegionOfDefinition(), tuttle::plugin::crop::CropPlugin::getRegionOfDefinition(), tuttle::plugin::resize::ResizePlugin::getRegionOfDefinition(), tuttle::plugin::lens::LensDistortPlugin::getRegionOfDefinition(), tuttle::plugin::lens::LensDistortPlugin::getResizeRod(), tuttle::plugin::swscale::SwscalePlugin::isIdentity(), tuttle::plugin::warp::WarpOverlayInteract::penDown(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penDown(), tuttle::plugin::histogram::HistogramOverlay::penDown(), tuttle::plugin::warp::WarpOverlayInteract::penMotion(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penMotion(), tuttle::plugin::histogram::HistogramOverlay::penMotion(), tuttle::plugin::warp::WarpOverlayInteract::penUp(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penUp(), tuttle::plugin::histogram::HistogramOverlay::penUp(), tuttle::plugin::colorGradient::ColorGradientPlugin::render(), tuttle::plugin::av::writer::AVWriterPlugin::render(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::render(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::render(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::updateGeodesicForms(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::updateGeodesicForms(), tuttle::plugin::colorspace::ColorSpacePlugin::updateInParams(), tuttle::plugin::colorGradation::ColorGradationPlugin::updateParameters(), tuttle::plugin::print::PrintPlugin::updateParams(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::updateProcessGeodesicForms(), and tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::updateProcessGeodesicForms().

Here is the call graph for this function:

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

get value

Definition at line 1571 of file ofxsParam.h.

References getValue().

Referenced by getValue().

Here is the call graph for this function:

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

get the value at a time

Definition at line 2219 of file ofxsParams.cpp.

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

Here is the call graph for this function:

OFX::ChoiceParam::mDeclareProtectedAssignAndCC ( ChoiceParam  ) [private]
void OFX::ChoiceParam::resetOptions ( void  )

clear all the options so as to add some new ones in

set the default value

Definition at line 2260 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropChoiceOption, and OFX::PropertySet::propReset().

Referenced by tuttle::plugin::av::writer::AVWriterPlugin::updatePixelFormat().

Here is the call graph for this function:

void OFX::ChoiceParam::setDefault ( int  v)

set the default value

Definition at line 2199 of file ofxsParams.cpp.

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

Here is the call graph for this function:

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

set value

Definition at line 2227 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::GeneratorPlugin::changedParam(), tuttle::plugin::jpeg2000::writer::Jpeg2000WriterPlugin::changedParam(), tuttle::plugin::ctl::CTLPlugin::changedParam(), tuttle::plugin::seExpr::SeExprPlugin::changedParam(), tuttle::plugin::swscale::SwscalePlugin::changedParam(), tuttle::plugin::crop::CropPlugin::changedParam(), tuttle::plugin::resize::ResizePlugin::changedParam(), tuttle::plugin::colorGradation::ColorGradationPlugin::changedParam(), tuttle::plugin::av::writer::AVWriterPlugin::changedParam(), tuttle::plugin::inputBuffer::InputBufferPlugin::changedParam(), and tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters().

Here is the call graph for this function:

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

set the value at a time, implicitly adds a keyframe

Definition at line 2235 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 1550 of file ofxsParam.h.

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