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 VTKREMOTINGVIEWS_EXPORT vtkSMColorMapEditorHelper
{
public:
  static vtkSMProxy* GetLUTProxy(vtkSMProxy* proxy, vtkSMProxy* view);
 
  static bool GetUsingScalarColoring(vtkSMProxy* proxy);
 
  static void SetupLookupTable(vtkSMProxy* proxy);
 
  static bool UpdateScalarBarRange(vtkSMProxy* proxy, vtkSMProxy* view, bool deleteRange);
 
  static bool SetScalarColoring(vtkSMProxy* proxy, const char* arrayname, int attribute_type);
 
  static bool SetScalarColoring(
    vtkSMProxy* proxy, const char* arrayname, int attribute_type, int component);
 
  static bool RescaleTransferFunctionToDataRange(
    vtkSMProxy* proxy, bool extend = false, bool force = true);
 
  static bool RescaleTransferFunctionToDataRange(vtkSMProxy* proxy, const char* arrayname,
    int attribute_type, bool extend = false, bool force = true);
 
  static bool RescaleTransferFunctionToDataRangeOverTime(vtkSMProxy* proxy);
 
  static bool RescaleTransferFunctionToDataRangeOverTime(
    vtkSMProxy* proxy, const char* arrayname, int attribute_type);
 
 
  static bool RescaleTransferFunctionToVisibleRange(vtkSMProxy* proxy, vtkSMProxy* view);
  static bool RescaleTransferFunctionToVisibleRange(
    vtkSMProxy* proxy, vtkSMProxy* view, const char* arrayname, int attribute_type);
 
  static bool SetScalarBarVisibility(vtkSMProxy* proxy, vtkSMProxy* view, bool visible);
 
  static bool HideScalarBarIfNotNeeded(vtkSMProxy* repr, vtkSMProxy* view);
 
  static bool IsScalarBarVisible(vtkSMProxy* repr, vtkSMProxy* view);
 
  static vtkPVArrayInformation* GetArrayInformationForColorArray(
    vtkSMProxy* proxy, bool checkRepresentedData = true);
 
  static std::string GetDecoratedArrayName(vtkSMProxy* proxy, const std::string& arrayname);
 
  static vtkPVProminentValuesInformation* GetProminentValuesInformationForColorArray(
    vtkSMProxy* proxy, double uncertaintyAllowed = 1e-6, double fraction = 1e-3,
    bool force = false);
 
  static int GetEstimatedNumberOfAnnotationsOnScalarBar(vtkSMProxy* proxy, vtkSMProxy* view);
 
  static int IsScalarBarStickyVisible(vtkSMProxy* proxy, vtkSMProxy* view);
 
protected:
  // Add proxy parameter?
  static bool RescaleTransferFunctionToDataRange(
    vtkSMProxy* proxy, vtkPVArrayInformation* info, bool extend = false, bool force = true);
 
  static bool SetScalarColoringInternal(
    vtkSMProxy* proxy, const char* arrayname, int attribute_type, bool useComponent, int component);
 
  static vtkSMProxy* GetLastLUTProxy(vtkSMProxy* proxy);
  static void SetLastLUTProxy(vtkSMProxy* proxy, vtkSMProxy* lutProxy);
 
private:
  vtkSMColorMapEditorHelper() = delete;
  vtkSMColorMapEditorHelper(const vtkSMColorMapEditorHelper&) = delete;
  ~vtkSMColorMapEditorHelper() = delete;
  void operator=(const vtkSMColorMapEditorHelper&) = delete;
};
 
#endif