SoWinColorSlider.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_SLIDER_
#define  _SO_WIN_COLOR_SLIDER_
 
#include <Inventor/Win/SoWinBeginStrict.h>
 
#include <Inventor/Win/SoWinSlider.h>
 
class SbColor;
class SbVec2f;
 
 
//
//  Class: SoWinColorSlider
//
//      This class defines the color slider which is a set of predefined
//  sliders (R, G, B, H, S, V,..) with special behaviors.
//
 
 
{
  
 public:
  
  //
  // list of color sliders types
  //
  enum Type {
    RED_SLIDER, 
    GREEN_SLIDER, 
    BLUE_SLIDER, 
    HUE_SLIDER, 
    SATURATION_SLIDER, 
    VALUE_SLIDER, 
    INTENSITY_SLIDER // independent of the slider value
  };
  
  // Constructor/Destructor
  SoWinColorSlider(SoWidget parent = NULL,
                   const char *name = NULL, 
                   SbBool buildInsideParent = TRUE, 
                   Type type = INTENSITY_SLIDER);
  
  ~SoWinColorSlider();
  
  //
  // Routine used to specify the slider value and also the top region
  // color (WYSIWYGmode in most cases). Users should call this routine 
  // instead of the base class setValue() routine if they want the color 
  // slider top region to correctly reflect the current color.
  // (code is optimized for WYSIWYGmode off)
  //
  // NOTE: routine expects
  //        an rgb color for R, G or B slider type
  //        an hsv color for H, S, or V slider type
  //        an rgb color for Intensity slider type
  //
  // NOTE: if calling setBaseColor() changes the thumb position the
  // valueChanged callbacks will be called with the new value.
  //
  void setBaseColor(const float rgbOrHsv[3], SbBool updateText = TRUE);
  const float *getBaseColor() { return color; }
  
  //
  // This routine sets the WYSIWYG (What You See Is What You Get) mode
  // to be true or false (default FALSE). Immediate mode.
  // This has no effect on monochrome sliders.
  //
  void  setWYSIWYG(SbBool trueOrFalse);    // default FALSE
  SbBool isWYSIWYG() { return WYSIWYGmode; }
  
  // returns the type of the slider
  SoWinColorSlider::Type getType() { return type; }
  
 private:
  
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoWinSlider::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoWinColorSlider(SoWidget parent,
                     const char *name, 
                     SbBool buildInsideParent, 
                     Type type,
                     SbBool buildNow);
  
  // redefine this routine to cache slider top geometry
  virtual void sizeChanged(const SbVec2s &newSize);
  
  // redefine this routine to do the actual slider top region drawing.
  // This routine is automatically called by the SoWinSlider::redraw() routine.
  virtual void drawSliderTopRegion();
  
 private:
  
  // local vars
  Boolean WYSIWYGmode;
  Type type;
  float color[3];
  SbColor *defaultColors, *colors;
  SbVec2f *geometry;
  
  // routine that make the default and WYSIWYG colors
  void makeDefaultColors();
  void makeWYSIWYGcolors();
  
  static void sliderChangedCB(void *, float val);
  
  // this is called by both constructors
  void constructorCommon(SoWinColorSlider::Type type, SbBool buildNow);
};
 
#include <Inventor/Win/SoWinEndStrict.h>
 
 
#endif  /* _SO_WIN_COLOR_SLIDER_ */