Inventor/nodes/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-2020 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/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 SimplexSelectorHelper;

class SoExtSelectionImpl;

class  SoExtSelection : public SoSelection {
  
  SO_NODE_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;

  enum ReturnType {
    NOSELECT_CONTINUE,
    SELECT_RETURN,
    SELECT_CONTINUE,
    NOSELECT_RETURN
  }; 
  
  SoExtSelection();

#if 1             SoDEPRECATED
  void useOverlay(SbBool flg = TRUE)
    { m_use_overlay = flg; }
SoDEPRECATED
  SbBool isUsingOverlay()
    { return m_use_overlay; }
#endif 
  void useFastEditing(SbBool flg = TRUE);

  SbBool isUsingFastEditing()
    { return m_useFastEditing; }

  SoSeparator *getOverlaySceneGraph()
    { return m_lasso_root; }

  void setOverlayLassoColorIndex(int index)
    { m_overlay_lasso_color->index.setValue(index); }

  int getOverlayLassoColorIndex()
    { return m_overlay_lasso_color->index[0]; }

  void setLassoColor(SbColor c);

  SbColor getLassoColor()
    { return m_lasso_color; }

  void setLassoWidth(float width)
    { m_lasso_draw_style->lineWidth.setValue(width); }

  float getLassoWidth()
    { return m_lasso_draw_style->lineWidth.getValue(); }
  
  void setOverlayLassoPattern(unsigned short pattern);

  unsigned short getOverlayLassoPattern()
    { return(unsigned short) m_lasso_pattern; }

  void animateOverlayLasso(SbBool flg = TRUE);

  SbBool isOverlayLassoAnimated()
    { return m_lasso_animation; }

  void select(SoNode *root, int numCoord, SbVec2f *lassoCoord,  
              const SbViewportRegion &viewport, SbBool shiftPressed);

#if 1             SoDEPRECATED
  void select(SoNode *root, int numCoord, SbVec3f *lassoCoord,
              const SbViewportRegion &viewport, SbBool shiftPressed);

#endif 
  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
    { return tempSelectionList;}

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

 private:
  static void           initClass();
  static void           exitClass();

  void setSelection( SbBool on ) { m_makeSelection = on; }
  SbBool getSelection() const { return m_makeSelection; }

  //============================================================================
 private:

  // Paths list of selected objects
  SoPathList tempSelectionList;
  
  SoExtSelectionTriangleCB *triangleCBFunc;
  SoExtSelectionLineSegmentCB *lineSegmentCBFunc;
  SoExtSelectionPointCB *pointCBFunc;
  void *triangleCBData;
  void *lineSegmentCBData;
  void *pointCBData;

  // Destructor ----------------------------------------------------------------
  // Private to keep people from trying to delete
  // nodes, rather than using the reference count mechanism.
  virtual ~SoExtSelection();

  void manageEventCallbacks( SoHandleEventAction *action );

  void handleSelectionEvent(SoHandleEventAction *action);

  //============================================================================
 private:

  enum ShapeType {
    TRIANGLE_SHAPE,
    LINE_SHAPE,
    POINT_SHAPE
  };

  typedef void (SoExtSelection::*onTriangleMethod)(SoCallbackAction *action,
                                                   const SoPrimitiveVertex *v1,
                                                   const SoPrimitiveVertex *v2,
                                                   const SoPrimitiveVertex *v3);

  typedef void (SoExtSelection::*onLineMethod)( SoCallbackAction *action,
                                                const SoPrimitiveVertex *v1,
                                                const SoPrimitiveVertex *v2);

  typedef void (SoExtSelection::*onPointMethod)(SoCallbackAction *action,
                                                const SoPrimitiveVertex *v1 );

  typedef SoCallbackAction::Response (SoExtSelection::*onBboxMethod)(SoCallbackAction *action,
                                                                     const SbBox3f& bb );

  typedef void (SoExtSelection::*doSelectionMethod)( SimplexSelectorHelper* );

  // Private data --------------------------------------------------------------

  // Overlay scene graph
  SoTimerSensor *m_lasso_animation_timer;
  SoSeparator *m_lasso_root;
  SoColorIndex *m_overlay_lasso_color;
  SoDrawStyle *m_lasso_draw_style;
  LassoPointsWrapper *m_lasso_points;
  SoOrthographicCamera* m_lasso_camera;

  int m_lasso_window_height, m_max_lasso_points;
  SbBool m_new_lasso;

  // Lasso data
  SbBool m_use_overlay, m_lasso_animation;
  SbBool m_useFastEditing;
  unsigned long m_lasso_pattern, m_lasso_work_pattern;

  SbColor m_lasso_color;
  
  // Misc
  SbBool m_shift_down;
  SbBool m_end_triangle_search, m_end_line_search, m_end_point_search;
  SbBool m_hasBeenOut;
  SbBool m_button_was_pressed;
  
  // Computation
  SoPath *m_current_shape;
  SoState *m_current_state;
  SbViewportRegion m_current_viewport, m_current_local_viewport;

  ShapeType m_currentShapeType;
  SbVec3f  m_lassoFirstPoint;
  LassoRenderer *m_current_scene_offscreen;
  unsigned int m_shape_index;
  std::vector<SoRef<SoPath> > m_selectedShapes;

  MatricesEvaluator *m_matricesEvaluator;

  SoGetBoundingBoxAction *m_bbox_action;
  SoSeparator *m_bbox_root;
  SoMatrixTransform *m_bbox_trans;
  SbBool m_do_selection;
  
  SbViewportRegion vpRegionEvent;

  SbBool m_makeSelection; // Activate/deactivate lasso selection (lasso is still drawn)

  SoMaterial* m_lassoMaterial;

  SoPickStyle* m_lassoPickStyle;

  SoSeparator* m_defaultSelectionSceneGraph;

  SoSeparator* m_customSceneGraphSeparator;

  SelectionEventCallback* m_startSelectionCallback;
  void* m_startSelectionCallbackUserData;

  SelectionEventCallback* m_endSelectionCallback;
  void* m_endSelectionCallbackUserData;

  SelectionEventCallback* m_movingSelectionCallback;
  void* m_movingSelectionCallbackUserData;

  bool m_isSelecting;

  const SoCamera* m_activeCamera;

  SoExtSelectionImpl* m_impl;

  // Selection should be check in shape path only when selection if made through handle event.
  // If selection started using select(), then selection might not be part of the scenegraph.
  bool m_shouldCheckPathForSelection;

  onTriangleMethod   m_currentTriangleMethod;
  onLineMethod       m_currentLineMethod;
  onPointMethod      m_currentPointMethod;
  onBboxMethod       m_currBboxMethod;
  doSelectionMethod  m_currDoSelection;

  // OIV_SELECTION_IN_VIEWVOLUME_ONLY environment variable status
  // This variable allows to activate the selection of shapes which
  // are only inside the viewport. Default behavior is "deactivated".
  static bool s_onlySelectInViewVol;

  // Private methods -----------------------------------------------------------
  
  // Misc
  void transformToLocalViewport(float &bbox_x_min, float &bbox_y_min, 
                                float &bbox_x_max, float &bbox_y_max);
  SbVec3f getVec3fPosition(const SbVec2f &pos, 
                           const SbViewportRegion &vp);
  SbVec3f getVec3fMousePosition(const SoEvent *event, 
                                const SbViewportRegion &vp);
  void vec3fToPixel(const SbVec3f &vec, 
                    const SbViewportRegion &vp, 
                    long &x, long &y);
  int isSquareInsideLasso(const SbVec4f &p0, const SbVec4f &p1,
                          const SbVec4f &p2, const SbVec4f &p3);

  SbBool isLassoPtsHalfPlaneLine(const SbVec4f &line0, const SbVec4f &line1) const;

  // Computation
  void selectObjects(SoNode *root, bool useViewport = false);
  void doSelection( SimplexSelectorHelper* ssh );
  void doSelection_( SimplexSelectorHelper* ssh );
  void computeEllipsePoints(const SbVec3f &start, const SbVec3f &end);
  SoCallbackAction::Response windBBoxCheck( SoState *state, const SbXfBox3f &tmpbox ) const;

  // Laso animation
  void onLassoAnimation();
  static void onLassoAnimationCB(void *data, SoSensor *);

  // Lasso drawing on non overlay systems
  void initLasso(int x, int y);
  void drawLasso(int x, int y);
  void eraseLasso();

  bool setStartSelecting( const SbVec2s &pixel, SbVec3f scenePos );
  bool setEndSelecting( const SbVec2s &pixel, SbVec3f scenePos );
  bool notifyWhileSelecting( const SbVec2s &pixel, SbVec3f scenePos );

  void setMouseButtonDown( bool value );
  
  enum TripletOrientation
  {
    COLINEAR,
    CLOCKWISE,
    COUNTERCLOCKWISE
  };

  static bool isPointOnSegment( const SbVec2f& p, const SbVec2f& s1, const SbVec2f& s2 );

  static TripletOrientation computeOrientation( const SbVec2f& p1, const SbVec2f& p2, const SbVec2f& p3 );

  static bool segmentsIntersection( const SbVec2f& s00, const SbVec2f& s01, const SbVec2f& s10, const SbVec2f& s11 );

  // Traversal callbacks
  SoCallbackAction::Response examineCamera(SoCallbackAction *action, const SoNode* node);
  SoCallbackAction::Response examineSeparatorPre(SoCallbackAction *action, const SoNode* node);
  SoCallbackAction::Response examineSeparatorPost(SoCallbackAction *action, const SoNode* node);
  SoCallbackAction::Response examineShape(SoCallbackAction *action, const SoNode* node);
  SoCallbackAction::Response examineClipPlane(SoCallbackAction *action, const SoNode* node);
  SoCallbackAction::Response postShape(SoCallbackAction *action);
  void examineTriangle_(SoCallbackAction *action,
                        const SoPrimitiveVertex *v1,
                        const SoPrimitiveVertex *v2,
                        const SoPrimitiveVertex *v3,
                        SimplexSelectorHelper* ssh = NULL);
  void examineLine_(SoCallbackAction *action,
                    const SoPrimitiveVertex *v1,
                    const SoPrimitiveVertex *v2,
                    SimplexSelectorHelper* ssh = NULL);
  void examinePoint_(SoCallbackAction *action,
                    const SoPrimitiveVertex *v1,
                    SimplexSelectorHelper* ssh = NULL);
  void examineTriangle(SoCallbackAction *action, 
                       const SoPrimitiveVertex *v1,
                       const SoPrimitiveVertex *v2,
                       const SoPrimitiveVertex *v3);
  void examineLine(SoCallbackAction *action, 
                   const SoPrimitiveVertex *v1,
                   const SoPrimitiveVertex *v2);
  void examinePoint(SoCallbackAction *action, 
                    const SoPrimitiveVertex *v1);
  void examineTriangleWClipPlanes(SoCallbackAction *action,
                                  const SoPrimitiveVertex *v1,
                                  const SoPrimitiveVertex *v2,
                                  const SoPrimitiveVertex *v3);
  void examineLineWClipPlanes(SoCallbackAction *action,
                              const SoPrimitiveVertex *v1,
                              const SoPrimitiveVertex *v2);
  void examinePointWClipPlanes(SoCallbackAction *action,
                               const SoPrimitiveVertex *v1);
  SoCallbackAction::Response 
    onBBox(SoCallbackAction *action, const SoNode *node);
  SoCallbackAction::Response
    onBBoxWClipPlanes(SoCallbackAction *action, const SbBox3f& bb);
  SoCallbackAction::Response
    onBBox_( SoCallbackAction *action, const SbBox3f& bb );
  SoCallbackAction::Response 
    onAnnoText3(SoCallbackAction *action, const SoNode *node);
  SoCallbackAction::Response 
    onShape(SoCallbackAction *action, const SoNode *node);
  SoCallbackAction::Response 
    onBaseKitPre(SoCallbackAction *action, const SoNode *node);

  void onTriangle_(SoCallbackAction *action,
                   const SbVec3f &p1,
                   const SbVec3f &p2,
                   const SbVec3f &p3);
  void onLineSegment_(SoCallbackAction *action,
                      const SbVec3f &p1,
                      const SbVec3f &p2);
  void onPoint_(SoCallbackAction *action,
                const SbVec3f &p1);
  void onTriangle(SoCallbackAction *action,
                  const SoPrimitiveVertex *v1,
                  const SoPrimitiveVertex *v2,
                  const SoPrimitiveVertex *v3);
  void onLineSegment(SoCallbackAction *action, 
                     const SoPrimitiveVertex *v1,
                     const SoPrimitiveVertex *v2);
  void onPoint(SoCallbackAction *action,
               const SoPrimitiveVertex *v1);
  void onTriangleWClipPlanes(SoCallbackAction *action,
                             const SoPrimitiveVertex *v1,
                             const SoPrimitiveVertex *v2,
                             const SoPrimitiveVertex *v3);
  void onLineSegmentWClipPlanes(SoCallbackAction *action,
                                const SoPrimitiveVertex *v1,
                                const SoPrimitiveVertex *v2);
  void onPointWClipPlanes(SoCallbackAction *action,
                          const SoPrimitiveVertex *v1);

  static SoCallbackAction::Response 
    examineCameraCB(void *data, SoCallbackAction *action, const SoNode *);
  static SoCallbackAction::Response 
    examineSeparatorPostCB(void *data, SoCallbackAction *action, const SoNode *);
  static SoCallbackAction::Response
    examineSeparatorPreCB(void *data, SoCallbackAction *action, const SoNode *);
  static SoCallbackAction::Response 
    examineShapeCB(void *data, SoCallbackAction *action, const SoNode *);
  static SoCallbackAction::Response 
    postShapeCB(void *data, SoCallbackAction *action, const SoNode *);
  static void onTriangleCB(void *object, 
                           SoCallbackAction *action,
                           SoPrimitiveVertex *v1,
                           SoPrimitiveVertex *v2, 
                           SoPrimitiveVertex *v3);
  static void onLineSegmentCB(void *object, SoCallbackAction *action,
                              SoPrimitiveVertex *v1,
                              SoPrimitiveVertex *v2);

  static void onPointCB(void *object, 
                        SoCallbackAction *action, 
                        SoPrimitiveVertex *v1);
  static void onText2CB(void *object, 
                        SoCallbackAction *action, 
                        const SoNode *node);
  static void onAnnoText3CB(void *object, 
                            SoCallbackAction *action, 
                            const SoNode *node);
  static void onImageCB(void *object, 
                        SoCallbackAction *action, 
                        const SoNode *node);
  static SoCallbackAction::Response 
    onShapeCB(void *object, SoCallbackAction *action, const SoNode *node);
  static SoCallbackAction::Response 
    onBaseKitPreCB(void *object, SoCallbackAction *action, const SoNode *node);

  static SoCallbackAction::Response
    onClipPlaneCB(void *object, SoCallbackAction *action, const SoNode * node);

  bool examineTrimmedTriangle( const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, 
                               const SbPlanarConvexPolygon& convexHull, SoCallbackAction* action, bool nested = false );
  bool examineTrimmedSegment( const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2,
                              const SbPlanarConvexPolygon& convexHull, SoCallbackAction* action );
  bool examineTrimmedPoint( const SoPrimitiveVertex *v1,
                            const SbPlanarConvexPolygon& convexHull, SoCallbackAction* action );

  void onTrimmedGeom( SoCallbackAction* action, const SbPlanarConvexPolygon& convexHull );

  bool areCallbackFuncsSet() const;

  // Returns true if the point is behind the near plane of the viewing volume, false otherwise.
  // The point coordinates must expressed in the device coordinate system, they are NOT normalized.
  bool isPointBehindNearPlane( const SbVec4f& pointCoordinates ) const;

  friend class SimplexSelectorHelper;

};

#endif  // _SO_EXTENDED_SELECTION_H_

---

Open Inventor Toolkit reference manual, generated on 22 Jul 2025
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/