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

Wraps up an doubleeger param. More...

#include <ofxsParam.h>

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

Public Member Functions

void setDefault (double v)
 set the default value
void setShowTimeMarker (bool v)
 if the double type is Absolute time, show a time marker on the time line if possible
void setRange (double min, double max)
 set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX
void setDisplayRange (double min, double max)
 set the display min and max, default is to be the same as the range param
void getDefault (double &v) const
 het the default value
double getDefault (void) const
 het the default value
void getRange (double &min, double &max) const
 set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX
void getDisplayRange (double &min, double &max) const
 set the display min and max, default is to be the same as the range param
void getValue (double &v) const
 get value
double getValue (void) const
 get value
void getValueAtTime (double t, double &v) const
 get the value at a time
double getValueAtTime (double t) const
 get value
void setValue (double v)
 set value
void setValueAtTime (double t, double v)
 set the value at a time, implicitly adds a keyframe
void differentiate (double t, double &v) const
 differentiate the param
double differentiate (double t) const
 differentiate the param
void integrate (double t1, double t2, double &v) const
 integrate the param
double integrate (double t1, double t2) const
 integrate the param

Protected Member Functions

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

Private Member Functions

 mDeclareProtectedAssignAndCC (DoubleParam)
 DoubleParam (void)

Friends

class ParamSet

Detailed Description

Wraps up an doubleeger param.

Definition at line 1216 of file ofxsParam.h.

Constructor & Destructor Documentation

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

Definition at line 1220 of file ofxsParam.h.

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

hidden constructor

Definition at line 1602 of file ofxsParams.cpp.

Member Function Documentation

void OFX::DoubleParam::differentiate ( double  t,
double &  v 
) const

differentiate the param

get the value at a time

Definition at line 1680 of file ofxsParams.cpp.

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

Here is the call graph for this function:

double OFX::DoubleParam::differentiate ( double  t) const [inline]

differentiate the param

Definition at line 1275 of file ofxsParam.h.

References differentiate().

Referenced by differentiate().

Here is the call graph for this function:

void OFX::DoubleParam::getDefault ( double &  v) const

het the default value

Definition at line 1627 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::lens::LensDistortPlugin::isIdentity().

Here is the call graph for this function:

double OFX::DoubleParam::getDefault ( void  ) const [inline]

het the default value

Definition at line 1245 of file ofxsParam.h.

References getDefault().

Referenced by getDefault().

Here is the call graph for this function:

void OFX::DoubleParam::getDisplayRange ( double &  min,
double &  max 
) const

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

Definition at line 1640 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::DoubleParam::getRange ( double &  min,
double &  max 
) const

set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX

Definition at line 1633 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::DoubleParam::getValue ( double &  v) const

get value

Definition at line 1647 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::av::writer::AVWriterPlugin::beginSequenceRender(), tuttle::plugin::crop::CropPlugin::changedParam(), tuttle::plugin::crop::CropPlugin::computeCropRegion(), tuttle::plugin::histogramKeyer::HSLOverlay::draw(), tuttle::plugin::histogram::HSLOverlay::draw(), tuttle::plugin::histogramKeyer::RGBOverlay::draw(), tuttle::plugin::histogram::RGBOverlay::draw(), tuttle::plugin::av::reader::AVReaderPlugin::getClipPreferences(), tuttle::plugin::anisotropicFilter::tensors::TensorsPlugin::getMargin(), tuttle::plugin::colorTransform::ColorTransformPlugin::getProcessParams(), tuttle::plugin::timeShift::TimeShiftPlugin::getProcessParams(), tuttle::plugin::fade::FadePlugin::getProcessParams(), tuttle::plugin::colorTransfer::ColorTransferPlugin::getProcessParams(), tuttle::plugin::floodFill::FloodFillPlugin::getProcessParams(), tuttle::plugin::idKeyer::IdKeyerPlugin::getProcessParams(), tuttle::plugin::colorSuppress::ColorSuppressPlugin::getProcessParams(), tuttle::plugin::gamma::GammaPlugin::getProcessParams(), tuttle::plugin::mathOperator::MathOperatorPlugin::getProcessParams(), tuttle::plugin::blur::BlurPlugin::getProcessParams(), tuttle::plugin::colorGradation::ColorGradationPlugin::getProcessParams(), tuttle::plugin::text::TextPlugin::getProcessParams(), tuttle::plugin::pushPixel::PushPixelPlugin::getProcessParams(), tuttle::plugin::inputBuffer::InputBufferPlugin::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::lens::LensDistortPlugin::getRegionOfDefinition(), tuttle::plugin::timeShift::TimeShiftPlugin::isIdentity(), tuttle::plugin::lens::LensDistortPlugin::isIdentity(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::render(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::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:

double OFX::DoubleParam::getValue ( void  ) const [inline]

get value

Definition at line 1257 of file ofxsParam.h.

References getValue().

Referenced by getValue().

Here is the call graph for this function:

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

get the value at a time

Definition at line 1655 of file ofxsParams.cpp.

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

Here is the call graph for this function:

double OFX::DoubleParam::getValueAtTime ( double  t) const [inline]

get value

Definition at line 1263 of file ofxsParam.h.

References getValueAtTime().

Referenced by getValueAtTime().

Here is the call graph for this function:

void OFX::DoubleParam::integrate ( double  t1,
double  t2,
double &  v 
) const

integrate the param

get the value at a time

Definition at line 1689 of file ofxsParams.cpp.

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

Here is the call graph for this function:

double OFX::DoubleParam::integrate ( double  t1,
double  t2 
) const [inline]

integrate the param

Definition at line 1281 of file ofxsParam.h.

References integrate().

Referenced by integrate().

Here is the call graph for this function:

OFX::DoubleParam::mDeclareProtectedAssignAndCC ( DoubleParam  ) [private]
void OFX::DoubleParam::setDefault ( double  v)

set the default value

Definition at line 1607 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::DoubleParam::setDisplayRange ( double  min,
double  max 
)

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

Definition at line 1620 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::DoubleParam::setRange ( double  min,
double  max 
)

set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX

Definition at line 1613 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::DoubleParam::setShowTimeMarker ( bool  v)

if the double type is Absolute time, show a time marker on the time line if possible

void OFX::DoubleParam::setValue ( double  v)

set value

Definition at line 1663 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), tuttle::plugin::crop::CropPlugin::changedParam(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters(), and tuttle::plugin::raw::reader::RawReaderPlugin::updateInfos().

Here is the call graph for this function:

void OFX::DoubleParam::setValueAtTime ( double  t,
double  v 
)

set the value at a time, implicitly adds a keyframe

Definition at line 1671 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::BaseDoubleParam.

Definition at line 1226 of file ofxsParam.h.

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