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)
	Constructor. More...
const Type &	getType () const
void	setType (const Type &type)
	Sets the mouse event type. More...
const MouseButton &	getButton () 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

Detailed Description

Definition at line 49 of file mouse_event.h.

Member Enumeration Documentation

enum pcl::visualization::MouseEvent::MouseButton

Enumerator
NoButton
LeftButton
MiddleButton
RightButton
VScroll

Definition at line 62 of file mouse_event.h.

enum pcl::visualization::MouseEvent::Type

Enumerator
MouseMove
MouseButtonPress
MouseButtonRelease
MouseScrollDown
MouseScrollUp
MouseDblClick

Definition at line 52 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  )

inline

Constructor.

Parameters

[in]	type	event type
[in]	button	The Button that causes the event
[in]	x	x position of mouse pointer at that time where event got fired
[in]	y	y position of mouse pointer at that time where event got fired
[in]	alt	whether the ALT key was pressed at that time where event got fired
[in]	ctrl	whether the CTRL key was pressed at that time where event got fired
[in]	shift	whether the Shift key was pressed at that time where event got fired

Definition at line 132 of file mouse_event.h.

Member Function Documentation

const MouseEvent::MouseButton & pcl::visualization::MouseEvent::getButton ( ) const

inline

Returns

the Button that caused the action

Definition at line 164 of file mouse_event.h.

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 188 of file mouse_event.h.

const MouseEvent::Type & pcl::visualization::MouseEvent::getType ( ) const

inline

Returns

type of mouse event

Definition at line 152 of file mouse_event.h.

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 176 of file mouse_event.h.

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 182 of file mouse_event.h.

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

inline

Set the button that caused the event.

Definition at line 170 of file mouse_event.h.

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

inline

Sets the mouse event type.

Definition at line 158 of file mouse_event.h.

---

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

• /builddir/build/BUILD/PCL-1.6.0-Source/visualization/include/pcl/visualization/mouse_event.h