SoSelection.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-93   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 SoSelection node class.
 |
 |   Classes:   SoSelection
 |
 |   Author(s)  : David Mott, Thad Beier
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_SELECTION_
#define  _SO_SELECTION_
 
#include <Inventor/SbColor.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/fields/SoSFBool.h>
 
class SoCallbackList;
class SoEvent;
class SoHandleEventAction;
class SoSearchAction;
class SoPickedPoint;
class SoPickedPointList;
class SoTypeList;
class SoSelection;
class SoPath;
 
typedef INVENTOR_API void SoSelectionPathCB(void *userData, SoPath *path);
typedef INVENTOR_API void SoSelectionClassCB(void *userData, SoSelection *sel);
typedef INVENTOR_API SoPath * SoSelectionPickCB(void *userData, const SoPickedPoint *pick);
 
 
 
 
class INVENTOR_API SoSelection : public SoSeparator {
 
    SO_NODE_HEADER(SoSelection);
 
  public:
 
    SoSelection();
    SoSelection(int nChildren);
    
 
    enum Policy {
        SINGLE,
        
        TOGGLE,
        
        SHIFT
    };
 
 
 
    SoSFEnum            policy; 
 
    SoSFBool            selectOnlyOnClick;
 
 
    void                select(const SoPath *path);    
 
    void                select(SoNode *node);
 
    void                deselect(const SoPath *path);
    void                deselect(int which);
 
    void                deselect(SoNode *node);
 
    void                toggle(const SoPath *path);
 
    void                toggle(SoNode *node);
 
    bool                isSelected(const SoPath *path) const;
    bool                isSelected(SoNode *node) const;
 
    void                deselectAll();
 
    int                 getNumSelected() const  { return selectionList.getLength(); }
    const SoPathList    *getList() const { return &selectionList; }
    SoPath              *getPath(int index) const;
 
    SoPath *            operator [](int i) const
                        { return getPath(i); }
 
    void    addSelectionCallback(SoSelectionPathCB *f, void *userData = NULL);
    void    removeSelectionCallback(SoSelectionPathCB *f, void *userData = NULL);
 
    void    addDeselectionCallback(SoSelectionPathCB *f, void *userData = NULL);
    void    removeDeselectionCallback(SoSelectionPathCB *f, void *userData = NULL);
 
    void    addStartCallback(SoSelectionClassCB *f, void *userData = NULL);
        void    removeStartCallback(SoSelectionClassCB *f, void *userData = NULL);
 
    void    addFinishCallback(SoSelectionClassCB *f, void *userData = NULL);
    void    removeFinishCallback(SoSelectionClassCB *f, void *userData = NULL);
 
    void    setPickFilterCallback(
                SoSelectionPickCB *f,
                void *userData = NULL, 
                bool callOnlyIfSelectable = TRUE); 
 
    void    setPickMatching(bool pickTwice) { pickMatching = pickTwice; }
    bool    isPickMatching() const { return pickMatching; }
    bool    getPickMatching() const { return pickMatching; }
    
  SoINTERNAL public:
    void   addChangeCallback(SoSelectionClassCB *f, void *userData = NULL);
    void   removeChangeCallback(SoSelectionClassCB *f, void *userData = NULL);
 
    static void         initClass();
 
  protected:
    SoPathList          selectionList;
 
    SoCallbackList      *selCBList;
    SoCallbackList      *deselCBList;
    SoCallbackList      *startCBList;
    SoCallbackList      *finishCBList;
    
    SoSelectionPickCB   *pickCBFunc;
    void                *pickCBData;
    bool                callPickCBOnlyIfSelectable;
    
    SoCallbackList      *changeCBList;
    
    SoPath              *mouseDownPickPath;
    bool                pickMatching;
 
    bool                abortSelection;
 
    SbVec2s             mouseDownPosition;
 
    void                invokeSelectionPolicy(SoPath *path, bool shiftDown);
    void                performSingleSelection(SoPath *path);
    void                performToggleSelection(SoPath *path);
    
    SoPath              *copyFromThis(const SoPath *path) const;
 
    SoPath              *getPickedPath(const SoPickedPoint* pickedPoint);
    
    void                addPath(SoPath *path);
    void                removePath(int which);
    
    int                 findPath(const SoPath *path) const;
 
    virtual void        handleEvent(SoHandleEventAction *action);
    
    ~SoSelection();
 
  private:
 
    static SoSearchAction *searchAction;
 
    void                constructorCommon();  
};
 
 
 
#endif /* _SO_SELECTION_ */