SoDialogViz.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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Nicolas DAGUISE (Oct 2002)
**=======================================================================*/
#ifndef  _SO_DIALOG_VIZ_
#define _SO_DIALOG_VIZ_
 
#include <SoVersion.h>
#if !defined(SOQT) || defined(LOAD_DIALOGVIZ_FOR_IVTUNE)
#  ifdef _WIN32
#    include <DialogViz/SoDialogVizWinLibName.h>
#    define __DIALOGVIZDLL __DIALOGVIZWINDLL
#    define __DIALOGVIZLIB __DIALOGVIZWINLIB
#  else
#    include <DialogViz/SoDialogVizXtLibName.h>
#    define __DIALOGVIZDLL __DIALOGVIZXTDLL
#    define __DIALOGVIZLIB __DIALOGVIZXTLIB
#  endif
#else
#  include <DialogViz/SoDialogVizQtLibName.h>
#  define __DIALOGVIZDLL __DIALOGVIZQTDLL
#  define __DIALOGVIZLIB __DIALOGVIZQTLIB
#endif
 
// On Windows the "comment" pragma will automatically add our DialogViz
// library to the application's link string.
 
#ifdef _WIN32
#  if !defined(DialogVizWin_EXPORTS) && !defined(DialogVizQt_EXPORTS)
#    ifndef OIV_DISABLE_AUTOLINK
#      pragma comment(lib,__DIALOGVIZLIB)
#    endif
#  endif
#endif
 
#include <Inventor/actions/SoGetBoundingBoxAction.h>
#include <Inventor/draggers/SoDragger.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFString.h>
#if !defined(LOAD_DIALOGVIZ_FOR_IVTUNE) || defined(SCALEVIZGUIQTBUILD)
#include <Inventor/Xt/SoXt.h>
#else
//#undef SoWidget
//#define SoWidget QWidget
#endif
 
#include <DialogViz/auditors/SoAuditor.h>
#include <DialogViz/dialog/SoSubDialogViz.h>
 
class SoGetMatrixAction;
class SoMaterial;
class SoNode;
class SoPickStyle;
class SoSearchAction;
class SoText3;
class SoTopLevelDialog;
class SoTransform;
class SoTranslation;
 
#include <Inventor/SoModule.h>
SO_MODULE_HEADER(SoDialogViz,__DIALOGVIZDLL)
 
 
class  SoDialogViz : public SoDragger
{
  SO_DG_HEADER(SoDialogViz);
 
 public:
  SoSFBool enable;
 
  SoSFString  label;
 
  enum LabelAlignment {
    LEFT,
    CENTER,
    RIGHT
  };
 
  SoSFEnum labelAlignment;
 
  SoSFString auditorID;
 
  static void init();
 
  static void finish();
 
  static bool isInitialized();
 
  static const char *getProductName();
 
#if 1             SoDEPRECATED
  static const char *getVersion();
#endif 
  static SoDialogViz* loadFromFile(SbString filename, SbString auditorID = "");
 
  //  /**
  //   * Shows the component.
  //   */
  //  virtual void show() {};
 
  //  /**
  //   * Hides the component.
  //   */
  //  virtual void hide() {};
  
  static void setSkin(SbString skinName);
 
  static void setSkinsDirectories(SbString directories);
 
  static SbString getSkinsDirectories();
 
  static void setFont(DG_FONT font);
 
/*==============================================================================*/
 private:
//#pragma deprecated(setSkinsDirectory, getSkinsDirectory)
  static SbBool setSkinsDirectory(SbString directory) { setSkin(directory); return TRUE; }
  static SbString getSkinsDirectory() {return getSkinsDirectories(); }
 
  static void initClass();
  static void exitClass();
 
  virtual void  buildWidget(SoWidget parent, SbVec2i32 &rSize, SbVec2i32 &pos, SbBool is2dRender);
  virtual void  destroyWidget();
  virtual void  updateFromSensor(SoSensor* sensor);
          void  setParent(SoDialogViz* parent);
  virtual void  applyAuditor(SoDialogViz* ) {};
          SoDialogViz* getFirstTopParent(SbBool is2DRender = TRUE, SbBool getLastValidParent = FALSE);
  static  SbVec2i32 getLabelPixelSize(SbString string, SoDialogViz* cpt);
  static DG_FONT getDialogVizFont();
 
//  static void PrintMemoryInfo(SbString name);
 
  static void setWidgetFont(SoWidget widget);
  virtual void resetSize() {};
  virtual void destroy();
 
 
 
 private:
 
  SbString m_cLabel;
  SbBool m_isActive2d;
  SoWidget m_topParentWidget;
 
  static DG_FONT m_font;
 
  SoDialogViz();
  virtual ~SoDialogViz();
 
  static SbString  convertToCString(const SbString& oldString, SoDialogViz* cpt);
  static SbString  convertFromCString(const SbString& oldString, SbBool toEdit = FALSE);
  static void setStringToText3(SoText3* myText, const SbString& inString);
  static void destroyByRef(SoDialogViz* dialogToDestroy);
 
  static SbBool existWidget(SoWidget widget);
  static void   fieldChangedCB(void *guiComponent , SoSensor* sensor);
  static int    getNumLines( const SbString& string);  // retrieve the number of lines in the string.
  
  // reflex functions when fields change
  virtual void changeEnable() {};
  virtual void changeLabel() {};
  virtual void changeLabelAlignment() {};
 
  // auditor methods
  SoDialogViz* m_parentComponent;
  void addAuditor(SoAuditor* auditor);
  void removeAuditor(SoAuditor* auditor);
  SoAuditor*& getAuditor(int index);
  int getAuditorListLength();
 
 private:
 
  static int s_initRefCount;
 
  static const char *s_versionString;
 
  SbPList* m_auditorList;
  static SbBool m_errorMsgDelivered;
  static SbPList* s_listData;
 
  // Field sensors declare
  FIELD_SENSOR(enable);
  FIELD_SENSOR(label);
  FIELD_SENSOR(labelAlignment);
 
// 3D methods
private:
  static char* TextProperties; // Internal default skins.
  static void change3DSkin();
  static SbBool isSkinLoaded();
  static void setSkinLoaded(SbBool loaded);
  static void free3DSkin(SbString partName);
  static void load3DSkin(SbString partName);
 
  virtual void show3D(SbBool show);
  SbVec3f get3DParentTranslation();
  virtual void set3DParentTranslation(SbVec3f& tsl);
  void apply3DParentTranslation();  // this method need to be applied in each component create method.
 
  SbBool isBuilt3D();
  SbBool canBeTraversed();
  void setBuilt3D(SbBool built);
  void setCanBeTraversed(SbBool enable);
 
  virtual void change3DPosition() {};
  virtual void change3DWidgetEnable(SbBool state);
 
private:
 
  SO_DG_CATALOG_ENTRY_HEADER(geomSwitch);
 
  SoGetBoundingBoxAction* m_boundingBoxAction;
  SoSearchAction* m_searchAction;
  SoGetMatrixAction* m_getMatrixAction;
  SoPickStyle* m_enableNode;
  SoMaterial* m_enableMaterial;
 
  SbBool isLabelCachedBBox();
  void setLabelCacheBBox(SbBox3f bBox);
  SbBox3f getLabelCachedBBox();
 
  virtual void change3DEnable();
  virtual void change3DLabel();
  virtual void change3DLabelAlignment() {};
 
  void loadFontProperties();
  void undoTransformMatrix(SoNode* searchInNode, SoTransform* tsf);
#ifndef HIDDEN_FROM_DOC
  void writeNode(char* file);
#endif
 
  static void readDefaultSkinsParts( const SbString& fileName, char* defaultSkin );
 
  float compute3DDepth(SoNode* node);
  void apply3DTranslation(SoNode* node, float& variable, SbVec3f& vec);
 
  SbBool m_is3DVisible;
  static SoDialogViz* m_lastActive;
 
  static void set3DCurrentActive(SoDialogViz* dvNode);
  virtual void set3DInactive();
 
  static int insertTextTo3DText(SbString addStr, SoText3 * text, int line, int pos);
  static int wrap3DTextLine(SoText3* text, int line, float maxWidth, SoGroup* textProp, SoDialogViz* dv);
 
private:
  SbBox3f m_labelCachedBBox;
  static SbBool m_isSkinLoaded;
 
  SbBool m_isBuilt3D;
  SbBool m_canBeTraversed;
 
  static SbString s_skinsPath;
 
  SoTranslation *m_parentTranslation;
  SbVec3f m_3DParentTranslation;
 
  void create3DDialogViz();
 
  static SoGroup *readFromFile( const SbString& fileName );
#ifndef SOQT
#ifndef _WIN32
  static XFontStruct *requestInstalledFont();
#endif
#endif
 
};
 
#endif // _SO_DIALOG_VIZ_