vtkSMTransferFunctionManager.h

Go to the documentation of this file.

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

#include "vtkRemotingViewsModule.h" // needed for export macro
#include "vtkSMObject.h"

class vtkSMProxy;
class vtkSMSessionProxyManager;

class VTKREMOTINGVIEWS_EXPORT vtkSMTransferFunctionManager : public vtkSMObject
{
public:
  static vtkSMTransferFunctionManager* New();
  vtkTypeMacro(vtkSMTransferFunctionManager, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual vtkSMProxy* GetColorTransferFunction(
    const char* arrayName, vtkSMSessionProxyManager* pxm);

  virtual vtkSMProxy* GetOpacityTransferFunction(
    const char* arrayName, vtkSMSessionProxyManager* pxm);

  virtual vtkSMProxy* GetTransferFunction2D(const char* arrayName, vtkSMSessionProxyManager* pxm);
  virtual vtkSMProxy* GetTransferFunction2D(
    const char* arrayName, const char* array2Name, vtkSMSessionProxyManager* pxm);

  virtual vtkSMProxy* GetScalarBarRepresentation(
    vtkSMProxy* colorTransferFunctionProxy, vtkSMProxy* view);

  void ResetAllTransferFunctionRangesUsingCurrentData(
    vtkSMSessionProxyManager* pxm, bool animating = false);

  enum UpdateScalarBarsMode
  {
    HIDE_UNUSED_SCALAR_BARS = 0x01,
    SHOW_USED_SCALAR_BARS = 0x02
  };

  enum TransferFunctionResetMode
  {
    NEVER = -1,
    GROW_ON_APPLY = 0,
    GROW_ON_APPLY_AND_TIMESTEP = 1,
    RESET_ON_APPLY = 2,
    RESET_ON_APPLY_AND_TIMESTEP = 3
  };

  virtual bool UpdateScalarBars(vtkSMProxy* viewProxy, unsigned int mode);

  virtual bool UpdateScalarBarsComponentTitle(vtkSMProxy* lutProxy, vtkSMProxy* representation);

  virtual bool HideScalarBarIfNotNeeded(vtkSMProxy* lutProxy, vtkSMProxy* view);

protected:
  vtkSMTransferFunctionManager();
  ~vtkSMTransferFunctionManager() override;

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

#endif