cavewriting::Section Class Reference

#include <Section.H>

List of all members.

Public Member Functions
	Section (xercesc::DOMNode *node, int id)
virtual	~Section ()
void	start ()
const string &	getName ()
Array< Word * > &	getWords ()
int	addWordAtEnd (Word *word)
int	getEmptySpot (double widthNeeded)
	Returns the index of an empty spot, or -1 if there are no empty spots.
Vector3	getEmptySpotPosition (int spotIndex)
void	fillSpot (int spotIndex, Word *word)
	Fills the specified spot with the specified word, and adds this word to your section.
void	emptySpot (int index)
	Empties the spot at the specified index, and removes the word from our word list.
void	emptySpot (Word *word)
	Empties the word specified, and removes the word from our word list.
bool	isSpotEmpty (int spot)
void	show ()
	Show all the words in the section.
void	hide ()
	Hide all the words in the section.
double	getYRotationAngle ()
	Accessor for making words have correct y rotation.
int	findSpotIndex (Word *word)
Protected Member Functions
void	addEffect (xercesc::DOMElement *node)
bool	checkAllSpotInvariants ()
void	positionWords ()
void	updateSpotPosition (int index, CoordinateFrame frame)

---

Constructor & Destructor Documentation

cavewriting::Section::Section (  xercesc::DOMNode *  node, int  id )

virtual cavewriting::Section::~Section (   )  [virtual]

---

Member Function Documentation

void cavewriting::Section::addEffect (  xercesc::DOMElement *  node  )  [protected]

int cavewriting::Section::addWordAtEnd (  Word *  word  )

Make room for a new word, and add it at the end of the section (Same as addWord(Word* word) but returns the spot index)

bool cavewriting::Section::checkAllSpotInvariants (   )  [protected]

void cavewriting::Section::emptySpot (  Word *  word  )

Empties the word specified, and removes the word from our word list.

void cavewriting::Section::emptySpot (  int  index  )

Empties the spot at the specified index, and removes the word from our word list.

void cavewriting::Section::fillSpot (  int  spotIndex, Word *  word )

Fills the specified spot with the specified word, and adds this word to your section.

int cavewriting::Section::findSpotIndex (  Word *  word  )

int cavewriting::Section::getEmptySpot (  double  widthNeeded  )

Returns the index of an empty spot, or -1 if there are no empty spots.

Vector3 cavewriting::Section::getEmptySpotPosition (  int  spotIndex  )

const string& cavewriting::Section::getName (   )  [inline]

Array<Word*>& cavewriting::Section::getWords (   )  [inline]

double cavewriting::Section::getYRotationAngle (   )

Accessor for making words have correct y rotation.

void cavewriting::Section::hide (   )

Hide all the words in the section.

bool cavewriting::Section::isSpotEmpty (  int  spot  )

void cavewriting::Section::positionWords (   )  [protected]

void cavewriting::Section::show (   )

Show all the words in the section.

void cavewriting::Section::start (   )

void cavewriting::Section::updateSpotPosition (  int  index, CoordinateFrame  frame )  [protected]

---

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

• Section.H

---