CTK/Libs/Visualization/VTK/Widgets/ctkVTKDiscretizableColorTransferWidget.h

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

  Library:   CTK

  Copyright (c) Kitware Inc.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0.txt

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

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

#ifndef __ctkVTKDiscretizableColorTransferWidget_h
#define __ctkVTKDiscretizableColorTransferWidget_h

// CTK includes
#include "ctkVisualizationVTKWidgetsExport.h"
class ctkVTKDiscretizableColorTransferWidgetPrivate;
class ctkVTKScalarsToColorsComboBox;

// VTK includes
#include <vtkSmartPointer.h>
class vtkAlgorithmOutput;
class vtkDiscretizableColorTransferFunction;
class vtkImageAccumulate;
class vtkPiecewiseFunction;
class vtkScalarsToColors;

// Qt includes
#include <QWidget>
class QCheckBox;
class QLineEdit;
class QSpinBox;
class QToolButton;

class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKDiscretizableColorTransferWidget: public QWidget
{
  Q_OBJECT
  /// This property controls the color of the view.
  /// Dark gray by default.
  /// \accessors viewBackgroundColor() setViewBackgroundColor()
  Q_PROPERTY(QColor viewBackgroundColor READ viewBackgroundColor WRITE setViewBackgroundColor)
public:
  explicit ctkVTKDiscretizableColorTransferWidget(QWidget* parent_ = CTK_NULLPTR);
  virtual ~ctkVTKDiscretizableColorTransferWidget();

  enum ResetVisibleRange
  {
    UNION_DATA_AND_CTF,
    UNION_DATA_AND_VISIBLE,
    ONLY_DATA,
    ONLY_CTF
  };

  enum ResetCTFRange
  {
    CTF,
    DATA,
    VISIBLE
  };

  void copyColorTransferFunction(vtkScalarsToColors* ctf, bool useCtfRange = false);
  vtkDiscretizableColorTransferFunction* discretizableColorTransferFunction() const;

  /// Set/Get the left axis mode.
  /// This controls the axis range computation.
  /// \see vtkScalarsToColorsHistogramChart::SetLeftAxisMode
  void setLeftAxisMode(int mode);
  int leftAxisMode();

  void setHistogramConnection(vtkAlgorithmOutput* input);
  void updateHistogram(bool updateDataRange);

  void setViewBackgroundColor(const QColor& i_color);
  QColor viewBackgroundColor() const;

  ctkVTKScalarsToColorsComboBox* scalarsToColorsSelector() const;

  void setVisibleRange(double min, double max);
  void resetVisibleRange(ResetVisibleRange resetMode);
  void resetVisibleRangeToCTF();

  void setColorTransferFunctionRange(double min, double max);
  void resetColorTransferFunctionRange(ResetCTFRange resetMode);
  void resetCTFRangeToVisible();
  void centerColorTransferFunctionRange();

  void setDataRange(double min, double max);
  void resetRangesToData();

  void clearUndoHistory();

signals:
  void currentScalarsToColorsModified();
  void currentScalarsToColorsChanged(vtkDiscretizableColorTransferFunction* ctf);

public slots:
  void onCurrentPointEdit();
  void onPaletteIndexChanged(vtkScalarsToColors* ctf);
  void onResetRangesButtonClick();
  void onShrinkRangeButtonClick();
  void onExpandRangeButtonClick();
  void onUndoButtonClick();
  void onRangeSliderValueChange(double min, double max);

  void invertColorTransferFunction();
  void setGlobalOpacity(double opacity);
  void setNaNColor();
  void setDiscretize(bool checked);
  void setNumberOfDiscreteValues(int value);

protected:
  QScopedPointer<ctkVTKDiscretizableColorTransferWidgetPrivate> d_ptr;

  double* getColorTransferFunctionRange();
  double* getVisibleRange();
  double* getDataRange();
  void updateCtfWidgets();
  void disableCtfWidgets();
  void enableCtfWidgets();
  void updateHistogram();

private:
  Q_DECLARE_PRIVATE(ctkVTKDiscretizableColorTransferWidget);
  Q_DISABLE_COPY(ctkVTKDiscretizableColorTransferWidget);
};
#endif // __ctkVTKDiscretizableColorTransferWidget_h