Source

Coin / src / navigation / SoScXMLRotateTarget.cpp

Full commit
Tom Fredrik Blen… f9fcec5 
Marius Kintel 3ba6b41 




























Tom Fredrik Blen… f9fcec5 


















































































































































































































































































































Tom Fredrik Blen… 7cca44c 
Tom Fredrik Blen… f9fcec5 


Tom Fredrik Blen… 1cda217 
Tom Fredrik Blen… f9fcec5 
























































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

#include <Inventor/navigation/SoScXMLRotateTarget.h>

/*!
  \class SoScXMLRotateTarget SoScXMLRotateTarget.h Inventor/scxml/SoScXMLRotateTarget.h
  \brief Navigation system event target for rotating operations.

  \ingroup navigation
*/

#
#include <cassert>
#include <cmath>
#include <cfloat>

#include <boost/scoped_ptr.hpp>
#include <boost/intrusive_ptr.hpp>

#include <Inventor/SbViewVolume.h>
#include <Inventor/SbRotation.h>
#include <Inventor/SbPlane.h>
#include <Inventor/SbLine.h>
#include <Inventor/errors/SoDebugError.h>
#include <Inventor/nodes/SoOrthographicCamera.h>
#include <Inventor/nodes/SoPerspectiveCamera.h>
#include <Inventor/fields/SoSFVec3d.h>
#include <Inventor/SbTime.h>
#include <Inventor/SbVec2f.h>
#include <Inventor/SbViewVolume.h>
#include <Inventor/errors/SoDebugError.h>
#include <Inventor/projectors/SbSphereSheetProjector.h>
#include <Inventor/nodes/SoCamera.h>
#include <Inventor/scxml/ScXMLEvent.h>
#include <Inventor/scxml/SoScXMLStateMachine.h>
#include <Inventor/C/tidbits.h>
#include <Inventor/navigation/SoScXMLNavigation.h>
#include <Inventor/navigation/SoScXMLFlightControlTarget.h>
#include <Inventor/navigation/SoScXMLDollyTarget.h>

#include "scxml/SbStringConvert.h"
#include "SbBasicP.h"
#include "coindefs.h"
#include "base/coinString.h"

namespace {

class RotateData : public SoScXMLNavigationTarget::Data {
// sendspinstart
// should be persistent over rotations, but individually settable per session
// or better; per event origin point
public:
  RotateData(void) {
    this->projector.reset(new SbSphereSheetProjector);
    SbViewVolume volume;
    volume.ortho(-1, 1, -1, 1, -1, 1);
    this->projector->setViewVolume(volume);
    this->logsize = 0;
  }

  SbVec2f downposn;
  boost::intrusive_ptr<SoCamera> cameraclone;
  boost::scoped_ptr<SbSphereSheetProjector> projector;

  struct log {
    SbVec2f posn;
    SbTime time;
  } mouselog[3];
  int logsize;
};

static SoScXMLNavigationTarget::Data * NewRotateData(void) { return new RotateData; }

} // namespace

class SoScXMLRotateTarget::PImpl {
public:
  // received
  static SbName BEGIN;
  static SbName UPDATE;
  static SbName END;
  static SbName SET_FOCAL_POINT;
  // sent
  static SbName TRIGGER_SPIN;
};

SbName SoScXMLRotateTarget::PImpl::BEGIN;
SbName SoScXMLRotateTarget::PImpl::UPDATE;
SbName SoScXMLRotateTarget::PImpl::END;
SbName SoScXMLRotateTarget::PImpl::SET_FOCAL_POINT;
SbName SoScXMLRotateTarget::PImpl::TRIGGER_SPIN;

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

#define PRIVATE

SCXML_OBJECT_SOURCE(SoScXMLRotateTarget);

void
SoScXMLRotateTarget::initClass(void)
{
  SCXML_OBJECT_INIT_CLASS(SoScXMLRotateTarget, SoScXMLNavigationTarget, "SoScXMLNavigationTarget");

#define EVENT_PREFIX COIN_NAVIGATION_ROTATE_TARGET_EVENT_PREFIX
  PImpl::BEGIN            = SbName(EVENT_PREFIX ".BEGIN");
  PImpl::UPDATE           = SbName(EVENT_PREFIX ".UPDATE");
  PImpl::END              = SbName(EVENT_PREFIX ".END");
  PImpl::SET_FOCAL_POINT  = SbName(EVENT_PREFIX ".SET_FOCAL_POINT");
  PImpl::TRIGGER_SPIN     = SbName(EVENT_PREFIX ".TRIGGER_SPIN");
#undef EVENT_PREFIX
}

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

SoScXMLRotateTarget * SoScXMLRotateTarget::theSingleton = NULL;

SoScXMLRotateTarget *
SoScXMLRotateTarget::constructSingleton(void)
{
  assert(SoScXMLRotateTarget::theSingleton == NULL);
  SoScXMLRotateTarget::theSingleton =
    static_cast<SoScXMLRotateTarget *>(SoScXMLRotateTarget::classTypeId.createInstance());
  return SoScXMLRotateTarget::theSingleton;
}

void
SoScXMLRotateTarget::destructSingleton(void)
{
  assert(SoScXMLRotateTarget::theSingleton != NULL);
  delete SoScXMLRotateTarget::theSingleton;
  SoScXMLRotateTarget::theSingleton = NULL;
}

SoScXMLRotateTarget *
SoScXMLRotateTarget::singleton(void)
{
  assert(SoScXMLRotateTarget::theSingleton != NULL);
  return SoScXMLRotateTarget::theSingleton;
}

const SbName &
SoScXMLRotateTarget::BEGIN(void)
{
  return PImpl::BEGIN;
}

const SbName &
SoScXMLRotateTarget::UPDATE(void)
{
  return PImpl::UPDATE;
}

const SbName &
SoScXMLRotateTarget::END(void)
{
  return PImpl::END;
}

const SbName &
SoScXMLRotateTarget::SET_FOCAL_POINT(void)
{
  return PImpl::SET_FOCAL_POINT;
}

const SbName &
SoScXMLRotateTarget::TRIGGER_SPIN(void)
{
  return PImpl::TRIGGER_SPIN;
}

SoScXMLRotateTarget::SoScXMLRotateTarget(void)
{
  this->setEventTargetType(SOSCXML_NAVIGATION_TARGETTYPE);
  this->setEventTargetName("Rotate");
}

SoScXMLRotateTarget::~SoScXMLRotateTarget(void)
{
}


SbBool
SoScXMLRotateTarget::processOneEvent(const ScXMLEvent * event)
{
  assert(event);

  SbName sessionid = this->getSessionId(event);
  if (sessionid == SbName::empty()) { return FALSE; }

  const SbName & eventname = event->getEventName();

  if (eventname == BEGIN()) {
    RotateData * data =
      static_cast<RotateData *>(this->getSessionData(sessionid, NewRotateData));
    assert(data);

    SoScXMLStateMachine * statemachine = inherited::getSoStateMachine(event, sessionid);
    if (!statemachine) { return FALSE; }

    if (!inherited::getEventSbVec2f(event, "mouseposition", data->downposn)) {
      return FALSE;
    }

    data->mouselog[0].posn = data->downposn;
    data->mouselog[0].time = SbTime::getTimeOfDay();
    data->logsize = 1;

    SoCamera * camera = inherited::getActiveCamera(event, sessionid);
    if unlikely (!camera) { return FALSE; }

    // store current camera position
    data->cameraclone = static_cast<SoCamera *>(camera->copy());

    return TRUE;
  }

  else if (eventname == UPDATE()) {
    RotateData * data = static_cast<RotateData *>(this->getSessionData(sessionid, NewRotateData));
    assert(data);

    SoScXMLStateMachine * statemachine = inherited::getSoStateMachine(event, sessionid);
    if (!statemachine) { return FALSE; }

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

    assert(data->cameraclone.get());
    if unlikely (camera->getTypeId() != data->cameraclone->getTypeId()) {
      SoDebugError::post("SoScXMLRotateTarget::processOneEvent",
                         "while processing %s: camera type was changed",
                         eventname.getString());
      return FALSE;
    }

    // get mouse position
    SbVec2f currentpos;
    if (!inherited::getEventSbVec2f(event, "mouseposition", currentpos)) {
      return FALSE;
    }

    // update mouse log
    data->mouselog[2].time = data->mouselog[1].time;
    data->mouselog[2].posn = data->mouselog[1].posn;
    data->mouselog[1].time = data->mouselog[0].time;
    data->mouselog[1].posn = data->mouselog[0].posn;
    data->mouselog[0].posn = currentpos;
    data->mouselog[0].time = SbTime::getTimeOfDay();
    data->logsize += 1;

    // find rotation
    data->projector->project(data->downposn);
    SbRotation rot;
    data->projector->projectAndGetRotation(currentpos, rot);
    rot.invert();

    // restore camera to original position and do full reorientation
    camera->copyFieldValues(data->cameraclone.get());
    reorientCamera(camera, rot);

    return TRUE;
  }

  else if (eventname == END()) {
    SbBool triggerspincheck = FALSE; // default if not set
    inherited::getEventSbBool(event, "triggerspin", triggerspincheck, FALSE);

    if (triggerspincheck) {
      RotateData * data = static_cast<RotateData *>(this->getSessionData(sessionid, NewRotateData));
      assert(data);

      SbBool triggerspin = FALSE;
      SbRotation spinrotation;

      if (data->logsize > 2) {
        SbTime stoptime = (SbTime::getTimeOfDay() - data->mouselog[0].time);
        if (stoptime.getValue() < 0.100) {
          SbVec3f from = data->projector->project(data->mouselog[2].posn);
          SbVec3f to = data->projector->project(data->mouselog[0].posn);
          spinrotation = data->projector->getRotation(from, to);

          SbTime delta = data->mouselog[0].time - data->mouselog[2].time;
          double deltatime = delta.getValue();
          spinrotation.invert();
          spinrotation.scaleAngle(float(0.200 / deltatime));

          SbVec3f axis;
          float radians;
          spinrotation.getValue(axis, radians);
          if ((radians > 0.01f) && (deltatime < 0.300)) {
            triggerspin = TRUE;
          }
        }
      }

      if (triggerspin) {
        SoScXMLStateMachine * statemachine = inherited::getSoStateMachine(event, sessionid);
        if (!statemachine) { return FALSE; }
        SbString rotationstr;
        rotationstr = SbStringConvert::toString(spinrotation);

        SbString updatetimestr;
        double fromtime = SbTime::getTimeOfDay().getValue();
        updatetimestr = SbStringConvert::toString(fromtime);

        ScXMLEvent event;
        event.setEventName(TRIGGER_SPIN());
        event.setAssociation("rotation", rotationstr.getString());
        event.setAssociation("from", updatetimestr.getString());
        statemachine->queueEvent(&event);
      }
    }

    this->freeSessionData(sessionid);
    return TRUE;
  }

  else if (eventname == SET_FOCAL_POINT()) {
    // _sessionid
    // worldspace {SbVec3f}
    // [upvector] {SbVec3f}
    // [focaldistance] {double}

    SoScXMLStateMachine * statemachine = inherited::getSoStateMachine(event, sessionid);
    if (!statemachine) { return FALSE; }

    SoCamera * camera = inherited::getActiveCamera(event, sessionid);
    if unlikely (!camera) { return FALSE; }

    SbVec3f worldspace(0.0f, 0.0f, 0.0f);
    if (event->getAssociation("worldspace")) {
      SbString valuestr = event->getAssociation("worldspace");
      if (SbStringConvert::typeOf(valuestr) == SbStringConvert::SBVEC3F) {
        if (!inherited::getEventSbVec3f(event, "worldspace", worldspace)) {
          return FALSE;
        }
      } else {
        return FALSE;
      }
    }

    SbVec3f upvector(0.0f, 0.0f, 0.0f);
    SbBool useupvector = inherited::getEventSbVec3f(event, "upvector", upvector, FALSE);

    double focaldistance = 0.0f;
    SbBool usefocaldistance = inherited::getEventDouble(event, "focaldistance", focaldistance, FALSE);

    if (!useupvector) {
      // camera->pointAt() will turn the model away from its current up vector, so we
      // try to preserve the existing up vector here instead of calling the up-vector-less
      // version.
      camera->orientation.getValue().multVec(SbVec3f(0.0f, 1.0f, 0.0f), upvector);
      useupvector = TRUE;
    }

    if (!useupvector) {
      SoScXMLRotateTarget::setFocalPoint(camera, worldspace);
    } else {
      SoScXMLRotateTarget::setFocalPoint(camera, worldspace, upvector);
    }
    if (usefocaldistance) {
      SoScXMLDollyTarget::jump(camera, float(focaldistance));
    }

    return TRUE;
  }

  else {
    SoDebugError::post("SoScXMLRotateTarget::processOneEvent",
                       "processing %s: unknown event",
                       eventname.getString());
    return FALSE;
  }

  return TRUE;
}

// Rotate camera around its focal point.
void
SoScXMLRotateTarget::reorientCamera(SoCamera * camera, const SbRotation & rot)
{
  if (camera == NULL) return;

  // Find global coordinates of focal point.
  SbVec3f direction;
  camera->orientation.getValue().multVec(SbVec3f(0, 0, -1), direction);
  SbVec3f focalpoint = camera->position.getValue() +
    camera->focalDistance.getValue() * direction;

  // Set new orientation value by accumulating the new rotation.
  camera->orientation = rot * camera->orientation.getValue();

  // Reposition camera so we are still pointing at the same old focal point.
  camera->orientation.getValue().multVec(SbVec3f(0, 0, -1), direction);
  camera->position = focalpoint - camera->focalDistance.getValue() * direction;

  // some custom code to support UTMCamera cameras
  static const SoType utmcamtype(SoType::fromName("UTMCamera"));
  if (utmcamtype != SoType::badType() && camera->isOfType(utmcamtype)) {
    SbVec3d offset;
    offset.setValue(camera->position.getValue());
    SoSFVec3d * utmpositionfield = coin_assert_cast<SoSFVec3d *>(camera->getField("utmposition"));
    utmpositionfield->setValue(utmpositionfield->getValue()+offset);
    camera->position.setValue(0.0f, 0.0f, 0.0f);
  }
}

void
SoScXMLRotateTarget::setFocalPoint(SoCamera * camera, const SbVec3f & worldspace)
{
  camera->pointAt(worldspace);
}

void
SoScXMLRotateTarget::setFocalPoint(SoCamera * camera, const SbVec3f & worldspace, const SbVec3f & upvector)
{
  camera->pointAt(worldspace, upvector);
  SoScXMLFlightControlTarget::resetRoll(camera, upvector);
}

#undef PRIVATE