pqColorOpacityEditorWidget.h

Go to the documentation of this file.

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

   Program: ParaView
   Module:    $RCSfile$

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#ifndef pqColorOpacityEditorWidget_h
#define pqColorOpacityEditorWidget_h

#include "pqApplicationComponentsModule.h"
#include "pqPropertyWidget.h"
#include "pqSMProxy.h"
#include <QList>
#include <QVariant>

class pqColorMapModel;
class vtkImageData;
class vtkPiecewiseFunction;
class vtkSMPropertyGroup;
class vtkPVTransferFunction2D;

class PQAPPLICATIONCOMPONENTS_EXPORT pqColorOpacityEditorWidget : public pqPropertyWidget
{
  Q_OBJECT
  Q_PROPERTY(QList<QVariant> xrgbPoints READ xrgbPoints WRITE setXrgbPoints)
  Q_PROPERTY(QList<QVariant> xvmsPoints READ xvmsPoints WRITE setXvmsPoints)
  Q_PROPERTY(bool showDataHistogram READ showDataHistogram WRITE setShowDataHistogram)
  Q_PROPERTY(bool automaticDataHistogramComputation READ automaticDataHistogramComputation WRITE
      setAutomaticDataHistogramComputation)
  Q_PROPERTY(
    int dataHistogramNumberOfBins READ dataHistogramNumberOfBins WRITE setDataHistogramNumberOfBins)
  Q_PROPERTY(bool useLogScale READ useLogScale WRITE setUseLogScale)
  Q_PROPERTY(bool useLogScaleOpacity READ useLogScaleOpacity WRITE setUseLogScaleOpacity)
  Q_PROPERTY(bool useOpacityControlPointsFreehandDrawing READ useOpacityControlPointsFreehandDrawing
      WRITE setUseOpacityControlPointsFreehandDrawing)
  Q_PROPERTY(pqSMProxy scalarOpacityFunctionProxy READ scalarOpacityFunctionProxy WRITE
      setScalarOpacityFunctionProxy)
  Q_PROPERTY(
    pqSMProxy transferFunction2DProxy READ transferFunction2DProxy WRITE setTransferFunction2DProxy)
  Q_PROPERTY(bool use2DTransferFunction READ use2DTransferFunction WRITE setUse2DTransferFunction)
  Q_PROPERTY(QList<QVariant> transfer2DBoxes READ transfer2DBoxes WRITE setTransfer2DBoxes)

  typedef pqPropertyWidget Superclass;

public:
  pqColorOpacityEditorWidget(
    vtkSMProxy* proxy, vtkSMPropertyGroup* smgroup, QWidget* parent = nullptr);
  ~pqColorOpacityEditorWidget() override;

  QList<QVariant> xrgbPoints() const;

  QList<QVariant> xvmsPoints() const;

  bool useLogScale() const;

  bool useLogScaleOpacity() const;

  bool useOpacityControlPointsFreehandDrawing() const;

  bool showDataHistogram() const;

  bool automaticDataHistogramComputation() const;

  int dataHistogramNumberOfBins() const;

  pqSMProxy scalarOpacityFunctionProxy() const;

  pqSMProxy transferFunction2DProxy() const;

  bool use2DTransferFunction() const;

  QList<QVariant> transfer2DBoxes() const;

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void setXvmsPoints(const QList<QVariant>&);

  void setXrgbPoints(const QList<QVariant>&);

  void setUseLogScale(bool value);

  void setUseLogScaleOpacity(bool value);

  void setUseOpacityControlPointsFreehandDrawing(bool value);

  void setShowDataHistogram(bool value);

  void setAutomaticDataHistogramComputation(bool value);

  void setDataHistogramNumberOfBins(int value);

  void setScalarOpacityFunctionProxy(pqSMProxy sofProxy);

  void setTransferFunction2DProxy(pqSMProxy t2dProxy);

  void resetRangeToData();

  void resetRangeToCustom();

  void resetRangeToDataOverTime();

  void resetRangeToVisibleData();

  void invertTransferFunctions();

  void choosePreset(const char* presetName = nullptr);

  void saveAsPreset();

  void onRangeHandlesRangeChanged(double rangeMin, double rangeMax);

  void resetColorMapComboBox();

  void setUse2DTransferFunction(bool value);

  void setTransfer2DBoxes(const QList<QVariant>&);

  void chooseBoxColorAlpha();

Q_SIGNALS:
  void xrgbPointsChanged();

  void xvmsPointsChanged();

  void useLogScaleChanged();

  void useLogScaleOpacityChanged();

  void useOpacityControlPointsFreehandDrawingChanged();

  void showDataHistogramChanged();

  void automaticDataHistogramComputationChanged();

  void dataHistogramNumberOfBinsEdited();

  void scalarOpacityFunctionProxyChanged();

  void transferFunction2DProxyChanged();

  void use2DTransferFunctionChanged();

  void transfer2DBoxesChanged();

protected Q_SLOTS:
  void opacityCurrentChanged(vtkIdType);
  void colorCurrentChanged(vtkIdType);

  void updatePanel();

  void updateCurrentData();

  void currentDataEdited();

  void presetApplied();

  void updateDefaultPresetsList();

  void updateIndexedLookupState();

  void multiComponentsMappingChanged(vtkObject*, unsigned long, void*, void*);

  void useLogScaleClicked(bool);

  void useLogScaleOpacityClicked(bool);

  void useOpacityControlPointsFreehandDrawingClicked(bool);

  void showDataHistogramClicked(bool show = true);

  void show2DHistogram(bool show = true);

  void automaticDataHistogramComputationClicked(bool val);

  void dataHistogramNumberOfBinsEdited(int val);

  void updateDataHistogramEnableState();

  void representationOrViewChanged();

  void setHistogramOutdated();

  void realShowDataHistogram();

  void realShow2DHistogram();

  void transfer2DChanged();

  void updateTransferFunction2DProxy();

protected: // NOLINT(readability-redundant-access-specifiers)
  void prepareRangeForLogScaling();

  void initializeOpacityEditor(vtkPiecewiseFunction* pwf);

  void initializeTransfer2DEditor(vtkPVTransferFunction2D* tf2d);

private:
  Q_DISABLE_COPY(pqColorOpacityEditorWidget)

  class pqInternals;
  pqInternals* Internals;
};

#endif