SoQtColorEditor.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-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Alain Dumesny (MMM yyyy)
**=======================================================================*/
 
#ifndef  _SO_QT_COLOR_EDITOR_
#define  _SO_QT_COLOR_EDITOR_
#include <Inventor/Qt/OivQtCompat.h>
#include <Inventor/SbColor.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/Qt/SoQtComponent.h>
 
#include <qglobal.h>
#include <QPointer>
 
class SoBase;
class SoNodeSensor;
class SoMFColor;
class SoPathList;
class SoSFColor;
class SoSensor;
class SoQtColorPatch;
class SoQtColorWheel;
class SoQtColorSlider;
class QMenuBar;
class QMenu;
class QAction;
class QSlider;
 
class SoMFUInt32;
 
struct ColorEditorCBData;
 
typedef void SoQtColorEditorCB( void* userData, const SbColor* color );
 
 
//
//  Class: SoQtColorEditor
//
//      SoQtColorEditor class which lets you interactively edit a color.
//
 
class  SoQtColorEditor : public SoQtComponent {
 
  Q_OBJECT
 
public:
  
  enum Sliders 
  {
    NONE, 
    INTENSITY,
    RGB, 
    HSV, 
    RGB_V, 
    RGB_HSV 
  };
  
  enum UpdateFrequency 
  {
    CONTINUOUS,
    AFTER_ACCEPT
  };
  
  SoQtColorEditor( QWidget *parent = qApp->activeWindow(),
                   const char *name = NULL,              // a QDialog even if he has no direct parent
                   SbBool buildInsideParent = TRUE );
  ~SoQtColorEditor();
  
  void          attach(SoSFColor *color, SoBase *node);
  void  attach(SoMFColor *color, int index, SoBase *node);
  
  void  attach(SoMFUInt32 *color, int index, SoBase *node);
  
  void          detach();
  SbBool                isAttached()            { return attached; }
  
  inline void           addColorChangedCallback( SoQtColorEditorCB *f, 
                                                 void *userData = NULL );
  inline void           removeColorChangedCallback( SoQtColorEditorCB *f, 
                                                    void *userData = NULL );
  
  void          setColor(const SbColor &color);
  const SbColor &       getColor()      { return baseRGB; }
  
  void          setWYSIWYG(SbBool trueOrFalse);
  SbBool                isWYSIWYG()             { return WYSIWYGmode; }
  
  void          setCurrentSliders(SoQtColorEditor::Sliders whichSliders);
  SoQtColorEditor::Sliders getCurrentSliders()  { return whichSliders; }
  
  void  setUpdateFrequency(SoQtColorEditor::UpdateFrequency freq);
  SoQtColorEditor::UpdateFrequency getUpdateFrequency()
  { return updateFreq; }
  
  virtual void          show();
 
  virtual void          hide();
  
  SbBool alwaysOnTop;
 
private:
      
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoQtColorEditor::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
  SoQtColorEditor(
                  QWidget *parent,
                  const char *name, 
                  SbBool buildInsideParent, 
                  SbBool buildNow);
    
  // redefine these
  virtual SbString    getDefaultWidgetName() const;
  virtual SbString    getDefaultTitle() const;
  virtual SbString    getDefaultIconTitle() const;
    
private:
 
  QMenuBar* menubar ;
    
  int nCurrSliderId;
  QPointer<QMenu> menu_sliders, edit;
  QPointer<SoQtButton> lpleftButton ;
  QPointer<SoQtButton> lprightButton ;
  QPointer<SoQtButton> lpswitchButton ;
 
  QAction* edAcCon, *edAcMan, *edAcWy;
  QAction* msAcNone, *msAcInt, *msAcRGB, *msAcHSV, *msAcRGB_V, *msAcRGB_HSV;
    
  // redefine these to do colorEditor specific things
  QWidget*            buildWidget(QWidget *parent);
    
  // local variables
  QPointer<QWidget>                   mgrWidget;
  SbBool                    WYSIWYGmode;
  Sliders           whichSliders;
  SbColor                   baseRGB;
  float                       baseHSV[3];
  SbBool              ignoreCallback;
  SoQtColorSlider     *sliders[6];
  SoQtColorWheel      *wheel;
  SoQtColorPatch      *current, *previous;
  ColorEditorCBData *dataId;
  SbPList             menuItems;      // Widgets
  SoQtColorEditor::UpdateFrequency    updateFreq;
    
  // attach/detach variables
  SbBool              attached;
  SoBase              *editNode;
  SoSFColor           *colorSF;
  SoMFColor           *colorMF;
  SoNodeSensor        *colorSensor;
  SoCallbackList      *callbackList;
  int                 index;
    
  // additional attach variables for handling "orderedRGBA" fields
  SoMFUInt32      *colorUInt32MF;
  float            transparency;
        
  // list of widgets which need to be accessed
  QPointer<SoQtButton> acceptButton;
  QWidget    *wheelForm;
    
  // build/destroy routines
  QMenuBar*             buildPulldownMenu(QWidget *parent);
  void            buildControls(QWidget *parent);
  void                buildSlidersForm(QWidget *parent);
    
  void                doSliderLayout();
  void                doDynamicTopLevelLayout();
  int                 numberOfSliders(SoQtColorEditor::Sliders slider);
    
    
  // do the updates - if attached, update the node; if callback, call it.
  void        doUpdates();
    
  // color field sensor callback and routine
  void        fieldChanged();
  static void fieldChangedCB(void *, SoSensor *);
 
    
  // callbacks and actual routine from sliders, wheel, buttons, menu...
  static void wheelCallback(void *, const float hsv[3]);
  static void wheelCloseCB(void *userData, SoQtComponent *);
 
  void        wheelChanged(const float hsv[3]);
  
  static void sliderCallback(void *, float);
  void        sliderChanged(short id, float value);
 
  void        buttonPressed(short id);
  
  void sliderMenuCallback(int id);
  void editMenuCallback(int id);
    
  // this is called by both constructors
  void constructorCommon(SbBool buildNow);
 
private Q_SLOTS:
 
void slot_none();
  void slot_intensity();
  void slot_rgb();
  void slot_hsv();
  void slot_rgb_v();
  void slot_rgb_hsv();
 
  void slot_continuous();
  void slot_manual();
  void slot_wysiwyg();
 
  void slot_leftButton();
  void slot_rightButton();
  void slot_switchButton();
  void slot_acceptButton();
  void slot_help();
 
  void visibilityChangeCB(SbBool visible);
    
};
 
// Inline functions
void
SoQtColorEditor::addColorChangedCallback(SoQtColorEditorCB *f, 
                                         void *userData)
{ callbackList->addCallback((SoCallbackListCB *) f, userData); }
 
void
SoQtColorEditor::removeColorChangedCallback(SoQtColorEditorCB *f, 
                                            void *userData)
{ callbackList->removeCallback((SoCallbackListCB *) f, userData); }
 
 
#endif  /* _SO_QT_COLOR_EDITOR_ */