SoExtSelection.h

Go to the documentation of this file.

/*=======================================================================
 *** 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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Fabien ARNAUD (MMM yyyy)
** Modified by : Christophe OGNIER (MMM yyyy)
** Modified by : Daniel LICHAU (update)        * (MMM yyyy)
**=======================================================================*/
 
#ifndef _SO_EXTENDED_SELECTION_H_
#define _SO_EXTENDED_SELECTION_H_
 
//------------------------------------------------------------------------------
//Include files
 
#include <Inventor/actions/SoCallbackAction.h>
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/nodes/SoSelection.h>
#include <Inventor/nodes/SoColorIndex.h>
#include <Inventor/nodes/SoDrawStyle.h>
#include <Inventor/nodes/SoMatrixTransform.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/STL/vector>
#include <Inventor/misc/SoRef.h>
#include <Inventor/fields/SoSFNode.h>
#include <Inventor/SbEventArg.h>
#include <Inventor/SbEventHandler.h>
 
//------------------------------------------------------------------------------
// Class declaration
class SoCamera;
class SoSeparator;
class SoCoordinate3;
class SbViewportRegion;
class SoMaterial;
class SoPath;
class LassoRenderer;
class SoOrthographicCamera;
class LassoPointsWrapper;
class MatricesEvaluator;
class SbPlanarConvexPolygon;
class SoExtSelection;
 
SO_PIMPL_PUBLIC_DECLARATION( SoExtSelection )
 
 
class  SoExtSelection : public SoSelection {
 
  SO_NODE_HEADER(SoExtSelection);
  SO_PIMPL_PUBLIC_HEADER( SoExtSelection );
 
  //============================================================================
 public:
 
  enum LassoType {
    NOLASSO,
    LASSO,
    RECTANGLE,
    ELLIPSE
  };
 
  enum LassoPolicy {
    FULL_BBOX,
    PART_BBOX,
    FULL,
    PART
  };
 
  enum LassoMode {
    VISIBLE_SHAPES,
 
    ALL_SHAPES
  };
 
  SoSFEnum lassoType;
 
  SoSFEnum lassoPolicy;
 
  SoSFEnum lassoMode;
 
  SoSFBool animateLasso;
 
  SoSFColor lassoColor;
 
  SoSFFloat lassoWidth;
 
  SoSFUShort lassoPattern;
 
  SoSFInt32 lassoPatternScaleFactor;
 
  enum ReturnType {
    NOSELECT_CONTINUE,
    SELECT_RETURN,
    SELECT_CONTINUE,
    NOSELECT_RETURN
  };
 
  SoExtSelection();
 
  void useFastEditing(SbBool flg = TRUE);
 
  SbBool isUsingFastEditing();
 
  SoSeparator *getOverlaySceneGraph();
 
#if 1             SoDEPRECATED
  void setOverlayLassoColorIndex(int index);
SoDEPRECATED
  int getOverlayLassoColorIndex();
SoDEPRECATED
  void setLassoColor(SbColor c);
SoDEPRECATED
  SbColor getLassoColor();
SoDEPRECATED
  void setLassoWidth(float width);
SoDEPRECATED
  float getLassoWidth();
SoDEPRECATED
  void setOverlayLassoPattern(unsigned short pattern);
SoDEPRECATED
  unsigned short getOverlayLassoPattern();
SoDEPRECATED
  void animateOverlayLasso(SbBool flg = TRUE);
SoDEPRECATED
  SbBool isOverlayLassoAnimated();
 
#endif 
  void select(SoNode *root, int numCoord, SbVec2f *lassoCoord,
              const SbViewportRegion &viewport, SbBool shiftPressed);
 
  typedef SbBool SoExtSelectionTriangleCB(void *userData,
                                          SoCallbackAction *action,
                                          const SoPrimitiveVertex *v1,
                                          const SoPrimitiveVertex *v2,
                                          const SoPrimitiveVertex *v3);
  typedef SbBool SoExtSelectionLineSegmentCB(void *userData,
                                             SoCallbackAction *action,
                                             const SoPrimitiveVertex *v1,
                                             const SoPrimitiveVertex *v2);
  typedef SbBool SoExtSelectionPointCB(void *userData,
                                       SoCallbackAction *action,
                                       const SoPrimitiveVertex *v1);
 
   typedef SbBool SelectionEventCallback( const SbVec2s& position, const SbVec3f& scenePosition,
                                          SoExtSelection* selection, void* userData );
 
  virtual void addChild( SoNode *child );
 
  struct PreFilterEventArg : public SbEventArg {
  public:
 
    PreFilterEventArg(SoPath* path, SoExtSelection* source)
      :m_path(path), m_source(source), m_isSkipped(false)
    {}
 
    ~PreFilterEventArg() { }
 
    SoExtSelection* getSource() const { return m_source; }
 
    const SoNode* getNode() const { return m_path->getTail(); }
 
    const SoPath* getPath() const { return m_path; }
 
    void skipNode()  { m_isSkipped = true; }
 
    SbBool isNodeSkipped() const { return m_isSkipped; }
 
  private:
 
    SoPath* m_path;
    SoExtSelection* m_source;
    SbBool m_isSkipped;
  };
 
  SbEventHandler<PreFilterEventArg&> onPreFilter;
 
  virtual void setSelectionSceneGraph( SoNode* sceneGraph );
 
  virtual SoNode* getSelectionSceneGraph() const;
 
  virtual void setStartSelectionCallback( SelectionEventCallback* callback, void* userData = NULL );
 
  virtual void setEndSelectionCallback( SelectionEventCallback* callback, void* userData = NULL );
 
  virtual void setMovingSelectionCallback( SelectionEventCallback* callback, void* userData = NULL );
 
  void setTriangleFilterCallback(SoExtSelectionTriangleCB *cb,
                                 void *userData = NULL);
 
  void setLineSegmentFilterCallback(SoExtSelectionLineSegmentCB *cb,
                                    void *userData = NULL);
  void setPointFilterCallback(SoExtSelectionPointCB *cb,
                              void *userData = NULL);
 
  const SbVec2s *getLassoCoordsDC(int &numCoords);
 
  const SbVec3f *getLassoCoordsWC(int &numCoords);
 
  const SoPathList &getSelectionPathList() const;
 
  // Routines to add callbacks for checked primitives
  //(triangles, line segments, and points) for all shapes.
 
 private:
  // Traversal routine for SoHandleEventAction - this will call
  // action->setHandled() if the event is handled
  virtual void handleEvent(SoHandleEventAction *action);
  virtual void search(SoSearchAction *action);
  virtual void GLRender(SoGLRenderAction *action);
  virtual void getBoundingBox(SoGetBoundingBoxAction *action);
 
 private:
  static void           initClass();
  static void           exitClass();
 
  virtual void notify( SoNotList* list );
 
  void setSelection( SbBool on );
  SbBool getSelection() const;
 
  //============================================================================
 private:
 
  // Destructor ----------------------------------------------------------------
  // Private to keep people from trying to delete
  // nodes, rather than using the reference count mechanism.
  virtual ~SoExtSelection();
 
 private:
  void commonConstructor();
};
 
#endif  // _SO_EXTENDED_SELECTION_H_