Source

Coin / src / events / SoKeyboardEvent.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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
/**************************************************************************\
 * 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 SoKeyboardEvent SoKeyboardEvent.h Inventor/events/SoKeyboardEvent.h
  \brief The SoKeyboardEvent class contains information about
  keyboard interaction.
  \ingroup events

  When the user presses any keys on the keyboard, 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, SoSpaceballButtonEvent
  \sa SoEventCallback, SoHandleEventAction
*/

// *************************************************************************

#include <Inventor/events/SoKeyboardEvent.h>

#include "SbBasicP.h"
#include "tidbitsp.h"
#include "misc/SbHash.h"

#include <cassert>

#include <Inventor/SbName.h>

// *************************************************************************

// Avoid problem with Microsoft Win32 API headers (yes, they actually
// #define DELETE somewhere in their header files).
#undef DELETE


/*
  FIXME: The keycode handling in SoKeyboardEvent is really terrible --
  could we improve it while still keeping Open Inventor API
  compatibility?  -mortene.
*/



/*!
  \enum SoKeyboardEvent::Key
  This enum contains all keys detected by Coin.
 */

/*!
  \def SO_KEY_PRESS_EVENT(EVENT, KEY)
  This macro evaluates to \c TRUE iff the \c EVENT represents a press on the
  given \c KEY.
*/
/*!
  \def SO_KEY_RELEASE_EVENT(EVENT, KEY)
  This macro evaluates to \c TRUE iff the \c EVENT represents a release of the
  given \c KEY.
*/

static SbHash<int, char> * converttoprintable = NULL;
static SbHash<int, char> * converttoprintable_shift = NULL;

extern "C" {

static void
sokeyboardevent_cleanup(void)
{
  delete converttoprintable;
  converttoprintable = NULL;
  delete converttoprintable_shift;
  converttoprintable_shift = NULL;
}

} // extern "C"

static void
build_convert_dicts(void)
{
  int i;
  converttoprintable = new SbHash<int, char>();
  converttoprintable_shift = new SbHash<int, char>();
  coin_atexit(sokeyboardevent_cleanup, CC_ATEXIT_NORMAL);

#define ADD_KEY(x,y) d->put(SoKeyboardEvent::x, y)

  // shift not down
  SbHash<int, char> * d = converttoprintable;
  ADD_KEY(NUMBER_0, '0');
  ADD_KEY(NUMBER_1, '1');
  ADD_KEY(NUMBER_2, '2');
  ADD_KEY(NUMBER_3, '3');
  ADD_KEY(NUMBER_4, '4');
  ADD_KEY(NUMBER_5, '5');
  ADD_KEY(NUMBER_6, '6');
  ADD_KEY(NUMBER_7, '7');
  ADD_KEY(NUMBER_8, '8');
  ADD_KEY(NUMBER_9, '9');

  ADD_KEY(PAD_0, '0');
  ADD_KEY(PAD_1, '1');
  ADD_KEY(PAD_2, '2');
  ADD_KEY(PAD_3, '3');
  ADD_KEY(PAD_4, '4');
  ADD_KEY(PAD_5, '5');
  ADD_KEY(PAD_6, '6');
  ADD_KEY(PAD_7, '7');
  ADD_KEY(PAD_8, '8');
  ADD_KEY(PAD_9, '9');

  ADD_KEY(PAD_ADD, '+');
  ADD_KEY(PAD_SUBTRACT, '-');
  ADD_KEY(PAD_MULTIPLY, '*');
  ADD_KEY(PAD_DIVIDE, '/');
  ADD_KEY(PAD_SPACE, ' ');

  ADD_KEY(SPACE, ' ');
  ADD_KEY(APOSTROPHE, '\'');
  ADD_KEY(COMMA, ',');
  ADD_KEY(MINUS, '-');
  ADD_KEY(PERIOD, '.');
  ADD_KEY(SLASH, '/');
  ADD_KEY(SEMICOLON, ';');
  ADD_KEY(EQUAL, '=');
  ADD_KEY(BRACKETLEFT, '[');
  ADD_KEY(BACKSLASH, '\\');
  ADD_KEY(BRACKETRIGHT,']');
  ADD_KEY(GRAVE,'`');

  for (
       i = static_cast<int>(SoKeyboardEvent::A);
       i <= static_cast<int>(SoKeyboardEvent::Z);
       i++
       )
    {
      d->put(i, ('a' + i - static_cast<int>(SoKeyboardEvent::A)));
    }

  // shift down
  d = converttoprintable_shift;
  ADD_KEY(NUMBER_0, ')');
  ADD_KEY(NUMBER_1, '!');
  ADD_KEY(NUMBER_2, '@');
  ADD_KEY(NUMBER_3, '#');
  ADD_KEY(NUMBER_4, '$');
  ADD_KEY(NUMBER_5, '%');
  ADD_KEY(NUMBER_6, '^');
  ADD_KEY(NUMBER_7, '&');
  ADD_KEY(NUMBER_8, '*');
  ADD_KEY(NUMBER_9, '(');

  ADD_KEY(PAD_0, '0');
  ADD_KEY(PAD_1, '1');
  ADD_KEY(PAD_2, '2');
  ADD_KEY(PAD_3, '3');
  ADD_KEY(PAD_4, '4');
  ADD_KEY(PAD_5, '5');
  ADD_KEY(PAD_6, '6');
  ADD_KEY(PAD_7, '7');
  ADD_KEY(PAD_8, '8');
  ADD_KEY(PAD_9, '9');

  ADD_KEY(PAD_ADD, '+');
  ADD_KEY(PAD_SUBTRACT, '-');
  ADD_KEY(PAD_MULTIPLY, '*');
  ADD_KEY(PAD_DIVIDE, '/');
  ADD_KEY(PAD_SPACE, ' ');

  ADD_KEY(SPACE, ' ');
  ADD_KEY(APOSTROPHE, '\"');
  ADD_KEY(COMMA, '<');
  ADD_KEY(MINUS, '_');
  ADD_KEY(PERIOD, '>');
  ADD_KEY(SLASH, '?');
  ADD_KEY(SEMICOLON, ':');
  ADD_KEY(EQUAL, '+');
  ADD_KEY(BRACKETLEFT, '{');
  ADD_KEY(BACKSLASH, '|');
  ADD_KEY(BRACKETRIGHT,'}');
  ADD_KEY(GRAVE,'~');

  for (
       i = static_cast<int>(SoKeyboardEvent::A);
       i <= static_cast<int>(SoKeyboardEvent::Z);
       i++
       )
    {
    d->put(i, ('A' + i - static_cast<int>(SoKeyboardEvent::A)));
  }
#undef ADD_KEY
}

// *************************************************************************

SO_EVENT_SOURCE(SoKeyboardEvent);

// *************************************************************************

/*!
  Initialize the type information data.
 */
void
SoKeyboardEvent::initClass(void)
{
  SO_EVENT_INIT_CLASS(SoKeyboardEvent, SoButtonEvent);
}

/*!
  Constructor.
 */
SoKeyboardEvent::SoKeyboardEvent(void)
{
  this->key = SoKeyboardEvent::ANY;
  this->isprintableset = 0;
}

/*!
  Destructor.
*/
SoKeyboardEvent::~SoKeyboardEvent()
{
}

/*!
  Set the value of the key which the user interacted with.

  This method is used from the window specific device classes when
  translating events to the generic Coin library.

  \sa getKey()
 */
void
SoKeyboardEvent::setKey(SoKeyboardEvent::Key keyarg)
{
  this->key = keyarg;
  this->isprintableset = 0;
}

/*!
  Returns the value of the key which was pressed or released.

  Coin adds a new key value called UNDEFINED. This is needed to
  support GUI toolkits where it's not possible to find exactly which
  key is pressed, and/or to support non-US keyboards. The Open
  Inventor design for this class is flawed, since it assumes everybody
  uses a US keyboard. We recommend using getPrintableCharacter() to
  find which key is pressed/released, at least for printable
  non-alphanumerical characters.

  \sa getPrintableCharacter(), getState()
  \sa wasShiftDown(), wasCtrlDown(), wasAltDown(), getPosition(), getTime()
*/
SoKeyboardEvent::Key
SoKeyboardEvent::getKey(void) const
{
  return this->key;
}

/*!
  Convenience method for quickly checking if the given event is a
  keypress on the given key, \c whichKey.

  \sa isKeyReleaseEvent(), isOfType(), getKey(), getState()
 */
SbBool
SoKeyboardEvent::isKeyPressEvent(const SoEvent * e,
                                 SoKeyboardEvent::Key whichKey)
{
  return (e->isOfType(SoKeyboardEvent::getClassTypeId()) &&
          (whichKey == SoKeyboardEvent::ANY ||
           coin_assert_cast<const SoKeyboardEvent *>(e)->getKey() == whichKey) &&
          coin_assert_cast<const SoButtonEvent *>(e)->getState() == SoButtonEvent::DOWN);
}

/*!
  Convenience method for quickly checking if the given event is a
  key release of the given key, \c whichKey.

  \sa isKeyPressEvent(), isOfType(), getKey(), getState()
 */
SbBool
SoKeyboardEvent::isKeyReleaseEvent(const SoEvent * e,
                                   SoKeyboardEvent::Key whichKey)
{
  return (e->isOfType(SoKeyboardEvent::getClassTypeId()) &&
          (whichKey == SoKeyboardEvent::ANY ||
           coin_assert_cast<const SoKeyboardEvent *>(e)->getKey() == whichKey) &&
          coin_assert_cast<const SoButtonEvent *>(e)->getState() == SoButtonEvent::UP);
}

/*!
  Sets the printable character for this keyboard event. If this method
  is not called when creating an event, getPrintableCharacter() will
  convert the SoKeyboardEvent::Key value into a printable character.
  This conversion does not work on non-US keyboards, so we recommend
  that you set the printable character using this method instead.

  This printable character is cleared each time setKey() is called.

  This method is an extension versus the Open Inventor API.

  \sa getPrintableCharacter()
*/
void
SoKeyboardEvent::setPrintableCharacter(const char c)
{
  this->printable = c;
  this->isprintableset = 1;
}

/*!
  Return ASCII value which would be generated by the key and
  modifier combination.

  NB! If setPrintableCharacter() hasn't been called, this function
  does not always work as expected, particularly not on non-US
  keyboards. The Coin GUI toolkits (SoGtk/SoQt/SoWin/SoXt/Sc21) will
  set the printable character correctly.

  \sa getKey(), wasShiftDown(), wasCtrlDown(), wasAltDown(), setPrintableCharacter()
*/
char
SoKeyboardEvent::getPrintableCharacter(void) const
{
  if (this->isprintableset) return this->printable;

  if (converttoprintable == NULL) {
    build_convert_dicts();
  }

  SbHash<int, char> * dict =
    this->wasShiftDown() ? converttoprintable_shift : converttoprintable;
  char value;
  if (dict->get(this->getKey(), value)) { return value; }
  return '.';
}

/*!
  Converts from an enum value of type SoKeyboardEvent::State to a
  string containing the enum symbol.

  \COIN_FUNCTION_EXTENSION
  \since Coin 3.0
*/
// Should we add stringToEnum as well perhaps?
SbBool
SoKeyboardEvent::enumToString(Key enumval, SbString & stringrep)
{
  if (enumval >= SoKeyboardEvent::A && enumval <= SoKeyboardEvent::Z) {
    stringrep.sprintf("%c", 'A' + (enumval - SoKeyboardEvent::A));
    return TRUE;
  }
  if (enumval >= SoKeyboardEvent::F1 && enumval <= SoKeyboardEvent::F12) {
    stringrep.sprintf("F%d", 1 + (enumval - SoKeyboardEvent::F1));
    return TRUE;
  }

  switch (enumval) {
  case SoKeyboardEvent::ANY:
    stringrep = "ANY";
    break;
  case SoKeyboardEvent::UNDEFINED:
    stringrep = "UNDEFINED";
    break;
  case SoKeyboardEvent::LEFT_SHIFT:
    stringrep = "LEFT_SHIFT";
    break;
  case SoKeyboardEvent::RIGHT_SHIFT:
    stringrep = "RIGHT_SHIFT";
    break;
  case SoKeyboardEvent::LEFT_CONTROL:
    stringrep = "LEFT_CONTROL";
    break;
  case SoKeyboardEvent::RIGHT_CONTROL:
    stringrep = "RIGHT_CONTROL";
    break;
  case SoKeyboardEvent::LEFT_ALT:
    stringrep = "LEFT_ALT";
    break;
  case SoKeyboardEvent::NUMBER_0:
    stringrep = "NUMBER_0";
    break;
  case SoKeyboardEvent::NUMBER_1:
    stringrep = "NUMBER_1";
    break;
  case SoKeyboardEvent::NUMBER_2:
    stringrep = "NUMBER_2";
    break;
  case SoKeyboardEvent::NUMBER_3:
    stringrep = "NUMBER_3";
    break;
  case SoKeyboardEvent::NUMBER_4:
    stringrep = "NUMBER_4";
    break;
  case SoKeyboardEvent::NUMBER_5:
    stringrep = "NUMBER_5";
    break;
  case SoKeyboardEvent::NUMBER_6:
    stringrep = "NUMBER_6";
    break;
  case SoKeyboardEvent::NUMBER_7:
    stringrep = "NUMBER_7";
    break;
  case SoKeyboardEvent::NUMBER_8:
    stringrep = "NUMBER_8";
    break;
  case SoKeyboardEvent::NUMBER_9:
    stringrep = "NUMBER_9";
    break;
  case SoKeyboardEvent::HOME:
    stringrep = "HOME";
    break;
  case SoKeyboardEvent::LEFT_ARROW:
    stringrep = "LEFT_ARROW";
    break;
  case SoKeyboardEvent::UP_ARROW:
    stringrep = "UP_ARROW";
    break;
  case SoKeyboardEvent::RIGHT_ARROW:
    stringrep = "RIGHT_ARROW";
    break;
  case SoKeyboardEvent::DOWN_ARROW:
    stringrep = "DOWN_ARROW";
    break;
  case SoKeyboardEvent::PAGE_UP: // aka PRIOR
    stringrep = "PAGE_UP";
    break;
  case SoKeyboardEvent::PAGE_DOWN: // aka NEXT
    stringrep = "PAGE_DOWN";
    break;
  case SoKeyboardEvent::END:
    stringrep = "END";
    break;
  case SoKeyboardEvent::PAD_ENTER: // aka PAD_SPACE
    stringrep = "PAD_ENTER";
    break;
  case SoKeyboardEvent::PAD_F1:
    stringrep = "PAD_F1";
    break;
  case SoKeyboardEvent::PAD_F2:
    stringrep = "PAD_F2";
    break;
  case SoKeyboardEvent::PAD_F3:
    stringrep = "PAD_F3";
    break;
  case SoKeyboardEvent::PAD_F4:
    stringrep = "PAD_F4";
    break;
  case SoKeyboardEvent::PAD_0: // aka PAD_INSERT
    stringrep = "PAD_0";
    break;
  case SoKeyboardEvent::PAD_1:
    stringrep = "PAD_1";
    break;
  case SoKeyboardEvent::PAD_2:
    stringrep = "PAD_2";
    break;
  case SoKeyboardEvent::PAD_3:
    stringrep = "PAD_3";
    break;
  case SoKeyboardEvent::PAD_4:
    stringrep = "PAD_4";
    break;
  case SoKeyboardEvent::PAD_5:
    stringrep = "PAD_5";
    break;
  case SoKeyboardEvent::PAD_6:
    stringrep = "PAD_6";
    break;
  case SoKeyboardEvent::PAD_7:
    stringrep = "PAD_7";
    break;
  case SoKeyboardEvent::PAD_8:
    stringrep = "PAD_8";
    break;
  case SoKeyboardEvent::PAD_9:
    stringrep = "PAD_9";
    break;
  case SoKeyboardEvent::PAD_ADD:
    stringrep = "PAD_ADD";
    break;
  case SoKeyboardEvent::PAD_SUBTRACT:
    stringrep = "PAD_SUBTRACT";
    break;
  case SoKeyboardEvent::PAD_MULTIPLY:
    stringrep = "PAD_MULTIPLY";
    break;
  case SoKeyboardEvent::PAD_DIVIDE:
    stringrep = "PAD_DIVIDE";
    break;
  case SoKeyboardEvent::PAD_TAB:
    stringrep = "PAD_TAB";
    break;
  case SoKeyboardEvent::PAD_DELETE: // aka PAD_PERIOD
    stringrep = "PAD_DELETE";
    break;
  case SoKeyboardEvent::BACKSPACE:
    stringrep = "BACKSPACE";
    break;
  case SoKeyboardEvent::TAB:
    stringrep = "TAB";
    break;
  case SoKeyboardEvent::RETURN: // aka ENTER
    stringrep = "RETURN";
    break;
  case SoKeyboardEvent::PAUSE:
    stringrep = "PAUSE";
    break;
  case SoKeyboardEvent::SCROLL_LOCK:
    stringrep = "SCROLL_LOCK";
    break;
  case SoKeyboardEvent::ESCAPE:
    stringrep = "ESCAPE";
    break;
  case SoKeyboardEvent::KEY_DELETE:
    stringrep = "DELETE";
    break;
  case SoKeyboardEvent::PRINT:
    stringrep = "PRINT";
    break;
  case SoKeyboardEvent::INSERT:
    stringrep = "INSERT";
    break;
  case SoKeyboardEvent::NUM_LOCK:
    stringrep = "NUM_LOCK";
    break;
  case SoKeyboardEvent::CAPS_LOCK:
    stringrep = "CAPS_LOCK";
    break;
  case SoKeyboardEvent::SHIFT_LOCK:
    stringrep = "SHIFT_LOCK";
    break;
  case SoKeyboardEvent::SPACE:
    stringrep = "SPACE";
    break;
  case SoKeyboardEvent::APOSTROPHE:
    stringrep = "APOSTROPHE";
    break;
  case SoKeyboardEvent::COMMA:
    stringrep = "COMMA";
    break;
  case SoKeyboardEvent::MINUS:
    stringrep = "MINUS";
    break;
  case SoKeyboardEvent::PERIOD:
    stringrep = "PERIOD";
    break;
  case SoKeyboardEvent::SLASH:
    stringrep = "SLASH";
    break;
  case SoKeyboardEvent::SEMICOLON:
    stringrep = "SEMICOLON";
    break;
  case SoKeyboardEvent::EQUAL:
    stringrep = "EQUAL";
    break;
  case SoKeyboardEvent::BRACKETLEFT:
    stringrep = "BRACKETLEFT";
    break;
  case SoKeyboardEvent::BACKSLASH:
    stringrep = "BACKSLASH";
    break;
  case SoKeyboardEvent::BRACKETRIGHT:
    stringrep = "BRACKETRIGHT";
    break;
  case SoKeyboardEvent::GRAVE:
    stringrep = "GRAVE";
    break;
  default:
    return FALSE;
  }
  return TRUE;
}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.