OFX::Clip Class Reference

#include <ofxsImageEffect.h>

List of all members.

---

Detailed Description

Wraps up a clip instance.

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
BitDepthEnum	getPixelDepth (void) const
	get the pixel depth
PixelComponentEnum	getPixelComponents (void) const
	get the components in the image
std::string	getPixelComponentsProperty (void) const
	get the string representing the pixel components
BitDepthEnum	getUnmappedPixelDepth (void) const
	what is the actual pixel depth of the clip
PixelComponentEnum	getUnmappedPixelComponents (void) const
	what is the component type of the clip
std::string	getUnmappedPixelComponentsProperty (void) const
	get the string representing the pixel components
PreMultiplicationEnum	getPreMultiplication (void) const
	get the components in the image
FieldEnum	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	getRegionOfDefinition (double t)
	get the RoD for this clip in the cannonical coordinate system
Image *	fetchImage (double t)
	fetch an image
Image *	fetchImage (double t, OfxRectD bounds)
	fetch an image, with a specific region in cannonical coordinates
Image *	fetchImage (double 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

---

Constructor & Destructor Documentation

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

hidden constructor

---

Member Function Documentation

Image* OFX::Clip::fetchImage (  double  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.

Image * OFX::Clip::fetchImage (  double  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.

Image * OFX::Clip::fetchImage (  double  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.

FieldEnum OFX::Clip::getFieldOrder (  void   )  const

which spatial field comes first temporally

OfxRangeD OFX::Clip::getFrameRange (  void   )  const

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

double OFX::Clip::getFrameRate (  void   )  const

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

OfxImageClipHandle OFX::Clip::getHandle (   )  [inline]

get the OFX clip handle

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

fetch the labels

double OFX::Clip::getPixelAspectRatio (  void   )  const

get the scale factor that has been applied to this clip

PixelComponentEnum OFX::Clip::getPixelComponents (  void   )  const

get the components in the image

std::string OFX::Clip::getPixelComponentsProperty (  void   )  const [inline]

get the string representing the pixel components

BitDepthEnum OFX::Clip::getPixelDepth (  void   )  const

get the pixel depth

PreMultiplicationEnum OFX::Clip::getPreMultiplication (  void   )  const

get the components in the image

PropertySet& OFX::Clip::getPropertySet (   )  [inline]

get the underlying property set on this clip

const PropertySet& OFX::Clip::getPropertySet (   )  const [inline]

get the underlying property set on this clip

OfxRectD OFX::Clip::getRegionOfDefinition (  double  t  )

get the RoD for this clip in the cannonical coordinate system

OfxRangeD OFX::Clip::getUnmappedFrameRange (  void   )  const

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

double OFX::Clip::getUnmappedFrameRate (  void   )  const

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

PixelComponentEnum OFX::Clip::getUnmappedPixelComponents (  void   )  const

what is the component type of the clip

std::string OFX::Clip::getUnmappedPixelComponentsProperty (  void   )  const [inline]

get the string representing the pixel components

BitDepthEnum OFX::Clip::getUnmappedPixelDepth (  void   )  const

what is the actual pixel depth of the clip

bool OFX::Clip::hasContinuousSamples (  void   )  const

can the clip be continuously sampled

bool OFX::Clip::isConnected (  void   )  const

is the clip connected

OFX::Clip::mDeclareProtectedAssignAndCC (  Clip   )  [protected]

const std::string& OFX::Clip::name (  void   )  const [inline]

get the name

---

Friends And Related Function Documentation

friend class ImageEffect [friend]

so one can be made

---

Member Data Documentation

OfxImageClipHandle OFX::Clip::_clipHandle [protected]

handle for this clip

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

name of the clip

PropertySet OFX::Clip::_clipProps [protected]

properties for this clip

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

effect instance that owns this clip

---

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

• ofxsImageEffect.h
• ofxsImageEffect.cpp

---