vtkSMColorMapEditorHelper.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMColorMapEditorHelper_h
#define vtkSMColorMapEditorHelper_h

#include "vtkRemotingViewsModule.h" //needed for exports
#include "vtkSmartPointer.h"        // For LastLUTProxy

class vtkPVArrayInformation;
class vtkPVProminentValuesInformation;
class vtkSMProxy;
class vtkSMPVRepresentationProxy;

class VTKREMOTINGVIEWS_EXPORT vtkSMColorMapEditorHelper
{
public:

  static vtkSMProxy* GetLUTProxy(vtkSMProxy* proxy, vtkSMProxy* view);
  static vtkSMProxy* GetBlockLUTProxy(
    vtkSMProxy* proxy, vtkSMProxy* view, const std::string& blockSelector);


  static bool GetUsingScalarColoring(vtkSMProxy* proxy);
  static bool GetBlockUsingScalarColoring(vtkSMProxy* proxy, const std::string& blockSelector);
  static bool GetAnyBlockUsingScalarColoring(vtkSMProxy* proxy);


  static void SetupLookupTable(vtkSMProxy* proxy);
  static void SetupBlockLookupTable(vtkSMProxy* proxy, const std::string& blockSelector);


  static bool UpdateScalarBarRange(vtkSMProxy* proxy, vtkSMProxy* view, bool deleteRange);
  static bool UpdateBlockScalarBarRange(
    vtkSMProxy* proxy, vtkSMProxy* view, const std::string& blockSelector, bool deleteRange);


  static bool SetScalarColoring(vtkSMProxy* proxy, const char* arrayName, int attributeType);
  static bool SetBlockScalarColoring(
    vtkSMProxy* proxy, const std::string& blockSelector, const char* arrayName, int attributeType);


  static bool SetScalarColoring(
    vtkSMProxy* proxy, const char* arrayName, int attributeType, int component);
  static bool SetBlockScalarColoring(vtkSMProxy* proxy, const std::string& blockSelector,
    const char* arrayName, int attributeType, int component);


  static bool RescaleTransferFunctionToDataRange(
    vtkSMProxy* proxy, bool extend = false, bool force = true);
  static bool RescaleBlockTransferFunctionToDataRange(
    vtkSMProxy* proxy, const std::string& blockSelector, bool extend = false, bool force = true);


  static bool RescaleTransferFunctionToDataRange(vtkSMProxy* proxy, const char* arrayName,
    int attributeType, bool extend = false, bool force = true);
  static bool RescaleBlockTransferFunctionToDataRange(vtkSMProxy* proxy,
    const std::string& blockSelector, const char* arrayName, int attributeType, bool extend = false,
    bool force = true);


  static bool RescaleTransferFunctionToDataRangeOverTime(vtkSMProxy* proxy);
  static bool RescaleBlockTransferFunctionToDataRangeOverTime(
    vtkSMProxy* proxy, const std::string& blockSelector);


  static bool RescaleTransferFunctionToDataRangeOverTime(
    vtkSMProxy* proxy, const char* arrayName, int attributeType);
  static bool RescaleBlockTransferFunctionToDataRangeOverTime(
    vtkSMProxy* proxy, const std::string& blockSelector, const char* arrayName, int attributeType);


  static bool RescaleTransferFunctionToVisibleRange(vtkSMProxy* proxy, vtkSMProxy* view);
  static bool RescaleTransferFunctionToVisibleRange(
    vtkSMProxy* proxy, vtkSMProxy* view, const char* arrayName, int attributeType);
  static bool RescaleBlockTransferFunctionToVisibleRange(
    vtkSMProxy* proxy, vtkSMProxy* view, const std::string& blockSelector);
  static bool RescaleBlockTransferFunctionToVisibleRange(vtkSMProxy* proxy, vtkSMProxy* view,
    const std::string& blockSelector, const char* arrayName, int attributeType);


  static bool SetScalarBarVisibility(vtkSMProxy* proxy, vtkSMProxy* view, bool visible);
  static bool SetBlockScalarBarVisibility(
    vtkSMProxy* proxy, vtkSMProxy* view, const std::string& blockSelector, bool visible);

  static bool HideScalarBarIfNotNeeded(vtkSMProxy* repr, vtkSMProxy* view);


  static bool IsScalarBarVisible(vtkSMProxy* repr, vtkSMProxy* view);
  static bool IsBlockScalarBarVisible(
    vtkSMProxy* repr, vtkSMProxy* view, const std::string& blockSelector);


  static vtkPVArrayInformation* GetArrayInformationForColorArray(
    vtkSMProxy* proxy, bool checkRepresentedData = true);
  static vtkPVArrayInformation* GetBlockArrayInformationForColorArray(
    vtkSMProxy* proxy, const std::string& blockSelector, bool checkRepresentedData = true);


  static std::string GetDecoratedArrayName(vtkSMProxy* proxy, const std::string& arrayName);
  static std::string GetBlockDecoratedArrayName(
    vtkSMProxy* proxy, const std::string& blockSelector, const std::string& arrayName);


  static vtkPVProminentValuesInformation* GetProminentValuesInformationForColorArray(
    vtkSMProxy* proxy, double uncertaintyAllowed = 1e-6, double fraction = 1e-3,
    bool force = false);
  static vtkPVProminentValuesInformation* GetBlockProminentValuesInformationForColorArray(
    vtkSMProxy* proxy, const std::string& blockSelector, double uncertaintyAllowed = 1e-6,
    double fraction = 1e-3, bool force = false);


  static int GetEstimatedNumberOfAnnotationsOnScalarBar(vtkSMProxy* proxy, vtkSMProxy* view);
  static int GetBlockEstimatedNumberOfAnnotationsOnScalarBar(
    vtkSMProxy* proxy, vtkSMProxy* view, const std::string& blockSelector);


  static int IsScalarBarStickyVisible(vtkSMProxy* proxy, vtkSMProxy* view);
  static int IsBlockScalarBarStickyVisible(
    vtkSMProxy* proxy, vtkSMProxy* view, const std::string& blockSelector);


  static void SetBlockColorArray(
    vtkSMProxy* proxy, const std::string& blockSelector, int attributeType, std::string arrayName);
  static std::pair<int, std::string> GetBlockColorArray(
    vtkSMProxy* proxy, const std::string& blockSelector);
  static int GetBlockColorArrayAssociation(vtkSMProxy* proxy, const std::string& blockSelector)
  {
    return vtkSMColorMapEditorHelper::GetBlockColorArray(proxy, blockSelector).first;
  }
  static std::string GetBlockColorArrayName(vtkSMProxy* proxy, const std::string& blockSelector)
  {
    return vtkSMColorMapEditorHelper::GetBlockColorArray(proxy, blockSelector).second;
  }


  static void SetBlockUseSeparateColorMap(
    vtkSMProxy* proxy, const std::string& blockSelector, bool use);
  static bool GetBlockUseSeparateColorMap(vtkSMProxy* proxy, const std::string& blockSelector);

protected:

  // Add proxy parameter?
  static bool RescaleTransferFunctionToDataRange(
    vtkSMProxy* proxy, vtkPVArrayInformation* info, bool extend = false, bool force = true);
  static bool RescaleBlockTransferFunctionToDataRange(vtkSMProxy* proxy,
    const std::string& blockSelector, vtkPVArrayInformation* info, bool extend = false,
    bool force = true);


  static void SetBlockLookupTable(
    vtkSMProxy* proxy, const std::string& blockSelector, vtkSMProxy* lutProxy);
  static vtkSMProxy* GetBlockLookupTable(vtkSMProxy* proxy, const std::string& blockSelector);
  static void RemoveBlockLookupTable(vtkSMProxy* proxy, const std::string& blockSelector);

  static bool SetScalarColoringInternal(
    vtkSMProxy* proxy, const char* arrayName, int attributeType, bool useComponent, int component);
  static bool SetBlockScalarColoringInternal(vtkSMProxy* proxy, const std::string& blockSelector,
    const char* arrayName, int attributeType, bool useComponent, int component);


  static vtkSMProxy* GetLastLUTProxy(vtkSMProxy* proxy);
  static void SetLastLUTProxy(vtkSMProxy* proxy, vtkSMProxy* lutProxy);
  static vtkSMProxy* GetLastBlockLUTProxy(vtkSMProxy* proxy, const std::string& blockSelector);
  static void SetLastBlockLUTProxy(
    vtkSMProxy* proxy, const std::string& blockSelector, vtkSMProxy* lutProxy);

  friend class vtkSMPVRepresentationProxy;

private:
  vtkSMColorMapEditorHelper() = delete;
  vtkSMColorMapEditorHelper(const vtkSMColorMapEditorHelper&) = delete;
  ~vtkSMColorMapEditorHelper() = delete;
  void operator=(const vtkSMColorMapEditorHelper&) = delete;
};

#endif