OFX::Clip Class Reference

Wraps up a clip instance. More...

#include <ofxsImageEffect.h>

Collaboration diagram for OFX::Clip:

Public Member Functions
const PropertySet &	getPropertySet () const
	get the underlying property set on this clip
PropertySet &	getPropertySet ()
	get the underlying property set on this clip
OfxImageClipHandle	getHandle ()
	get the OFX clip handle
const std::string &	name (void) const
	get the name
void	getLabels (std::string &label, std::string &shortLabel, std::string &longLabel) const
	fetch the labels
EBitDepth	getPixelDepth (void) const
	what is the pixel depth images will be given to us as
EPixelComponent	getPixelComponents (void) const
	what is the components images will be given to us as
std::string	getPixelComponentsProperty (void) const
	get the string representing the pixel components
EBitDepth	getUnmappedPixelDepth (void) const
	what is the actual pixel depth of the clip
EPixelComponent	getUnmappedPixelComponents (void) const
	what is the component type of the clip
std::string	getUnmappedPixelComponentsProperty (void) const
	get the string representing the pixel components
EPreMultiplication	getPreMultiplication (void) const
	get the components in the image
EField	getFieldOrder (void) const
	which spatial field comes first temporally
bool	isConnected (void) const
	is the clip connected
bool	hasContinuousSamples (void) const
	can the clip be continuously sampled
double	getPixelAspectRatio (void) const
	get the scale factor that has been applied to this clip
double	getFrameRate (void) const
	get the frame rate, in frames per second on this clip, after any clip preferences have been applied
OfxRangeD	getFrameRange (void) const
	return the range of frames over which this clip has images, after any clip preferences have been applied
double	getUnmappedFrameRate (void) const
	get the frame rate, in frames per second on this clip, before any clip preferences have been applied
OfxRangeD	getUnmappedFrameRange (void) const
	return the range of frames over which this clip has images, before any clip preferences have been applied
OfxRectD	getCanonicalRod (const OfxTime t) const
	get the RoD for this clip in the cannonical coordinate system
OfxRectD	getCanonicalRod (const OfxTime t, const OfxPointD &renderScale) const
OfxPointD	getCanonicalRodSize (const OfxTime t) const
OfxPointD	getCanonicalRodSize (const OfxTime t, const OfxPointD &renderScale) const
OfxRectI	getPixelRod (const OfxTime t) const
	get the RoD for this clip in pixel space
OfxRectI	getPixelRod (const OfxTime t, const OfxPointD &renderScale) const
OfxPointI	getPixelRodSize (const OfxTime t) const
OfxPointI	getPixelRodSize (const OfxTime t, const OfxPointD &renderScale) const
Image *	fetchImage (OfxTime t)
	fetch an image
Image *	fetchImage (OfxTime t, OfxRectD bounds)
	fetch an image, with a specific region in cannonical coordinates
Image *	fetchImage (OfxTime t, OfxRectD *bounds)
	fetch an image, with a specific region in cannonical coordinates
Protected Member Functions
	mDeclareProtectedAssignAndCC (Clip)
	Clip (ImageEffect *effect, const std::string &name, OfxImageClipHandle handle, OfxPropertySetHandle props)
	hidden constructor
Protected Attributes
std::string	_clipName
	name of the clip
PropertySet	_clipProps
	properties for this clip
OfxImageClipHandle	_clipHandle
	handle for this clip
ImageEffect *	_effect
	effect instance that owns this clip
Friends
class	ImageEffect
	so one can be made

---

Detailed Description

Wraps up a clip instance.

Definition at line 580 of file ofxsImageEffect.h.

---

Constructor & Destructor Documentation

OFX::Clip::Clip	(	ImageEffect *	effect,
		const std::string &	name,
		OfxImageClipHandle	handle,
		OfxPropertySetHandle	props
	)		[protected]

hidden constructor

Definition at line 901 of file ofxsImageEffect.cpp.

References _clipProps, and OFX::Validation::validateClipInstanceProperties().

Here is the call graph for this function:

---

Member Function Documentation

Image * OFX::Clip::fetchImage

(

OfxTime

t

)

fetch an image

When finished with, the client code must delete the image.

If the same image is fetched twice, it must be deleted in each case, they will not be the same pointer.

Definition at line 1158 of file ofxsImageEffect.cpp.

References _clipHandle, OfxImageEffectSuiteV1::clipGetImage, OFX::Private::gEffectSuite, kOfxStatFailed, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::normalize::NormalizePlugin::changedParam(), tuttle::plugin::colorCubeViewer::SelectionAverage::computeAverageSelection(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::computeAverageSelection(), tuttle::plugin::histogramKeyer::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogram::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogramKeyer::OverlayData::computeFullData(), tuttle::plugin::histogram::OverlayData::computeFullData(), tuttle::plugin::colorCubeViewer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::extendGeodesicForm(), fetchImage(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateVBOData(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateVBOData(), tuttle::plugin::outputBuffer::OutputBufferPlugin::render(), tuttle::plugin::WriterPlugin::render(), tuttle::plugin::viewer::ViewerPlugin::render(), tuttle::plugin::dpx::writer::DPXWriterPlugin::render(), tuttle::plugin::inputBuffer::InputBufferPlugin::render(), tuttle::plugin::ImageFilterProcessor::setup(), and tuttle::plugin::ImageProcessor::setup().

Here is the call graph for this function:

Image * OFX::Clip::fetchImage	(	OfxTime	t,
		OfxRectD	bounds
	)

fetch an image, with a specific region in cannonical coordinates

When finished with, the client code must delete the image.

If the same image is fetched twice, it must be deleted in each case, they will not be the same pointer.

Definition at line 1174 of file ofxsImageEffect.cpp.

References _clipHandle, OfxImageEffectSuiteV1::clipGetImage, OFX::Private::gEffectSuite, kOfxStatFailed, and OFX::throwSuiteStatusException().

Here is the call graph for this function:

Image* OFX::Clip::fetchImage	(	OfxTime	t,
		OfxRectD *	bounds
	)		[inline]

fetch an image, with a specific region in cannonical coordinates

When finished with, the client code must delete the image.

If the same image is fetched twice, it must be deleted in each case, they will not be the same pointer.

Definition at line 720 of file ofxsImageEffect.h.

References fetchImage().

Here is the call graph for this function:

OfxRectD OFX::Clip::getCanonicalRod

(

const OfxTime

t

)

const

get the RoD for this clip in the cannonical coordinate system

Definition at line 1107 of file ofxsImageEffect.cpp.

References _clipHandle, OfxImageEffectSuiteV1::clipGetRegionOfDefinition, OFX::Private::gEffectSuite, kOfxStatFailed, OFX::throwSuiteStatusException(), OfxRectD::x1, OfxRectD::x2, OfxRectD::y1, and OfxRectD::y2.

Referenced by tuttle::plugin::colorCubeViewer::SelectionAverage::computeAverageSelection(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::computeAverageSelection(), tuttle::plugin::histogram::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogramKeyer::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogram::OverlayData::computeFullData(), tuttle::plugin::histogramKeyer::OverlayData::computeFullData(), tuttle::plugin::lens::LensDistortOverlayInteract::draw(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorCubeViewer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateVBOData(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateVBOData(), getCanonicalRod(), getCanonicalRodSize(), tuttle::plugin::interact::FrameClip::getFrame(), tuttle::plugin::interact::FrameOptionalClip::getFrame(), getPixelRod(), tuttle::plugin::pinning::PinningPlugin::getProcessParams(), tuttle::plugin::GeneratorPlugin::getRegionOfDefinition(), tuttle::plugin::quality::DiffPlugin::getRegionOfDefinition(), tuttle::plugin::thinning::ThinningPlugin::getRegionOfDefinition(), tuttle::plugin::move2D::Move2DPlugin::getRegionOfDefinition(), tuttle::plugin::localmaxima::LocalMaximaPlugin::getRegionOfDefinition(), tuttle::plugin::ctl::CTLPlugin::getRegionOfDefinition(), tuttle::plugin::swscale::SwscalePlugin::getRegionOfDefinition(), tuttle::plugin::resize::ResizePlugin::getRegionOfDefinition(), tuttle::plugin::blur::BlurPlugin::getRegionOfDefinition(), tuttle::plugin::merge::MergePlugin::getRegionOfDefinition(), tuttle::plugin::convolution::ConvolutionPlugin::getRegionOfDefinition(), tuttle::plugin::sobel::SobelPlugin::getRegionOfDefinition(), tuttle::plugin::lens::LensDistortPlugin::getRegionOfDefinition(), tuttle::plugin::thinning::ThinningPlugin::getRegionsOfInterest(), tuttle::plugin::flip::FlipPlugin::getRegionsOfInterest(), tuttle::plugin::colorTransfer::ColorTransferPlugin::getRegionsOfInterest(), tuttle::plugin::localmaxima::LocalMaximaPlugin::getRegionsOfInterest(), tuttle::plugin::blur::BlurPlugin::getRegionsOfInterest(), tuttle::plugin::normalize::NormalizePlugin::getRegionsOfInterest(), tuttle::plugin::pushPixel::PushPixelPlugin::getRegionsOfInterest(), tuttle::plugin::sobel::SobelPlugin::getRegionsOfInterest(), and tuttle::plugin::lens::LensDistortPlugin::getRegionsOfInterest().

Here is the call graph for this function:

OfxRectD OFX::Clip::getCanonicalRod	(	const OfxTime	t,
		const OfxPointD &	renderScale
	)		const

Definition at line 1120 of file ofxsImageEffect.cpp.

References getCanonicalRod(), OfxPointD::x, OfxRectD::x1, OfxRectD::x2, OfxPointD::y, OfxRectD::y1, and OfxRectD::y2.

Here is the call graph for this function:

OfxPointD OFX::Clip::getCanonicalRodSize

(

const OfxTime

t

)

const [inline]

Definition at line 667 of file ofxsImageEffect.h.

References getCanonicalRod(), OfxRectD::x1, OfxRectD::x2, OfxRectD::y1, and OfxRectD::y2.

Referenced by getCanonicalRodSize().

Here is the call graph for this function:

OfxPointD OFX::Clip::getCanonicalRodSize	(	const OfxTime	t,
		const OfxPointD &	renderScale
	)		const [inline]

Definition at line 673 of file ofxsImageEffect.h.

References getCanonicalRodSize(), OfxPointD::x, and OfxPointD::y.

Here is the call graph for this function:

EField OFX::Clip::getFieldOrder

(

void

)

const

which spatial field comes first temporally

Definition at line 1030 of file ofxsImageEffect.cpp.

References _clipName, _clipProps, OFX::eFieldLower, OFX::eFieldNone, OFX::eFieldUpper, OFX::Log::error(), kOfxImageClipPropFieldOrder, OFX::mapFieldStringToEnum(), and OFX::PropertySet::propGetString().

Here is the call graph for this function:

OfxRangeD OFX::Clip::getFrameRange

(

void

)

const

return the range of frames over which this clip has images, after any clip preferences have been applied

Definition at line 1081 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageEffectPropFrameRange, OfxRangeD::max, OfxRangeD::min, and OFX::PropertySet::propGetDouble().

Referenced by tuttle::plugin::nlmDenoiser::NLMDenoiserPlugin::getFramesNeeded(), and tuttle::plugin::timeShift::TimeShiftPlugin::getTimeDomain().

Here is the call graph for this function:

double OFX::Clip::getFrameRate

(

void

)

const

get the frame rate, in frames per second on this clip, after any clip preferences have been applied

Definition at line 1075 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageEffectPropFrameRate, and OFX::PropertySet::propGetDouble().

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

Here is the call graph for this function:

OfxImageClipHandle OFX::Clip::getHandle

(

)

[inline]

get the OFX clip handle

Definition at line 611 of file ofxsImageEffect.h.

References _clipHandle.

void OFX::Clip::getLabels	(	std::string &	label,
		std::string &	shortLabel,
		std::string &	longLabel
	)		const

fetch the labels

Definition at line 911 of file ofxsImageEffect.cpp.

References _clipProps, kOfxPropLabel, kOfxPropLongLabel, kOfxPropShortLabel, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

double OFX::Clip::getPixelAspectRatio

(

void

)

const

get the scale factor that has been applied to this clip

Definition at line 1063 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImagePropPixelAspectRatio, and OFX::PropertySet::propGetDouble().

Referenced by tuttle::plugin::av::writer::AVWriterPlugin::beginSequenceRender(), tuttle::plugin::GeneratorPlugin::getClipPreferences(), getPixelRod(), tuttle::plugin::dpx::reader::DPXReaderPlugin::getRegionOfDefinition(), tuttle::plugin::openImageIO::reader::OpenImageIOReaderPlugin::getRegionOfDefinition(), tuttle::plugin::png::reader::PngReaderPlugin::getRegionOfDefinition(), tuttle::plugin::imagemagick::reader::ImageMagickReaderPlugin::getRegionOfDefinition(), tuttle::plugin::jpeg::reader::JpegReaderPlugin::getRegionOfDefinition(), tuttle::plugin::turboJpeg::reader::TurboJpegReaderPlugin::getRegionOfDefinition(), tuttle::plugin::raw::reader::RawReaderPlugin::getRegionOfDefinition(), tuttle::plugin::lens::LensDistortPlugin::getRegionOfDefinition(), tuttle::plugin::anisotropicFilter::tensors::TensorsPlugin::getRegionsOfInterest(), tuttle::plugin::anisotropicFilter::diffusion::AnisotropicDiffusionPlugin::getRegionsOfInterest(), tuttle::plugin::nlmDenoiser::NLMDenoiserPlugin::getRegionsOfInterest(), tuttle::plugin::pushPixel::PushPixelPlugin::getRegionsOfInterest(), and tuttle::plugin::lens::LensDistortPlugin::getRegionsOfInterest().

Here is the call graph for this function:

EPixelComponent OFX::Clip::getPixelComponents

(

void

)

const

what is the components images will be given to us as

get the components in the image

Definition at line 942 of file ofxsImageEffect.cpp.

References _clipName, _clipProps, OFX::ePixelComponentNone, OFX::Log::error(), isConnected(), kOfxImageEffectPropComponents, OFX::mapPixelComponentStringToEnum(), and OFX::PropertySet::propGetString().

Referenced by tuttle::plugin::normalize::NormalizePlugin::changedParam(), tuttle::plugin::colorCubeViewer::SelectionAverage::computeAverageSelection(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::computeAverageSelection(), tuttle::plugin::histogramKeyer::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogram::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogramKeyer::OverlayData::computeFullData(), tuttle::plugin::histogram::OverlayData::computeFullData(), tuttle::plugin::doGilRender(), tuttle::plugin::doGilRender2(), tuttle::plugin::colorCubeViewer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateVBOData(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateVBOData(), tuttle::plugin::GeneratorPlugin::getClipPreferences(), tuttle::plugin::dpx::writer::DPXWriterPlugin::getProcessParams(), tuttle::plugin::bitDepth::BitDepthPlugin::render(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::render(), tuttle::plugin::imagemagick::reader::ImageMagickReaderPlugin::render(), tuttle::plugin::jpeg2000::reader::Jpeg2000ReaderPlugin::render(), tuttle::plugin::imagemagick::writer::ImageMagickWriterPlugin::render(), tuttle::plugin::idKeyer::IdKeyerPlugin::render(), tuttle::plugin::dpx::reader::DPXReaderPlugin::render(), tuttle::plugin::nlmDenoiser::NLMDenoiserPlugin::render(), tuttle::plugin::ocio::lut::OCIOLutPlugin::render(), tuttle::plugin::invert::InvertPlugin::render(), tuttle::plugin::colorSuppress::ColorSuppressPlugin::render(), tuttle::plugin::basicKeyer::BasicKeyerPlugin::render(), tuttle::plugin::ocio::colorspace::OCIOColorSpacePlugin::render(), tuttle::plugin::colorTransfer::ColorTransferPlugin::render(), tuttle::plugin::ctl::CTLPlugin::render(), tuttle::plugin::dpx::writer::DPXWriterPlugin::render(), tuttle::plugin::text::TextPlugin::render(), tuttle::plugin::merge::MergePlugin::render(), tuttle::plugin::normalize::NormalizePlugin::render(), tuttle::plugin::pushPixel::PushPixelPlugin::render(), tuttle::plugin::pinning::PinningPlugin::render(), tuttle::plugin::warp::WarpPlugin::render(), tuttle::plugin::colorGradient::ColorGradientPlugin::renderFunctor(), and tuttle::plugin::bitDepth::BitDepthPlugin::setupDestView().

Here is the call graph for this function:

std::string OFX::Clip::getPixelComponentsProperty

(

void

)

const [inline]

get the string representing the pixel components

Definition at line 626 of file ofxsImageEffect.h.

References _clipProps, kOfxImageEffectPropComponents, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

EBitDepth OFX::Clip::getPixelDepth

(

void

)

const

what is the pixel depth images will be given to us as

get the pixel depth

Definition at line 919 of file ofxsImageEffect.cpp.

References _clipName, _clipProps, OFX::eBitDepthNone, OFX::Log::error(), isConnected(), kOfxImageEffectPropPixelDepth, OFX::mapBitDepthStringToEnum(), and OFX::PropertySet::propGetString().

Referenced by tuttle::plugin::normalize::NormalizePlugin::changedParam(), tuttle::plugin::colorCubeViewer::SelectionAverage::computeAverageSelection(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::computeAverageSelection(), tuttle::plugin::histogramKeyer::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogram::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogramKeyer::OverlayData::computeFullData(), tuttle::plugin::histogram::OverlayData::computeFullData(), tuttle::plugin::doGilRender(), tuttle::plugin::doGilRender2(), tuttle::plugin::colorCubeViewer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateVBOData(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateVBOData(), tuttle::plugin::GeneratorPlugin::getClipPreferences(), tuttle::plugin::bitDepth::BitDepthPlugin::render(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::render(), tuttle::plugin::imagemagick::reader::ImageMagickReaderPlugin::render(), tuttle::plugin::jpeg2000::reader::Jpeg2000ReaderPlugin::render(), tuttle::plugin::imagemagick::writer::ImageMagickWriterPlugin::render(), tuttle::plugin::idKeyer::IdKeyerPlugin::render(), tuttle::plugin::dpx::reader::DPXReaderPlugin::render(), tuttle::plugin::nlmDenoiser::NLMDenoiserPlugin::render(), tuttle::plugin::invert::InvertPlugin::render(), tuttle::plugin::ocio::lut::OCIOLutPlugin::render(), tuttle::plugin::colorSuppress::ColorSuppressPlugin::render(), tuttle::plugin::basicKeyer::BasicKeyerPlugin::render(), tuttle::plugin::ocio::colorspace::OCIOColorSpacePlugin::render(), tuttle::plugin::colorTransfer::ColorTransferPlugin::render(), tuttle::plugin::ctl::CTLPlugin::render(), tuttle::plugin::dpx::writer::DPXWriterPlugin::render(), tuttle::plugin::text::TextPlugin::render(), tuttle::plugin::merge::MergePlugin::render(), tuttle::plugin::normalize::NormalizePlugin::render(), tuttle::plugin::pushPixel::PushPixelPlugin::render(), tuttle::plugin::pinning::PinningPlugin::render(), tuttle::plugin::warp::WarpPlugin::render(), tuttle::plugin::colorGradient::ColorGradientPlugin::renderFunctor(), and tuttle::plugin::bitDepth::BitDepthPlugin::setupDestView().

Here is the call graph for this function:

OfxRectI OFX::Clip::getPixelRod

(

const OfxTime

t

)

const

get the RoD for this clip in pixel space

Definition at line 1131 of file ofxsImageEffect.cpp.

References getCanonicalRod(), getPixelAspectRatio(), OfxRectI::x1, OfxRectD::x1, OfxRectI::x2, OfxRectD::x2, OfxRectI::y1, OfxRectD::y1, OfxRectI::y2, and OfxRectD::y2.

Referenced by tuttle::plugin::normalize::NormalizePlugin::changedParam(), tuttle::plugin::colorCubeViewer::SelectionAverage::computeAverageSelection(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::computeAverageSelection(), tuttle::plugin::crop::CropPlugin::computeCropRegion(), tuttle::plugin::histogram::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogramKeyer::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::flip::FlipPlugin::computeFlipRegion(), tuttle::plugin::histogram::OverlayData::computeFullData(), tuttle::plugin::histogramKeyer::OverlayData::computeFullData(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::draw(), tuttle::plugin::histogram::HistogramOverlay::draw(), tuttle::plugin::colorCubeViewer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorCubeViewer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateVBOData(), tuttle::plugin::colorCubeViewer::CloudPointData::generateVBOData(), getPixelRod(), getPixelRodSize(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::getRegionsOfInterest(), tuttle::plugin::histogram::HistogramOverlay::penMotion(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penMotion(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penUp(), tuttle::plugin::histogram::HistogramOverlay::penUp(), tuttle::plugin::av::writer::AVWriterPlugin::render(), tuttle::plugin::inputBuffer::InputBufferPlugin::render(), tuttle::plugin::ImageFilterProcessor::setup(), and tuttle::plugin::ImageProcessor::setup().

Here is the call graph for this function:

OfxRectI OFX::Clip::getPixelRod	(	const OfxTime	t,
		const OfxPointD &	renderScale
	)		const

Definition at line 1147 of file ofxsImageEffect.cpp.

References getPixelRod(), OfxPointD::x, OfxRectI::x1, OfxRectI::x2, OfxPointD::y, OfxRectI::y1, and OfxRectI::y2.

Here is the call graph for this function:

OfxPointI OFX::Clip::getPixelRodSize

(

const OfxTime

t

)

const [inline]

Definition at line 684 of file ofxsImageEffect.h.

References getPixelRod(), OfxRectI::x1, OfxRectI::x2, OfxRectI::y1, and OfxRectI::y2.

Referenced by tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::addRefCloudPointData(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::addRefCloudPointData(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::addRefOverlayData(), tuttle::plugin::histogram::HistogramPlugin::addRefOverlayData(), tuttle::plugin::crop::CropPlugin::computeCropRegion(), tuttle::plugin::histogramKeyer::HSLOverlay::draw(), tuttle::plugin::histogram::HSLOverlay::draw(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::draw(), tuttle::plugin::histogramKeyer::RGBOverlay::draw(), tuttle::plugin::histogram::HistogramOverlay::draw(), tuttle::plugin::histogram::RGBOverlay::draw(), getPixelRodSize(), tuttle::plugin::histogram::HistogramOverlay::penDown(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penDown(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penUp(), tuttle::plugin::histogram::HistogramOverlay::penUp(), and tuttle::plugin::dpx::writer::DPXWriterPlugin::render().

Here is the call graph for this function:

OfxPointI OFX::Clip::getPixelRodSize	(	const OfxTime	t,
		const OfxPointD &	renderScale
	)		const [inline]

Definition at line 690 of file ofxsImageEffect.h.

References getPixelRodSize(), OfxPointI::x, OfxPointD::x, OfxPointI::y, and OfxPointD::y.

Here is the call graph for this function:

EPreMultiplication OFX::Clip::getPreMultiplication

(

void

)

const

get the components in the image

Definition at line 1011 of file ofxsImageEffect.cpp.

References _clipName, _clipProps, OFX::eImageOpaque, OFX::Log::error(), kOfxImageEffectPropPreMultiplication, OFX::mapPreMultiplicationStringToEnum(), and OFX::PropertySet::propGetString().

Here is the call graph for this function:

const PropertySet& OFX::Clip::getPropertySet

(

)

const [inline]

get the underlying property set on this clip

Definition at line 605 of file ofxsImageEffect.h.

References _clipProps.

PropertySet& OFX::Clip::getPropertySet

(

)

[inline]

get the underlying property set on this clip

Definition at line 608 of file ofxsImageEffect.h.

References _clipProps.

OfxRangeD OFX::Clip::getUnmappedFrameRange

(

void

)

const

return the range of frames over which this clip has images, before any clip preferences have been applied

Definition at line 1097 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageEffectPropUnmappedFrameRange, OfxRangeD::max, OfxRangeD::min, and OFX::PropertySet::propGetDouble().

Here is the call graph for this function:

double OFX::Clip::getUnmappedFrameRate

(

void

)

const

get the frame rate, in frames per second on this clip, before any clip preferences have been applied

Definition at line 1091 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageEffectPropUnmappedFrameRate, and OFX::PropertySet::propGetDouble().

Here is the call graph for this function:

EPixelComponent OFX::Clip::getUnmappedPixelComponents

(

void

)

const

what is the component type of the clip

Definition at line 988 of file ofxsImageEffect.cpp.

References _clipName, _clipProps, OFX::ePixelComponentNone, OFX::Log::error(), isConnected(), kOfxImageClipPropUnmappedComponents, OFX::mapPixelComponentStringToEnum(), and OFX::PropertySet::propGetString().

Here is the call graph for this function:

std::string OFX::Clip::getUnmappedPixelComponentsProperty

(

void

)

const [inline]

get the string representing the pixel components

Definition at line 635 of file ofxsImageEffect.h.

References _clipProps, kOfxImageClipPropUnmappedComponents, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

EBitDepth OFX::Clip::getUnmappedPixelDepth

(

void

)

const

what is the actual pixel depth of the clip

Definition at line 965 of file ofxsImageEffect.cpp.

References _clipName, _clipProps, OFX::eBitDepthNone, OFX::Log::error(), isConnected(), kOfxImageClipPropUnmappedPixelDepth, OFX::mapBitDepthStringToEnum(), and OFX::PropertySet::propGetString().

Here is the call graph for this function:

bool OFX::Clip::hasContinuousSamples

(

void

)

const

can the clip be continuously sampled

Definition at line 1057 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageClipPropContinuousSamples, and OFX::PropertySet::propGetInt().

Here is the call graph for this function:

bool OFX::Clip::isConnected

(

void

)

const

is the clip connected

Definition at line 1051 of file ofxsImageEffect.cpp.

References _clipProps, kOfxImageClipPropConnected, and OFX::PropertySet::propGetInt().

Referenced by tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::changedClip(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::changedClip(), tuttle::plugin::normalize::NormalizePlugin::changedParam(), tuttle::plugin::colorCubeViewer::SelectionAverage::computeAverageSelection(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::computeAverageSelection(), tuttle::plugin::crop::CropPlugin::computeCropRegion(), tuttle::plugin::histogram::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogramKeyer::OverlayData::computeCurveFromSelectionData(), tuttle::plugin::histogram::OverlayData::computeFullData(), tuttle::plugin::histogramKeyer::OverlayData::computeFullData(), tuttle::plugin::lens::LensDistortOverlayInteract::draw(), tuttle::plugin::warp::WarpOverlayInteract::draw(), tuttle::plugin::pinning::PinningOverlayInteract::draw(), tuttle::plugin::histogram::HistogramOverlay::draw(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::draw(), tuttle::plugin::colorCubeViewer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorSpaceKeyer::SelectionAverage::extendGeodesicForm(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateColorSelectionVBO(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorCubeViewer::CloudPointData::generateSpillSelectionVBO(), tuttle::plugin::colorSpaceKeyer::CloudPointData::generateVBOData(), tuttle::plugin::colorCubeViewer::CloudPointData::generateVBOData(), tuttle::plugin::GeneratorPlugin::getClipPreferences(), tuttle::plugin::interact::FrameClip::getFrame(), tuttle::plugin::interact::FrameOptionalClip::getFrame(), getPixelComponents(), getPixelDepth(), tuttle::plugin::GeneratorPlugin::getRegionOfDefinition(), tuttle::plugin::lens::LensDistortPlugin::getRegionOfDefinition(), tuttle::plugin::colorTransfer::ColorTransferPlugin::getRegionsOfInterest(), tuttle::plugin::pushPixel::PushPixelPlugin::getRegionsOfInterest(), tuttle::plugin::lens::LensDistortPlugin::getRegionsOfInterest(), getUnmappedPixelComponents(), getUnmappedPixelDepth(), tuttle::plugin::ImageFilterProcessor::ImageFilterProcessor(), tuttle::plugin::ImageGilFilterProcessor< SView, DView >::ImageGilFilterProcessor(), tuttle::plugin::interact::FrameClip::isEnabled(), tuttle::plugin::interact::FrameOptionalClip::isEnabled(), tuttle::plugin::fade::FadePlugin::isIdentity(), and tuttle::plugin::pushPixel::PushPixelProcess< View >::PushPixelProcess().

Here is the call graph for this function:

OFX::Clip::mDeclareProtectedAssignAndCC

(

Clip

)

[protected]

const std::string& OFX::Clip::name

(

void

)

const [inline]

get the name

Definition at line 614 of file ofxsImageEffect.h.

References _clipName.

Referenced by tuttle::plugin::histogram::HistogramPlugin::changedParam(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::changedParam(), OFX::Private::framesNeededAction(), OFX::Private::isIdentityAction(), OFX::Private::regionsOfInterestAction(), tuttle::plugin::inputBuffer::InputBufferPlugin::render(), OFX::ClipPreferencesSetter::setClipBitDepth(), OFX::ClipPreferencesSetter::setClipComponents(), OFX::ClipPreferencesSetter::setPixelAspectRatio(), tuttle::plugin::ImageFilterProcessor::setup(), and tuttle::plugin::ImageProcessor::setup().

---

Friends And Related Function Documentation

friend class ImageEffect [friend]

so one can be made

Definition at line 601 of file ofxsImageEffect.h.

---

Field Documentation

OfxImageClipHandle OFX::Clip::_clipHandle [protected]

handle for this clip

Definition at line 592 of file ofxsImageEffect.h.

Referenced by fetchImage(), getCanonicalRod(), and getHandle().

std::string OFX::Clip::_clipName [protected]

name of the clip

Definition at line 586 of file ofxsImageEffect.h.

Referenced by getFieldOrder(), getPixelComponents(), getPixelDepth(), getPreMultiplication(), getUnmappedPixelComponents(), getUnmappedPixelDepth(), and name().

PropertySet OFX::Clip::_clipProps [protected]

properties for this clip

Definition at line 589 of file ofxsImageEffect.h.

Referenced by Clip(), getFieldOrder(), getFrameRange(), getFrameRate(), getLabels(), getPixelAspectRatio(), getPixelComponents(), getPixelComponentsProperty(), getPixelDepth(), getPreMultiplication(), getPropertySet(), getUnmappedFrameRange(), getUnmappedFrameRate(), getUnmappedPixelComponents(), getUnmappedPixelComponentsProperty(), getUnmappedPixelDepth(), hasContinuousSamples(), and isConnected().

ImageEffect* OFX::Clip::_effect [protected]

effect instance that owns this clip

Definition at line 595 of file ofxsImageEffect.h.

---

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

• libraries/openfxHack/Support/include/ofxsImageEffect.h
• libraries/openfxHack/Support/Library/ofxsImageEffect.cpp