MeVis/ThirdParty/Sources/Inventor/inventor/lib/interaction/include/Inventor/draggers/SoDragger.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */


/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      This file defines the base class for draggers that
 |      use a click-drag-release paradigm.
 |
 | NOTE TO DEVELOPERS:
 |     For info about the structure of SoDragger:
 |     [1] compile: /usr/share/src/Inventor/samples/ivNodeKitStructure
 |     [2] type:    ivNodeKitStructure SoDragger.
 |     [3] The program prints a diagram of the scene graph and a table with 
 |         information about each part.
 |
 |   Author(s): Paul Isaacs, David Mott, Howard Look
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_DRAGGER_
#define  _SO_DRAGGER_

#include <Inventor/SbBox.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/SbLinear.h>
#include <Inventor/nodekits/SoInteractionKit.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/nodes/SoMatrixTransform.h>
#include <Inventor/nodes/SoScale.h>


class SoPickedPoint;
class SoAction;
class SoHandleEventAction;
class SoGetBoundingBoxAction;
class SoEvent;
class SoPath;
class SoTempPath;
class SbPList;

class SoDragger;  

typedef void INVENTOR_API SoDraggerCB(void *userData, SoDragger *dragger );





class INVENTOR_API SoDragger : public SoInteractionKit {

    SO_KIT_HEADER(SoDragger);

    SO_KIT_CATALOG_ENTRY_HEADER(motionMatrix);

  public:

    SoSFBool  isActive;

    void    addStartCallback(SoDraggerCB *f, void *userData = NULL);
    void removeStartCallback(SoDraggerCB *f, void *userData = NULL);

    void    addMotionCallback(SoDraggerCB *f, void *userData = NULL);
    void removeMotionCallback(SoDraggerCB *f, void *userData = NULL);

    void    addFinishCallback(SoDraggerCB *f, void *userData = NULL);
    void removeFinishCallback(SoDraggerCB *f, void *userData = NULL);

    void    addValueChangedCallback(SoDraggerCB *f, void *userData = NULL);
    void removeValueChangedCallback(SoDraggerCB *f, void *userData = NULL);

    void    setMinGesture(int pixels)       { minGesture = pixels; }
    int     getMinGesture() const           { return minGesture; }

    static void  setMinScale( float newMinScale ) { minScale = newMinScale; }
    static float getMinScale() { return minScale; }

    SbBool enableValueChangedCallbacks( SbBool newVal );

  SoEXTENDER public:

    const SbMatrix &getMotionMatrix();


    void    addOtherEventCallback(SoDraggerCB *f, void *userData = NULL);
    void removeOtherEventCallback(SoDraggerCB *f, void *userData = NULL);

    void registerChildDragger(SoDragger *child);
    void unregisterChildDragger(SoDragger *child);
    void registerChildDraggerMovingIndependently(SoDragger *child);
    void unregisterChildDraggerMovingIndependently(SoDragger *child);
                                  
    SbMatrix getLocalToWorldMatrix();
    SbMatrix getWorldToLocalMatrix();

    SbVec3f     getLocalStartingPoint();
    SbVec3f     getWorldStartingPoint();

    void getPartToLocalMatrix( const SbName &partName, 
                               SbMatrix &partToLocalMatrix, 
                               SbMatrix &localToPartMatrix);

    void  transformMatrixLocalToWorld( const SbMatrix &fromMatrix, 
                                       SbMatrix &toMatrix);
    void  transformMatrixWorldToLocal( const SbMatrix &fromMatrix, 
                                       SbMatrix &toMatrix);
    void  transformMatrixToLocalSpace( const SbMatrix &fromMatrix,
            SbMatrix &toMatrix, const SbName &fromSpacePartName);

    void            setMotionMatrix( const SbMatrix &newMatrix );

    void valueChanged();

    const SbMatrix &getStartMotionMatrix() { return startMotionMatrix; }
    virtual void saveStartParameters();

    const SoPath              *getPickPath()       const;
    const SoEvent             *getEvent() const;
    SoPath                    *createPathToThis();

            const SoPath *getSurrogatePartPickedOwner() const 
                  { return pathToSurrogatePickOwner;}
            const SbName &getSurrogatePartPickedName() const 
                { return surrogateNameInPickOwner; }
            const SoPath *getSurrogatePartPickedPath() const 
                { return surrogatePathInPickOwner;}

    void setStartingPoint( const SoPickedPoint *newPoint );
    void setStartingPoint( const SbVec3f &newPoint );

    const SbViewVolume      &getViewVolume() { return viewVolume; }
    void  setViewVolume(const SbViewVolume &vol) { viewVolume = vol; }

    const SbViewportRegion  &getViewportRegion() { return vpRegion; }
    void  setViewportRegion(const  SbViewportRegion &reg) { vpRegion = reg; }

    SoHandleEventAction *getHandleEventAction() const 
        { return handleEventAction; }
    void setHandleEventAction( SoHandleEventAction *newAction );

    void                setTempPathToThis(const SoPath *somethingClose);

    virtual void grabEventsSetup();
    virtual void grabEventsCleanup();

    void workFieldsIntoTransform( SbMatrix &mtx );
    static void workValuesIntoTransform( SbMatrix &mtx, 
                                        const SbVec3f *translationPtr,
                                        const SbRotation *rotationPtr, 
                                        const SbVec3f *scaleFactorPtr, 
                                        const SbRotation *scaleOrientationPtr, 
                                        const SbVec3f *centerPtr);

    static void getTransformFast( SbMatrix &mtx, SbVec3f &translation,
                            SbRotation &rotation, SbVec3f &scaleFactor, 
                            SbRotation &scaleOrientation, 
                            const SbVec3f &center);
    static void getTransformFast( SbMatrix &mtx, SbVec3f &translation,
                            SbRotation &rotation, SbVec3f &scaleFactor, 
                            SbRotation &scaleOrientation);

    static SbMatrix appendTranslation( const SbMatrix &mtx, 
                const SbVec3f &translation,
                const SbMatrix *conversion = NULL );
    static SbMatrix appendScale( const SbMatrix &mtx, 
                const SbVec3f &scale, const SbVec3f &scaleCenter,
                const SbMatrix *conversion = NULL );
    static SbMatrix appendRotation( const SbMatrix &mtx, 
                const SbRotation &rot, const SbVec3f &rotCenter,
                const SbMatrix *conversion = NULL );

  SoINTERNAL public:
    static void initClass();

    static void initClasses();

    enum ProjectorFrontSetting {
        FRONT, BACK, USE_PICK
    };
    void setFrontOnProjector( ProjectorFrontSetting newVal )
        { projectorFrontSetting = newVal; }
    ProjectorFrontSetting getFrontOnProjector() const 
        { return projectorFrontSetting;}

  protected:

    SoDragger();

    SbVec2f     getNormalizedLocaterPosition();
    SbVec2s     getLocaterPosition();

    SbVec2s     getStartLocaterPosition() const     { return startLocater; }

    void        setStartLocaterPosition(SbVec2s p)   { startLocater = p; }

    SbBool      isAdequateConstraintMotion();

    virtual SbBool shouldGrabBasedOnSurrogate( const SoPath *pickPath,
                                               const SoPath *surrogatePath );

    void setCameraInfo( SoAction *action );

    virtual void               handleEvent(SoHandleEventAction *ha);

    void transferMotion(SoDragger *child);

    void    setIgnoreInBbox( SbBool newVal ) { ignoreInBbox = newVal; }
    SbBool  isIgnoreInBbox() { return ignoreInBbox; }
    
    virtual void        getBoundingBox(SoGetBoundingBoxAction *action);

    static void childTransferMotionAndValueChangedCB(void *, SoDragger *);
    static void childValueChangedCB(void *, SoDragger *);
    static void childStartCB(void *, SoDragger *);
    static void childMotionCB(void *, SoDragger *);
    static void childFinishCB(void *, SoDragger *);
    static void childOtherEventCB(void *, SoDragger *);

    void       setActiveChildDragger( SoDragger *newChildDragger );
    SoDragger *getActiveChildDragger() const { return activeChildDragger; }

    virtual void setDefaultOnNonWritingFields();

    virtual ~SoDragger();

  private:

    SoCallbackList      *startCallbacks;
    SoCallbackList      *motionCallbacks;
    SoCallbackList      *finishCallbacks;
    SoCallbackList      *valueChangedCallbacks;
    
    SoCallbackList      *otherEventCallbacks;

    SbBool    valueChangedCallbacksEnabled;
    SoDragger *activeChildDragger;

    SoHandleEventAction *handleEventAction; 

    SbVec3f             startingWorldPoint;       

    SbMatrix startMotionMatrix;

    SbVec2s     startLocater;


    void                setPickPath(SoPath *newPickPath);
    SoPath              *pickPath;          

    void setNoPickedSurrogate();
    void setPickedSurrogate( SoPath *pathToOwner, SbName &nameUsedByOwner,
                             SoPath *pathUsedByOwner );

    SbName surrogateNameInPickOwner;
    SoPath *pathToSurrogatePickOwner;
    SoPath *surrogatePathInPickOwner;

    SoTempPath          *tempPathToThis;
    SbPList             *tempPathNumKidsHack;
    SbBool              isTempPathToThisOk();
    SoTempPath      *createTempPathFromFullPath( const SoFullPath *fp ) const;

    int         minGesture;

    static float        minScale;

    SbViewVolume        viewVolume;         
    SbViewportRegion    vpRegion;           


    void validateMatrices();
    
    SbBool   cachedPathToThisValid;
    SbBool   cachedMotionMatrixValid;
    SbMatrix cachedMotionMatrix;
    SbMatrix postMotionToWorldMatrix;
    SbMatrix worldToPostMotionMatrix;
    SbMatrix preMotionToWorldMatrix;  
    SbMatrix worldToPreMotionMatrix;

    SbBool ignoreInBbox;

    SbBool mouseMovedYet;

    ProjectorFrontSetting projectorFrontSetting;
};

#endif /* _SO_DRAGGER_ */