vtkSMTransferFunctionPresets.h

Go to the documentation of this file.

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

#include "vtkSMObject.h"

#include "vtkRemotingViewsModule.h" // needed for exports
#include "vtkSmartPointer.h"        // for ivars
#include <vector>                   // for vector
#include <vtk_jsoncpp_fwd.h>        // for forward declarations

class vtkPVXMLElement;
class VTKREMOTINGVIEWS_EXPORT vtkSMTransferFunctionPresets : public vtkSMObject
{
public:
  // Used to return information about the imported presets to the caller of ImportPresets
  struct ImportedPreset
  {
    std::string name;
    struct
    {
      bool isValid = false;
      std::vector<std::string> groups;
    } potentialGroups;
  };

  static vtkSMTransferFunctionPresets* New();
  vtkTypeMacro(vtkSMTransferFunctionPresets, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkSMTransferFunctionPresets* GetInstance();

  unsigned int GetNumberOfPresets();

  std::string GetPresetAsString(unsigned int index);

  bool AddPreset(const char* name, const std::string& preset);

  bool RemovePreset(unsigned int index);


  const Json::Value& GetFirstPresetWithName(const char* name, int& idx);
  const Json::Value& GetFirstPresetWithName(const char* name);

  const Json::Value& GetPreset(unsigned int index);

  std::string GetPresetName(unsigned int index);

  bool HasPreset(const char* name);

  bool GetPresetHasOpacities(const Json::Value& preset);
  bool GetPresetHasOpacities(unsigned int index)
  {
    return this->GetPresetHasOpacities(this->GetPreset(index));
  }

  bool GetPresetHasIndexedColors(const Json::Value& preset);
  bool GetPresetHasIndexedColors(unsigned int index)
  {
    return this->GetPresetHasIndexedColors(this->GetPreset(index));
  }

  bool GetPresetHasAnnotations(const Json::Value& preset);
  bool GetPresetHasAnnotations(unsigned int index)
  {
    return this->GetPresetHasAnnotations(this->GetPreset(index));
  }

  bool SetPreset(const char* name, const Json::Value& preset);

  bool AddPreset(const char* name, const Json::Value& preset);

  std::string AddUniquePreset(const Json::Value& preset, const char* prefix = nullptr);

  bool IsPresetBuiltin(unsigned int index);

  bool RenamePreset(unsigned int index, const char* newname);


  bool ImportPresets(const char* filename, vtkTypeUInt32 location = 0x10 /*vtkPVSession::CLIENT*/);
  bool ImportPresets(const char* filename, std::vector<ImportedPreset>* importedPresets,
    vtkTypeUInt32 location = 0x10 /*vtkPVSession::CLIENT*/);
  bool ImportPresets(const Json::Value& presets);
  bool ImportPresets(const Json::Value& presets, std::vector<ImportedPreset>* importedPresets);

  void ReloadPresets();

protected:
  vtkSMTransferFunctionPresets();
  ~vtkSMTransferFunctionPresets() override;

private:
  vtkSMTransferFunctionPresets(const vtkSMTransferFunctionPresets&) = delete;
  void operator=(const vtkSMTransferFunctionPresets&) = delete;

  class vtkInternals;
  vtkInternals* Internals;

  static vtkSmartPointer<vtkSMTransferFunctionPresets> Instance;
};

#endif