Controls Class Reference

Inheritance diagram for Controls:

[legend]Collaboration diagram for Controls:

[legend]

---

Detailed Description

Keyboard and mouse controls.

Definition at line 22 of file Controls.h.

Public Member Functions
	Controls (PhaseLocker *locker)
	Create list of drivers.
	~Controls ()
	Delete drivers.
void	addUnit (Unit *unit)
	Add unit under our control.
const Unit *	getActive ()
	Returns active unit or NULL.
bool	driving (const InputProvider *input)
	Let drivers to drive.
void	lockPhases ()
void	checkActive ()
	Check whether active unit can still drive, otherwise make switch.
void	switchActive ()
	Switch active unit.
bool	makeMove (char move)
	Make this move.
bool	cannotMove () const
	Returns true when there is no unit which will be able to move.
void	controlEvent (const KeyStroke &stroke)
	Obtain first control symbol from keyboard events.
bool	activateSelected (const Cube *occupant)
	Activate fish under cursor.
virtual int	getStepCount () const
virtual std::string	getMoves () const
virtual bool	isPowerful () const
	Returns true when active fish is powerful.

---

Constructor & Destructor Documentation

Controls::Controls (  PhaseLocker *  locker  )

Create list of drivers. Parameters: locker  shared locker for anim Definition at line 22 of file Controls.cpp. : m_units(), m_moves() { m_locker = locker; m_active = m_units.begin(); m_speedup = 0; m_switch = true; m_strokeSymbol = ControlSym::SYM_NONE; }

Controls::~Controls (   )

Delete drivers. Definition at line 35 of file Controls.cpp. { t_units::iterator end = m_units.end(); for (t_units::iterator i = m_units.begin(); i != end; ++i) { delete (*i); } }

---

Member Function Documentation

bool Controls::activateSelected (  const Cube *  occupant  )

Activate fish under cursor. Parameters: occupant  model to activate Returns: true when fish was selected Definition at line 271 of file Controls.cpp. { t_units::iterator end = m_units.end(); for (t_units::iterator i = m_units.begin(); i != end; ++i) { if ((*i)->equalsModel(occupant)) { m_active = i; m_switch = true; return true; } } return false; }

void Controls::addUnit (  Unit *  unit  )

Add unit under our control. Returns: model index Definition at line 48 of file Controls.cpp. { m_units.push_back(unit); //NOTE: insertion invalidates m_active t_units::iterator end = m_units.end(); for (t_units::iterator i = m_units.begin(); i != end; ++i) { if ((*i)->startActive()) { setActive(i); return; } } setActive(m_units.begin()); }

bool Controls::cannotMove (   )  const

Returns true when there is no unit which will be able to move. Definition at line 319 of file Controls.cpp. { t_units::const_iterator end = m_units.end(); for (t_units::const_iterator i = m_units.begin(); i != end; ++i) { if ((*i)->willMove()) { return false; } } return true; }

void Controls::checkActive (   )

Check whether active unit can still drive, otherwise make switch. Definition at line 207 of file Controls.cpp. { if (m_active == m_units.end() || !(*m_active)->canDrive()) { switchActive(); } }

void Controls::controlEvent (  const KeyStroke &  stroke  )

Obtain first control symbol from keyboard events. Definition at line 244 of file Controls.cpp. { SDLKey key = stroke.getKey(); if (m_strokeSymbol == ControlSym::SYM_NONE) { if (m_active != m_units.end()) { m_strokeSymbol = (*m_active)->mySymbolBorrowed(key, m_arrows); } if (m_strokeSymbol == ControlSym::SYM_NONE) { t_units::iterator end = m_units.end(); for (t_units::iterator i = m_units.begin(); i != end; ++i) { m_strokeSymbol = (*i)->mySymbol(key); if (m_strokeSymbol != ControlSym::SYM_NONE) { return; } } } } }

bool Controls::driving (  const InputProvider *  input  )

Let drivers to drive. Only one driver can drive at the same time. Parameters: input  wrapped input Returns: true when a fish has moved (switch does not count) Definition at line 82 of file Controls.cpp. { bool moved = false; if (!useSwitch()) { if (!useStroke()) { moved = driveUnit(input); } else { moved = true; } } return moved; }

const Unit * Controls::getActive (   )

Returns active unit or NULL. Definition at line 66 of file Controls.cpp. { Unit *result = NULL; if (m_active != m_units.end()) { result = *m_active; } return result; }

virtual std::string Controls::getMoves (   )  const [inline, virtual]

Implements StepCounter. Definition at line 57 of file Controls.h. { return m_moves; }

virtual int Controls::getStepCount (   )  const [inline, virtual]

Implements StepCounter. Definition at line 56 of file Controls.h. { return m_moves.size(); }

bool Controls::isPowerful (   )  const [virtual]

Returns true when active fish is powerful. Implements StepCounter. Definition at line 334 of file Controls.cpp. { bool result = false; if (m_active != m_units.end()) { result = (*m_active)->isPowerful(); } return result; }

void Controls::lockPhases (   )

Definition at line 161 of file Controls.cpp. { if (m_active != m_units.end() && (*m_active)->isMoving()) { if ((*m_active)->isPushing()) { m_speedup = 0; } else if (!(*m_active)->isTurning()) { m_speedup++; } m_locker->ensurePhases(getNeededPhases(m_speedup)); } else { m_speedup = 0; } }

bool Controls::makeMove (  char  move  )

Make this move. Returns: false for bad move Definition at line 302 of file Controls.cpp. { t_units::iterator end = m_units.end(); for (t_units::iterator i = m_units.begin(); i != end; ++i) { if ((*i)->driveOrder(move) == move) { setActive(i); m_moves.push_back(move); return true; } } return false; }

void Controls::switchActive (   )

Switch active unit. Activate next driveable unit. Definition at line 219 of file Controls.cpp. { if (!m_units.empty()) { t_units::iterator start = m_active; do { if (m_active == m_units.end() || m_active + 1 == m_units.end()) { m_active = m_units.begin(); } else { ++m_active; } } while (m_active != start && !(*m_active)->canDrive()); if (start != m_active) { m_speedup = 0; m_switch = true; } } }

---

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

• Controls.h
• Controls.cpp

---