'\"! tbl | mmdoc
'\"macro stdmacro
.ie n \{\
.   ds Cr \fB
.   ds Cb \fB
.\}
.el \{\
.   ds Cr \f7
.   ds Cb \f8
.\}
.TH SoButtonEvent(3IV)
.SH NAME
SoButtonEvent \(em base class for all button events 
.SH INHERITS FROM
SoEvent > SoButtonEvent
.SH SYNOPSIS
.ps -1
\*(Cr#include <Inventor/events/SoButtonEvent.h>
.sp
.in 0.5i
\*(Crenum \*(CbState\*(Cr {
.in 1i
.ta 24m
.in 1.5i+24n
.ti 1i
.ta 24m
.ds Pt \*(CbSoButtonEvent::UP\f1
.ie \w'\*(Pt'>=24n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
Button up event
.br
.in 1.5i+24n
.ti 1i
.ta 24m
.ds Pt \*(CbSoButtonEvent::DOWN\f1
.ie \w'\*(Pt'>=24n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
Button down event
.br
.in 1.5i+24n
.ti 1i
.ta 24m
.ds Pt \*(CbSoButtonEvent::UNKNOWN\f1
.ie \w'\*(Pt'>=24n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
Button in unknown state
.br
.in 0.5i
\*(Cr}
.sp
.in 1i
\f1Methods from class SoButtonEvent:
.in 0.5i
.sp
.ta 22m
.in 1i+22n
.ti 0.5i
.ta 22m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=22n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoButtonEvent\*(Cr()
.br
.in 1i+22n
.ti 0.5i
.ta 22m
.ds Pt \*(Crstatic SoType
.ie \w'\*(Pt'>=22n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetClassTypeId\*(Cr()
.br
.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
\*(CbSoButtonEvent\f1 represents generic button press and release events in the Inventor event model. It is the base class for device-specific button events, namely \*(CbSoKeyboardEvent\f1, \*(CbSoMouseButtonEvent\f1, and \*(CbSoSpaceballButtonEvent\f1. This class stores the down/up state of the button
\&when the event occurred. 
.SH METHODS
.ta 22m
.in 1i+22n
.ti 0.5i
.ta 22m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=22n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoButtonEvent\*(Cr()
.br
.in 1i
\f1Constructor. 
.sp
.in 0.5i
.in 1i+22n
.ti 0.5i
.ta 22m
.ds Pt \*(Crstatic SoType
.ie \w'\*(Pt'>=22n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetClassTypeId\*(Cr()
.br
.in 1i
\f1Return the type id for the \*(CbSoButtonEvent\f1 class. 
.sp
.in 0.5i
.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
.br
.in 1i
\f1Set and get the state of the button. 
.sp
.in 0.5i
.SH SEE ALSO
\*(CbSoEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event, SoMouseButtonEvent, SoSpaceballButtonEvent, SoHandleEventAction, SoEventCallback, SoSelection, SoInteraction, SoXtDevice