SoMenuPopup.h

/*=======================================================================
 *** 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      : Nicolas DAGUISE (Oct 2002)
**=======================================================================*/
#ifndef  _SO_MENU_POPUP_
#define  _SO_MENU_POPUP_
 
#include <DialogViz/dialog/SoMenuItem.h>
 
class SoDialogAuditor;

class  SoMenuPopup : public SoMenuItem  
{
  SO_DG_HEADER(SoMenuPopup);
 
 public:

  SoMenuPopup();

  void addAuditor(SoDialogAuditor* auditor);

  void removeAuditor(SoDialogAuditor* auditor);

  SoDialogViz* searchForAuditorId(SbString id);

  virtual void addChild(SoMenuItem *child);

  virtual void insertChild(SoMenuItem *child, int newChildIndex);

  virtual SoNode *getChild(int index) const;

  virtual int getNumChildren() const;

  virtual int findChild(const SoMenuItem *child) const;

  virtual void removeChild(int index);

  virtual void removeChild(SoMenuItem *child);

  virtual void removeAllChildren();

  virtual void replaceChild(int index, SoMenuItem *newChild);

  virtual void replaceChild(SoMenuItem *oldChild, SoMenuItem *newChild);
 
  /*==============================================================================*/
 private:
  // Returns pointer to children
  virtual SoChildList *getChildren() const;
 
  virtual void buildMenu(void* parent, SbBool isActive2d, int index = -1);
  static  void initClass();
  static  void exitClass();
  virtual void updateFromSensor(SoSensor* sensor);
  virtual void destroyNoDeleteMenuItem();
  virtual SbVec2i32 getItemInitSize();
  virtual void updateAfterSceneGraphChange();
 
  // Internal child management following inheritance of classes.
  virtual void internalRemoveChild( int index )                          { removeChild(index); }
  virtual void internalRemoveChild( SoNode *child  )                     { removeChild(findChild(dynamic_cast<SoMenuItem*>(child))); }
  virtual void internalRemoveAllChildren()                               { removeAllChildren(); }
  virtual void internalAddChild( SoNode *child )                         { addChild(dynamic_cast<SoMenuItem*>(child)); }
  virtual int internalFindChild( const SoNode *child ) const             { return findChild(dynamic_cast<const SoMenuItem*>(child)); }
  virtual void internalInsertChild( SoNode *child, int newChildIndex )   { insertChild(dynamic_cast<SoMenuItem*>(child), newChildIndex); }
  virtual SoNode *internalGetChild( int index) const                     { return getChild(index); }
  virtual void internalReplaceChild( int index, SoNode *newChild)        { replaceChild(index, dynamic_cast<SoMenuItem*>(newChild)); }
  virtual void internalReplaceChild( SoNode *oldChild, SoNode *newChild) { replaceChild(dynamic_cast<SoMenuItem*>(oldChild),dynamic_cast<SoMenuItem*>(newChild)); }
 
 private:
 
  // Reads stuff into instance of SoGroup. Returns FALSE on error
  virtual SbBool readInstance(SoInput *in, unsigned short flags);
  
  // Reads just the children into instance of SoGroup. Returns FALSE on error
  virtual SbBool readChildren(SoInput *in);
  
  virtual      ~SoMenuPopup();
  virtual void changeLabel();
  virtual void changeEnable();
 
 private:
  int m_numberOfChildren;
  void* m_menuPopupWin;
  SbBool m_firstBuild;
 
 
  void insertMenuItem(int index);
  void updateMenuItem();
 
  virtual void applyAuditor(SoDialogViz* dlgCpt);

// 3D methods
private:
  static char* MenuPopup; //Internal default skin.
  static void change3DSkin();
  static SbBool isSkinLoaded();
  static void setSkinLoaded(SbBool loaded);
 
  virtual void get3DDefaultSize(SbVec3f& size);
          void show3DChildren(SbBool show);
  virtual void change3DPosition();
          void update3DChildren();
          void update3DChildrenSize();
 
private:
  SO_DG_CATALOG_ENTRY_HEADER( frameSep      );
  SO_DG_CATALOG_ENTRY_HEADER( frameSwitch   );
  SO_DG_CATALOG_ENTRY_HEADER( released      );
  SO_DG_CATALOG_ENTRY_HEADER( pressed       );
  SO_DG_CATALOG_ENTRY_HEADER( shapeReleased );
  SO_DG_CATALOG_ENTRY_HEADER( shapePressed  );
 
  SoScale* menuPopupFrameScale;
  SoTranslation* menuPopupFrameTranslation;
  SoTransform* menuPopupFrameTransform;
 
  virtual void set3DInactive();
 
private:
  SbBool m_isOpenPopup;
  float m_mPopupCachedDepth;
  float m_mChildrenCachedDepth;
  static SbBool m_isSkinLoaded;
 
  void create3DPopup(int index);
  void update3DPopup();
 
  static void startCB3D( void *, SoDragger *inDragger );
  virtual void draggerStartCallback3D();
 
private:
  virtual void getBoundingBox(SoGetBoundingBoxAction* action);
  virtual void rayPick(SoRayPickAction *action);
  virtual void search(SoSearchAction *action);
  virtual void write(SoWriteAction *action);

 
};
 
#endif // _SO_MENU_POPUP_