OFX::ParamSet Class Reference

A set of parameters in a plugin instance. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::ParamSet:

Collaboration diagram for OFX::ParamSet:

Public Types
typedef ParamSet	This
Public Member Functions
virtual	~ParamSet ()
	dtor
bool	paramExists (const std::string &name) const
void	beginEditBlock (const std::string &name)
	open an undoblock
void	endEditBlock ()
	close an undoblock
Param *	getParam (const std::string &name)
IntParam *	fetchIntParam (const std::string &name)
	Fetch an integer param.
Int2DParam *	fetchInt2DParam (const std::string &name)
	Fetch a 2D integer param.
Int3DParam *	fetchInt3DParam (const std::string &name)
	Fetch a 3D integer param.
DoubleParam *	fetchDoubleParam (const std::string &name)
	Fetch an double param.
Double2DParam *	fetchDouble2DParam (const std::string &name)
	Fetch a 2D double param.
Double3DParam *	fetchDouble3DParam (const std::string &name)
	Fetch a 3D double param.
StringParam *	fetchStringParam (const std::string &name)
	Fetch a string param.
RGBAParam *	fetchRGBAParam (const std::string &name)
	Fetch a RGBA param.
RGBParam *	fetchRGBParam (const std::string &name)
	Fetch an RGB param.
BooleanParam *	fetchBooleanParam (const std::string &name)
	Fetch a Boolean param.
ChoiceParam *	fetchChoiceParam (const std::string &name)
	Fetch a Choice param.
GroupParam *	fetchGroupParam (const std::string &name)
	Fetch a group param.
const GroupParam *	fetchGroupParam (const std::string &name) const
PageParam *	fetchPageParam (const std::string &name)
	Fetch a page param.
PushButtonParam *	fetchPushButtonParam (const std::string &name)
	Fetch a push button param.
CustomParam *	fetchCustomParam (const std::string &name)
	Fetch a custom param.
ParametricParam *	fetchParametricParam (const std::string &name)
	Fetch a parametric param.
Protected Member Functions
	mDeclareProtectedAssignAndCC (ParamSet)
ParamTypeEnum	getParamType (const std::string &name) const
template<class T >
T *	fetchAttribute (OfxImageEffectHandle pluginHandle, const std::string &name)
	Fetch a parametric param.
	ParamSet (void)
	Hidden ctor.
void	setParamSetHandle (OfxParamSetHandle h)
	set the param set handle
Private Member Functions
Param *	findPreviouslyFetchedParam (const std::string &name)
	see if we have a param of the given name in out map
void	fetchRawParam (const std::string &name, ParamTypeEnum paramType, OfxParamHandle &handle)
	calls the raw OFX routine to define a param
void	fetchRawCameraParam (OfxImageEffectHandle pluginHandle, const std::string &name, NukeOfxCameraHandle &handle)
	calls the raw OFX routine to fetch a param
template<class T >
T *	fetchParam (const std::string &name)
	Fetch a param of the given name and type.
Private Attributes
PropertySet	_paramSetProps
	Properties that belong to this param set.
OfxParamSetHandle	_paramSetHandle
	Parameter set handle.
std::map< std::string, Param * >	_fetchedParams
	Set of all previously fetched parameters, created on demand.

---

Detailed Description

A set of parameters in a plugin instance.

Definition at line 1891 of file ofxsParam.h.

---

Member Typedef Documentation

typedef ParamSet OFX::ParamSet::This

Definition at line 1894 of file ofxsParam.h.

---

Constructor & Destructor Documentation

OFX::ParamSet::ParamSet

(

void

)

[protected]

Hidden ctor.

hidden ctor

Definition at line 2540 of file ofxsParams.cpp.

OFX::ParamSet::~ParamSet

(

)

[virtual]

dtor

Definition at line 2565 of file ofxsParams.cpp.

References _fetchedParams.

---

Member Function Documentation

void OFX::ParamSet::beginEditBlock

(

const std::string &

name

)

open an undoblock

Definition at line 2830 of file ofxsParams.cpp.

References _paramSetHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramEditBegin, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::interact::InteractScene::penDown().

Here is the call graph for this function:

void OFX::ParamSet::endEditBlock

(

)

close an undoblock

Definition at line 2837 of file ofxsParams.cpp.

References _paramSetHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramEditEnd, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::interact::InteractScene::penUp().

Here is the call graph for this function:

CameraParam * OFX::ParamSet::fetchAttribute< CameraParam >	(	OfxImageEffectHandle	pluginHandle,
		const std::string &	name
	)		[inline, protected]

Fetch a parametric param.

Definition at line 1950 of file ofxsParam.h.

BooleanParam * OFX::ParamSet::fetchBooleanParam

(

const std::string &

name

)

Fetch a Boolean param.

Definition at line 2788 of file ofxsParams.cpp.

Referenced by tuttle::plugin::anisotropicFilter::diffusion::AnisotropicDiffusionProcess< View >::AnisotropicDiffusionProcess(), tuttle::plugin::anisotropicFilter::tensors::AnisotropicTensorsProcess< View >::AnisotropicTensorsProcess(), tuttle::plugin::av::reader::AVReaderPlugin::AVReaderPlugin(), tuttle::plugin::av::writer::AVWriterPlugin::AVWriterPlugin(), tuttle::plugin::blur::BlurPlugin::BlurPlugin(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::ColorCubeViewerPlugin(), tuttle::plugin::colorGradation::ColorGradationPlugin::ColorGradationPlugin(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::ColorSpaceKeyerPlugin(), tuttle::plugin::colorSuppress::ColorSuppressPlugin::ColorSuppressPlugin(), tuttle::plugin::component::ComponentPlugin::ComponentPlugin(), tuttle::plugin::crop::CropPlugin::CropPlugin(), tuttle::plugin::av::writer::AVWriterPlugin::disableAVOptionsForCodecOrFormat(), tuttle::plugin::dpx::writer::DPXWriterPlugin::DPXWriterPlugin(), tuttle::plugin::flip::FlipPlugin::FlipPlugin(), tuttle::plugin::floodFill::FloodFillPlugin::FloodFillPlugin(), tuttle::plugin::gamma::GammaPlugin::GammaPlugin(), tuttle::plugin::GeneratorPlugin::GeneratorPlugin(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::HistogramKeyerPlugin(), tuttle::plugin::histogram::HistogramPlugin::HistogramPlugin(), tuttle::plugin::idKeyer::IdKeyerPlugin::IdKeyerPlugin(), tuttle::plugin::imagemagick::writer::ImageMagickWriterPlugin::ImageMagickWriterPlugin(), tuttle::plugin::invert::InvertPlugin::InvertPlugin(), tuttle::plugin::jpeg2000::writer::Jpeg2000WriterPlugin::Jpeg2000WriterPlugin(), tuttle::plugin::jpeg::writer::JpegWriterPlugin::JpegWriterPlugin(), tuttle::plugin::lens::LensDistortPlugin::LensDistortPlugin(), tuttle::plugin::mathOperator::MathOperatorPlugin::MathOperatorPlugin(), tuttle::plugin::nlmDenoiser::NLMDenoiserProcess< View >::NLMDenoiserProcess(), tuttle::plugin::normalize::NormalizePlugin::NormalizePlugin(), tuttle::plugin::pinning::PinningPlugin::PinningPlugin(), tuttle::plugin::print::PrintPlugin::PrintPlugin(), tuttle::plugin::pushPixel::PushPixelPlugin::PushPixelPlugin(), tuttle::plugin::ramp::RampPlugin::RampPlugin(), tuttle::plugin::raw::reader::RawReaderPlugin::RawReaderPlugin(), tuttle::plugin::resize::ResizePlugin::ResizePlugin(), tuttle::plugin::sobel::SobelPlugin::SobelPlugin(), tuttle::plugin::swscale::SwscalePlugin::SwscalePlugin(), tuttle::plugin::anisotropicFilter::tensors::TensorsPlugin::TensorsPlugin(), tuttle::plugin::text::TextPlugin::TextPlugin(), tuttle::plugin::turboJpeg::reader::TurboJpegReaderPlugin::TurboJpegReaderPlugin(), tuttle::plugin::turboJpeg::writer::TurboJpegWriterPlugin::TurboJpegWriterPlugin(), tuttle::plugin::warp::WarpPlugin::WarpPlugin(), and tuttle::plugin::WriterPlugin::WriterPlugin().

ChoiceParam * OFX::ParamSet::fetchChoiceParam

(

const std::string &

name

)

Fetch a Choice param.

Definition at line 2794 of file ofxsParams.cpp.

Referenced by tuttle::plugin::anisotropicFilter::tensors::AnisotropicTensorsProcess< View >::AnisotropicTensorsProcess(), tuttle::plugin::av::reader::AVReaderPlugin::AVReaderPlugin(), tuttle::plugin::av::writer::AVWriterPlugin::AVWriterPlugin(), tuttle::plugin::basicKeyer::BasicKeyerPlugin::BasicKeyerPlugin(), tuttle::plugin::bitDepth::BitDepthPlugin::BitDepthPlugin(), tuttle::plugin::blur::BlurPlugin::BlurPlugin(), tuttle::plugin::colorBars::ColorBarsPlugin::ColorBarsPlugin(), tuttle::plugin::colorCube::ColorCubePlugin::ColorCubePlugin(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::ColorCubeViewerPlugin(), tuttle::plugin::colorGradation::ColorGradationPlugin::ColorGradationPlugin(), tuttle::plugin::colorGradient::ColorGradientPlugin::ColorGradientPlugin(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::ColorSpaceKeyerPlugin(), tuttle::plugin::colorspace::ColorSpacePlugin::ColorSpacePlugin(), tuttle::plugin::colorSuppress::ColorSuppressPlugin::ColorSuppressPlugin(), tuttle::plugin::colorTransfer::ColorTransferPlugin::ColorTransferPlugin(), tuttle::plugin::colorWheel::ColorWheelPlugin::ColorWheelPlugin(), tuttle::plugin::component::ComponentPlugin::ComponentPlugin(), tuttle::plugin::convolution::ConvolutionPlugin::ConvolutionPlugin(), tuttle::plugin::crop::CropPlugin::CropPlugin(), tuttle::plugin::ctl::CTLPlugin::CTLPlugin(), tuttle::plugin::quality::DiffPlugin::DiffPlugin(), tuttle::plugin::av::writer::AVWriterPlugin::disableAVOptionsForCodecOrFormat(), tuttle::plugin::dpx::writer::DPXWriterPlugin::DPXWriterPlugin(), tuttle::plugin::exr::reader::EXRReaderPlugin::EXRReaderPlugin(), tuttle::plugin::exr::writer::EXRWriterPlugin::EXRWriterPlugin(), tuttle::plugin::fade::FadePlugin::FadePlugin(), tuttle::plugin::floodFill::FloodFillPlugin::FloodFillPlugin(), tuttle::plugin::gamma::GammaPlugin::GammaPlugin(), tuttle::plugin::GeneratorPlugin::GeneratorPlugin(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::HistogramKeyerPlugin(), tuttle::plugin::histogram::HistogramPlugin::HistogramPlugin(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::ImageStatisticsPlugin(), tuttle::plugin::inputBuffer::InputBufferPlugin::InputBufferPlugin(), tuttle::plugin::jpeg2000::writer::Jpeg2000WriterPlugin::Jpeg2000WriterPlugin(), tuttle::plugin::lens::LensDistortPlugin::LensDistortPlugin(), tuttle::plugin::localmaxima::LocalMaximaPlugin::LocalMaximaPlugin(), tuttle::plugin::mathOperator::MathOperatorPlugin::MathOperatorPlugin(), tuttle::plugin::merge::MergePlugin::MergePlugin(), tuttle::plugin::normalize::NormalizePlugin::NormalizePlugin(), tuttle::plugin::ocio::colorspace::OCIOColorSpacePlugin::OCIOColorSpacePlugin(), tuttle::plugin::ocio::lut::OCIOLutPlugin::OCIOLutPlugin(), tuttle::plugin::openImageIO::writer::OpenImageIOWriterPlugin::OpenImageIOWriterPlugin(), tuttle::plugin::pinning::PinningPlugin::PinningPlugin(), tuttle::plugin::png::writer::PngWriterPlugin::PngWriterPlugin(), tuttle::plugin::print::PrintPlugin::PrintPlugin(), tuttle::plugin::pushPixel::PushPixelPlugin::PushPixelPlugin(), tuttle::plugin::ramp::RampPlugin::RampPlugin(), tuttle::plugin::raw::reader::RawReaderPlugin::RawReaderPlugin(), tuttle::plugin::ReaderPlugin::ReaderPlugin(), tuttle::plugin::resize::ResizePlugin::ResizePlugin(), tuttle::plugin::SamplerPlugin::SamplerPlugin(), tuttle::plugin::seExpr::SeExprPlugin::SeExprPlugin(), tuttle::plugin::sobel::SobelPlugin::SobelPlugin(), tuttle::plugin::swscale::SwscalePlugin::SwscalePlugin(), tuttle::plugin::text::TextPlugin::TextPlugin(), tuttle::plugin::thinning::ThinningPlugin::ThinningPlugin(), tuttle::plugin::turboJpeg::reader::TurboJpegReaderPlugin::TurboJpegReaderPlugin(), tuttle::plugin::turboJpeg::writer::TurboJpegWriterPlugin::TurboJpegWriterPlugin(), tuttle::plugin::warp::WarpPlugin::WarpPlugin(), and tuttle::plugin::WriterPlugin::WriterPlugin().

CustomParam * OFX::ParamSet::fetchCustomParam

(

const std::string &

name

)

Fetch a custom param.

Definition at line 2818 of file ofxsParams.cpp.

Double2DParam * OFX::ParamSet::fetchDouble2DParam

(

const std::string &

name

)

Fetch a 2D double param.

Definition at line 2758 of file ofxsParams.cpp.

Referenced by tuttle::plugin::basicKeyer::BasicKeyerPlugin::BasicKeyerPlugin(), tuttle::plugin::blur::BlurPlugin::BlurPlugin(), tuttle::plugin::colorGradient::ColorGradientPlugin::ColorGradientPlugin(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::ImageStatisticsPlugin(), tuttle::plugin::inputBuffer::InputBufferPlugin::InputBufferPlugin(), tuttle::plugin::lens::LensDistortPlugin::LensDistortPlugin(), tuttle::plugin::move2D::Move2DPlugin::Move2DPlugin(), tuttle::plugin::pinning::PinningPlugin::PinningPlugin(), tuttle::plugin::raw::reader::RawReaderPlugin::RawReaderPlugin(), tuttle::plugin::resize::ResizePlugin::ResizePlugin(), tuttle::plugin::seExpr::SeExprPlugin::SeExprPlugin(), tuttle::plugin::sobel::SobelPlugin::SobelPlugin(), tuttle::plugin::swscale::SwscalePlugin::SwscalePlugin(), tuttle::plugin::text::TextPlugin::TextPlugin(), and tuttle::plugin::warp::WarpPlugin::WarpPlugin().

Double3DParam * OFX::ParamSet::fetchDouble3DParam

(

const std::string &

name

)

Fetch a 3D double param.

Definition at line 2764 of file ofxsParams.cpp.

Referenced by tuttle::plugin::imageStatistics::ImageStatisticsPlugin::ImageStatisticsPlugin(), and tuttle::plugin::pinning::PinningPlugin::PinningPlugin().

DoubleParam * OFX::ParamSet::fetchDoubleParam

(

const std::string &

name

)

Fetch an double param.

Fetch an double param, only callable from describe in context.

Definition at line 2752 of file ofxsParams.cpp.

Referenced by tuttle::plugin::anisotropicFilter::tensors::AnisotropicTensorsProcess< View >::AnisotropicTensorsProcess(), tuttle::plugin::av::reader::AVReaderPlugin::AVReaderPlugin(), tuttle::plugin::av::writer::AVWriterPlugin::AVWriterPlugin(), tuttle::plugin::blur::BlurPlugin::BlurPlugin(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::ColorCubeViewerPlugin(), tuttle::plugin::colorGradation::ColorGradationPlugin::ColorGradationPlugin(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::ColorSpaceKeyerPlugin(), tuttle::plugin::colorspace::ColorSpacePlugin::ColorSpacePlugin(), tuttle::plugin::colorSuppress::ColorSuppressPlugin::ColorSuppressPlugin(), tuttle::plugin::colorTransfer::ColorTransferPlugin::ColorTransferPlugin(), tuttle::plugin::colorTransform::ColorTransformPlugin::ColorTransformPlugin(), tuttle::plugin::convolution::ConvolutionPlugin::ConvolutionPlugin(), tuttle::plugin::crop::CropPlugin::CropPlugin(), tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::DebugImageEffectApiPlugin(), tuttle::plugin::av::writer::AVWriterPlugin::disableAVOptionsForCodecOrFormat(), tuttle::plugin::fade::FadePlugin::FadePlugin(), tuttle::plugin::floodFill::FloodFillPlugin::FloodFillPlugin(), tuttle::plugin::gamma::GammaPlugin::GammaPlugin(), tuttle::plugin::GeneratorPlugin::GeneratorPlugin(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::HistogramKeyerPlugin(), tuttle::plugin::histogram::HistogramPlugin::HistogramPlugin(), tuttle::plugin::idKeyer::IdKeyerPlugin::IdKeyerPlugin(), tuttle::plugin::inputBuffer::InputBufferPlugin::InputBufferPlugin(), tuttle::plugin::lens::LensDistortPlugin::LensDistortPlugin(), tuttle::plugin::mathOperator::MathOperatorPlugin::MathOperatorPlugin(), tuttle::plugin::nlmDenoiser::NLMDenoiserProcess< View >::NLMDenoiserProcess(), tuttle::plugin::pushPixel::PushPixelPlugin::PushPixelPlugin(), tuttle::plugin::raw::reader::RawReaderPlugin::RawReaderPlugin(), tuttle::plugin::SamplerPlugin::SamplerPlugin(), tuttle::plugin::sobel::SobelPlugin::SobelPlugin(), tuttle::plugin::anisotropicFilter::tensors::TensorsPlugin::TensorsPlugin(), tuttle::plugin::text::TextPlugin::TextPlugin(), tuttle::plugin::timeShift::TimeShiftPlugin::TimeShiftPlugin(), and tuttle::plugin::warp::WarpPlugin::WarpPlugin().

GroupParam * OFX::ParamSet::fetchGroupParam

(

const std::string &

name

)

Fetch a group param.

Definition at line 2800 of file ofxsParams.cpp.

Referenced by tuttle::plugin::crop::CropPlugin::CropPlugin(), tuttle::plugin::av::writer::AVWriterPlugin::disableAVOptionsForCodecOrFormat(), fetchGroupParam(), OFX::Param::getParent(), tuttle::plugin::invert::InvertPlugin::InvertPlugin(), tuttle::plugin::lens::LensDistortPlugin::LensDistortPlugin(), tuttle::plugin::normalize::NormalizePlugin::NormalizePlugin(), tuttle::plugin::pinning::PinningPlugin::PinningPlugin(), and tuttle::plugin::warp::WarpPlugin::WarpPlugin().

const GroupParam* OFX::ParamSet::fetchGroupParam

(

const std::string &

name

)

const [inline]

Definition at line 2013 of file ofxsParam.h.

References fetchGroupParam().

Here is the call graph for this function:

Int2DParam * OFX::ParamSet::fetchInt2DParam

(

const std::string &

name

)

Fetch a 2D integer param.

Definition at line 2740 of file ofxsParams.cpp.

Referenced by tuttle::plugin::checkerboard::CheckerboardPlugin::CheckerboardPlugin(), tuttle::plugin::convolution::ConvolutionPlugin::ConvolutionPlugin(), tuttle::plugin::av::writer::AVWriterPlugin::disableAVOptionsForCodecOrFormat(), tuttle::plugin::GeneratorPlugin::GeneratorPlugin(), tuttle::plugin::inputBuffer::InputBufferPlugin::InputBufferPlugin(), tuttle::plugin::merge::MergePlugin::MergePlugin(), tuttle::plugin::print::PrintPlugin::PrintPlugin(), tuttle::plugin::resize::ResizePlugin::ResizePlugin(), and tuttle::plugin::swscale::SwscalePlugin::SwscalePlugin().

Int3DParam * OFX::ParamSet::fetchInt3DParam

(

const std::string &

name

)

Fetch a 3D integer param.

Definition at line 2746 of file ofxsParams.cpp.

IntParam * OFX::ParamSet::fetchIntParam

(

const std::string &

name

)

Fetch an integer param.

Fetch an integer param, only callable from describe in context.

Definition at line 2734 of file ofxsParams.cpp.

Referenced by tuttle::plugin::basicKeyer::BasicKeyerPlugin::BasicKeyerPlugin(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::ColorCubeViewerPlugin(), tuttle::plugin::colorGradient::ColorGradientPlugin::ColorGradientPlugin(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::ColorSpaceKeyerPlugin(), tuttle::plugin::crop::CropPlugin::CropPlugin(), tuttle::plugin::av::writer::AVWriterPlugin::disableAVOptionsForCodecOrFormat(), tuttle::plugin::GeneratorPlugin::GeneratorPlugin(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::HistogramKeyerPlugin(), tuttle::plugin::histogram::HistogramPlugin::HistogramPlugin(), tuttle::plugin::idKeyer::IdKeyerPlugin::IdKeyerPlugin(), tuttle::plugin::imagemagick::writer::ImageMagickWriterPlugin::ImageMagickWriterPlugin(), tuttle::plugin::inputBuffer::InputBufferPlugin::InputBufferPlugin(), tuttle::plugin::jpeg::writer::JpegWriterPlugin::JpegWriterPlugin(), tuttle::plugin::nlmDenoiser::NLMDenoiserPlugin::NLMDenoiserPlugin(), tuttle::plugin::nlmDenoiser::NLMDenoiserProcess< View >::NLMDenoiserProcess(), tuttle::plugin::openImageIO::writer::OpenImageIOWriterPlugin::OpenImageIOWriterPlugin(), tuttle::plugin::print::PrintPlugin::PrintPlugin(), tuttle::plugin::raw::reader::RawReaderPlugin::RawReaderPlugin(), tuttle::plugin::resize::ResizePlugin::ResizePlugin(), tuttle::plugin::SamplerPlugin::SamplerPlugin(), tuttle::plugin::swscale::SwscalePlugin::SwscalePlugin(), tuttle::plugin::text::TextPlugin::TextPlugin(), tuttle::plugin::turboJpeg::writer::TurboJpegWriterPlugin::TurboJpegWriterPlugin(), tuttle::plugin::warp::WarpPlugin::WarpPlugin(), and tuttle::plugin::WriterPlugin::WriterPlugin().

PageParam * OFX::ParamSet::fetchPageParam

(

const std::string &

name

)

Fetch a page param.

Fetch a Page param.

Definition at line 2806 of file ofxsParams.cpp.

template<class T >

T* OFX::ParamSet::fetchParam

(

const std::string &

name

)

[inline, private]

Fetch a param of the given name and type.

Definition at line 1918 of file ofxsParam.h.

References _fetchedParams, fetchRawParam(), and findPreviouslyFetchedParam().

Here is the call graph for this function:

ParametricParam * OFX::ParamSet::fetchParametricParam

(

const std::string &

name

)

Fetch a parametric param.

Definition at line 2824 of file ofxsParams.cpp.

Referenced by tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::HistogramKeyerPlugin(), and tuttle::plugin::histogram::HistogramPlugin::HistogramPlugin().

PushButtonParam * OFX::ParamSet::fetchPushButtonParam

(

const std::string &

name

)

Fetch a push button param.

Definition at line 2812 of file ofxsParams.cpp.

Referenced by tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::ColorCubeViewerPlugin(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::ColorSpaceKeyerPlugin(), tuttle::plugin::ctl::CTLPlugin::CTLPlugin(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::HistogramKeyerPlugin(), tuttle::plugin::histogram::HistogramPlugin::HistogramPlugin(), tuttle::plugin::normalize::NormalizePlugin::NormalizePlugin(), tuttle::plugin::pinning::PinningPlugin::PinningPlugin(), tuttle::plugin::warp::WarpPlugin::WarpPlugin(), and tuttle::plugin::WriterPlugin::WriterPlugin().

void OFX::ParamSet::fetchRawCameraParam	(	OfxImageEffectHandle	pluginHandle,
		const std::string &	name,
		NukeOfxCameraHandle &	handle
	)		[private]

calls the raw OFX routine to fetch a param

Definition at line 2599 of file ofxsParams.cpp.

References NukeOfxCameraSuiteV1::cameraGetHandle, OFX::Private::gCameraParameterSuite, and OFX::throwSuiteStatusException().

Here is the call graph for this function:

void OFX::ParamSet::fetchRawParam	(	const std::string &	name,
		ParamTypeEnum	paramType,
		OfxParamHandle &	handle
	)		[private]

calls the raw OFX routine to define a param

calls the raw OFX routine to fetch a param

Definition at line 2580 of file ofxsParams.cpp.

References _paramSetHandle, OFX::Private::gParamSuite, kOfxParamPropType, OFX::mapParamTypeEnumToString(), OfxParameterSuiteV1::paramGetHandle, OFX::PropertySet::propGetString(), and OFX::throwSuiteStatusException().

Referenced by fetchParam().

Here is the call graph for this function:

RGBAParam * OFX::ParamSet::fetchRGBAParam

(

const std::string &

name

)

Fetch a RGBA param.

Definition at line 2776 of file ofxsParams.cpp.

Referenced by tuttle::plugin::basicKeyer::BasicKeyerPlugin::BasicKeyerPlugin(), tuttle::plugin::checkerboard::CheckerboardPlugin::CheckerboardPlugin(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::ColorCubeViewerPlugin(), tuttle::plugin::colorGradient::ColorGradientPlugin::ColorGradientPlugin(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::ColorSpaceKeyerPlugin(), tuttle::plugin::colorTransform::ColorTransformPlugin::ColorTransformPlugin(), tuttle::plugin::constant::ConstantPlugin::ConstantPlugin(), tuttle::plugin::crop::CropPlugin::CropPlugin(), tuttle::plugin::quality::DiffPlugin::DiffPlugin(), tuttle::plugin::fade::FadePlugin::FadePlugin(), tuttle::plugin::idKeyer::IdKeyerPlugin::IdKeyerPlugin(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::ImageStatisticsPlugin(), tuttle::plugin::normalize::NormalizePlugin::NormalizePlugin(), tuttle::plugin::ramp::RampPlugin::RampPlugin(), and tuttle::plugin::text::TextPlugin::TextPlugin().

RGBParam * OFX::ParamSet::fetchRGBParam

(

const std::string &

name

)

Fetch an RGB param.

Definition at line 2782 of file ofxsParams.cpp.

Referenced by tuttle::plugin::anisotropicFilter::diffusion::AnisotropicDiffusionPlugin::AnisotropicDiffusionPlugin(), tuttle::plugin::anisotropicFilter::diffusion::AnisotropicDiffusionProcess< View >::AnisotropicDiffusionProcess(), tuttle::plugin::pinning::PinningPlugin::PinningPlugin(), and tuttle::plugin::warp::WarpPlugin::WarpPlugin().

StringParam * OFX::ParamSet::fetchStringParam

(

const std::string &

name

)

Fetch a string param.

Definition at line 2770 of file ofxsParams.cpp.

Referenced by tuttle::plugin::av::reader::AVReaderPlugin::AVReaderPlugin(), tuttle::plugin::ctl::CTLPlugin::CTLPlugin(), tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::DebugImageEffectApiPlugin(), tuttle::plugin::av::writer::AVWriterPlugin::disableAVOptionsForCodecOrFormat(), tuttle::plugin::dpx::writer::DPXWriterPlugin::DPXWriterPlugin(), tuttle::plugin::inputBuffer::InputBufferPlugin::InputBufferPlugin(), tuttle::plugin::lut::LutPlugin::LutPlugin(), tuttle::plugin::ocio::colorspace::OCIOColorSpacePlugin::OCIOColorSpacePlugin(), tuttle::plugin::ocio::lut::OCIOLutPlugin::OCIOLutPlugin(), tuttle::plugin::outputBuffer::OutputBufferPlugin::OutputBufferPlugin(), tuttle::plugin::raw::reader::RawReaderPlugin::RawReaderPlugin(), tuttle::plugin::ReaderPlugin::ReaderPlugin(), tuttle::plugin::seExpr::SeExprPlugin::SeExprPlugin(), tuttle::plugin::text::TextPlugin::TextPlugin(), and tuttle::plugin::WriterPlugin::WriterPlugin().

Param * OFX::ParamSet::findPreviouslyFetchedParam

(

const std::string &

name

)

[private]

see if we have a param of the given name in out map

if a param has been fetched in this set, go find it

Definition at line 2723 of file ofxsParams.cpp.

References _fetchedParams.

Referenced by fetchParam().

Param * OFX::ParamSet::getParam

(

const std::string &

name

)

Definition at line 2632 of file ofxsParams.cpp.

References _paramSetHandle, OFX::eBooleanParam, OFX::eCameraParam, OFX::eChoiceParam, OFX::eCustomParam, OFX::eDouble2DParam, OFX::eDouble3DParam, OFX::eDoubleParam, OFX::eGroupParam, OFX::eInt2DParam, OFX::eInt3DParam, OFX::eIntParam, OFX::ePageParam, OFX::eParametricParam, OFX::ePushButtonParam, OFX::eRGBAParam, OFX::eRGBParam, OFX::eStringParam, OFX::Private::gParamSuite, kOfxParamPropType, kOfxStatErrFatal, OFX::mapParamTypeStringToEnum(), OfxParameterSuiteV1::paramGetHandle, OFX::PropertySet::propGetString(), and OFX::throwSuiteStatusException().

Here is the call graph for this function:

ParamTypeEnum OFX::ParamSet::getParamType

(

const std::string &

name

)

const [protected]

Definition at line 2608 of file ofxsParams.cpp.

References _paramSetHandle, OFX::Private::gParamSuite, kOfxParamPropType, OFX::mapParamTypeStringToEnum(), OfxParameterSuiteV1::paramGetHandle, OFX::PropertySet::propGetString(), and OFX::throwSuiteStatusException().

Here is the call graph for this function:

OFX::ParamSet::mDeclareProtectedAssignAndCC

(

ParamSet

)

[protected]

bool OFX::ParamSet::paramExists

(

const std::string &

name

)

const

Definition at line 2621 of file ofxsParams.cpp.

References _paramSetHandle, OFX::Private::gParamSuite, kOfxStatOK, and OfxParameterSuiteV1::paramGetHandle.

void OFX::ParamSet::setParamSetHandle

(

OfxParamSetHandle

h

)

[protected]

set the param set handle

Definition at line 2545 of file ofxsParams.cpp.

References _paramSetHandle, _paramSetProps, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetGetPropertySet, OFX::PropertySet::propSetHandle(), and OFX::throwSuiteStatusException().

Referenced by OFX::ImageEffect::ImageEffect().

Here is the call graph for this function:

---

Field Documentation

std::map<std::string, Param*> OFX::ParamSet::_fetchedParams [mutable, private]

Set of all previously fetched parameters, created on demand.

Definition at line 1907 of file ofxsParam.h.

Referenced by fetchParam(), findPreviouslyFetchedParam(), and ~ParamSet().

OfxParamSetHandle OFX::ParamSet::_paramSetHandle [private]

Parameter set handle.

Definition at line 1904 of file ofxsParam.h.

Referenced by beginEditBlock(), endEditBlock(), fetchRawParam(), getParam(), getParamType(), paramExists(), and setParamSetHandle().

PropertySet OFX::ParamSet::_paramSetProps [private]

Properties that belong to this param set.

Definition at line 1901 of file ofxsParam.h.

Referenced by setParamSetHandle().

---

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

• libraries/openfxHack/Support/include/ofxsParam.h
• libraries/openfxHack/Support/Library/ofxsParams.cpp