##

CessnaGUIPlugin Class Reference

A GUI plugin that controls the Cessna model using the keyboard. More...

`#include <CessnaGUIPlugin.hh>`

Inherits GUIPlugin.

## Public Types

typedef boost::shared_ptr< GUIPlugin > | TPtr
| plugin pointer type definition More...

## Public Member Functions

| CessnaGUIPlugin ()
| Constructor. More...
virtual | ~CessnaGUIPlugin ()
| Destructor. More...
std::string | GetFilename () const
| Get the name of the handler. More...
std::string | GetHandle () const
| Get the short name of the handler. More...
PluginType | GetType () const
| Returns the type of the plugin. More...
virtual void | Load (sdf::ElementPtr)
| Load function. More...
virtual void | paintEvent (QPaintEvent *)

## Static Public Member Functions

static TPtr | Create (const std::string &_filename, const std::string &_name)
| a class method that creates a plugin from a file name. More...

## Protected Member Functions

void | LoadParam (const sdf::ElementPtr &_sdf, const std::string &_name, V &_target, V _defaultValue=V()) const
| Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More...
void | LoadParam (sdf::ElementPtr &_sdf, const std::string &_name, std::string &_target, const char *_defaultValue) const
| Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More...

## Protected Attributes

std::string | filename
| Path to the shared library file. More...
std::string | handleName
| Short name. More...
PluginType | type
| Type of plugin. More...

## Detailed Description

A GUI plugin that controls the Cessna model using the keyboard.

If you are reading this, feel free to improve this plugin by adding graphical widgets to make the demo more interesting and fun.

Keyboard controls: w Increase thrust (+10 %) s Decrease thrust (-10 %) d Increase rudder angle (+1 degree) a Decrease rudder angle (-1 degree) Left-Key Left roll (+1 degree) Right-Key Right roll (+1 degree) Up-Key Pitch down (+1 degree) Down-Key Pitch up (+1 degree) 1 Preset for take-off 2 Preset for cruise 3 Preset for landing

## Member Typedef Documentation

## TPtr

typedef boost::shared_ptr<GUIPlugin > TPtr

inherited

plugin pointer type definition

## Constructor & Destructor Documentation

## CessnaGUIPlugin()

CessnaGUIPlugin | ( |  | ) |

Constructor.

## ~CessnaGUIPlugin()

virtual ~CessnaGUIPlugin | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## Create()

static TPtr Create | ( | const std::string & | _filename,
|  | const std::string & | _name
| ) |  |

inline static inherited

a class method that creates a plugin from a file name.

It locates the shared library and loads it dynamically.

Parameters

  [in] | _filename | the path to the shared library.
  [in] | _name | short name of the plugin

Returns
  Shared Pointer to this class type

## GetFilename()

std::string GetFilename | ( |  | ) | const

inline inherited

Get the name of the handler.

## GetHandle()

std::string GetHandle | ( |  | ) | const

inline inherited

Get the short name of the handler.

## GetType()

PluginType GetType | ( |  | ) | const

inline inherited

Returns the type of the plugin.

Returns
  type of the plugin

## Load()

virtual void Load | ( | sdf::ElementPtr |  | ) |

inline virtual inherited

Load function.

Called when a plugin is first created. This function should not be blocking. This function will be called with an empty sdf element when a GUI plugin is loaded via a gui.ini file or via a command line argument.

Parameters

  [in] | _sdf | Pointer the the SDF element of the plugin. This is the plugin SDF, <plugin ...>, and its children. It will be an empty element when loaded from INI file or command line argument.

Reimplemented in LookAtDemoPlugin, and TimerGUIPlugin.

## LoadParam() [1/2]

void LoadParam | ( | const sdf::ElementPtr & | _sdf,
|  | const std::string & | _name,
|  | V & | _target,
|  | V | _defaultValue = `V()`
| ) |  | const

inline protected inherited

Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.

A message is written using gzmsg reporting whether the default value was used or not.

Parameters

  [in] | _sdf | The SDF element of the plugin.
  [in] | _name | Name of a tag inside the SDF.
  [out] | _target | The reference to store the param value to.
  [in] | _defaultValue | The default value.

## LoadParam() [2/2]

void LoadParam | ( | sdf::ElementPtr & | _sdf,
|  | const std::string & | _name,
|  | std::string & | _target,
|  | const char * | _defaultValue
| ) |  | const

inline protected inherited

Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.

A message is written using gzmsg reporting whether the default value was used or not. String specialization to allow accepting const char* values for std::string parameters.

Parameters

  [in] | _sdf | The SDF element of the plugin.
  [in] | _name | Name of a tag inside the SDF.
  [out] | _target | The reference to store the param value to.
  [in] | _defaultValue | The default value.

## paintEvent()

virtual void paintEvent | ( | QPaintEvent * |  | ) |

inline virtual inherited

## Member Data Documentation

## filename

std::string filename

protected inherited

Path to the shared library file.

## handleName

std::string handleName

protected inherited

Short name.

## type

PluginType type

protected inherited

Type of plugin.

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

- CessnaGUIPlugin.hh