'\"! tbl | mmdoc
'\"macro stdmacro
.ie n \{\
.   ds Cr \fB
.   ds Cb \fB
.\}
.el \{\
.   ds Cr \f7
.   ds Cb \f8
.\}
.TH SoMouseButtonEvent(3IV)
.SH NAME
SoMouseButtonEvent \(em mouse button press and release events 
.SH INHERITS FROM
SoEvent > SoButtonEvent > SoMouseButtonEvent
.SH SYNOPSIS
.ps -1
\*(Cr#include <Inventor/events/SoMouseButtonEvent.h>
.sp
\*(Cr#define SO_MOUSE_PRESS_EVENT(EVENT,BUTTON)
    (SoMouseButtonEvent::isButtonPressEvent(EVENT,SoMouseButtonEvent::BUTTON)) 
.br
\*(Cr#define SO_MOUSE_RELEASE_EVENT(EVENT,BUTTON)
    (SoMouseButtonEvent::isButtonReleaseEvent(EVENT,SoMouseButtonEvent::BUTTON)) 
.sp
.in 0.5i
\*(Crenum \*(CbButton\*(Cr {
.in 1i
.ta 29m
.in 1.5i+29n
.ti 1i
.ta 29m
.ds Pt \*(CbSoMouseButtonEvent::ANY\f1
.ie \w'\*(Pt'>=29n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
Any button
.br
.in 1.5i+29n
.ti 1i
.ta 29m
.ds Pt \*(CbSoMouseButtonEvent::BUTTON1\f1
.ie \w'\*(Pt'>=29n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
First mouse button
.br
.in 1.5i+29n
.ti 1i
.ta 29m
.ds Pt \*(CbSoMouseButtonEvent::BUTTON2\f1
.ie \w'\*(Pt'>=29n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
Second mouse button
.br
.in 1.5i+29n
.ti 1i
.ta 29m
.ds Pt \*(CbSoMouseButtonEvent::BUTTON3\f1
.ie \w'\*(Pt'>=29n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
Third mouse button
.br
.in 0.5i
\*(Cr}
.sp
.in 1i
\f1Methods from class SoMouseButtonEvent:
.in 0.5i
.sp
.ta 28m
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoMouseButtonEvent\*(Cr()
.br
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(Crstatic SoType
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetClassTypeId\*(Cr()
.br
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetButton\*(Cr(SoMouseButtonEvent::Button b)
.br
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(CrSoMouseButtonEvent::Button
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetButton\*(Cr() const
.br
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(Crstatic SbBool
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisButtonPressEvent\*(Cr(const SoEvent *e, SoMouseButtonEvent::Button whichButton)
.br
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(Crstatic SbBool
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisButtonReleaseEvent\*(Cr(const SoEvent *e, SoMouseButtonEvent::Button whichButton)
.sp
.in 1i
\f1Methods from class SoButtonEvent:
.in 0.5i
.sp
.ta 22m
.in 1i+22n
.ti 0.5i
.ta 22m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=22n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetState\*(Cr(SoButtonEvent::State s)
.br
.in 1i+22n
.ti 0.5i
.ta 22m
.ds Pt \*(CrSoButtonEvent::State
.ie \w'\*(Pt'>=22n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetState\*(Cr() const
.sp
.in 1i
\f1Methods from class SoEvent:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SoType
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetTypeId\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisOfType\*(Cr(SoType type) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetTime\*(Cr(SbTime t)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbTime
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetTime\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetPosition\*(Cr(const SbVec2s &p)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crconst SbVec2s &
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetPosition\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crconst SbVec2s &
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetPosition\*(Cr(const SbViewportRegion &vpRgn) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crconst SbVec2f &
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetNormalizedPosition\*(Cr(const SbViewportRegion &vpRgn) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetShiftDown\*(Cr(SbBool isDown)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetCtrlDown\*(Cr(SbBool isDown)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetAltDown\*(Cr(SbBool isDown)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbwasShiftDown\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbwasCtrlDown\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbwasAltDown\*(Cr() const
.sp
.SH DESCRIPTION
\*(CbSoMouseButtonEvent\f1 represents mouse button press and release events in the Inventor event model. 
.SH METHODS
.ta 28m
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoMouseButtonEvent\*(Cr()
.br
.in 1i
\f1Constructor. 
.sp
.in 0.5i
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(Crstatic SoType
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetClassTypeId\*(Cr()
.br
.in 1i
\f1Return the type id for the \*(CbSoMouseButtonEvent\f1 class. 
.sp
.in 0.5i
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetButton\*(Cr(SoMouseButtonEvent::Button b)
.br
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(CrSoMouseButtonEvent::Button
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetButton\*(Cr() const
.br
.in 1i
\f1Set and get which mouse button generated the event. 
.sp
.in 0.5i
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(Crstatic SbBool
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisButtonPressEvent\*(Cr(const SoEvent *e, SoMouseButtonEvent::Button whichButton)
.br
.in 1i+28n
.ti 0.5i
.ta 28m
.ds Pt \*(Crstatic SbBool
.ie \w'\*(Pt'>=28n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisButtonReleaseEvent\*(Cr(const SoEvent *e, SoMouseButtonEvent::Button whichButton)
.br
.in 1i
\f1Returns whether the passed event is a mouse button press or release event of the passed button. When \*(CbSoMouseButtonEvent::ANY\f1 is passed, this returns TRUE if the event represents a button press or release of any mouse button. 
.sp
.in 0.5i
.SH SEE ALSO
\*(CbSoEvent, SoButtonEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event, SoSpaceballButtonEvent, SoHandleEventAction, SoEventCallback, SoSelection, SoInteraction, SoXtDevice