vtkSMTransferFunctionPresets.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkSMTransferFunctionPresets.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkSMTransferFunctionPresets_h
#define vtkSMTransferFunctionPresets_h

#include "vtkSMObject.h"

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

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

  static vtkSMTransferFunctionPresets* GetInstance();

  unsigned int GetNumberOfPresets();

  vtkStdString GetPresetAsString(unsigned int index);

  bool AddPreset(const char* name, const vtkStdString& preset);

  bool RemovePreset(unsigned int index);

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

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

  vtkStdString 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 IsPresetDefault(const Json::Value& preset);
  bool IsPresetDefault(unsigned int index) { return this->IsPresetDefault(this->GetPreset(index)); }

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

  vtkStdString AddUniquePreset(const Json::Value& preset, const char* prefix = NULL);

  bool IsPresetBuiltin(unsigned int index);

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


  bool ImportPresets(const char* filename);
  bool ImportPresets(const Json::Value& presets);

  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