SoMenuBar.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-2018 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Nicolas DAGUISE (Oct 2002)
**=======================================================================*/
#ifndef  _SO_MENU_BAR_
#define  _SO_MENU_BAR_
 
#include <DialogViz/dialog/SoTopComponent.h>
#include <DialogViz/dialog/SoMenuPopup.h>
 
class SoDialogAuditor;

class  SoMenuBar : public SoTopComponent  
{
  SO_DG_HEADER(SoMenuBar);
 
 public:

  SoMenuBar();

  void addAuditor(SoDialogAuditor* auditor);

  void removeAuditor(SoDialogAuditor* auditor);

  SoDialogViz* searchForAuditorId(SbString id);

  virtual void addChild(SoMenuPopup *child);

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

  virtual SoNode *getChild(int index) const;

  virtual int getNumChildren() const;

  virtual int findChild(const SoMenuPopup *child) const;

  virtual void removeChild(int index);

  virtual void removeChild(SoMenuPopup *child);

  virtual void removeAllChildren();

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

  virtual void replaceChild(SoMenuPopup *oldChild, SoMenuPopup *newChild);
 
/*==============================================================================*/
private:
  virtual SoChildList *getChildren() const;
 
  virtual void   buildWidget(SoWidget parent, SbVec2i32 &, SbVec2i32 & pos, SbBool isActive2d);
  virtual void   destroyWidget();
  static  void   initClass();
  static  void   exitClass();
  virtual void   updateFromSensor(SoSensor* sensor);
  void* getMenu(void* parent);
  void destroyNoDeleteMenuItems();
  void updateChildren();
  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<SoMenuPopup*>(child))); }
  virtual void internalRemoveAllChildren()                               { removeAllChildren(); }
  virtual void internalAddChild( SoNode *child )                         { addChild(dynamic_cast<SoMenuPopup*>(child)); }
  virtual int internalFindChild( const SoNode *child ) const             { return findChild(dynamic_cast<const SoMenuPopup*>(child)); }
  virtual void internalInsertChild( SoNode *child, int newChildIndex )   { insertChild(dynamic_cast<SoMenuPopup*>(child), newChildIndex); }
  virtual SoNode *internalGetChild( int index) const                     { return getChild(index); }
  virtual void internalReplaceChild( int index, SoNode *newChild)        { replaceChild(index, dynamic_cast<SoMenuPopup*>(newChild)); }
  virtual void internalReplaceChild( SoNode *oldChild, SoNode *newChild) { replaceChild(dynamic_cast<SoMenuPopup*>(oldChild),dynamic_cast<SoMenuPopup*>(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 ~SoMenuBar();
  virtual void getSize(SbVec2i32 &size, SbVec2i32 &min, SbVec2i32 &max);
 
 private:
  int m_numberOfChildren;
  void* m_menuBarWin;
  SbBool m_firstBuild;
 
  void   createMenuBar(SoWidget parent);
  SbBool existMenuBar();
  void   updateMenuBar();
  virtual void changeEnable();
  virtual void applyAuditor(SoDialogViz* dlgCpt);

// 3D methods
private:
  static char* MenuBar; //Internal default skin.
  static void change3DSkin();
  static SbBool isSkinLoaded();
  static void setSkinLoaded(SbBool loaded);
 
  virtual void show3D(SbBool show);
          void show3DChildren(SbBool show);
  virtual void set3DParentTranslation(SbVec3f& tsl);
          void update3DChildrenSize();
 
private:
  SO_DG_CATALOG_ENTRY_HEADER( frameSep );
  SO_DG_CATALOG_ENTRY_HEADER( frame    );
 
  SoScale* menuBarFrameScale;
  SoTranslation* menuBarFrameTranslation;
  SoTransform* menuBarFrameTransform;
 
private:
  static SbBool m_isSkinLoaded;
  float m_mBarCachedDepth;
 
  void create3DBar();
  void update3DBar();
  void update3DChildren();
  virtual void change3DPosition();
 
private:
  virtual void getBoundingBox(SoGetBoundingBoxAction* action);
  virtual void rayPick(SoRayPickAction *action);
  virtual void search(SoSearchAction *action);
  virtual void write(SoWriteAction *action);

 
};
 
#endif // _SO_MENU_BAR_