Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

amire::common::Updateable Class Reference

Inheritance diagram for amire::common::Updateable:

amire::common::Image amire::common::Tracker amire::common::ProjectionVideoImage amire::common::MarkerCameraTracker amire::common::MarkerObjectTracker amire::common::ARToolKitVideoImage List of all members.

Public Member Functions

 Updateable (bool updateEnabled=true)
virtual ~Updateable ()
void setUpdateEnabled (bool updateEnabled)
bool isUpdateEnabled ()
void update ()

Protected Member Functions

virtual void doUpdate ()=0

Protected Attributes

bool updateEnabled

Detailed Description

The class Updateable is the base of all update able classes. It allows to freeze the update. The doUpdate method of the implementation class is called by the Updateable class to performe the update.


Constructor & Destructor Documentation

amire::common::Updateable::Updateable bool  updateEnabled = true  ) 
 

virtual amire::common::Updateable::~Updateable  )  [virtual]
 


Member Function Documentation

virtual void amire::common::Updateable::doUpdate  )  [protected, pure virtual]
 

This method must be implemented by the derived implementation class to perform the update.

Implemented in amire::common::ARToolKitVideoImage, amire::common::Image, amire::common::MarkerCameraTracker, and amire::common::MarkerObjectTracker.

bool amire::common::Updateable::isUpdateEnabled  ) 
 

Returns true if the update mechanism is enable. Otherwise, false is returned.

void amire::common::Updateable::setUpdateEnabled bool  updateEnabled  ) 
 

Disables/Enables the update mechanism.

void amire::common::Updateable::update  ) 
 

This method should be called to get the actualize the implementation class. If the update mechanism is enabled, then the update is performed. Otherwise the updateable will not be changed.


Member Data Documentation

bool amire::common::Updateable::updateEnabled [protected]
 


The documentation for this class was generated from the following file:
Generated on Tue May 20 17:23:56 2003 for AMIRE-Framework by doxygen1.3