Inventor/nodes/SoSelection.h

Go to the documentation of this file.

/*=======================================================================
 * 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      : David Mott (MMM yyyy)
** Modified by : Thad Beier (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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/


#ifndef  _SO_SELECTION_
#define  _SO_SELECTION_

#include <Inventor/SoLists.h>
#include <Inventor/SbColor.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/nodes/SoSeparator.h>

#include <Inventor/STL/list>

class SoCallbackList;
class SoEvent;
class SoHandleEventAction;
class SoSearchAction;
class SoPickedPoint;
class SoPickedPointList;
class SoTypeList;
class SoSelection;
class SoPath;


// callback function prototypes
typedef void SoSelectionPathCB(void *userData, SoPath *path);
typedef void SoSelectionClassCB(void *userData, SoSelection *sel);
typedef SoPath * SoSelectionPickCB(void *userData, const SoPickedPoint *pick);

//
//  Class: SoSelection
//
//  Selection group node: Manages selection list from picks of its children.
//


class  SoSelection : public SoSeparator {

  SO_NODE_HEADER(SoSelection);

 public:
  SoSelection();
  SoSelection(int nChildren);
    
  //
  // Selection policy
  // ----------------

  // Default selection policy is SoSelection::SHIFT.
  enum Policy {
    SINGLE,
        
    TOGGLE,
        
    SHIFT,

    DISABLE
  };

  // Fields
  SoSFEnum            policy;

  //
  // Selection list management
  // -------------------------

  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);

  SbBool              isSelected(const SoPath *path) const;
  SbBool              isSelected(SoNode *node) const;
  SbBool              isSelected(const 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                setPickRadius(float radiusInPixels) 
    { m_pickRadius = radiusInPixels; }

  float               getPickRadius() const
    { return m_pickRadius; }
  //
  // Selection change callbacks
  // --------------------------
  //
  // Callbacks are invoked when an object is selected or deselected.
  //
    
  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, 
                                SbBool callOnlyIfSelectable = TRUE); 
    
  void    setPickMatching(SbBool pickTwice) { pickMatching = pickTwice; }
  SbBool  isPickMatching() const { return pickMatching; }
    
 private:
  // Traversal routine for SoHandleEventAction - this will call
  // action->setHandled() if the event is handled
  virtual void        handleEvent(SoHandleEventAction *action);

 private:

  virtual void notify(SoNotList *list);

  // Selection notify callbacks - invoked whenever the selection changes.
  // Used by the render area to redraw for selection highlighting.
  void   addChangeCallback(SoSelectionClassCB *f, void *userData = NULL);
  void   removeChangeCallback(SoSelectionClassCB *f, void *userData = NULL);
   
  SbBool  getPickMatching() const { return pickMatching; }

  // Internal:
  static void         initClass();
  static void         exitClass();

  // add a list of paths without duplication check
  void addPaths( const SoPathList &in );

 private:

   // add path without duplication check
   void addPathCore( const SoPath *path );
   // remove a path
   void removePathCore( SoPath *p );

  // List of paths of selected objects
  SoPathList          selectionList;

  // Selection callback lists
  SoCallbackList      *selCBList;
  SoCallbackList      *deselCBList;
  SoCallbackList      *startCBList;
  SoCallbackList      *finishCBList;
    
  // Pick filter is a single callback function, not a list
  SoSelectionPickCB   *pickCBFunc;
  void                *pickCBData;
  SbBool              callPickCBOnlyIfSelectable;
    
  // Change callbacks
  SoCallbackList      *changeCBList;
    
  // Mouse down picked path
  SoPath              *mouseDownPickPath;
  SbBool              pickMatching;
  SbBool              m_mouse_button_down;
  // Selection policies (shiftSelection is a combination of these)
  // invokeSelectionPolicy() is called from handleEvent() - for a customized
  // selection policy, either derive a class and write a new handleEvent()
  // method, or use an SoEventCallback node placed such that it receives
  // events before the selection node.
  void                invokeSelectionPolicy(SoPath *path, SbBool shiftDown);
  void                performSingleSelection(SoPath *path);
  void                performToggleSelection(SoPath *path);
    
  // This copies the path so the copy is rooted by 'this'.
  // Returns NULL if 'this' not found in the passed path.
  SoPath              *copyFromThis(const SoPath *path) const;

  // This copies the path so the copy is rooted by 'this'.
  // Returns NULL if 'this' not found in the passed path.
  SoPath              *copyFromThis_( const SoPath *path, bool tempPath = false) const;
    
  // addPath() assumes the path is rooted by 'this'
  void                addPath(SoPath *path);
  void                removePath(int which);
  void                removePaths( const std::list<int> &which );
  void                truncatePaths( int fromWhich );
    
  // This locates path in the selection list. The head of this path
  // does not necessarily have to be 'this'.
  int                 findPath(const SoPath *path) const;
    
  // Destructor removes everything from the list.
  ~SoSelection();

  //The pick radius
  float               m_pickRadius;

 private:
  // This action is used to search for nodes.
  static SoSearchAction *searchAction;

  // this is called from the two constructors.
  void                constructorCommon();  


};



#endif /* _SO_SELECTION_ */

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/