shawn::MovementObservable Class Reference

#include <movement_observable.h>

Inheritance diagram for shawn::MovementObservable:

[legend]

Collaboration diagram for shawn::MovementObservable:

[legend]

List of all members.

Protected Member Functions
virtual BoxContainer::BoxIterator	movement_boxes_begin () throw ()
	Begin iterator over the currenty active boxes.
virtual BoxContainer::BoxIterator	movement_boxes_end () throw ()
	End iterator over the currenty active boxes.
virtual bool	movement_boxes_violated (const Vec &pos)
virtual void	movement_boxes_from (MovementObservable &mo) throw ()
void	movement_initial_boxes (Node &n, const Vec &newpos, const Vec &velo) throw ()
	Removes all active boxes and retrieves a list of initial boxes from all registered Observers.
void	movement_update_boxes (Node &n, const Vec &newpos, const Vec &velo) throw ()
	Removes all active boxes and updates a list of new boxes from all registered Observers.

---

Detailed Description

A movement that needs to inform Observers that certains areas have been left has to implement this interface (e.g. NodeMovement extends this class). Observers can be added by using the Observable<MovementObserver> interface.

Two helper methods implement this notification mechanism: obtain_initial_boxes and update_boxes.

By using boxes_begin and boxes_end, all currently active boxes can be iterated.

---

Member Function Documentation

virtual BoxContainer::BoxIterator shawn::MovementObservable::movement_boxes_begin

(

)

throw () [inline, protected, virtual]

Begin iterator over the currenty active boxes.

Here is the call graph for this function:

virtual BoxContainer::BoxIterator shawn::MovementObservable::movement_boxes_end

(

)

throw () [inline, protected, virtual]

End iterator over the currenty active boxes.

Here is the call graph for this function:

virtual bool shawn::MovementObservable::movement_boxes_violated

(

const Vec &

pos

)

[inline, protected, virtual]

Here is the call graph for this function:

virtual void shawn::MovementObservable::movement_boxes_from

(

MovementObservable &

mo

)

throw () [inline, protected, virtual]

Here is the call graph for this function:

void shawn::MovementObservable::movement_initial_boxes	(	Node &	n,
		const Vec &	newpos,
		const Vec &	velo
	)			throw () [inline, protected]

Removes all active boxes and retrieves a list of initial boxes from all registered Observers.

Here is the call graph for this function:

void shawn::MovementObservable::movement_update_boxes	(	Node &	n,
		const Vec &	newpos,
		const Vec &	velo
	)			throw () [inline, protected]

Removes all active boxes and updates a list of new boxes from all registered Observers.

Here is the call graph for this function:

---

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

• src/sys/node_movements/movement_observable.h