SoWinColorWheel.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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_WIN_COLOR_WHEEL_
#define  _SO_WIN_COLOR_WHEEL_
 
#include <Inventor/Win/SoWinBeginStrict.h>
#include <Inventor/SbColor.h>
#include <Inventor/SbLinear.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/Win/SoWinGLWidget.h>
 
class SoWinMouse;
 
// callback function prototypes
typedef void SoWinColorWheelCB(void *userData, const float hsv[3]);
                                           
//
//  Class: SoWinColorWheel
//
//      Lets you interactively select colors using a color wheel. User register
//  callback(s) to be notified when a new color has been selected. There is
//  also a call to tell the color wheel what the current color is when it is
//  changed externally.
//
 
{
 
 public:
    
  SoWinColorWheel(
                  SoWidget parent = NULL,
                  const char *name = NULL, 
                  SbBool buildInsideParent = TRUE);
  ~SoWinColorWheel();
    
  //
  // Routine to tell the color wheel what the current HSV color is.
  //
  // NOTE: if calling setBaseColor() changes the marker position the
  // valueChanged callbacks will be called with the new hsv color.
  //
  void        setBaseColor(const float hsv[3]);
  const float *getBaseColor()         { return hsvColor; }
    
  //
  // This routine sets the WYSIWYG (What You See Is What You Get) mode.
  // When WYSIWYG is on the colors on the wheel will reflect the current
  // color intensity (i.e. get darker and brighter)
  //
  void        setWYSIWYG(SbBool trueOrFalse);    // default FALSE
  SbBool      isWYSIWYG()             { return WYSIWYGmode; }
    
  //
  // Those routines are used to register callbacks for the different 
  // color wheel actions.
  //
  // NOTE: the start and finish callbacks are only to signal when the mouse
  // goes down and up. No valid callback data is passed (NULL passed).
  //
  void    addStartCallback(
                           SoWinColorWheelCB *f,
                           void *userData = NULL)
    { startCallbacks->addCallback((SoCallbackListCB *) f, userData); }
 
  void    addValueChangedCallback(
                                  SoWinColorWheelCB *f, 
                                  void *userData = NULL)
    { changedCallbacks->addCallback((SoCallbackListCB *) f, userData); }
        
  void    addFinishCallback(
                            SoWinColorWheelCB *f,
                            void *userData = NULL)
    { finishCallbacks->addCallback((SoCallbackListCB *) f, userData); }
                                       
  void    removeStartCallback(
                              SoWinColorWheelCB *f,
                              void *userData = NULL)
    { startCallbacks->removeCallback((SoCallbackListCB *) f, userData); }
 
  void    removeValueChangedCallback(
                                     SoWinColorWheelCB *f,
                                     void *userData = NULL)
    { changedCallbacks->removeCallback((SoCallbackListCB *) f, userData); }
 
  void    removeFinishCallback(
                               SoWinColorWheelCB *f,
                               void *userData = NULL)
    { finishCallbacks->removeCallback((SoCallbackListCB *) f, userData); }
        
        
  // true while the color is changing interactively
  SbBool  isInteractive()                     { return interactive; }
 
 private:  
 
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoWinColorWheel::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoWinColorWheel(
                    SoWidget parent,
                    const char *name, 
                    SbBool buildInsideParent, 
                    SbBool buildNow);
 
  SoWidget          buildWidget(SoWidget parent);
 
 private:
    
  // redefine these to do color wheel specific things
  virtual void    redraw();
  virtual void    redrawOverlay();
  virtual void    processEvent(XAnyEvent *anyevent);
  virtual void    sizeChanged(const SbVec2s &newSize);
    
  // color wheels local variables
  SbBool      WYSIWYGmode;
  SbBool      blackMarker;
  float       hsvColor[3];
  short       cx, cy, radius;
  SbColor     *defaultColors, *colors;
  SbVec2f     *geometry;
  SoWinMouse  *mouse;
    
  // callback variables
  SoCallbackList *startCallbacks;
  SoCallbackList *changedCallbacks;
  SoCallbackList *finishCallbacks;
  SbBool      interactive;
    
  // routines to make the wheel geometry, colors, draw it....
  void    makeWheelGeometry();
  void    makeWheelColors(SbColor *col, float intensity);
  void    drawWheelSurrounding();
  void    drawWheelColors();
  void    checkMarkerColor();
  void    drawWheelMarker();
  void    moveWheelMarker(short x, short y);
 
  // this is called by both constructors
  void constructorCommon(SbBool buildNow);
#ifdef _WIN32
  void SaveUnder(short x,short y);
  void RestoreUnder();
 
  SbBool nSaved;
  int nMarkR,nMarkG,nMarkB;
  short nSaveX,nSaveY;
#ifndef GDISAVE
  unsigned long *pSaveBuf;
#else
  HBITMAP hSaveBits;
  HDC     hSaveDC;
#endif
#endif
};
 
#include <Inventor/Win/SoWinEndStrict.h>
 
#endif  /* _SO_WIN_COLOR_WHEEL_ */