vtkKWColorPresetMenu.h

Go to the documentation of this file.

/*=========================================================================

  Module:    $RCSfile: vtkKWColorPresetMenu.h,v $

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkKWColorPresetMenu_h
#define __vtkKWColorPresetMenu_h

#include "vtkKWMenuButtonWithLabel.h"

class vtkColorTransferFunction;
class vtkKWColorPresetMenuInternals;

class KWWidgets_EXPORT vtkKWColorPresetMenu : public vtkKWMenuButtonWithLabel
{
// @cond section_public
public:
  static vtkKWColorPresetMenu* New();
  vtkTypeRevisionMacro(vtkKWColorPresetMenu,vtkKWMenuButtonWithLabel);
  void PrintSelf(ostream& os, vtkIndent indent);


  virtual void SetColorTransferFunction(vtkColorTransferFunction *p);
  vtkGetObjectMacro(ColorTransferFunction,vtkColorTransferFunction);


  vtkGetVector2Macro(ScalarRange, double);
  vtkSetVector2Macro(ScalarRange, double);
  vtkGetMacro(ApplyPresetBetweenEndPoints, int);
  vtkSetMacro(ApplyPresetBetweenEndPoints, int);
  vtkBooleanMacro(ApplyPresetBetweenEndPoints, int);


  virtual int AddPreset(
    const char *name, vtkColorTransferFunction *func, double range[2]);


  virtual int RemovePreset(const char *name);
  virtual int RemoveAllPresets();


  virtual int AddSolidRGBPreset(const char *name, double rgb[3]);
  virtual int AddSolidRGBPreset(const char *name, double r,double g, double b);
  virtual int AddSolidHSVPreset(const char *name, double hsv[3]);
  virtual int AddSolidHSVPreset(const char *name, double h,double s, double v);


  virtual int AddGradientRGBPreset(
    const char *name, double rgb1[3], double rgb2[3]);
  virtual int AddGradientRGBPreset(
    const char *name, 
    double r1, double g1, double b1, 
    double r2, double g2, double b2);
  virtual int AddGradientHSVPreset(
    const char *name, double hsv1[3], double hsv2[3]);
  virtual int AddGradientHSVPreset(
    const char *name, 
    double h1, double s1, double v1, 
    double h2, double s2, double v2);


  virtual int AddFlagRGBPreset(
    const char *name, int nb_colors, double **rgb, int repeat);


  vtkGetMacro(PreviewSize, int);
  virtual void SetPreviewSize(int);


  vtkGetMacro(SolidColorPresetsVisibility, int);
  vtkBooleanMacro(SolidColorPresetsVisibility, int);
  virtual void SetSolidColorPresetsVisibility(int);


  vtkGetMacro(GradientPresetsVisibility, int);
  vtkBooleanMacro(GradientPresetsVisibility, int);
  virtual void SetGradientPresetsVisibility(int);


  vtkGetMacro(PresetNameVisibility, int);
  vtkBooleanMacro(PresetNameVisibility, int);
  virtual void SetPresetNameVisibility(int);

  virtual void SetPresetSelectedCommand(vtkObject *object, const char *method);

  virtual void PresetSelectedCallback(const char *name);

// @endcond
// @cond section_protected
protected:
  vtkKWColorPresetMenu();
  ~vtkKWColorPresetMenu();

  virtual void CreateWidget();

  double ScalarRange[2];
  vtkColorTransferFunction *ColorTransferFunction;
  int PreviewSize;
  int SolidColorPresetsVisibility;
  int GradientPresetsVisibility;
  int ApplyPresetBetweenEndPoints;
  int PresetNameVisibility;

  char *PresetSelectedCommand;
  virtual void InvokePresetSelectedCommand(const char *name);

  // PIMPL Encapsulation for STL containers

  vtkKWColorPresetMenuInternals *Internals;


  virtual int HasPreset(const char *name);
  virtual int AllocatePreset(const char *name);


  virtual vtkColorTransferFunction* GetPresetColorTransferFunction(
    const char *name);

  virtual void CreateDefaultPresets();


  virtual int MapColorTransferFunction(
    vtkColorTransferFunction *source, double source_range[2],
    vtkColorTransferFunction *target, double target_range[2]);


  virtual int CreateColorTransferFunctionPreview(
    vtkColorTransferFunction *func, const char *img_name);

  virtual void PopulatePresetMenu();

// @endcond
// @cond section_private
private:
  vtkKWColorPresetMenu(const vtkKWColorPresetMenu&); // Not implemented
  void operator=(const vtkKWColorPresetMenu&); // Not Implemented
};

#endif

// @endcond

---