SoClipPlaneManip.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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : R. ALBOU (Feb 1997)
**=======================================================================*/
 
                                                             /* include files */
#ifndef  _SO_CLIP_PLANE_MANIP_
#define  _SO_CLIP_PLANE_MANIP_
 
#include <Inventor/draggers/SoDragger.h>
#include <Inventor/nodes/SoClipPlane.h>
#include <Inventor/sensors/SoFieldSensor.h>
#include <Inventor/fields/SoSFVec3f.h>
 
/*----------------------------------------------------------------------------*/
 
class  SoClipPlaneManip : public SoClipPlane {
  
  SO_NODE_HEADER(SoClipPlaneManip) ;
 
 public:
  SoClipPlaneManip() ;
 
  // Fields
  SoSFVec3f draggerPosition ;
 
  SoDragger *getDragger() ;
 
  virtual SoNode *copy(SbBool copyConnections = FALSE) const;
 
  void setValue(const SbBox3f &box, const SbVec3f &planeNormal, float draggerScaleFactor) ;
 
  SbBool replaceNode(SoPath *p) ;
 
  SbBool replaceManip(SoPath *p, SoClipPlane *newOne) const;
 
 private:
 
  // These functions implement all actions for this manip.
  // They first traverse the children, then use the 
  // SoClipPlane version of the actions. They traverse first 
  // so that the SoClipPlane will affect objects which 
  // follow it in the tree, but not the dragger-child.
  virtual void doAction(SoAction *action);
  virtual void callback(SoCallbackAction *action);
  virtual void GLRender(SoGLRenderAction *action);
  virtual void getBoundingBox(SoGetBoundingBoxAction *action);
  virtual void getMatrix(SoGetMatrixAction *action);
  virtual void handleEvent(SoHandleEventAction *action);
  virtual void pick(SoPickAction *action);
  virtual void search(SoSearchAction *action);
  virtual void write( SoWriteAction *action );
 
 private:
 
  // call this after SoInteraction::init();
  static void initClass();
  static void exitClass();
 
  virtual SoChildList *getChildren() const;
  virtual bool isGroup() { return true; }
 
  // Internal child management following inheritance of classes.
  virtual void internalRemoveChild( int index );
  virtual void internalRemoveChild( SoNode *child) { internalRemoveChild(internalFindChild(child)); }
  virtual void internalRemoveAllChildren();
  virtual void internalAddChild( SoNode *child );
  virtual int internalFindChild( const SoNode *child ) const;
  virtual void internalInsertChild( SoNode *child, int newChildIndex );
  virtual SoNode *internalGetChild( int index) const { return (*children)[index]; }
  virtual void internalReplaceChild( int index, SoNode *newChild);
  virtual void internalReplaceChild( SoNode *oldChild, SoNode *newChild) { internalReplaceChild(internalFindChild(oldChild),newChild); }
 
 private:
  // When the dragger moves, this interprets the fields modifications 
  // of the dragger and sets the fields of this SoClip plane accordingly
  static void valueChangedCB(void *,SoDragger *);
  
  // When one of the field of this node changes, moves the
  // child-dragger to a new location, if necessary.
  SoFieldSensor *planeFieldSensor ;
  SoFieldSensor *onFieldSensor ;
  SoFieldSensor *draggerPosFieldSensor ;
  static void fieldSensorCB(void *, SoSensor *);
  
  // Establishes the given dragger as the new child-dragger
  void setDragger(SoDragger *newDragger);
  
  // The hidden children.
  SoChildList *children ;
  virtual SbBool readInstance(SoInput *in, unsigned short flags);
  virtual SbBool readChildren(SoInput *in);
 
  // Destructor
  ~SoClipPlaneManip();
 
 private:
  SbVec3f projectPointPlane() const ;
 
  int getNumChildren() const { return (children->getLength()); } 
} ;
/*----------------------------------------------------------------------------*/
 
#endif /* _SO_CLIP_PLANE_MANIP_  */