SoDialogEditText.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_EDIT_TEXT_
#define  _SO_DIALOG_EDIT_TEXT_
 
#include <DialogViz/dialog/SoDialogComponent.h>
 
class SoDialogEditTextAuditor;
class SoEventCallback;
class SoClipPlane;
class SbLineProjector;
 
class  SoDialogEditText : public SoDialogComponent  
{
  SO_DG_HEADER(SoDialogEditText);
 
 public:
 
  SoSFString editText;
 
  SoSFBool editable;
 
  SoSFBool multiLine;
 
  SoSFBool wrapLine;
 
  SoSFBool trigOnEnter;
 
  SoSFBool isNumeric;
 
  SoDialogEditText();
 
  void addAuditor(SoDialogEditTextAuditor* auditor);
 
  void removeAuditor(SoDialogEditTextAuditor* auditor);
 
  /*==============================================================================*/
 private:
  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();
  static  void   initClass();
  static  void   exitClass();
  virtual void   updateFromSensor(SoSensor* sensor);
  void      processEvent(SbBool force);
 
  void      updateLabelWidget();                // update label widget position and size
  void      updateEditTextWidget();             // update edit widget position and size
 
  void   applyDlgCptAuditor();
 
private:
  SoWidget m_editTextWidget;
          
  virtual        ~SoDialogEditText();
 
private:
  SbVec2i32 m_oeSize, m_olSize;
  SbBool m_fromSensor;
 
  void createLabelWidget();
  void createEditTextWidget();
  virtual SbVec2i32 getComponentInitSize();
  virtual void getDefaultSize(SbVec2i32 &size, SbVec2i32 &min, SbVec2i32 &max);
 
  virtual void changeEditable();
  virtual void changeMultiLine();
  virtual void changeWrapLine();
  virtual void changeEditText();
  virtual void changeEnable();                     // update edit and label widget state
  virtual void changeWidgetEnable(SbBool state);
  virtual void changeLabel();                      // change the label widget text
  virtual void changeLabelAlignment();             // change the label widget alignment
  virtual void changeLabelVisibility();            // show or hide the label widget.
  virtual void changeEdgeStyle();
 
  virtual void setFocus();                         // set focus to current edit area
 
  // Declare Field Sensors.
  FIELD_SENSOR(editText);
  FIELD_SENSOR(editable);
  FIELD_SENSOR(multiLine);
  FIELD_SENSOR(wrapLine);
 
// 3D methods
private:
  static char* DialogEditText; // Internal default skins.
  static void change3DSkin();
  static SbBool isSkinLoaded();
  static void setSkinLoaded(SbBool loaded);
  void insertCharTo3DText(char c);
  void removeCharIn3DText();
 
private:
  SO_DG_CATALOG_ENTRY_HEADER( labelSep      );
  SO_DG_CATALOG_ENTRY_HEADER( labelSwitch   );
  SO_DG_CATALOG_ENTRY_HEADER( labelProp     );
 
  SO_DG_CATALOG_ENTRY_HEADER( scrollVSwitch );
  SO_DG_CATALOG_ENTRY_HEADER( downSep       );
  SO_DG_CATALOG_ENTRY_HEADER( downSwitch    );
  SO_DG_CATALOG_ENTRY_HEADER( downPressed   );
  SO_DG_CATALOG_ENTRY_HEADER( downReleased  );
  SO_DG_CATALOG_ENTRY_HEADER( upSep         );
  SO_DG_CATALOG_ENTRY_HEADER( upSwitch      );
  SO_DG_CATALOG_ENTRY_HEADER( upPressed     );
  SO_DG_CATALOG_ENTRY_HEADER( upReleased    );
  SO_DG_CATALOG_ENTRY_HEADER( scrollVSep    );
  SO_DG_CATALOG_ENTRY_HEADER( scrollVBack   );
  SO_DG_CATALOG_ENTRY_HEADER( scrollVFrame  );
  SO_DG_CATALOG_ENTRY_HEADER( cursorVSep    );
  SO_DG_CATALOG_ENTRY_HEADER( cursorVFrame  );
 
  SO_DG_CATALOG_ENTRY_HEADER( scrollHSwitch );
  SO_DG_CATALOG_ENTRY_HEADER( leftSep       );
  SO_DG_CATALOG_ENTRY_HEADER( leftSwitch    );
  SO_DG_CATALOG_ENTRY_HEADER( leftPressed   );
  SO_DG_CATALOG_ENTRY_HEADER( leftReleased  );
  SO_DG_CATALOG_ENTRY_HEADER( rightSep      );
  SO_DG_CATALOG_ENTRY_HEADER( rightSwitch   );
  SO_DG_CATALOG_ENTRY_HEADER( rightPressed  );
  SO_DG_CATALOG_ENTRY_HEADER( rightReleased );
  SO_DG_CATALOG_ENTRY_HEADER( scrollHSep    );
  SO_DG_CATALOG_ENTRY_HEADER( scrollHBack   );
  SO_DG_CATALOG_ENTRY_HEADER( scrollHFrame  );
  SO_DG_CATALOG_ENTRY_HEADER( cursorHSep    );
  SO_DG_CATALOG_ENTRY_HEADER( cursorHFrame  );
 
  SO_DG_CATALOG_ENTRY_HEADER( editSep       );
  SO_DG_CATALOG_ENTRY_HEADER( frameSep      );
  SO_DG_CATALOG_ENTRY_HEADER( frameSwitch   );
  SO_DG_CATALOG_ENTRY_HEADER( frame         );
  SO_DG_CATALOG_ENTRY_HEADER( editFrame     );
  SO_DG_CATALOG_ENTRY_HEADER( textSep       );
  SO_DG_CATALOG_ENTRY_HEADER( textProp      );
 
  SO_DG_CATALOG_ENTRY_HEADER( caretSep      );
  SO_DG_CATALOG_ENTRY_HEADER( caretSwitch   );
  SO_DG_CATALOG_ENTRY_HEADER( caretFrame    );
 
private:
 
  SoText3 *editTextText, *editTextLabel;
  SoTranslation *editTextLabelTranslation, *editTextFrameTranslation;
  SoTranslation *editTextTextTranslation, *scrollVCursorTranslation, *scrollHCursorTranslation;
  SoTranslation *editTextDownTranslation, *editTextUpTranslation;
  SoTranslation *editTextLeftTranslation, *editTextRightTranslation;
  SoTranslation *editTextScrollVTranslation, *scrollVCursorPosTranslation, *editTextCaretTranslation;
  SoTranslation *editTextScrollHTranslation, *scrollHCursorPosTranslation, *editTextScrollTextTranslation;
  SoScale *editTextFrameScale;
  SoScale *editTextButtonScale, *editTextScrollVScale, *editTextScrollHScale;
  SoScale *scrollVCursorScale, *scrollHCursorScale, *editTextCaretScale;
  SoTransform *editTextFrameTransform, *scrollVFrameTransform, *scrollHFrameTransform;
  SoClipPlane *editTextClipPlaneTop, *editTextClipPlaneBottom;
  SoClipPlane *editTextClipPlaneLeft, *editTextClipPlaneRight;
 
  SoEventCallback* eventCB;
  SbBool m_isEditing;
  SbLineProjector* m_lineProj;
  SbVec3f m_initialVPos, m_initialHPos;
  int m_currentPos;
  int m_current3DLine;
  int m_current3DCaretPos;
 
  SbBox3f m_textCachedBBox;
 
  void create3DDialogEditText();
  void update3DEditText();
  void update3DLabel();
  void update3DCursors();
  void update3DScrollBars();
  void update3DTextPosition();
  void update3DTextScrollPosition();
  void move3DCursor(float inc);
  void move3DCaret(int line, int pos);
  void update3DTextCache(int prevLine);
  void apply3DEvent(SbString str);
 
  void change3DEditText();
  virtual void change3DLabelVisibility();
  virtual void change3DLabel();
  virtual void change3DLabelAlignment();
  virtual void set3DInactive();
 
  static void startCB3D( void *, SoDragger *inDragger );
  static void motionCB3D( void *, SoDragger *inDragger );
  static void finishCB3D( void *, SoDragger *inDragger );
  static void processKeyEvents(void *inDragger, SoEventCallback *cb);
  void draggerStartCallback3D();
  void draggerMotionCallback3D();
  void draggerFinishCallback3D();
 
  void finish3DEditing();
 
  static SbBool m_isSkinLoaded;
 
 
};
 
#endif // _SO_DIALOG_EDIT_TEXT_