SoWinColorEditor.h

/*=======================================================================
 *** 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-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_WIN_COLOR_EDITOR_
#define  _SO_WIN_COLOR_EDITOR_
 
#include <Inventor/sys/port.h>
#ifdef _WIN32
#  include <Inventor/Win/SoWinBeginStrict.h>
#else
#  include <Xm/Xm.h>
#endif
#include <Inventor/SbColor.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/Win/SoWinComponent.h>
 
 
class SoBase;
class SoNodeSensor;
class SoMFColor;
class SoPathList;
class SoSFColor;
class SoSensor;
class SoWinClipboard;
class SoWinColorPatch;
class SoWinColorWheel;
class SoWinColorSlider;
 
class SoMFUInt32;      //Allow attaching to "orderedRGBA" field
 
struct ColorEditorCBData;
 
// callback function prototypes
typedef void SoWinColorEditorCB(void *userData, const SbColor *color);
 
#ifdef _WIN32
class CBitButton ;
#endif
                                           
//
//  Class: SoWinColorEditor
//
//      SoWinColorEditor class which lets you interactively edit a color.
//
 
class  SoWinColorEditor : public SoWinComponent {
    
 public:
  enum Sliders {
    NONE, 
    INTENSITY,
    RGB, 
    HSV, 
    RGB_V, 
    RGB_HSV, 
  };
    
  enum UpdateFrequency {
    CONTINUOUS,
    AFTER_ACCEPT,
  };
    
  SoWinColorEditor(
                   SoWidget parent = NULL,
                   const char *name = NULL, 
                   SbBool buildInsideParent = TRUE);
  ~SoWinColorEditor();
    
  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(
                                              SoWinColorEditorCB *f, 
                                              void *userData = NULL);
  inline void         removeColorChangedCallback(
                                                 SoWinColorEditorCB *f, 
                                                 void *userData = NULL);
 
  void                setColor(const SbColor &color);
  const SbColor &     getColor()      { return baseRGB; }
    
  void                setWYSIWYG(SbBool trueOrFalse);
  SbBool              isWYSIWYG()             { return WYSIWYGmode; }
    
  void        setCurrentSliders(SoWinColorEditor::Sliders whichSliders);
  SoWinColorEditor::Sliders getCurrentSliders()       { return whichSliders; }
    
  void        setUpdateFrequency(SoWinColorEditor::UpdateFrequency freq);
  SoWinColorEditor::UpdateFrequency getUpdateFrequency()
    { return updateFreq; }
 
 
  SbBool alwaysOnTop;
 private:
 
 
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoWinColorEditor::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoWinColorEditor(
                     SoWidget parent,
                     const char *name, 
                     SbBool buildInsideParent, 
                     SbBool buildNow);
    
  // redefine these
  virtual SbString    getDefaultWidgetName() const;
  virtual SbString    getDefaultTitle() const;
  virtual SbString    getDefaultIconTitle() const;
    
 private:
 
#ifdef _WIN32
  POINT sliderPos[6] ;
  POINT sliderLabPos[6] ;
  POINT sliderValPos[6] ;
  RECT areaPos[6] ;
  RECT rcDlg ;
 
  unsigned long sliderId[6] ;
  unsigned long sliderLabId[6] ;
  unsigned long sliderValId[6] ;
  unsigned long areaId[6] ;
  unsigned long nCurrSliderId ;
  unsigned long nCurrEditId ;
 
  HMENU menubar ;
  HGLOBAL hDlgTemplate;
 
  CBitButton *lpleftButton ;
  CBitButton *lprightButton ;
  CBitButton *lpswitchButton ;
 
  void finishBuild() ;
  void getControlPositions() ;
  void hideAllSliders() ;
  void showAllSliders() ;
  void moveSlider(int nSlider,int nPos) ;
  void showSlider(int nSlider) ;
  void hideSlider(int nSlider) ;
  void showControl(int nId) ;
  void hideControl(int nId) ;
  void sizeToArea(int n) ;
  void layoutAccept(WBOOL nReduceOk) ;
  void showArea0() ;
  void showArea1() ;
  void showArea2() ;
  void showArea3() ;
  void showArea4() ;
  void showArea5() ;
 
  static WBOOL CALLBACK mgrDlgProc( Hwnd hdlg, UINT message,
                                    WPARAM wParam, LPARAM lParam );
  static void onCommand(
                        Hwnd hdlg,
                        int id,
                        Hwnd hCtrl,
                        UINT codeNotify ) ;
 
  void handleEdit(
                  int nSlider,
                  Hwnd hEdit,
                  UINT codeNotify) ;
 
  WBOOL handleDrawItem(
                       WPARAM wParam,
                       LPARAM lParam ) ;
 
 
#endif
            
  // 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;
  SoWinColorSlider    *sliders[6];
  SoWinColorWheel     *wheel;
  SoWinColorPatch     *current, *previous;
  ColorEditorCBData *dataId;
  SbPList             menuItems;      // Widgets
  SoWinColorEditor::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;
    
  // copy/paste support
  SoWinClipboard      *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(SoWinColorEditor::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);
 
#ifdef _WIN32
  void buttonsCallback(int id);
#else
  static void buttonsCallback(SoWidget, ColorEditorCBData *, XtPointer);
#endif
  void        buttonPressed(short id);
 
#ifdef _WIN32
  void editMenuCallback(int id);
  void sliderMenuCallback(int id);
#else
  static void editMenuCallback(SoWidget, ColorEditorCBData *, XmAnyCallbackStruct *);
  static void sliderMenuCallback(SoWidget, ColorEditorCBData *, XtPointer);
#endif
 
  static void menuDisplay(SoWidget, SoWinColorEditor *editor, XtPointer);
 
  // this is called by both constructors
  void constructorCommon(SbBool buildNow);
 
};
 
// Inline functions
void
SoWinColorEditor::addColorChangedCallback(
                                          SoWinColorEditorCB *f, 
                                          void *userData)
{ callbackList->addCallback((SoCallbackListCB *) f, userData); }
 
void
SoWinColorEditor::removeColorChangedCallback(
                                             SoWinColorEditorCB *f, 
                                             void *userData)
{ callbackList->removeCallback((SoCallbackListCB *) f, userData); }
 
 
#ifdef _WIN32
#include <Inventor/Win/SoWinEndStrict.h>
#endif
#endif  /* _SO_WIN_COLOR_EDITOR_ */