Action.hpp

Go to the documentation of this file.

/****************************************************************************\
 *                                 VRVis                                    *
 *                      http://vrvis.sourceforge.net                        *
 *                       (C) 2004 by Alex Loeffler                          *
 *                 mailto:aloeffler@users.sourceforge.net                   *
 ****************************************************************************
 *                                License                                   *
 *                                                                          *
 * This library is free software; you can redistribute it and/or modify it  *
 * under the terms of the GNU Library General Public License as published   *
 * by the Free Software Foundation, version 2.                              *
 *                                                                          *
 * This library is distributed in the hope that it will be useful, but      *
 * WITHOUT ANY WARRANTY; without even the implied warranty of               *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU        *
 * Library General Public License for more details.                         *
 *                                                                          *
 * You should have received a copy of the GNU Library General Public        *
 * License along with this library; if not, write to the Free Software      *
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                *
\****************************************************************************/

#ifndef ACTION_HPP
#define ACTION_HPP

#include <map>
#include <string>
#include <gadget/Type/Digital.h>
#include "Common.hpp"

namespace vrvis
{

class ActionSet;
class Input;

/****************************************************************************\
 *                                  Action                                  *
\****************************************************************************/

class Action
{
  // ================================================================== PUBLIC

  public:

  // ------------------------------------------------------------- Destructor.

  virtual ~Action(void);

  // -------------------------------------------------------------- Accessors.

  const std::string& getName(void) const;

  // =============================================================== PROTECTED

  protected:

  // ------------------------------------------------------------ Constructor.

  Action(const std::string& crName);

  // ------------------------------------------------------------------ Input.

  Input* getInput(void) const;

  // ------------------------------------------------------------- Activation.

  virtual void activate(void);

  virtual void deactivate(void);

  // ----------------------------------------------------------------- Search.

  static Action* getByName(const std::string& crName);

  // ================================================================= PRIVATE

  private:

  // ---------------------------------------------------------------- Friends.

  friend class ActionSet;

  // --------------------------------------------------------------- Typedefs.

  typedef std::map<std::string, Action*> NameActionMap;

  // ------------------------------------------------------------------ Input.

  void setInput(Input* pInput);

  // ---------------------------------------------------------------- Members.

  std::string mName;  
  Input* mpInput;     

  // --------------------------------------------------------- Static Members.

  static NameActionMap sNameActionMap;  
};

/****************************************************************************\
 *                               AnalogAction                               *
\****************************************************************************/

class AnalogAction : public Action
{
  // ================================================================== PUBLIC

  public:

  // ------------------------------------------------------------- Destructor.

  virtual ~AnalogAction(void);

  // -------------------------------------------------------------- Execution.

  virtual void execute(const float cAnalogDataValue) = 0;

  // --------------------------------------------------------- Static Members.

  static const float THRESHOLD;

  // =============================================================== PROTECTED

  protected:

  // ------------------------------------------------------------ Constructor.

  AnalogAction(const std::string& crName);
};

/****************************************************************************\
 *                              DigitalAction                               *
\****************************************************************************/

class DigitalAction : public Action
{
  // ================================================================== PUBLIC

  public:

  // ------------------------------------------------------------- Destructor.

  virtual ~DigitalAction(void);

  // -------------------------------------------------------------- Execution.

  virtual void execute(const gadget::Digital::State cButtonState) = 0;

  // =============================================================== PROTECTED

  protected:

  // ------------------------------------------------------------ Constructor.

  DigitalAction(const std::string& crName);
};

}  // End namespace.

#endif // ACTION_HPP

---