estar::Region Class Reference

#include <Region.hpp>

List of all members.

---

Detailed Description

A Region is a Sprite that has been placed at a specific location.

Public Types
typedef Sprite::sindex	sindex
typedef Sprite::indexlist_t	indexlist_t
Public Member Functions
	Region (boost::shared_ptr< Sprite > sprite, double x0, double y0, ssize_t xbegin, ssize_t xend, ssize_t ybegin, ssize_t yend)
	Create a region instance by translating an existing sprite.
	Region (double radius, double scale, double x0, double y0, ssize_t xbegin, ssize_t xend, ssize_t ybegin, ssize_t yend)
	Create a region instance by creating a circular sprite.
const Sprite &	GetSprite () const
const indexlist_t &	GetBorder () const
const indexlist_t &	GetArea () const
Public Attributes
const double	x0
const double	y0
Private Member Functions
void	Init (double radius, double scale, double x0, double y0, ssize_t xbegin, ssize_t xend, ssize_t ybegin, ssize_t yend)
Private Attributes
boost::shared_ptr< Sprite >	m_sprite
indexlist_t	m_border
indexlist_t	m_area

---

Member Typedef Documentation

typedef Sprite::sindex estar::Region::sindex

typedef Sprite::indexlist_t estar::Region::indexlist_t

---

Constructor & Destructor Documentation

estar::Region::Region	(	boost::shared_ptr< Sprite >	sprite,
		double	x0,
		double	y0,
		ssize_t	xbegin,
		ssize_t	xend,
		ssize_t	ybegin,
		ssize_t	yend
	)

Create a region instance by translating an existing sprite.

Parameters:

x0	x-coordinate of where the sprite's center should be located
y0	y-coordinate of where the sprite's center should be located

estar::Region::Region	(	double	radius,
		double	scale,
		double	x0,
		double	y0,
		ssize_t	xbegin,
		ssize_t	xend,
		ssize_t	ybegin,
		ssize_t	yend
	)

Create a region instance by creating a circular sprite.

Parameters:

radius	radius of the disk
scale	grid resolution (to scale the disk to grid cell units)
x0	x-coordinate of the disk center
y0	y-coordinate of the disk center

---

Member Function Documentation

const Sprite& estar::Region::GetSprite

(

)

const [inline]

const indexlist_t& estar::Region::GetBorder

(

)

const [inline]

const indexlist_t& estar::Region::GetArea

(

)

const [inline]

void estar::Region::Init	(	double	radius,
		double	scale,
		double	x0,
		double	y0,
		ssize_t	xbegin,
		ssize_t	xend,
		ssize_t	ybegin,
		ssize_t	yend
	)			[private]

Todo:

braindead implementation!

---

Member Data Documentation

const double estar::Region::x0

const double estar::Region::y0

boost::shared_ptr<Sprite> estar::Region::m_sprite [private]

indexlist_t estar::Region::m_border [private]

indexlist_t estar::Region::m_area [private]

---

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

• estar/Region.hpp
• estar/Region.cpp

---

E* Interpolated Graph Replanner Wed Dec 12 18:55:50 2007