claw::graphic::xbm Class Reference

#include <xbm.hpp>

Inheritance diagram for claw::graphic::xbm:

List of all members.

---

Detailed Description

A class for xbm pictures.

Author:

Julien Jorge

Definition at line 45 of file xbm.hpp.

Public Member Functions
	xbm (unsigned int w, unsigned int h)
	Constructor. Creates an empty image.
	xbm (const image &that)
	Copy constructor.
	xbm (std::istream &f)
	Constructor. Load an image from a xbm file.
	~xbm ()
	Destructor.
void	save (std::ostream &os) const
	Save the image.
void	set_name (const std::string &name)
	Set the name of the image.
void	set_hot (const claw::math::coordinate_2d< int > &hot)
	Set the hot spot of the image.
Private Attributes
std::string	m_name
	The name of the image structure in the file.
claw::math::coordinate_2d< int > *	m_hot
	The position of the hot spot in the image.
Classes
class	reader
	This class read data from a xbm file and store it in an image. More...
class	writer
	This class write an image in a xbm file. More...

---

Constructor & Destructor Documentation

claw::graphic::xbm::xbm	(	unsigned int	w,
		unsigned int	h
	)

Constructor. Creates an empty image.

Parameters:

	w	Image's width.
	h	Image's height.

Precondition:

w > 0 and h > 0

Definition at line 39 of file xbm.cpp.

  : image(w, h), m_hot(NULL)
{

} // xbm::xbm() [constructor]

claw::graphic::xbm::xbm

(

const image &

that

)

Copy constructor.

Parameters:

that

Image to copy from.

Definition at line 50 of file xbm.cpp.

  : image(that), m_hot(NULL)
{

} // xbm::xbm() [copy constructor]

claw::graphic::xbm::xbm

(

std::istream &

f

)

Constructor. Load an image from a xbm file.

Parameters:

f

Xbm file.

Definition at line 61 of file xbm.cpp.

  : m_hot(NULL)
{
  reader(*this, f);
} // xbm::xbm() [constructor, from file]

claw::graphic::xbm::~xbm

(

)

Destructor.

Definition at line 71 of file xbm.cpp.

References m_hot.

{
  if (m_hot != NULL)
    delete m_hot;
} // xbm::~xbm()

---

Member Function Documentation

void claw::graphic::xbm::save

(

std::ostream &

f

)

const

Save the image.

Parameters:

f

The file in which we write.

Definition at line 82 of file xbm.cpp.

References m_hot, and m_name.

{
  writer( *this, f, writer::options( m_name, m_hot ) );
} // xbm::save()

void claw::graphic::xbm::set_name

(

const std::string &

name

)

Set the name of the image.

Parameters:

name

The name of the image;

Definition at line 92 of file xbm.cpp.

References m_name.

Referenced by claw::graphic::xbm::reader::reader().

{
  m_name = name;
} // xbm::set_name()

void claw::graphic::xbm::set_hot

(

const claw::math::coordinate_2d< int > &

hot

)

Set the hot spot of the image.

Parameters:

hot

The hot spot of the image;

Definition at line 102 of file xbm.cpp.

References m_hot.

Referenced by claw::graphic::xbm::reader::reader().

{
  if (m_hot != NULL)
    delete m_hot;

  m_hot = new claw::math::coordinate_2d<int>(hot);
} // xbm::set_hot()

---

Member Data Documentation

std::string claw::graphic::xbm::m_name [private]

The name of the image structure in the file.

Definition at line 146 of file xbm.hpp.

Referenced by save(), and set_name().

claw::math::coordinate_2d<int>* claw::graphic::xbm::m_hot [private]

The position of the hot spot in the image.

Definition at line 149 of file xbm.hpp.

Referenced by save(), set_hot(), and ~xbm().

---

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

• xbm.hpp
• code/xbm.cpp