SoXtColorEditor.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      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifdef SOQT
#  include <Inventor/Qt/SoQtColorEditor.h>
#elif defined(_WIN32)
#  include <Inventor/Win/SoWinColorEditor.h>
#else // _WIN32
 
#ifndef  _SO_XT_COLOR_EDITOR_
#define  _SO_XT_COLOR_EDITOR_
 
#include <Xm/Xm.h>
#include <Inventor/SbColor.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/Xt/SoXtComponent.h>
 
class SoBase;
class SoNodeSensor;
class SoMFColor;
class SoPathList;
class SoSFColor;
class SoSensor;
class SoXtClipboard;
class SoXtColorPatch;
class SoXtColorWheel;
class SoXtColorSlider;
 
class SoMFUInt32;
 
struct _ColorEditorCBData;
 
// callback function prototypes
typedef void SoXtColorEditorCB(void *userData, const SbColor *color);
        
//
//  Class: SoXtColorEditor
//
// SoXtColorEditor class which lets you interactively edit a color.
//
 
class  SoXtColorEditor : public SoXtComponent {
  
 public:
 
  enum Sliders {
    NONE, 
    INTENSITY,
    RGB, 
    HSV, 
    RGB_V, 
    RGB_HSV
  };
  
  enum UpdateFrequency {
    CONTINUOUS,
    AFTER_ACCEPT
  };
  
  SoXtColorEditor(SoWidget parent = NULL,
                  const char *name = NULL, 
                  SbBool buildInsideParent = TRUE);
  ~SoXtColorEditor();
  
  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(SoXtColorEditorCB *f, void *userData = NULL);
  inline void removeColorChangedCallback(SoXtColorEditorCB *f, void *userData = NULL);
  
  void setColor(const SbColor &color);
  const SbColor & getColor() { return baseRGB; }
  
  void setWYSIWYG(SbBool trueOrFalse);
  SbBool isWYSIWYG() { return WYSIWYGmode; }
  
  void setCurrentSliders(SoXtColorEditor::Sliders whichSliders);
  SoXtColorEditor::Sliders getCurrentSliders() { return whichSliders; }
  
  void setUpdateFrequency(SoXtColorEditor::UpdateFrequency freq);
  SoXtColorEditor::UpdateFrequency getUpdateFrequency() { return updateFreq; }
  
 private:
  
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoXtColorEditor::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoXtColorEditor(SoWidget parent,
                    const char *name, 
                    SbBool buildInsideParent, 
                    SbBool buildNow);
  
  // redefine these
  virtual SbString getDefaultWidgetName() const;
  virtual SbString getDefaultTitle() const;
  virtual SbString getDefaultIconTitle() const;
  
 private:
  
  // redefine these to do colorEditor specific things
  SoWidget buildWidget(SoWidget parent);
  static void visibilityChangeCB(void *pt, SbBool visible);
  
  // local variables
  SoWidget mgrWidget; // form manages all child widgets
  SbBool WYSIWYGmode;
  Sliders whichSliders;
  SbColor baseRGB;
  float baseHSV[3];
  SbBool ignoreCallback;
  SoXtColorSlider *sliders[6];
  SoXtColorWheel *wheel;
  SoXtColorPatch *current, *previous;
  _ColorEditorCBData *dataId;
  SbPList menuItems;   // Widgets
  SoXtColorEditor::UpdateFrequency updateFreq;
  
  // attach/detach variables
  SbBool attached;
  SoBase *editNode;
  SoSFColor *colorSF;
  SoMFColor *colorMF;
  SoNodeSensor *colorSensor;
  SoCallbackList *callbackList;
  int index;
  
  // Extension (mmh)
  // additional attach variables for handling "orderedRGBA" fields
  SoMFUInt32 *colorUInt32MF;
  float transparency;
  
  // copy/paste support
  SoXtClipboard *clipboard;
  void copy(Time eventTime);
  void paste(Time eventTime);
  void pasteDone(SoPathList *pathList);
  static void pasteDoneCB(void *userData, SoPathList *pathList);
  
  // list of widgets which need to be accessed
  SoWidget acceptButton, slidersForm, buttonsForm, wheelForm;
  
  // build/destroy routines
  SoWidget buildPulldownMenu(SoWidget parent);
  SoWidget buildControls(SoWidget parent);
  SoWidget buildSlidersForm(SoWidget parent);
  
  void doSliderLayout();
  void doDynamicTopLevelLayout();
  int numberOfSliders(SoXtColorEditor::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]);
  void wheelChanged(const float hsv[3]);
  static void sliderCallback(void *, float);
  void sliderChanged(short id, float value);
  static void buttonsCallback(SoWidget, _ColorEditorCBData *, XtPointer);
  void buttonPressed(short id);
  static void editMenuCallback(SoWidget, _ColorEditorCBData *, XmAnyCallbackStruct *);
  static void sliderMenuCallback(SoWidget, _ColorEditorCBData *, XtPointer);
  
  static void menuDisplay(SoWidget, SoXtColorEditor *editor, XtPointer);
  
  // this is called by both constructors
  void constructorCommon(SbBool buildNow);
  // Function used to create strings in motif buttons/menus.
  void initStrings( void );
 
};
 
// Inline functions
void
SoXtColorEditor::addColorChangedCallback(SoXtColorEditorCB *f, void *userData)
{
  callbackList->addCallback((SoCallbackListCB *)f, userData);
}
 
void
SoXtColorEditor::removeColorChangedCallback(SoXtColorEditorCB *f, void *userData)
{
  callbackList->removeCallback((SoCallbackListCB *)f, userData);
}
 
#endif  /* _SO_XT_COLOR_EDITOR_ */
 
#endif // _WIN32