---

Mouse Class Reference

UIObject subclass implementing Mouse-based motion control, picking, etc. More...

#include <Mouse.h>

Inheritance diagram for Mouse:

List of all members.

Public Types
enum	MoveMode {   ROTATION, TRANSLATION, SCALING, LIGHT,   USERPOINT, PICK, QUERY, CENTER,   LABELATOM, LABELBOND, LABELANGLE, LABELDIHEDRAL,   MOVEATOM, MOVERES, MOVEFRAG, MOVEMOL,   MOVEREP, FORCEATOM, FORCERES, FORCEFRAG,   ADDBOND }
	different available mouse movement/picking modes. More...
enum	MouseButton { B_NONE = 0, B_LEFT = 1, B_MIDDLE, B_RIGHT }
Public Methods
	Mouse (VMDApp *)
virtual	~Mouse (void)
virtual void	reset (void)
	reset the mouse interface (force update of all info displays). More...
int	move_mode (MoveMode, int=0)
	set the current move mode. More...
void	stop_rotation (void)
	stop rotation of object. More...
virtual int	check_event (void)
	check for events, queue any found, return TRUE if an event was generated. More...
void	set_rocking (int on)
	turn on/off rocking. More...
Static Public Methods
const char *	get_mode_str (MoveMode mode)
	gets a string representing a mode's name. More...

---

Detailed Description

UIObject subclass implementing Mouse-based motion control, picking, etc.

Definition at line 42 of file Mouse.h.

---

Member Enumeration Documentation

enum Mouse::MouseButton

Enumeration values: B_NONE  B_LEFT  B_MIDDLE  B_RIGHT  Definition at line 57 of file Mouse.h.

enum Mouse::MoveMode

different available mouse movement/picking modes. Enumeration values: ROTATION  TRANSLATION  SCALING  LIGHT  USERPOINT  PICK  QUERY  CENTER  LABELATOM  LABELBOND  LABELANGLE  LABELDIHEDRAL  MOVEATOM  MOVERES  MOVEFRAG  MOVEMOL  MOVEREP  FORCEATOM  FORCERES  FORCEFRAG  ADDBOND  Definition at line 45 of file Mouse.h. Referenced by VMDApp::mouse_set_mode.

---

Constructor & Destructor Documentation

Mouse::Mouse (  VMDApp *    )

Definition at line 44 of file Mouse.C. References UIObject::app, B_NONE, VMDApp::display, DisplayDevice::NORMAL_CURSOR, DisplayDevice::queue_events, reset, ROTATION, DisplayDevice::set_cursor, and stop_rotation.

Mouse::~Mouse (  void    )  [virtual]

Definition at line 80 of file Mouse.C. References move_mode, and ROTATION.

---

Member Function Documentation

int Mouse::check_event (  void    )  [virtual]

check for events, queue any found, return TRUE if an event was generated. Reimplemented from UIObject. Definition at line 500 of file Mouse.C. References UIObject::app, B_NONE, VideoStream::cli_connected, VMDApp::display, LIGHT, VMDApp::light_rotate, UIObject::make_callbacks, DisplayDevice::read_event, VMDApp::scene_rotate_by, VMDApp::uivs, and USERPOINT.

const char * Mouse::get_mode_str (  MoveMode    mode )  [static]

gets a string representing a mode's name. Definition at line 84 of file Mouse.C. References ADDBOND, CENTER, FORCEATOM, FORCEFRAG, FORCERES, LABELANGLE, LABELATOM, LABELBOND, LABELDIHEDRAL, LIGHT, MOVEATOM, MOVEFRAG, MOVEMOL, MOVEREP, MOVERES, PICK, QUERY, ROTATION, SCALING, TRANSLATION, and USERPOINT. Referenced by move_mode.

int Mouse::move_mode (  MoveMode   , int    = 0 )

set the current move mode. Definition at line 125 of file Mouse.C. References UIObject::app, VMDApp::display, get_mode_str, LIGHT, VMDApp::light_highlight, DisplayDevice::NORMAL_CURSOR, DisplayDevice::PICK_CURSOR, ROTATION, UIObject::runcommand, DisplayDevice::SCALE_CURSOR, SCALING, DisplayDevice::set_cursor, stop_rotation, DisplayDevice::TRANS_CURSOR, TRANSLATION, and USERPOINT. Referenced by VMDApp::mouse_set_mode, and ~Mouse.

void Mouse::reset (  void    )  [virtual]

reset the mouse interface (force update of all info displays). Reimplemented from UIObject. Definition at line 393 of file Mouse.C. References UIObject::app, VMDApp::display, stop_rotation, DisplayDevice::x, and DisplayDevice::y. Referenced by Mouse.

void Mouse::set_rocking (  int    on )

turn on/off rocking. Definition at line 492 of file Mouse.C. Referenced by VMDApp::set_mouse_rocking.

void Mouse::stop_rotation (  void    )

stop rotation of object. Definition at line 120 of file Mouse.C. Referenced by Mouse, move_mode, reset, and VMDApp::scene_stoprotation.

---

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

• Mouse.h
• Mouse.C

---