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

Wraps up a boolean param. More...

#include <ofxsParam.h>

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

Public Member Functions

void setDefault (bool v)
 set the default value
void getDefault (bool &v) const
 get the default value
bool getDefault (void) const
 get the default value
void getValue (bool &v) const
 get value
bool getValue (void) const
 get value
void getValueAtTime (double t, bool &v) const
 get the value at a time
bool getValueAtTime (double t) const
 get value
void setValue (bool v)
 set value
void setValueAtTime (double t, bool v)
 set the value at a time, implicitly adds a keyframe

Protected Member Functions

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

Private Member Functions

 mDeclareProtectedAssignAndCC (BooleanParam)
 BooleanParam (void)

Friends

class ParamSet

Detailed Description

Wraps up a boolean param.

Definition at line 1585 of file ofxsParam.h.

Constructor & Destructor Documentation

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

Definition at line 1589 of file ofxsParam.h.

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

hidden constructor

Definition at line 2135 of file ofxsParams.cpp.

Member Function Documentation

void OFX::BooleanParam::getDefault ( bool &  v) const

get the default value

het the default value

Definition at line 2146 of file ofxsParams.cpp.

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

Here is the call graph for this function:

bool OFX::BooleanParam::getDefault ( void  ) const [inline]

get the default value

Definition at line 1606 of file ofxsParam.h.

References getDefault().

Referenced by getDefault().

Here is the call graph for this function:

void OFX::BooleanParam::getValue ( bool &  v) const

get value

Definition at line 2152 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::interact::IsActiveBooleanParamFunctor< negate >::active(), tuttle::plugin::av::writer::AVWriterPlugin::beginSequenceRender(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::changedClip(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::changedClip(), tuttle::plugin::GeneratorPlugin::changedParam(), tuttle::plugin::swscale::SwscalePlugin::changedParam(), tuttle::plugin::av::reader::AVReaderPlugin::changedParam(), tuttle::plugin::crop::CropPlugin::changedParam(), tuttle::plugin::resize::ResizePlugin::changedParam(), tuttle::plugin::pinning::PinningPlugin::changedParam(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::changedParam(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::changedParam(), tuttle::plugin::histogram::HistogramPlugin::changedParam(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::changedParam(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::ColorCubeViewerPlugin(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::ColorSpaceKeyerPlugin(), tuttle::plugin::crop::CropPlugin::computeCropRegion(), tuttle::plugin::anisotropicFilter::tensors::TensorsMargin::draw(), tuttle::plugin::lens::LensDistortOverlayInteract::draw(), tuttle::plugin::warp::WarpOverlayInteract::draw(), tuttle::plugin::pinning::PinningOverlayInteract::draw(), tuttle::plugin::histogramKeyer::HSLOverlay::draw(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerOverlay::draw(), tuttle::plugin::colorCubeViewer::ColorCubeViewerOverlay::draw(), tuttle::plugin::histogram::HSLOverlay::draw(), tuttle::plugin::histogram::RGBOverlay::draw(), tuttle::plugin::histogramKeyer::RGBOverlay::draw(), tuttle::plugin::histogram::HistogramOverlay::draw(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::draw(), tuttle::plugin::av::reader::AVReaderPlugin::getClipPreferences(), tuttle::plugin::histogramKeyer::HSLOverlay::getOnlyChannelSelectedHSL(), tuttle::plugin::histogram::HSLOverlay::getOnlyChannelSelectedHSL(), tuttle::plugin::histogram::RGBOverlay::getOnlyChannelSelectedRGB(), tuttle::plugin::histogramKeyer::RGBOverlay::getOnlyChannelSelectedRGB(), tuttle::plugin::jpeg::writer::JpegWriterPlugin::getProcessParams(), tuttle::plugin::imagemagick::writer::ImageMagickWriterPlugin::getProcessParams(), tuttle::plugin::turboJpeg::reader::TurboJpegReaderPlugin::getProcessParams(), tuttle::plugin::jpeg2000::writer::Jpeg2000WriterPlugin::getProcessParams(), tuttle::plugin::flip::FlipPlugin::getProcessParams(), tuttle::plugin::turboJpeg::writer::TurboJpegWriterPlugin::getProcessParams(), tuttle::plugin::invert::InvertPlugin::getProcessParams(), tuttle::plugin::floodFill::FloodFillPlugin::getProcessParams(), tuttle::plugin::idKeyer::IdKeyerPlugin::getProcessParams(), tuttle::plugin::openImageIO::writer::OpenImageIOWriterPlugin::getProcessParams(), tuttle::plugin::resize::ResizePlugin::getProcessParams(), tuttle::plugin::gamma::GammaPlugin::getProcessParams(), tuttle::plugin::colorSuppress::ColorSuppressPlugin::getProcessParams(), tuttle::plugin::print::PrintPlugin::getProcessParams(), tuttle::plugin::blur::BlurPlugin::getProcessParams(), tuttle::plugin::normalize::NormalizePlugin::getProcessParams(), tuttle::plugin::dpx::writer::DPXWriterPlugin::getProcessParams(), tuttle::plugin::colorGradation::ColorGradationPlugin::getProcessParams(), tuttle::plugin::pushPixel::PushPixelPlugin::getProcessParams(), tuttle::plugin::text::TextPlugin::getProcessParams(), tuttle::plugin::sobel::SobelPlugin::getProcessParams(), tuttle::plugin::raw::reader::RawReaderPlugin::getProcessParams(), tuttle::plugin::warp::WarpPlugin::getProcessParams(), tuttle::plugin::lens::LensDistortPlugin::getProcessParams(), tuttle::plugin::GeneratorPlugin::getRegionOfDefinition(), tuttle::plugin::av::reader::AVReaderPlugin::getRegionOfDefinition(), tuttle::plugin::swscale::SwscalePlugin::getRegionOfDefinition(), tuttle::plugin::resize::ResizePlugin::getRegionOfDefinition(), tuttle::plugin::lens::LensDistortPlugin::getRegionsOfInterest(), tuttle::plugin::WriterPlugin::isIdentity(), tuttle::plugin::lens::LensDistortPlugin::isIdentity(), tuttle::plugin::histogram::Compute_alpha_pixel::operator()(), tuttle::plugin::histogramKeyer::Compute_alpha_pixel::operator()(), tuttle::plugin::histogram::HistogramOverlay::penDown(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penDown(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::render(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::render(), and tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters().

Here is the call graph for this function:

bool OFX::BooleanParam::getValue ( void  ) const [inline]

get value

Definition at line 1612 of file ofxsParam.h.

References getValue().

Referenced by getValue().

Here is the call graph for this function:

void OFX::BooleanParam::getValueAtTime ( double  t,
bool &  v 
) const

get the value at a time

Definition at line 2162 of file ofxsParams.cpp.

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

Here is the call graph for this function:

bool OFX::BooleanParam::getValueAtTime ( double  t) const [inline]

get value

Definition at line 1618 of file ofxsParam.h.

References getValueAtTime().

Referenced by getValueAtTime().

Here is the call graph for this function:

OFX::BooleanParam::mDeclareProtectedAssignAndCC ( BooleanParam  ) [private]
void OFX::BooleanParam::setDefault ( bool  v)

set the default value

Definition at line 2140 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::BooleanParam::setValue ( bool  v)

set value

Definition at line 2172 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::av::reader::AVReaderPlugin::changedParam(), and tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters().

Here is the call graph for this function:

void OFX::BooleanParam::setValueAtTime ( double  t,
bool  v 
)

set the value at a time, implicitly adds a keyframe

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

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