SoTrackballDragger.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul Isaacs (MMM yyyy)
** Modified by : David Mott (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2019 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_TRACKBALL_DRAGGER_
#define  _SO_TRACKBALL_DRAGGER_
 
#include <Inventor/SbLinear.h>
#include <Inventor/SbTime.h>
#include <Inventor/sensors/SoSensor.h>
#include <Inventor/draggers/SoDragger.h>
#include <Inventor/fields/SoSFVec3f.h>
#include <Inventor/fields/SoSFRotation.h>
 
class SbDict;
class SoGroup;
class SoRotation;
class SbSphereProjector;
class SbCylinderProjector;
class SbLineProjector;
class SoFieldSensor;
class SoTimerSensor;

//
//  Class: SoTrackballDragger
//
//  Trackball dragger - allows user to rotate objects.
//

class  SoTrackballDragger : public SoDragger {
 
  SO_KIT_HEADER(SoTrackballDragger);
 
  // For making the dragger surround what lies above it.
  SO_KIT_CATALOG_ENTRY_HEADER(surroundScale);
  // For keeping the dragger even size in all 3 dimensions
  SO_KIT_CATALOG_ENTRY_HEADER(antiSquish);
 
  SO_KIT_CATALOG_ENTRY_HEADER(rotatorSwitch);
  SO_KIT_CATALOG_ENTRY_HEADER(rotator);
  SO_KIT_CATALOG_ENTRY_HEADER(rotatorActive);
  SO_KIT_CATALOG_ENTRY_HEADER(XRotatorSwitch);
  SO_KIT_CATALOG_ENTRY_HEADER(XRotator);
  SO_KIT_CATALOG_ENTRY_HEADER(XRotatorActive);
  SO_KIT_CATALOG_ENTRY_HEADER(YRotatorSwitch);
  SO_KIT_CATALOG_ENTRY_HEADER(YRotator);
  SO_KIT_CATALOG_ENTRY_HEADER(YRotatorActive);
  SO_KIT_CATALOG_ENTRY_HEADER(ZRotatorSwitch);
  SO_KIT_CATALOG_ENTRY_HEADER(ZRotator);
  SO_KIT_CATALOG_ENTRY_HEADER(ZRotatorActive);
 
  // The userAxisRotation is not a public part.
  SO_KIT_CATALOG_ENTRY_HEADER(userAxisRotation);
 
  SO_KIT_CATALOG_ENTRY_HEADER(userAxisSwitch);
  SO_KIT_CATALOG_ENTRY_HEADER(userAxis);
  SO_KIT_CATALOG_ENTRY_HEADER(userAxisActive);
  SO_KIT_CATALOG_ENTRY_HEADER(userRotatorSwitch);
  SO_KIT_CATALOG_ENTRY_HEADER(userRotator);
  SO_KIT_CATALOG_ENTRY_HEADER(userRotatorActive);
 
 public:
  SoTrackballDragger();

  SoSFRotation rotation;
  SoSFVec3f scaleFactor;

  SbBool isAnimationEnabled() { return animationEnabled; }
  void setAnimationEnabled( SbBool newVal );
 
 private:
  static void         initClass();    // initialize the class
  static void exitClass();
 
 private:
 
  // Callbacks for drag start, motion, and finish
  static void startCB(void *, SoDragger *);
  static void motionCB(void *, SoDragger *);
  static void finishCB(void *, SoDragger *);
    
  SoFieldSensor *rotFieldSensor;
  SoFieldSensor *scaleFieldSensor;
  static void fieldSensorCB( void *, SoSensor * );
  static void valueChangedCB( void *, SoDragger * );
 
  // Callback for pressing and releasing the meta keys
  static void metaKeyChangeCB(void *, SoDragger *);
 
  // These really do the work during startCB, motionCB, and finishCB
  void        dragStart();
  void        drag();
  void        dragFinish();
 
  void setAllPartsActive( SbBool onOrOff );
 
  // detach/attach any sensors, callbacks, and/or field connections.
  // Called by:            start/end of SoBaseKit::readInstance
  // and on new copy by:   start/end of SoBaseKit::copy.
  // Classes that redefine must call setUpConnections(TRUE,TRUE) 
  // at end of constructor.
  // Returns the state of the node when this was called.
  virtual SbBool setUpConnections( SbBool onOff, SbBool doItAlways = FALSE );
 
  virtual void setDefaultOnNonWritingFields();
 
  virtual ~SoTrackballDragger();
 
 private:
 
  enum State
  { INACTIVE, FREE_ROTATE, X_ROTATE, Y_ROTATE, Z_ROTATE,
    SCALE, USER_AXIS_ADJUST, USER_AXIS_ROTATE, SPINNING };
  State               currentState;     
 
  SbVec3f             constrainedAxis;// if so, about what axis?
  SbVec3f             userAxisVec;       // For storing the user definable
  // 'special' rotation axis.
 
  SbSphereProjector   *sphereProj;
  SbCylinderProjector *stripeProj;
  SbLineProjector     *lineProj;
 
  SbVec3f             startWorldHitPt; // used during interaction
  SbBool              ctlDown, shftDown; // keep track of meta keys
  SbVec3f             prevWorldHitPt; // used during interaction by 
  // spherical projector.
  SbMatrix            prevMotionMatrix; // used during interaction by
  // spherical projector.
 
  // functions which do all the work
  void        setHighlights();
 
  SbBool              rotateDrag();
  SbBool              scaleDrag();
  SbBool              userStripeDrag();
    
  // character strings from which the shared geometry is read
  static const char geomBuffer[];            
 
  // variables used for doing spinning animation
  SbBool animationEnabled;
  SbTime          prevTime;
  SbTime          spinTime;
  SbTime          scheduleRate;
  SoTimerSensor   *spinSensor;
  SbRotation      *rotBuffer;
  SbTime          *timeBuffer;
  int             firstIndex, lastIndex;
  SbVec3f         averageAxis;
  float           angleVelocity;
  SbBool          computeAverage;
 
  // routines used for doing spinning animation
  static  void spinSensorCB(void *, SoSensor *);
  void    spinAnimate();
  void    resetSpinStuff();
 
  // We record whether ball was spinning at drag start. If so, it will 
  // call ha->setHandled() in dragFinish().  This way, it won't be 
  // considered an item selection, which is usually the case when you click 
  // on an object without moving the mouse.
  SbBool  wasSpinningAtDragStart;
 
};
 
#endif /* _SO_TRACKBALL_DRAGGER_ */