SoDialogGroup.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_DIALOG_GROUP_
#define  _SO_DIALOG_GROUP_
 
#include <DialogViz/dialog/SoDialogComponent.h>
 
class SoDialogAuditor;
class SoDialogGroupAuditor;
 
class  SoDialogGroup : public SoDialogComponent
{
  SO_DG_HEADER(SoDialogGroup);
 
 public:
 
  enum ScrollVisibility {
    NEVER,
    ALWAYS,
    AUTO
  };
 
  SoSFEnum vScrollVisibility;
 
  SoSFEnum hScrollVisibility;
 
  SoSFBool windowResizedByChildren;
 
  SoSFInt32 margin;
 
  void addAuditor(SoDialogAuditor* auditor);
 
  void removeAuditor(SoDialogAuditor* auditor);
 
  void applyAuditors();
 
  SoDialogViz* searchForAuditorId(SbString id);
 
  virtual void addChild(SoDialogComponent *child);
 
  virtual void insertChild(SoDialogComponent *child, int newChildIndex);
 
  virtual SoNode *getChild(int index) const;
 
  virtual int getNumChildren() const;
 
  virtual int findChild(const SoDialogComponent *child) const;
 
  virtual void removeChild(int index);
 
  virtual void removeChild(SoDialogComponent *child);
 
  virtual void removeAllChildren();
 
  virtual void replaceChild(int index, SoDialogComponent *newChild);
 
  virtual void replaceChild(SoDialogComponent *oldChild, SoDialogComponent *newChild);
 
/*==============================================================================*/
private:
  virtual SoChildList *getChildren() const;
 
  virtual void   buildWidget(SoWidget parent, SbVec2i32 & rSize, SbVec2i32 & pos, SbBool isActive2d);
  static  void   initClass();
  static  void   exitClass();
  virtual void   updateFromSensor(SoSensor* sensor);
          SbBool isVScrollVisible() {return m_vScrollVisible;};
          void   updateAfterSceneGraphChange();
  virtual void   resetSize();
  virtual void   destroyWidget();
 
  // Internal child management following inheritance of classes.
  virtual void internalRemoveChild( int index )                          { removeChild(index); }
  virtual void internalRemoveChild( SoNode *child  )                     { removeChild(internalFindChild(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<SoDialogComponent*>(oldChild),dynamic_cast<SoDialogComponent*>(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);
  
  int        m_arrayNumChildren;
  SbVec2i32* m_childrenMin;
  SbVec2i32* m_childrenMax;
  SbVec2i32* m_childrenSize;
  int        m_cptToResize;
  SbBool     m_hScrollVisible;
  SbBool     m_vScrollVisible;
  SoWidget     m_groupWidget;
  SoWidget     m_horzSBXt;
  SoWidget     m_vertSBXt;
  int m_numberOfChildren;
  SbBool     m_firstBuild;
 
  SoDialogGroup();
  virtual           ~SoDialogGroup();
  virtual void      fixSizeWithBorder(SbVec2i32 &size, int revert = 1);
  virtual SbVec2i32 getLabelInitSize();
  virtual SbVec2i32 getComponentInitSize();
 
  virtual void      getSize(SbVec2i32 &size, SbVec2i32 &min, SbVec2i32 &max);
  virtual void      setChildrenComponentSize() {};
  virtual void      setChildrenLabelSize() {};
  virtual void      setComponentSize(SbVec2i32& size);
  virtual void      setLabelSize(SbVec2i32& size);
          void      setScrollProperties();
          void      updateGroupWidgetScrollPosition();
          void      updateChildrenSizeDB();
 
  virtual void changeEnable();
  virtual void changeWidgetEnable(SbBool state);
 
 private:
 
          void createGroupWidget(SbVec2i32 & rSize, SbVec2i32 & pos);
  virtual void applyAuditor(SoDialogViz* dlgCpt);
 
 
  SoDialogGroupAuditor* m_defaultAuditor;
 
// 3D methods
private:
  virtual void show3D(SbBool show);
  virtual void change3DPosition();
  virtual void change3DEnable();
  virtual void change3DWidgetEnable(SbBool state);
 
private:
  virtual void getBoundingBox(SoGetBoundingBoxAction* action);
  virtual void rayPick(SoRayPickAction *action);
  virtual void search(SoSearchAction *action);
  virtual void write(SoWriteAction *action);
 
 
};
 
#endif // _SO_DIALOG_GROUP_