Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Types | Public Member Functions | Protected Attributes
pcl::visualization::MouseEvent Class Reference

#include <pcl/visualization/mouse_event.h>

Public Types

enum  Type {
  MouseMove = 1, MouseButtonPress, MouseButtonRelease, MouseScrollDown,
  MouseScrollUp, MouseDblClick
}
 
enum  MouseButton {
  NoButton = 0, LeftButton, MiddleButton, RightButton,
  VScroll
}
 

Public Member Functions

 MouseEvent (const Type &type, const MouseButton &button, unsigned int x, unsigned int y, bool alt, bool ctrl, bool shift, bool selection_mode=false)
 Constructor. More...
 
const TypegetType () const
 
void setType (const Type &type)
 Sets the mouse event type. More...
 
const MouseButtongetButton () const
 
void setButton (const MouseButton &button)
 Set the button that caused the event. More...
 
unsigned int getX () const
 
unsigned int getY () const
 
unsigned int getKeyboardModifiers () const
 
bool getSelectionMode () const
 

Protected Attributes

Type type_
 
MouseButton button_
 
unsigned int pointer_x_
 
unsigned int pointer_y_
 
unsigned int key_state_
 
bool selection_mode_
 

Detailed Description

Definition at line 47 of file mouse_event.h.

Member Enumeration Documentation

Enumerator
NoButton 
LeftButton 
MiddleButton 
RightButton 
VScroll 

Definition at line 60 of file mouse_event.h.

Enumerator
MouseMove 
MouseButtonPress 
MouseButtonRelease 
MouseScrollDown 
MouseScrollUp 
MouseDblClick 

Definition at line 50 of file mouse_event.h.

Constructor & Destructor Documentation

pcl::visualization::MouseEvent::MouseEvent ( const Type type,
const MouseButton button,
unsigned int  x,
unsigned int  y,
bool  alt,
bool  ctrl,
bool  shift,
bool  selection_mode = false 
)
inline

Constructor.

Parameters
[in]typeevent type
[in]buttonThe Button that causes the event
[in]xx position of mouse pointer at that time where event got fired
[in]yy position of mouse pointer at that time where event got fired
[in]altwhether the ALT key was pressed at that time where event got fired
[in]ctrlwhether the CTRL key was pressed at that time where event got fired
[in]shiftwhether the Shift key was pressed at that time where event got fired
[in]selection_modewhether we are in selection mode

Definition at line 139 of file mouse_event.h.

References pcl::visualization::KeyboardEvent::Alt, pcl::visualization::KeyboardEvent::Ctrl, key_state_, and pcl::visualization::KeyboardEvent::Shift.

Member Function Documentation

const MouseEvent::MouseButton & pcl::visualization::MouseEvent::getButton ( ) const
inline
Returns
the Button that caused the action

Definition at line 173 of file mouse_event.h.

References button_.

unsigned int pcl::visualization::MouseEvent::getKeyboardModifiers ( ) const
inline
Returns
returns the keyboard modifiers state at that time where the event got fired

Definition at line 197 of file mouse_event.h.

References key_state_.

bool pcl::visualization::MouseEvent::getSelectionMode ( ) const
inline
Returns
selection mode status

Definition at line 203 of file mouse_event.h.

References selection_mode_.

const MouseEvent::Type & pcl::visualization::MouseEvent::getType ( ) const
inline
Returns
type of mouse event

Definition at line 161 of file mouse_event.h.

References type_.

unsigned int pcl::visualization::MouseEvent::getX ( ) const
inline
Returns
the x position of the mouse pointer at that time where the event got fired

Definition at line 185 of file mouse_event.h.

References pointer_x_.

unsigned int pcl::visualization::MouseEvent::getY ( ) const
inline
Returns
the y position of the mouse pointer at that time where the event got fired

Definition at line 191 of file mouse_event.h.

References pointer_y_.

void pcl::visualization::MouseEvent::setButton ( const MouseButton button)
inline

Set the button that caused the event.

Definition at line 179 of file mouse_event.h.

References button_.

void pcl::visualization::MouseEvent::setType ( const Type type)
inline

Sets the mouse event type.

Definition at line 167 of file mouse_event.h.

References type_.

Member Data Documentation

MouseButton pcl::visualization::MouseEvent::button_
protected

Definition at line 132 of file mouse_event.h.

Referenced by getButton(), and setButton().

unsigned int pcl::visualization::MouseEvent::key_state_
protected

Definition at line 135 of file mouse_event.h.

Referenced by getKeyboardModifiers(), and MouseEvent().

unsigned int pcl::visualization::MouseEvent::pointer_x_
protected

Definition at line 133 of file mouse_event.h.

Referenced by getX().

unsigned int pcl::visualization::MouseEvent::pointer_y_
protected

Definition at line 134 of file mouse_event.h.

Referenced by getY().

bool pcl::visualization::MouseEvent::selection_mode_
protected

Definition at line 136 of file mouse_event.h.

Referenced by getSelectionMode().

Type pcl::visualization::MouseEvent::type_
protected

Definition at line 131 of file mouse_event.h.

Referenced by getType(), and setType().


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