pqScalarsToColors.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 pqScalarsToColors_h
#define pqScalarsToColors_h

#include "pqProxy.h"
#include <QList>
#include <QPair>
#include <QVariant>

class pqRenderViewBase;
class pqScalarBarRepresentation;
class pqScalarsToColorsInternal;

class PQCORE_EXPORT pqScalarsToColors : public pqProxy
{
  Q_OBJECT
public:
  pqScalarsToColors(const QString& group, const QString& name, vtkSMProxy* proxy, pqServer* server,
    QObject* parent = nullptr);
  ~pqScalarsToColors() override;

  pqScalarBarRepresentation* getScalarBar(pqRenderViewBase* ren) const;

  bool getScalarRangeLock() const;

  void setScalarRange(double min, double max);

  QPair<double, double> getScalarRange() const;

  bool getUseLogScale() const;

  enum Mode
  {
    MAGNITUDE = 0,
    COMPONENT = 1
  };

  // Set the color mode (component/magnitude) and
  // component to color by. When mode is magnitude, component is ignored.
  void setVectorMode(Mode mode, int component);

  // Returns the vector mode and component used by the Lookup table.
  // When vector mode is MAGNITUDE, value returned by
  // getVectorComponent() is indeterminate.
  Mode getVectorMode() const;
  int getVectorComponent() const;

  void updateScalarBarTitles(const QString& component);

  enum RangeScalingModes
  {
    GROW_ON_MODIFIED, /* only when a pipeline object is explicitly modified */
    GROW_ON_UPDATED   /* any time the pipeline updates */
  };

  static void setColorRangeScalingMode(int);
  static int colorRangeScalingMode(int default_value = GROW_ON_MODIFIED);

Q_SIGNALS:
  void componentOrModeChanged();

public Q_SLOTS:
  // This method checks if this LUT is used by any display,
  // if not, it hides all the scalars bar showing this LUT.
  void hideUnusedScalarBars();

  void setScalarRangeLock(bool lock);

  void build();

protected Q_SLOTS:
  void checkRange();

private:
  pqScalarsToColorsInternal* Internal;
};

#endif