Point Cloud Library (PCL)  1.3.1
Public Member Functions | Static Public Attributes
pcl::visualization::KeyboardEvent Class Reference

/brief Class representing key hit/release events More...

#include <pcl/visualization/keyboard_event.h>

List of all members.

Public Member Functions

 KeyboardEvent (bool action, const std::string &key_sym, unsigned char key, bool alt, bool ctrl, bool shift)
 Constructor.
bool isAltPressed () const
bool isCtrlPressed () const
bool isShiftPressed () const
unsigned char getKeyCode () const
const std::string & getKeySym () const
bool keyDown () const
bool keyUp () const

Static Public Attributes

static const unsigned int Alt = 1
 bit patter for the ALT key
static const unsigned int Ctrl = 2
 bit patter for the Control key
static const unsigned int Shift = 4
 bit patter for the Shift key

Detailed Description

/brief Class representing key hit/release events


Constructor & Destructor Documentation

pcl::visualization::KeyboardEvent::KeyboardEvent ( bool  action,
const std::string &  key_sym,
unsigned char  key,
bool  alt,
bool  ctrl,
bool  shift 
) [inline]

Constructor.

Parameters:
[in]actiontrue for key was pressed, false for released
[in]key_symthe key-name that caused the action
[in]keythe key code that caused the action
[in]altwhether the alt key was pressed at the time where this event was triggered
[in]ctrlwhether the ctrl was pressed at the time where this event was triggered
[in]shiftwhether the shift was pressed at the time where this event was triggered

Definition at line 120 of file keyboard_event.h.


Member Function Documentation

unsigned char pcl::visualization::KeyboardEvent::getKeyCode ( ) const [inline]
Returns:
the ASCII Code of the key that caused the event. If 0, then it was a special key, like ALT, F1, F2,... PgUp etc. Then the name of the key is in the keysym field.

Definition at line 156 of file keyboard_event.h.

const std::string & pcl::visualization::KeyboardEvent::getKeySym ( ) const [inline]
Returns:
name of the key that caused the event

Definition at line 162 of file keyboard_event.h.

bool pcl::visualization::KeyboardEvent::isAltPressed ( ) const [inline]
Returns:
whether the alt key was pressed at the time where this event was triggered

Definition at line 138 of file keyboard_event.h.

bool pcl::visualization::KeyboardEvent::isCtrlPressed ( ) const [inline]
Returns:
whether the ctrl was pressed at the time where this event was triggered

Definition at line 144 of file keyboard_event.h.

bool pcl::visualization::KeyboardEvent::isShiftPressed ( ) const [inline]
Returns:
whether the shift was pressed at the time where this event was triggered

Definition at line 150 of file keyboard_event.h.

bool pcl::visualization::KeyboardEvent::keyDown ( ) const [inline]
Returns:
true if a key-press caused the event, false otherwise

Definition at line 168 of file keyboard_event.h.

bool pcl::visualization::KeyboardEvent::keyUp ( ) const [inline]
Returns:
true if a key-release caused the event, false otherwise

Definition at line 174 of file keyboard_event.h.


Member Data Documentation

const unsigned int pcl::visualization::KeyboardEvent::Alt = 1 [static]

bit patter for the ALT key

Definition at line 53 of file keyboard_event.h.

const unsigned int pcl::visualization::KeyboardEvent::Ctrl = 2 [static]

bit patter for the Control key

Definition at line 55 of file keyboard_event.h.

const unsigned int pcl::visualization::KeyboardEvent::Shift = 4 [static]

bit patter for the Shift key

Definition at line 57 of file keyboard_event.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines