Source

Coin / src / navigation / SoScXMLNavigationTarget.cpp

Tom Fredrik Blen… f9fcec5 
Marius Kintel 3ba6b41 




























Tom Fredrik Blen… f9fcec5 

Tom Fredrik Blen… 87fd51d 
Tom Fredrik Blen… f9fcec5 




































































































































































































































Tom Fredrik Blen… 1cda217 
Tom Fredrik Blen… f9fcec5 




















































































Tom Fredrik Blen… 1cda217 
Tom Fredrik Blen… f9fcec5 



































Tom Fredrik Blen… 1cda217 
Tom Fredrik Blen… f9fcec5 



































Tom Fredrik Blen… 1cda217 
Tom Fredrik Blen… f9fcec5 



































Tom Fredrik Blen… 1cda217 
Tom Fredrik Blen… f9fcec5 
















  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
/**************************************************************************\
 * 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.
\**************************************************************************/

/*! \file SoScXMLNavigationTarget.h */
#include <Inventor/navigation/SoScXMLNavigationTarget.h>

/*!
  \class SoScXMLNavigationTarget SoScXMLNavigationTarget.h Inventor/navigation/SoScXMLNavigationTarget.h
  \brief base class for navigation system SCXML event target services

  This class contains some common, useful, utility functions for implementing
  navigation system event targets.

  \ingroup navigation
  \since 2009-02-14
*/

#include <cassert>
#include <cstring>
#include <cstdio>
#include <map>

#include <boost/scoped_array.hpp>

#include <Inventor/SbVec2f.h>
#include <Inventor/SbVec3f.h>
#include <Inventor/SbRotation.h>
#include <Inventor/scxml/SoScXMLStateMachine.h>
#include <Inventor/scxml/SoScXMLEvent.h>
#include <Inventor/navigation/SoScXMLNavigation.h>
#include <Inventor/errors/SoDebugError.h>
#include "scxml/SbStringConvert.h"
#include "coindefs.h"

#include "base/coinString.h"


class SoScXMLNavigationTarget::PImpl {
public:
  PImpl(void) : sessiondatamap(NULL) { }

  typedef std::map<const char *, SoScXMLNavigationTarget::Data *> SessionDataMap;
  typedef std::pair<const char *, SoScXMLNavigationTarget::Data *> SessionDataEntry;

  SessionDataMap * sessiondatamap;
};

SoScXMLNavigationTarget::Data::~Data(void)
{
}

#define PRIVATE(obj) ((obj)->pimpl)

SCXML_OBJECT_ABSTRACT_SOURCE(SoScXMLNavigationTarget);

void
SoScXMLNavigationTarget::initClass(void)
{
  SCXML_OBJECT_INIT_ABSTRACT_CLASS(SoScXMLNavigationTarget, ScXMLEventTarget, "ScXMLEventTarget");
}

void
SoScXMLNavigationTarget::cleanClass(void)
{
  SoScXMLNavigationTarget::classTypeId = SoType::badType();
}

SoScXMLNavigationTarget::SoScXMLNavigationTarget(void)
{
  PRIVATE(this)->sessiondatamap = new PImpl::SessionDataMap;
}

SoScXMLNavigationTarget::~SoScXMLNavigationTarget(void)
{
  PImpl::SessionDataMap::iterator it = PRIVATE(this)->sessiondatamap->begin();
  while (it != PRIVATE(this)->sessiondatamap->end()) {
    // we could warn about undeleted data here, but it could be caused by natural
    // causes like systems being taken down while the user is interacting, so we'll
    // let these go unwarned.
    delete it->second;
    ++it;
  }
  delete PRIVATE(this)->sessiondatamap;
  PRIVATE(this)->sessiondatamap = NULL;
}

/*!
  Returns the Data* base handle for the datastructure that corresponds to the given
  \a sessionid.  The \a constructor argument is the function responsible for creating
  the Data-derived object if the session is new (or have been cleaned up earlier).
*/

SoScXMLNavigationTarget::Data *
SoScXMLNavigationTarget::getSessionData(SbName sessionid, NewDataFunc * constructor)
{
  Data * data = NULL;
  SoScXMLNavigation::syncLock();
  PImpl::SessionDataMap::iterator findit =
    PRIVATE(this)->sessiondatamap->find(sessionid.getString());
  if (findit == PRIVATE(this)->sessiondatamap->end()) {
    assert(constructor);
    data = (*constructor)();
    assert(data);
    PImpl::SessionDataEntry entry(sessionid.getString(), data);
    PRIVATE(this)->sessiondatamap->insert(entry);
  } else {
    data = findit->second;
  }
  SoScXMLNavigation::syncUnlock();
  return data;
}

/*!
  Cleans out the data structure that is mapped to the given \a sessionid.
*/
void
SoScXMLNavigationTarget::freeSessionData(SbName sessionid)
{
  SoScXMLNavigation::syncLock();
  PImpl::SessionDataMap::iterator findit =
    PRIVATE(this)->sessiondatamap->find(sessionid.getString());
  if (findit != PRIVATE(this)->sessiondatamap->end()) {
    Data * data = findit->second;
    PRIVATE(this)->sessiondatamap->erase(findit);
    delete data;
  }
  SoScXMLNavigation::syncUnlock();
}

/*!
  Returns the sessionid that is associated with the \a event.  If no
  session id is found, SbName::empty() is returned.
*/
SbName
SoScXMLNavigationTarget::getSessionId(const ScXMLEvent * event)
{
  assert(event);
  const char * sessionidstr = event->getAssociation("_sessionid");
  if unlikely (!sessionidstr) {
    SoDebugError::post("SoScXMLNavigationTarget::getSessionId",
                       "while processing %s: no _sessionid found.",
                           event->getEventName().getString());
    return SbName::empty();
  }
  if (sessionidstr[0] == '\'') { // unwrap string representation
    boost::scoped_array<char> buf(new char [strlen(sessionidstr)+1]);
    int res = sscanf(sessionidstr, "'%[^']'", buf.get());
    if (res == 1) {
      return SbName(buf.get());
    }
  }
  return SbName(sessionidstr);
}

/*!
  Returns the state machine that is associated with the given sessionid, or NULL
  if there are no state machines registered for the session id.
*/
ScXMLStateMachine *
SoScXMLNavigationTarget::getStateMachine(const ScXMLEvent * event, SbName sessionid)
{
  assert(event);
  ScXMLStateMachine * sm = ScXMLStateMachine::getStateMachineForSessionId(sessionid.getString());
  if (!sm) {
    SoDebugError::post("SoScXMLNavigationTarget::getSoStateMachine",
                       "while processing %s: no statemachine for session '%s'.",
                       event->getEventName().getString(), sessionid.getString());
    return NULL;
  }
  return sm;
}

/*!
  Returns the So- state machine that is associated with the given sessionid, or NULL
  if there are no state machines registered for the session id or if the state machine
  is not of SoScXMLStateMachine type.
*/
SoScXMLStateMachine *
SoScXMLNavigationTarget::getSoStateMachine(const ScXMLEvent * event, SbName sessionid)
{
  assert(event);
  ScXMLStateMachine * sm = SoScXMLNavigationTarget::getStateMachine(event, sessionid);
  if unlikely (!sm) {
    return NULL;
  }
  if unlikely (!sm->isOfType(SoScXMLStateMachine::getClassTypeId())) {
    SoDebugError::post("SoScXMLNavigationTarget::getSoStateMachine",
                       "while processing %s: statemachine not of So-type for session '%s'.",
                       event->getEventName().getString(), sessionid.getString());
    return NULL;
  }
  return static_cast<SoScXMLStateMachine *>(sm);
}

/*!
  Returns the current active camera, or NULL if there is no active camera set.
  If NULL is returned, error messages has been posted.
*/
SoCamera *
SoScXMLNavigationTarget::getActiveCamera(const ScXMLEvent * event, SbName sessionid)
{
  SoScXMLStateMachine * statemachine = SoScXMLNavigationTarget::getSoStateMachine(event, sessionid);
  if unlikely (!statemachine) { return NULL; }

  SoCamera * camera = statemachine->getActiveCamera();
  if unlikely (!camera) {
    SoDebugError::post("SoScXMLZoomTarget::processOneEvent",
                       "while processing %s: no current camera",
                       event->getEventName().getString());
    return NULL;
  }
  return camera;
}

/*!
  Returns TRUE if a double was delivered with the event under the label \a label,
  and FALSE otherwise. If \a required is TRUE, then errors will be given, otherwise
  this function will remain quiet.
*/
SbBool
SoScXMLNavigationTarget::getEventDouble(const ScXMLEvent * event, const char * label, double & dbl_out, SbBool required)
{
  assert(event);
  const char * valuestr = event->getAssociation(label);
  if (!valuestr) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventDouble",
                         "while processing %s: required parameter '%s' not found.",
                         event->getEventName().getString(), label);
    }
    return FALSE;
  }
  SbBool conversionOk;
  dbl_out = SbStringConvert::fromString<double>(valuestr,&conversionOk);
  if (!conversionOk) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventDouble",
                         "while processing %s: parameter '%s' contains invalid float data ('%s').",
                         event->getEventName().getString(), label, valuestr);
    } else {
      if (COIN_DEBUG) {
        SoDebugError::postWarning("SoScXMLNavigationTarget::getEventDouble",
                                  "while processing %s: parameter '%s' contains invalid float data ('%s').",
                                  event->getEventName().getString(), label, valuestr);
      }
    }
    return FALSE;
  }
  return TRUE;
}

/*!
  Returns TRUE if a string was delivered with the event under the label \a label,
  and FALSE otherwise. If \a required is TRUE, then errors will be given, otherwise
  this function will remain quiet.
*/
SbBool
SoScXMLNavigationTarget::getEventString(const ScXMLEvent * event, const char * label, SbString & str_out, SbBool required)
{
  assert(event);
  const char * valuestr = event->getAssociation(label);
  if (!valuestr) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventString",
                         "while processing %s: required parameter '%s' not found.",
                         event->getEventName().getString(), label);
    }
    return FALSE;
  }
  if (valuestr[0] != '\'') {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventString",
                         "while processing %s: parameter '%s' contains invalid string data (\"%s\").",
                         event->getEventName().getString(), label, valuestr);
    } else {
      if (COIN_DEBUG) {
        SoDebugError::postWarning("SoScXMLNavigationTarget::getEventString",
                                  "while processing %s: parameter '%s' contains invalid string data (\"%s\").",
                                  event->getEventName().getString(), label, valuestr);
      }
    }
    return FALSE;
  }
  else {
    boost::scoped_array<char> buf(new char [strlen(valuestr) + 1]);
    int res = sscanf(valuestr, "'%[^']'", buf.get());
    if (res == 1) {
      str_out = buf.get();
      return TRUE;
    } else {
      SoDebugError::postWarning("SoScXMLNavigationTarget::getEventString",
                                "while processing %s: parameter '%s' contains invalid string data (\"%s\").",
                                event->getEventName().getString(), label, valuestr);
      return FALSE;
    }
  }
  return TRUE;
}


/*!
  Returns TRUE if a boolean value was delivered with the event under the label \a label,
  and FALSE otherwise. If \a required is TRUE, then errors will be given, otherwise
  this function will remain quiet.
*/
SbBool
SoScXMLNavigationTarget::getEventSbBool(const ScXMLEvent * event, const char * label, SbBool & bool_out, SbBool required)
{
  assert(event);
  const char * valuestr = event->getAssociation(label);
  if (!valuestr) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventSbBool",
                         "while processing %s: required parameter '%s' not found.",
                         event->getEventName().getString(), label);
    }
    return FALSE;
  }
  SbBool conversionOk;
  bool_out = SbStringConvert::fromString<bool>(valuestr,&conversionOk);
  if (!conversionOk) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventSbBool",
                         "while processing %s: parameter '%s' contains invalid bool data ('%s').",
                         event->getEventName().getString(), label, valuestr);
    } else {
      if (COIN_DEBUG) {
        SoDebugError::postWarning("SoScXMLNavigationTarget::getEventSbBool",
                                  "while processing %s: parameter '%s' contains invalid bool data ('%s').",
                                  event->getEventName().getString(), label, valuestr);
      }
    }
    return FALSE;
  }
  return TRUE;
}

/*!
  Returns TRUE if an SbVec2f was delivered with the event under the label \a label,
  and FALSE otherwise. If \a required is TRUE, then errors will be given, otherwise
  this function will remain quiet.
*/
SbBool
SoScXMLNavigationTarget::getEventSbVec2f(const ScXMLEvent * event, const char * label, SbVec2f & vec_out, SbBool required)
{
  assert(event);
  const char * valuestr = event->getAssociation(label);
  if (!valuestr) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventSbVec2f",
                         "while processing %s: required parameter '%s' not found.",
                         event->getEventName().getString(), label);
    }
    return FALSE;
  }
  SbBool conversionOk;
  vec_out = SbStringConvert::fromString<SbVec2f>(valuestr, &conversionOk);
  if (!conversionOk) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventSbVec2f",
                         "while processing %s: parameter '%s' contains invalid SbVec2f data ('%s').",
                         event->getEventName().getString(), label, valuestr);
    } else {
      if (COIN_DEBUG) {
        SoDebugError::postWarning("SoScXMLNavigationTarget::getEventSbVec2f",
                                  "while processing %s: parameter '%s' contains invalid SbVec2f data ('%s').",
                                  event->getEventName().getString(), label, valuestr);
      }
    }
    return FALSE;
  }
  return TRUE;
}

/*!
  Returns TRUE if an SbVec3f was delivered with the event under the label \a label,
  and FALSE otherwise. If \a required is TRUE, then errors will be given, otherwise
  this function will remain quiet.
*/
SbBool
SoScXMLNavigationTarget::getEventSbVec3f(const ScXMLEvent * event, const char * label, SbVec3f & vec_out, SbBool required)
{
  assert(event);
  const char * valuestr = event->getAssociation(label);
  if (!valuestr) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventSbVec3f",
                         "while processing %s: required parameter '%s' not found.",
                         event->getEventName().getString(), label);
    }
    return FALSE;
  }
  SbBool conversionOk;
  vec_out = SbStringConvert::fromString<SbVec3f>(valuestr, &conversionOk);
  if (!conversionOk) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventSbVec3f",
                         "while processing %s: parameter '%s' contains invalid SbVec3f data ('%s').",
                         event->getEventName().getString(), label, valuestr);
    } else {
      if (COIN_DEBUG) {
        SoDebugError::postWarning("SoScXMLNavigationTarget::getEventSbVec3f",
                                  "while processing %s: parameter '%s' contains invalid SbVec3f data ('%s').",
                                  event->getEventName().getString(), label, valuestr);
      }
    }
    return FALSE;
  }
  return TRUE;
}

/*!
  Returns TRUE if an SbRotation was delivered with the event under the label \a label,
  and FALSE otherwise. If \a required is TRUE, then errors will be given, otherwise
  this function will remain quiet.
*/
SbBool
SoScXMLNavigationTarget::getEventSbRotation(const ScXMLEvent * event, const char * label, SbRotation & rot_out, SbBool required)
{
  assert(event);
  const char * valuestr = event->getAssociation(label);
  if (!valuestr) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventSbRotation",
                         "while processing %s: required parameter '%s' not found.",
                         event->getEventName().getString(), label);
    }
    return FALSE;
  }
  SbBool conversionOk;
  rot_out = SbStringConvert::fromString<SbRotation>(valuestr, &conversionOk);
  if (!conversionOk) {
    if (required) {
      SoDebugError::post("SoScXMLNavigationTarget::getEventSbRotation",
                         "while processing %s: parameter '%s' contains invalid Sbrotation data ('%s').",
                         event->getEventName().getString(), label, valuestr);
    } else {
      if (COIN_DEBUG) {
        SoDebugError::postWarning("SoScXMLNavigationTarget::getEventSbRotation",
                                  "while processing %s: parameter '%s' contains invalid SbRotation data ('%s').",
                                  event->getEventName().getString(), label, valuestr);
      }
    }
    return FALSE;
  }
  return TRUE;
}

#undef PRIVATE