iso::visual::Image Class Reference

#include <iso_visual_image.h>

Inherits iso::visual::Dataset.

Inherited by iso::visual::TypedImage< DataType >, and iso::visual::TypedImage< float >.

Inheritance diagram for iso::visual::Image:

[legend]Collaboration diagram for iso::visual::Image:

[legend]List of all members.

Public Member Functions
	Image (const base::String &pName)
	create image
	Image (const base::String &pName, const math::Vector< int > &pSize, ColorType pColorType)
	create image
	Image (const Image &pImage)
	create image
	~Image ()
	destructor
virtual const Dataset &	operator= (const Dataset &pDataset) throw (VisualException)
math::Vector< int >	size () const
	return image size
int	pixelCount () const
	return number of pixels
ColorType	colorType () const
	return color type
int	channelCount () const
	return number of channels
template<typename DataType>
const DataType *	data () const throw (VisualException)
	return image data
template<typename DataType>
DataType *	data () throw (VisualException)
	return image data
bool	checkGL ()
bool	checkCL ()
virtual GLData *	createGL ()=0 throw (VisualException)
virtual CLData *	createCL ()=0 throw (VisualException)
virtual CLData *	createCL (CLMemoryUsage pUsage, CLDevice &pDevice)=0 throw (VisualException)
Protected Attributes
math::Vector< int >	mSize
ColorType	mColorType
AttributeData *	mPixelData
Static Protected Attributes
static math::Vector< int >	sDefaultSize
static ColorType	sDefaultColorType

---

Constructor & Destructor Documentation

Image::Image

(

const base::String &

pName

)

create image

creates image with default size and default color type

Image::Image	(	const base::String &	pName,
		const math::Vector< int > &	pSize,
		ColorType	pColorType
	)

create image

Parameters:

	pSize	size of image
	pChannelCount	number of channels of image

Image::Image

(

const Image &

pImage

)

create image

Image::~Image

(

)

destructor

---

Member Function Documentation

const Dataset & Image::operator=

(

const Dataset &

pDataset

)

throw (VisualException) [virtual]

Reimplemented from iso::visual::Dataset.

math::Vector< int > Image::size

(

)

const

return image size

Returns:

image size

int Image::pixelCount

(

)

const

return number of pixels

Returns:

number of pixels

ColorType Image::colorType

(

)

const

return color type

Returns:

color type

int Image::channelCount

(

)

const

return number of channels

Returns:

number of channels

template<typename DataType>

const DataType * iso::visual::Image::data

(

)

const throw (VisualException)

return image data

Returns:

image data

Exceptions:

VisualException

incompatible data type

template<typename DataType>

DataType * iso::visual::Image::data

(

)

throw (VisualException)

return image data

Returns:

image data

Exceptions:

VisualException

incompatible data type

bool Image::checkGL

(

)

[virtual]

Reimplemented from iso::visual::Dataset.

bool Image::checkCL

(

)

[virtual]

Reimplemented from iso::visual::Dataset.

virtual GLData* iso::visual::Image::createGL

(

)

throw (VisualException) [pure virtual]

Reimplemented from iso::visual::Dataset.

Implemented in iso::visual::TypedImage< DataType >, and iso::visual::TypedImage< float >.

virtual CLData* iso::visual::Image::createCL

(

)

throw (VisualException) [pure virtual]

Reimplemented from iso::visual::Dataset.

Implemented in iso::visual::TypedImage< DataType >, and iso::visual::TypedImage< float >.

virtual CLData* iso::visual::Image::createCL	(	CLMemoryUsage	pUsage,
		CLDevice &	pDevice
	)			throw (VisualException) [pure virtual]

Implemented in iso::visual::TypedImage< DataType >, and iso::visual::TypedImage< float >.

---

Member Data Documentation

math::Vector< int > Image::sDefaultSize [static, protected]

default image size

ColorType Image::sDefaultColorType [static, protected]

default image color type

math::Vector<int> iso::visual::Image::mSize [protected]

ColorType iso::visual::Image::mColorType [protected]

AttributeData* iso::visual::Image::mPixelData [protected]

image pixel values

---

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

• /Users/dbisig/programming/swarms/trunk/visual/trunk/code/data/iso_visual_image.h
• /Users/dbisig/programming/swarms/trunk/visual/trunk/code/data/iso_visual_image.cpp

---