SoDialogCheckBox.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_CHECK_BOX_
#define  _SO_DIALOG_CHECK_BOX_
 
#include <DialogViz/dialog/SoDialogComponent.h>
 
class SoDialogCheckBoxAuditor;
class SoText3;
class SoSeparator;
class SoSwitch;
 
class  SoDialogCheckBox : public SoDialogComponent  
{
  SO_DG_HEADER(SoDialogCheckBox);
 
 public:
 
  SoSFBool state;
 
  SoSFString  onString;
 
  SoSFString  offString;
 
  SoDialogCheckBox();
 
  void addAuditor(SoDialogCheckBoxAuditor* auditor);
 
  void removeAuditor(SoDialogCheckBoxAuditor* auditor);
 
  /*==============================================================================*/
 
 private:
  static  void    initClass();
  static  void    exitClass();
  virtual void    buildWidget(SoWidget parent, SbVec2i32 &rSize, SbVec2i32 & pos, SbBool isActive2d);
  virtual void    destroyWidget();
  virtual void    eventNotify(unsigned int event, uintptr_t param);
  virtual SoWidget  getLabelWidget();
  virtual void    updateFromSensor(SoSensor* sensor);
 
  void updateLabelWidget();
  void updateCheckBoxWidget();
 
  void applyDlgCptAuditor();
 
 private:
  SoWidget  m_checkBoxWidget;
          
  virtual ~SoDialogCheckBox();
 
  /* === FIELDS DECLARATION === */
  FIELD_SENSOR(state);
  FIELD_SENSOR(onString);
  FIELD_SENSOR(offString);
 
  // local change methods
  void changeOnOffString();
 
 private:
 
  SbVec2i32 m_oonSize, m_ooffSize, m_olSize;
 
 
  /* === SIZE COMPUTING METHODS === */
  virtual SbVec2i32 getComponentInitSize();
  virtual void getDefaultSize(SbVec2i32 &size, SbVec2i32 &min, SbVec2i32 &max);
 
  /* === CREATION METHODS === */
  void createLabelWidget();
  void createCheckBoxWidget();
 
  // local change methods
  void changeState();
 
  // inherited change methods from SoDialogComponent
  virtual void changeLabelVisibility();
  virtual void changeEdgeStyle();
 
  // inherited change methods from SoDialogViz
  virtual void changeEnable();
  virtual void changeWidgetEnable(SbBool state);
  virtual void changeLabel();
  virtual void changeLabelAlignment();
 
// 3D methods
private:
  static char* DialogCheckBox; // Internal default skins.
  static void change3DSkin();
  static SbBool isSkinLoaded();
  static void setSkinLoaded(SbBool loaded);
 
private:
  SO_DG_CATALOG_ENTRY_HEADER(frameSep);
  SO_DG_CATALOG_ENTRY_HEADER(frame);
  SO_DG_CATALOG_ENTRY_HEADER(stateSep);
  SO_DG_CATALOG_ENTRY_HEADER(stateSwitch);
  SO_DG_CATALOG_ENTRY_HEADER(stateOn);
  SO_DG_CATALOG_ENTRY_HEADER(stateOff);
  SO_DG_CATALOG_ENTRY_HEADER(labelSep);
  SO_DG_CATALOG_ENTRY_HEADER(labelSwitch);
  SO_DG_CATALOG_ENTRY_HEADER(labelProp);
  SO_DG_CATALOG_ENTRY_HEADER(onOffStringSep);
  SO_DG_CATALOG_ENTRY_HEADER(onOffStringProp);
 
  SoText3 *checkBoxString, *checkBoxLabel;
  SoTranslation *checkBoxLabelTranslation, *checkBoxButtonTranslation;
  SoTranslation *checkBoxStringTranslation, *checkBoxFrameTranslation;
  SoScale *checkBoxFrameScale;
  SoTransform *checkBoxFrameTransform;
 
  virtual void change3DState();
  void change3DOnOffString();
 
private:
  SbBox3f m_checkStringCachedBBox;
 
  void create3DDialogCheckBox();
  void update3DCheckBox();
  void update3DLabel();
 
  virtual void change3DLabelVisibility();
  void change3DLabel();
  virtual void change3DLabelAlignment();
 
  static void finishCB3D( void *, SoDragger *inDragger );
  virtual void draggerFinishCallback3D();
 
  static SbBool m_isSkinLoaded;
 
 
};
 
#endif // _SO_DIALOG_CHECK_BOX_