Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | Related Pages

Activator Class Reference

#include <activator.h>

Inheritance diagram for Activator:

Inheritance graph
[legend]
List of all members.

Detailed Description

Simple class for activator control, use virtual inheritance Used by any objects that need to keep track of activated/deactivated state. Use virtual inheritance to avoid multiple base objects in inheritance lattice. Remember to call base methods in overridden methods. A class only needs to overload the Activate and Deactivate methods.

Author:
Mattias Jansson (mattias@realityrift.com)


Public Member Functions

 Activator (bool bActive=true)
virtual ~Activator ()
bool IsActive () const
virtual void Activate ()
virtual void Deactivate ()
bool Toggle ()

Protected Attributes

bool m_bActive


Constructor & Destructor Documentation

Activator bool  bActive = true  )  [inline]
 

Initialize state of object

Parameters:
bActive Initial state, default is true (active)

~Activator  )  [inline, virtual]
 


Member Function Documentation

bool IsActive  )  const [inline]
 

Query state of object

Returns:
true if active, false if not

void Activate  )  [inline, virtual]
 

Activate object

void Deactivate  )  [inline, virtual]
 

Deactivate object

bool Toggle  )  [inline]
 

Toggle active state. This method does not need to be overloaded, it is only a wrapper to Activate and Deactivate

Returns:
true if activated, false if deactivated


Member Data Documentation

bool m_bActive [protected]
 

Active flag


The documentation for this class was generated from the following file:
Generated on Wed Jan 21 14:21:10 2004 for NeoEngine by doxygen 1.3.5