SoTopLevelDialog.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      : Nicolas DAGUISE (Oct 2002)
**=======================================================================*/
#ifndef  _SO_TOP_LEVEL_DIALOG_
#define  _SO_TOP_LEVEL_DIALOG_
 
#include <DialogViz/dialog/SoDialogViz.h>
#include <DialogViz/dialog/SoTopComponent.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFVec2i32.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFEnum.h>
 
class SbPlaneProjector;
class SoDialogAuditor;
class SoText3;
class SoTranslation;
class SoTransform;
class SoScale;
 
class SoMenuBar;
 
class  SoTopLevelDialog : public SoDialogViz
{
  SO_DG_HEADER(SoTopLevelDialog);
 
 public:
 
  SoSFInt32 width;
 
  SoSFInt32 height;
 
 
  SoSFVec2i32 position;
 
  SoSFVec3f position3D;
 
  SoSFVec3f minimized3DPosition;
 
  SoSFBool resizable;
  
  SoSFBool minimized;
 
  SoSFBool independentMinimizedPosition;
  
  SoSFInt32 minWidth;
 
  SoSFInt32 maxWidth;
 
  SoSFInt32 minHeight;
 
  SoSFInt32 maxHeight;
 
  SoSFInt32 margin;
 
  SoSFInt32 rowSpacing;
 
  enum ScrollVisibility {
    NEVER,
    ALWAYS,
    AUTO
  };
 
  SoSFEnum vScrollVisibility;
 
  SoSFEnum hScrollVisibility;
 
  SoSFBool windowResizedByChildren;
 
  SoSFBool modalFrame;
 
  SoSFBool hideChildren;
 
  SoTopLevelDialog();
 
  void buildDialog(SoWidget parent, SbBool buildInsideParent = FALSE);
 
  void close();
 
  virtual void show();
 
  virtual void hide();
 
  void addAuditor(SoDialogAuditor* auditor);
 
  void removeAuditor(SoDialogAuditor* auditor);
 
  void applyAuditors();
 
  SoDialogViz* searchForAuditorId(SbString id);
 
  virtual void addChild(SoTopComponent *child);
 
  virtual void insertChild(SoTopComponent *child, int newChildIndex);
 
  virtual SoNode *getChild(int index) const;
 
  virtual int getNumChildren() const;
 
  virtual int findChild(const SoTopComponent *child) const;
 
  virtual void removeChild(int index);
 
  virtual void removeChild(SoTopComponent *child);
 
  virtual void removeAllChildren();
 
  virtual void replaceChild(int index, SoTopComponent *newChild);
 
  virtual void replaceChild(SoTopComponent *oldChild, SoTopComponent *newChild);
 
/*==============================================================================*/
 private:
 
  //update from minimized state
  void updateMinimizedState();
 
  //Returns computed top level dialog size
  SbVec3f getTopLevelSize(){ return topLevelFrameScale->scaleFactor.getValue();}
 
  void buildWidget(SoWidget parent, SbVec2i32 &, SbVec2i32 &, SbBool isActive2d);
  void updateDialogBuild(SbBool is2dRender);
  void fixSizeWithBorder(SbVec2i32 &size, int revert = 1);
  SoWidget getBaseWidget() {return m_baseWidget;};
  SoWidget getWidget();
 
  static void initClass();
  static void exitClass();
 
  void setCurrentFocusedWidget(SoWidget widget);
  void setCurrentScrolledWidget(SoWidget widget);
  SoWidget getCurrentScrolledWidget();
  SoWidget getCurrentFocusedWidget();
 
  SbBool destroyDialog();
  void setScrollProperties();
  void setPosition(SbVec2i32& pos);
  void setSize(int32_t sw, int32_t sh, int32_t smw, int32_t smh, int32_t smmw, int32_t smmh);
  void updateTopLevelWidgetScrollPosition();
  void updateAfterSceneGraphChange();
  virtual void resetSize();
 
  void setDefaultState();
  void getDefaultState(SbVec2i32 &size, SbVec2i32 &min, SbVec2i32 &max);
 
  SoMenuBar* widgetHasMenuBar();
  void* getLayout();
  void updateChildren();
  void updateTopLevelWidget(SbVec2i32 &rSize);
 
  // Internal child management following inheritance of classes.
  virtual void internalRemoveChild( int index )                          { removeChild(index); }
  virtual void internalRemoveChild( SoNode *child  )                     { removeChild(findChild(dynamic_cast<SoTopComponent*>(child))); }
  virtual void internalRemoveAllChildren()                               { removeAllChildren(); }
  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 getChild(index); }
  virtual void internalReplaceChild( int index, SoNode *newChild);
  virtual void internalReplaceChild( SoNode *oldChild, SoNode *newChild) { replaceChild(dynamic_cast<SoTopComponent*>(oldChild),dynamic_cast<SoTopComponent*>(newChild)); }
 
 private:
 
  virtual SoChildList *getChildren() const;
  
  // 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);
  
  SoWidget     m_baseWidget;
  SbBool     m_buildInside;
  SoWidget     m_topLevelWidget;
  SoWidget     m_topLevelWidgetXt;
  SoWidget     m_topForm;
    
  virtual ~SoTopLevelDialog();
  void    getDefaultSize(SbVec2i32 &size, SbVec2i32 &min, SbVec2i32 &max);
  void    getSize(SbVec2i32 &size, SbVec2i32 &min, SbVec2i32 &max);
 
 private:
  FIELD_SENSOR(minimized);
  FIELD_SENSOR(margin);
  FIELD_SENSOR(modalFrame);
  FIELD_SENSOR(resizable);
  FIELD_SENSOR(rowSpacing);
  FIELD_SENSOR(position);
  FIELD_SENSOR(position3D);
  FIELD_SENSOR(minimized3DPosition);
  FIELD_SENSOR(independentMinimizedPosition);
  FIELD_SENSOR(width);
  FIELD_SENSOR(height);
  FIELD_SENSOR(minWidth);
  FIELD_SENSOR(minHeight);
  FIELD_SENSOR(maxWidth);
  FIELD_SENSOR(maxHeight);
 
  int        m_numberOfChildren;
  SbBool     m_firstBuild;
  SoWidget     m_currentFocusedWidget;
  SoWidget     m_currentScrolledWidget;
  SoWidget     m_menu;
  void*      m_layout;
  SbBool     m_isFirstBuild;
  int        m_arrayNumChildren;
  SbVec2i32* m_childrenMax;
  SbVec2i32* m_childrenMin;
  SbVec2i32* m_childrenSize;
  int        m_cptToResize;
  SbBool     m_hScrollVisible;
  SbBool     m_vScrollVisible;
  SoWidget     m_clipWindowXt;
  SoWidget     m_vertSBXt;
  SoWidget     m_horzSBXt;
  int        m_borderWidth;
  int        m_borderHeight;
  int        m_menuHeight;
  int        m_titleHeight;
 
  SbVec2i32  m_initSize;
  SbVec2i32  m_initMinSize;
  SbVec2i32  m_initMaxSize;
 
  void computeNewChildrenHeight(SbVec2i32 &rSize);
  void createBaseWidget(SoWidget parent);
  int m_scrollWidth;
  void createTopLevelWidget();
  void initWidgetConstant();
  void setChildrenComponentSize();
  void setChildrenLabelSize();
  void updateBaseWidget();
  void updateChildrenSizeDB();
  void computeSize(SbVec2i32 &rSize, SbVec2i32 & pos);
 
  void changeRowSpacing();
  void changeResizable();
  void changeModalFrame();
  void changePosition();
  void changeMinMaxSize();
 
  virtual void changeEnable();
  virtual void changeLabel();
  virtual void changeWidth();
  virtual void changeHeight();
 
  virtual void applyAuditor(SoDialogViz* dlgCpt);
 
  virtual void      updateFromSensor(SoSensor* sensor);
  SoDialogAuditor* m_defaultAuditor;
 
// 3D methods
private:
  static char* TopLevelDialog; //Internal default skin.
  static void change3DSkin();
  static SbBool isSkinLoaded();
  static void setSkinLoaded(SbBool loaded);
 
  virtual void show3D(SbBool show);
 
private:
 
  SO_DG_CATALOG_ENTRY_HEADER( frameSep    );
  SO_DG_CATALOG_ENTRY_HEADER( frame       );
  SO_DG_CATALOG_ENTRY_HEADER( labelSep    );
  SO_DG_CATALOG_ENTRY_HEADER( labelProp   );
  SO_DG_CATALOG_ENTRY_HEADER( minSep      );
  SO_DG_CATALOG_ENTRY_HEADER( minSwtch    );
  SO_DG_CATALOG_ENTRY_HEADER( minPressed  );
  SO_DG_CATALOG_ENTRY_HEADER( minReleased );
 
 
private:
  
  SbPlaneProjector* m_planeProj;
  SbVec3f m_worldRestartPt; // used if SHIFT key goes down to 
  SbVec3f m_initialPos;
  float m_mTopLevelCachedDepth;
  SbBool m_firstMinimization;
  static SbBool m_isSkinLoaded;
 
  SoScale* topLevelFrameScale;
  SoText3* topLevelLabel;
  SoTranslation* topLevelFrameTranslation, *topLevelMinTranslation, *topLevelLabelTranslation;
  SoTransform* topLevelFrameTransform;
 
  void create3DTopLevelDialog();
  void update3DTopLevelDialog();
  void update3DChildren();
  void update3DChildrenPosition();
  void update3DLabel();
 
  void minimize3DDialog();
  void restore3DDialog();
  void show3DChildren(SbBool show);
 
  virtual void change3DLabel();
  virtual void change3DPosition();
 
  static void startCB3D( void *, SoDragger *inDragger );
  void draggerStartCallback3D();
  static void motionCB3D( void *, SoDragger *inDragger );
  void draggerMotionCallback3D();
  static void finishCB3D( void *, SoDragger *inDragger );
  void draggerFinishCallback3D();
 
 private:
  virtual void getBoundingBox(SoGetBoundingBoxAction* action);
  virtual void rayPick(SoRayPickAction *action);
  virtual void search(SoSearchAction *action);
  virtual void write(SoWriteAction *action);
 
 
};
 
#endif // _SO_TOP_LEVEL_DIALOG_