SoGuiComponent.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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : T.MEHAMLI (Jun 2007)
**=======================================================================*/
 
#ifndef SO_GUI_COMPONENT_H
#define SO_GUI_COMPONENT_H
 
//
//  Class: SoGuiComponent
//
// SoXXComponent implementation class
// 
//
 
 
#include <ScaleViz/viewers/SoGuiBase.h>
#include <Inventor/STL/string>
#include <Inventor/SbBasic.h>
 
#ifndef HIDDEN_FROM_DOC
 // Defines used when specifying the glModes flag to the constructor.
 // (used instead of the glx.h defines which do overlap)
#  define SO_GLX_RGB      (1<<0)
#  define SO_GLX_DOUBLE   (1<<1)
#  define SO_GLX_ZBUFFER  (1<<2)
#  define SO_GLX_STEREO   (1<<4)
#  define SO_GLX_STENCIL  (1<<5)
#endif
 
 
class  SoGuiComponent : public SoGuiBase
{
#ifndef HIDDEN_FROM_DOC
  SO_FIELDCONTAINER_HEADER( SoGuiComponent );
#endif
 
private:
 
  SoGuiComponent();
 
  SbBool isTopLevelShell() const;
 
  void setTopLevelShell( const SbBool topLevelShell );
 
  void setFullScreen( const SbBool enable );
 
  SbBool isFullScreen() const;
 
  void setFullScreenEnable( const SbBool enable );
 
  SbBool isFullScreenEnable() const;
 
  void setTitle( const SbString& newTitle );
 
  SbString getTitle() const;
 
  void setIconTitle( const SbString& newIconTitle );
 
  SbString getIconTitle() const;
 
  SbString getWidgetName() const;
 
  void setWidgetName( const SbString& name );
 
  SbString getClassName() const;
 
  // ----------------------- Extension usage -----------------------------------
  
  // Subclasses need to set the class name in the constructor
  // before the widget is built.
  void setClassName( const SbString& n );
 
  void setSynchronize( SbBool synch );
  SbBool getSynchronize();
 
  void setVisible( SbBool visible );
 
  void setIsQt( const SbBool flag )  { m_isQt = flag; }
 
  SbBool isQt() const { return m_isQt; }
 
  void setBaseWidgetHandle( void* _baseWidget ) { m_baseWidgetHandle = _baseWidget; };
  void* getBaseWidgetHandle() const { return m_baseWidgetHandle; };
 
  virtual SbBool bindNormalContext() { return FALSE; };
  virtual SbBool unbindNormalContext() { return FALSE; };
 
private:
 
  virtual ~SoGuiComponent();
 
// ----------------------- Private usage -------------------------------------
private:
 
  SbBool m_topLevelShell; // TRUE if in its own window
  SbString m_name; // name of the widget
  SbString m_title; // title for window if in its own window
  SbString m_iconTitle; // title for icon if in its own window
  SbString m_className;
 
  // For fullscreen mode.
  SbBool m_fullScreenOn;
  SbBool m_fullScreenEnabled;
 
  SbBool m_isQt;
  void* m_baseWidgetHandle;
};
 
#endif // SO_GUI_COMPONENT_H