vrvis::ToggleAction Class Reference

Small Action that toggles a boolean value between its two states. More...

#include <ToggleAction.hpp>

Inheritance diagram for vrvis::ToggleAction:

List of all members.

Public Member Functions
	ToggleAction (bool &rToggleVar)
	Constructor that takes a reference to the value to be toggled.
	~ToggleAction (void)
	Destructor.
virtual void	execute (const gadget::Digital::State cButtonState)
	Toggle the toggle value.

---

Detailed Description

Example of a very basic Action that changes a boolean value that it given to it to the opposite on button release. This is one of the most used Actions though, e.g. to switch lights on and off, etc..

---

Constructor & Destructor Documentation

ToggleAction::ToggleAction (  bool &  rToggleVar  )

Constructs a ToggleAction for a given boolean value. Parameters: [in]  rToggleVar  Reference to the boolean value to be toggled by this Action.

ToggleAction::~ToggleAction (  void   )

Destructor.

---

Member Function Documentation

void ToggleAction::execute (  const gadget::Digital::State  cButtonState  )  [virtual]

On release of the assigned button, the boolean value that this Action references, is toggled. Parameters: [in]  cButtonState  The state of the digital device connected to this Action. Implements vrvis::DigitalAction.

---

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

• ToggleAction.hpp
• ToggleAction.cpp

---