image::CImage Class Reference
[Image module, Nodes]

A generic image node class. More...

#include <ImageModule.h>

Inherits fsf::CCharBuffer.

Collaboration diagram for image::CImage:

[legend]

List of all members.

Public Member Functions
Creators
	CImage ()
	Default constructor.
	CImage (fsf::CNode *pParent, fsf::Time tTime=0)
	2-parameter constructor: parent and time stamp
	CImage (const string &strName, fsf::CNode *pParent=NULL, fsf::Time tTime=0)
	3-parameter constructor: name, parent and time stamp
	CImage (int nWidth, int nHeight, int nNbChannels=3, int nDepth=IMAGE_DEPTH_8U, fsf::CNode *pParent=NULL, fsf::Time tTime=0)
	6-parameter constructor: image width, height, number of channels, pixel depth, node parent and time stamp
	CImage (const string &strName, int nWidth, int nHeight, int nNbChannels=3, int nDepth=IMAGE_DEPTH_8U, fsf::CNode *pParent=NULL, fsf::Time tTime=0)
	7-parameter constructor: node name, image width, height, number of channels, pixel depth node parent and time stamp
	CImage (const CImage &)
virtual fsf::CNode *	clone () const
	Cloning: necessary for run-time polymorphism.
Manipulators
CImage &	operator= (const CImage &)
	Assignment operator.
void	allocateImageBuffer (bool bNoAlign=false)
	Allocate image buffer consistently with current image parameter values.
void	copyParameters (const CImage &)
	Copies this image member data values to the argument image's.
void	copyImageData (const CImage &)
	Copies this node's image data to the argument image's.
void	setWidth (int nWidth)
	Sets this image node's width value.
void	setHeight (int nHeight)
	Sets this image node's height value.
void	setNbChannels (int nNbChannels)
	Sets this image node's number of channels value.
void	setPixelDepth (int nDepth)
	Sets this image node's pixel depth value.
void	setWidthStep (int nWidthStep)
	Sets this image node's aligned width step value.
void	setBytes (int val)
	Sets all byte values to argument.
Accessors
virtual void	getTypeID (string &str) const
	Gets this node's factory mapping key.
int	getWidth () const
int	getHeight () const
int	getNbChannels () const
int	getPixelDepth () const
int	getWidthStep () const
Drawing primitives
No border testing.
void	drawPoint (int x, int y, const unsigned char *col)
	Sets pixel values at location x,y to argument color.
void	drawLine (int xo, int yo, int xd, int yd, const unsigned char *col)
	Sets all pixels on stright line betweem specified points to argument color.
void	drawRectangle (int x, int y, int w, int h, const unsigned char *col)
	Sets pixel values on image-aligned rectangle to argument color.
void	fillRectangle (int x, int y, int w, int h, const unsigned char *col)
	Sets pixel values on and inside image-aligned rectangle to argument color.

---

Detailed Description

A generic image node class.

---

Constructor & Destructor Documentation

image::CImage::CImage

(

)

[inline]

Default constructor.

image::CImage::CImage	(	fsf::CNode *	pParent,
		fsf::Time	tTime = 0
	)			[inline]

2-parameter constructor: parent and time stamp

image::CImage::CImage	(	const string &	strName,
		fsf::CNode *	pParent = NULL,
		fsf::Time	tTime = 0
	)			[inline]

3-parameter constructor: name, parent and time stamp

image::CImage::CImage	(	int	nWidth,
		int	nHeight,
		int	nNbChannels = 3,
		int	nDepth = IMAGE_DEPTH_8U,
		fsf::CNode *	pParent = NULL,
		fsf::Time	tTime = 0
	)			[inline]

6-parameter constructor: image width, height, number of channels, pixel depth, node parent and time stamp

image::CImage::CImage	(	const string &	strName,
		int	nWidth,
		int	nHeight,
		int	nNbChannels = 3,
		int	nDepth = IMAGE_DEPTH_8U,
		fsf::CNode *	pParent = NULL,
		fsf::Time	tTime = 0
	)			[inline]

7-parameter constructor: node name, image width, height, number of channels, pixel depth node parent and time stamp

CImage::CImage

(

const CImage &

rhs

)

---

Member Function Documentation

void CImage::allocateImageBuffer

(

bool

bNoAlign = false

)

Allocate image buffer consistently with current image parameter values.

All parameter values must be set!

virtual fsf::CNode* image::CImage::clone

(

)

const [inline, virtual]

Cloning: necessary for run-time polymorphism.

Reimplemented from fsf::CCharBuffer.

void image::CImage::copyImageData

(

const CImage &

)

Copies this node's image data to the argument image's.

void CImage::copyParameters

(

const CImage &

rhs

)

Copies this image member data values to the argument image's.

void CImage::drawLine	(	int	xo,
		int	yo,
		int	xd,
		int	yd,
		const unsigned char *	col
	)

Sets all pixels on stright line betweem specified points to argument color.

void CImage::drawPoint	(	int	x,
		int	y,
		const unsigned char *	col
	)

Sets pixel values at location x,y to argument color.

void CImage::drawRectangle	(	int	x,
		int	y,
		int	w,
		int	h,
		const unsigned char *	col
	)

Sets pixel values on image-aligned rectangle to argument color.

void CImage::fillRectangle	(	int	x,
		int	y,
		int	w,
		int	h,
		const unsigned char *	col
	)

Sets pixel values on and inside image-aligned rectangle to argument color.

int image::CImage::getHeight

(

)

const [inline]

int image::CImage::getNbChannels

(

)

const [inline]

int image::CImage::getPixelDepth

(

)

const [inline]

virtual void image::CImage::getTypeID

(

string &

str

)

const [inline, virtual]

Gets this node's factory mapping key.

int image::CImage::getWidth

(

)

const [inline]

int image::CImage::getWidthStep

(

)

const [inline]

CImage & CImage::operator=

(

const CImage &

rhs

)

Assignment operator.

void image::CImage::setBytes

(

int

val

)

[inline]

Sets all byte values to argument.

void image::CImage::setHeight

(

int

nHeight

)

[inline]

Sets this image node's height value.

void image::CImage::setNbChannels

(

int

nNbChannels

)

[inline]

Sets this image node's number of channels value.

void image::CImage::setPixelDepth

(

int

nDepth

)

[inline]

Sets this image node's pixel depth value.

void image::CImage::setWidth

(

int

nWidth

)

[inline]

Sets this image node's width value.

void image::CImage::setWidthStep

(

int

nWidthStep

)

[inline]

Sets this image node's aligned width step value.

---

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

• ImageModule.h
• ImageModule.cc