pqColorOpacityEditorWidget.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#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(QList<QVariant> transfer2DBoxes READ transfer2DBoxes WRITE setTransfer2DBoxes)

  typedef pqPropertyWidget Superclass;

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

  void updateWidget(bool showing_advanced_properties) 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 using2DTransferFunction() 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 computeDataHistogram();

  void onRangeHandlesRangeChanged(double rangeMin, double rangeMax);

  void resetColorMapComboBox();

  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 transfer2DBoxesChanged();

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

  void updateCurrentData();

  void currentDataEdited();

  void presetApplied();

  void updateDefaultPresetsList();

  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 opacityFunctionModified();

  void updateTransferFunction2DProxy();

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

  void initializeOpacityEditor(vtkPiecewiseFunction* pwf);

  void initializeTransfer2DEditor(vtkPVTransferFunction2D* tf2d);

  void observeRepresentationModified(vtkSMProxy* reprProxy, vtkPiecewiseFunction* pwf);

private:
  Q_DISABLE_COPY(pqColorOpacityEditorWidget)

  class pqInternals;
  pqInternals* Internals;
};

#endif