# Coin / src / events / SoSpaceballButtonEvent.cpp

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 /**************************************************************************\ * Copyright (c) Kongsberg Oil & Gas Technologies AS * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * Neither the name of the copyright holder nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \**************************************************************************/ /*! \class SoSpaceballButtonEvent SoSpaceballButtonEvent.h Inventor/events/SoSpaceballButtonEvent.h \brief The SoSpaceballButtonEvent class contains information about spaceball button interaction. \ingroup events 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 scenegraph by using instances of this class. \sa SoEvent, SoButtonEvent, SoMouseButtonEvent, SoKeyboardEvent \sa SoEventCallback, SoHandleEventAction */ #include #include "SbBasicP.h" #include #include /*! \enum SoSpaceballButtonEvent::Button This enum contains all spaceball buttons detected by Coin. */ /*! \def SO_SPACEBALL_PRESS_EVENT(EVENT, BUTTON) This macro evaluates to \c TRUE iff the \c EVENT represents a press on the given \c BUTTON. */ /*! \def SO_SPACEBALL_RELEASE_EVENT(EVENT, BUTTON) This macro evaluates to \c TRUE iff the \c EVENT represents a release of the given \c BUTTON. */ SO_EVENT_SOURCE(SoSpaceballButtonEvent); /*! Initialize the type information data. */ void SoSpaceballButtonEvent::initClass(void) { SO_EVENT_INIT_CLASS(SoSpaceballButtonEvent, SoButtonEvent); } /*! Constructor. */ SoSpaceballButtonEvent::SoSpaceballButtonEvent(void) { this->button = SoSpaceballButtonEvent::ANY; } /*! Destructor. */ SoSpaceballButtonEvent::~SoSpaceballButtonEvent() { } /*! Set the value of the button which the user interacted with. This method is used from the window specific device classes when translating events to the generic Coin library. \sa getButton() */ void SoSpaceballButtonEvent::setButton(SoSpaceballButtonEvent::Button buttonarg) { this->button = buttonarg; } /*! Returns the value of the button which was pressed or released. \sa getState() \sa wasShiftDown(), wasCtrlDown(), wasAltDown(), getPosition(), getTime() */ SoSpaceballButtonEvent::Button SoSpaceballButtonEvent::getButton(void) const { return this->button; } /*! Convenience method for quickly checking if the given event is a press on the given button, \c whichButton. \sa isButtonReleaseEvent(), isOfType(), getButton(), getState() */ SbBool SoSpaceballButtonEvent::isButtonPressEvent(const SoEvent * e, SoSpaceballButtonEvent::Button whichButton) { return (e->isOfType(SoSpaceballButtonEvent::getClassTypeId()) && ( whichButton == SoSpaceballButtonEvent::ANY || coin_assert_cast(e)->getButton() == whichButton ) && coin_assert_cast(e)->getState() == SoButtonEvent::DOWN ); } /*! Convenience method for quickly checking if the given event is a release of the given button, \c whichButton. \sa isButtonPressEvent(), isOfType(), getButton(), getState() */ SbBool SoSpaceballButtonEvent::isButtonReleaseEvent(const SoEvent * e, SoSpaceballButtonEvent::Button whichButton) { return (e->isOfType(SoSpaceballButtonEvent::getClassTypeId()) && ( whichButton == SoSpaceballButtonEvent::ANY || coin_assert_cast(e)->getButton() == whichButton ) && coin_assert_cast(e)->getState() == SoButtonEvent::UP ); } /*! Converts from an enum value of type SoMouseButtonEvent::Button to a string containing the enum symbol. \COIN_FUNCTION_EXTENSION \since Coin 3.0 */ // Should we add stringToEnum as well perhaps? SbBool SoSpaceballButtonEvent::enumToString(Button enumval, SbString & stringrep) { switch (enumval) { case SoSpaceballButtonEvent::ANY: stringrep = "ANY"; break; case SoSpaceballButtonEvent::BUTTON1: stringrep = "BUTTON1"; break; case SoSpaceballButtonEvent::BUTTON2: stringrep = "BUTTON2"; break; case SoSpaceballButtonEvent::BUTTON3: stringrep = "BUTTON3"; break; case SoSpaceballButtonEvent::BUTTON4: stringrep = "BUTTON4"; break; case SoSpaceballButtonEvent::BUTTON5: stringrep = "BUTTON5"; break; case SoSpaceballButtonEvent::BUTTON6: stringrep = "BUTTON6"; break; case SoSpaceballButtonEvent::BUTTON7: stringrep = "BUTTON7"; break; case SoSpaceballButtonEvent::BUTTON8: stringrep = "BUTTON8"; break; case SoSpaceballButtonEvent::PICK: stringrep = "PICK"; break; default: return FALSE; } return TRUE; }