.TH "SoSpaceballButtonEvent" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoSpaceballButtonEvent \- The \fBSoSpaceballButtonEvent\fP class contains information about spaceball button interaction\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoButtonEvent\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "enum \fBButton\fP { \fBANY\fP, \fBBUTTON1\fP, \fBBUTTON2\fP, \fBBUTTON3\fP, \fBBUTTON4\fP, \fBBUTTON5\fP, \fBBUTTON6\fP, \fBBUTTON7\fP, \fBBUTTON8\fP, \fBPICK\fP }" .br .in -1c Public Types inherited from \fBSoButtonEvent\fP .in +1c .ti -1c .RI "enum \fBState\fP { \fBUP\fP, \fBDOWN\fP, \fBUNKNOWN\fP }" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoSpaceballButtonEvent\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fB~SoSpaceballButtonEvent\fP ()" .br .ti -1c .RI "\fBvoid\fP \fBsetButton\fP (\fBButton\fP button)" .br .ti -1c .RI "\fBButton\fP \fBgetButton\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoButtonEvent\fP .in +1c .ti -1c .RI "\fBSoButtonEvent\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fB~SoButtonEvent\fP ()" .br .ti -1c .RI "\fBvoid\fP \fBsetState\fP (\fBState\fP state)" .br .ti -1c .RI "\fBState\fP \fBgetState\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoEvent\fP .in +1c .ti -1c .RI "\fBSoEvent\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fB~SoEvent\fP ()" .br .ti -1c .RI "SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetTime\fP (\fBconst\fP \fBSbTime\fP t)" .br .ti -1c .RI "\fBSbTime\fP \fBgetTime\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetPosition\fP (\fBconst\fP \fBSbVec2s\fP &\fBp\fP)" .br .ti -1c .RI "\fBconst\fP \fBSbVec2s\fP & \fBgetPosition\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBconst\fP \fBSbVec2s\fP & \fBgetPosition\fP (\fBconst\fP \fBSbViewportRegion\fP &\fBvpRgn\fP) \fBconst\fP" .br .ti -1c .RI "\fBconst\fP \fBSbVec2f\fP & \fBgetNormalizedPosition\fP (\fBconst\fP \fBSbViewportRegion\fP &\fBvpRgn\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetShiftDown\fP (SbBool \fBisDown\fP)" .br .ti -1c .RI "SbBool \fBwasShiftDown\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetCtrlDown\fP (SbBool \fBisDown\fP)" .br .ti -1c .RI "SbBool \fBwasCtrlDown\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetAltDown\fP (SbBool \fBisDown\fP)" .br .ti -1c .RI "SbBool \fBwasAltDown\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBisButtonPressEvent\fP (\fBconst\fP \fBSoEvent\fP *e, \fBButton\fP \fBwhichButton\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBisButtonReleaseEvent\fP (\fBconst\fP \fBSoEvent\fP *e, \fBButton\fP \fBwhichButton\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBenumToString\fP (\fBButton\fP \fBenumval\fP, \fBSbString\fP &\fBstringrep\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoButtonEvent\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBenumToString\fP (\fBState\fP \fBenumval\fP, \fBSbString\fP &\fBstringrep\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoEvent\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .in -1c .SH "Detailed Description" .PP The \fBSoSpaceballButtonEvent\fP class contains information about spaceball button interaction\&. When the user presses any buttons on a spaceball device, these will be translated from a system specific event into a Coin event and sent to the scene graph by using instances of this class\&. .PP \fBSee also\fP .RS 4 \fBSoEvent\fP, \fBSoButtonEvent\fP, \fBSoMouseButtonEvent\fP, \fBSoKeyboardEvent\fP .PP \fBSoEventCallback\fP, \fBSoHandleEventAction\fP .RE .PP .SH "Member Enumeration Documentation" .PP .SS "\fBenum\fP \fBSoSpaceballButtonEvent::Button\fP" This enum contains all spaceball buttons detected by Coin\&. .PP \fBEnumerator\fP .in +1c .TP \fB\fIANY \fP\fP Any of the buttons\&. .TP \fB\fIBUTTON1 \fP\fP Spaceball button 1\&. .TP \fB\fIBUTTON2 \fP\fP Spaceball button 2\&. .TP \fB\fIBUTTON3 \fP\fP Spaceball button 3\&. .TP \fB\fIBUTTON4 \fP\fP Spaceball button 4\&. .TP \fB\fIBUTTON5 \fP\fP Spaceball button 5\&. .TP \fB\fIBUTTON6 \fP\fP Spaceball button 6\&. .TP \fB\fIBUTTON7 \fP\fP Spaceball button 7\&. .TP \fB\fIBUTTON8 \fP\fP Spaceball button 8\&. .TP \fB\fIPICK \fP\fP Spaceball pick button\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoSpaceballButtonEvent::SoSpaceballButtonEvent (\fBvoid\fP)" Constructor\&. .SS "SoSpaceballButtonEvent::~SoSpaceballButtonEvent ()\fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoSpaceballButtonEvent::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "\fBSoType\fP SoSpaceballButtonEvent::getTypeId (\fBvoid\fP) const\fC [virtual]\fP" Returns the type identification of an object derived from a class inheriting \fBSoEvent\fP\&. This is used for runtime type checking and 'downward' casting\&. .br .PP Reimplemented from \fBSoButtonEvent\fP\&. .SS "\fBvoid\fP SoSpaceballButtonEvent::initClass (\fBvoid\fP)\fC [static]\fP" Initialize the type information data\&. .SS "\fBvoid\fP SoSpaceballButtonEvent::setButton (\fBSoSpaceballButtonEvent::Button\fP buttonarg)" Set the value of the button which the user interacted with\&. .PP This method is used from the window specific device classes when translating events to the generic Coin library\&. .PP \fBSee also\fP .RS 4 \fBgetButton()\fP .RE .PP .SS "\fBSoSpaceballButtonEvent::Button\fP SoSpaceballButtonEvent::getButton (\fBvoid\fP) const" Returns the value of the button which was pressed or released\&. .PP \fBSee also\fP .RS 4 \fBgetState()\fP .PP \fBwasShiftDown()\fP, \fBwasCtrlDown()\fP, \fBwasAltDown()\fP, \fBgetPosition()\fP, \fBgetTime()\fP .RE .PP .SS "SbBool SoSpaceballButtonEvent::isButtonPressEvent (\fBconst\fP \fBSoEvent\fP * e, \fBSoSpaceballButtonEvent::Button\fP whichButton)\fC [static]\fP" Convenience method for quickly checking if the given event is a press on the given button, \fCwhichButton\fP\&. .PP \fBSee also\fP .RS 4 \fBisButtonReleaseEvent()\fP, \fBisOfType()\fP, \fBgetButton()\fP, \fBgetState()\fP .RE .PP .SS "SbBool SoSpaceballButtonEvent::isButtonReleaseEvent (\fBconst\fP \fBSoEvent\fP * e, \fBSoSpaceballButtonEvent::Button\fP whichButton)\fC [static]\fP" Convenience method for quickly checking if the given event is a release of the given button, \fCwhichButton\fP\&. .PP \fBSee also\fP .RS 4 \fBisButtonPressEvent()\fP, \fBisOfType()\fP, \fBgetButton()\fP, \fBgetState()\fP .RE .PP .SS "SbBool SoSpaceballButtonEvent::enumToString (\fBButton\fP enumval, \fBSbString\fP & stringrep)\fC [static]\fP" Converts from an enum value of type \fBSoMouseButtonEvent::Button\fP to a string containing the enum symbol\&. .PP This function is an extension for Coin, and it is not available in the original SGI Open Inventor \fBv2\&.1\fP API\&. .br \fBSince\fP .RS 4 Coin \fB3\&.0\fP .RE .PP .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.