CarnegieMellonGraphics2
Class MouseEvent

class MouseEvent

MouseEvents are generated whenever the user performs some action with the mouse. The types of MouseEvents that can occur are listed below as part of the MouseEvent::Event enumeration.

MouseEvents are designed to work in a manner so that a user can easily "match" and filter out events in which they have interest. Basically the user constructs a new event to match against the event they currently have. The MouseEvent constructor has several default parameters so the user doesn't need to specify more detail about the event than they need.

It is also possible to simply obtain pertinent information about an event through the accessor member functions.

For example, if the user has just removed a mouse event from the mouse input queue, and they want to see if the mouse was clicked they can do the following:

    if(MouseEvent(MouseEvent::BUTTON_CLICK_EVENT) == an_event) 
    // do something

Or a more complicated example would be if the user wanted to check to see if the mouse has was moved over position (x, y) while holding down the left button they would do this:

  if(MouseEvent(MouseEvent::MOUSE_MOVE_EVENT, MouseEvent::LEFT_BUTTON, x, y) == an_event) 
    // do something else

Finally, if you wanted to check to see if the right mouse buton has been pressed down while holding down the shift key, you would do the following:

  if(MouseEvent(MouseEvent::ButtonDown, MouseEvent::RIGHT_BUTTON, -1, -1, 
                                        KeyModifiers::SHIFT) == an_event) 
    // do more of something else 

In this case the coordinate of (-1, -1) indicates the location at which the button press occurred does not matter.

Note that on some platforms, certain mouse and modifier combinations will be trapped by the operating system/window manager and will not be reported as having taken place.

MouseEvent

public MouseEvent( const MouseEvent::Event e, const MouseEvent::Button b = ANY_BUTTON, const int x =-1, const int y =-1, const KeyModifiers km = KeyModifiers::ANY_MODIFIERS );

Constructor for a mouse event from a set of parameters.

MouseEvent

public MouseEvent( const MouseEvent& me );

Copy constructor

MouseEvent

public MouseEvent();

Default constructor

getButton

public const MouseEvent::Button getButton() const;

Returns:

Which button(s), if any, were involved with this event.

getEvent

public const MouseEvent::Event getEvent() const;

Returns:

The actual event information for the mouse event.

getModifiers

public const KeyModifiers getModifiers() const;

Returns:

set of modifiers active at the time of the event, if relevant.

getX

public const int getX() const;

Returns:

The X coordinate that this event occurred, if relevant, otherwise returns -1.

getY

public const int getY() const;

Returns:

The Y coordinate that this event occurred, if relevant, otherwise returns -1

operator!=

public bool operator!=( const MouseEvent& rhs ) const;

Comparison operator for inequality on events.

operator==

public bool operator==( const MouseEvent& rhs ) const;

Comparison operator for equality on events.