vtkVtkJSSceneGraphSerializer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkVtkJSSceneGraphSerializer_h
#define vtkVtkJSSceneGraphSerializer_h
 
#include "vtkRenderingVtkJSModule.h" // For export macro
 
#include "vtkObject.h"
#include <vtk_jsoncpp.h> // For Json::Value
 
VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkAlgorithm;
class vtkCamera;
class vtkCompositePolyDataMapper;
class vtkDataArray;
class vtkDataObject;
class vtkDataSet;
class vtkGlyph3DMapper;
class vtkImageData;
class vtkLight;
class vtkLookupTable;
class vtkMapper;
class vtkPolyData;
class vtkProperty;
class vtkRenderer;
class vtkRenderWindow;
class vtkTexture;
class vtkTransform;
class vtkViewNode;
 
class VTKRENDERINGVTKJS_EXPORT vtkVtkJSSceneGraphSerializer : public vtkObject
{
public:
  static vtkVtkJSSceneGraphSerializer* New();
  vtkTypeMacro(vtkVtkJSSceneGraphSerializer, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void Reset();
 
 
  const Json::Value& GetRoot() const;
 
 
  vtkIdType GetNumberOfDataObjects() const;
  Json::ArrayIndex GetDataObjectId(vtkIdType) const;
  vtkDataObject* GetDataObject(vtkIdType) const;
 
 
  vtkIdType GetNumberOfDataArrays() const;
  std::string GetDataArrayId(vtkIdType) const;
  vtkDataArray* GetDataArray(vtkIdType) const;
 
 
  virtual void Add(vtkViewNode*, vtkActor*);
  virtual void Add(vtkViewNode*, vtkCompositePolyDataMapper*);
  virtual void Add(vtkViewNode*, vtkGlyph3DMapper*);
  virtual void Add(vtkViewNode*, vtkMapper*);
  virtual void Add(vtkViewNode*, vtkRenderer*);
  virtual void Add(vtkViewNode*, vtkRenderWindow*);
 
protected:
  vtkVtkJSSceneGraphSerializer();
  ~vtkVtkJSSceneGraphSerializer() override;
 
 
  virtual Json::Value ToJson(vtkDataArray*);
  virtual Json::Value ToJson(Json::Value&, vtkAlgorithm*, vtkDataObject*);
  virtual Json::Value ToJson(Json::Value&, vtkActor*, bool newPropertyId = false);
  virtual Json::Value ToJson(Json::Value&, Json::ArrayIndex, vtkGlyph3DMapper*);
  virtual Json::Value ToJson(Json::Value&, vtkCamera*);
  virtual Json::Value ToJson(Json::Value&, vtkAlgorithm*, vtkImageData*);
  virtual Json::Value ToJson(Json::Value&, vtkLight*);
  virtual Json::Value ToJson(Json::Value&, vtkLookupTable*);
  virtual Json::Value ToJson(Json::Value&, Json::ArrayIndex, vtkMapper*, bool newLUTId = false);
  virtual Json::Value ToJson(Json::Value&, vtkRenderer*);
  virtual Json::Value ToJson(Json::Value&, vtkAlgorithm*, vtkPolyData*);
  virtual Json::Value ToJson(Json::Value&, vtkProperty*);
  virtual Json::Value ToJson(Json::Value&, vtkTexture*);
  virtual Json::Value ToJson(Json::Value&, vtkTransform*);
  virtual Json::Value ToJson(vtkRenderWindow*);
 
 
  Json::ArrayIndex UniqueId(void* ptr = nullptr);
 
  struct Internal;
  Internal* Internals;
 
private:
  vtkVtkJSSceneGraphSerializer(const vtkVtkJSSceneGraphSerializer&) = delete;
  void operator=(const vtkVtkJSSceneGraphSerializer&) = delete;
 
  virtual void Add(Json::Value*, vtkAlgorithm*);
 
  void Add(vtkViewNode* node, vtkDataObject* dataObject, vtkCompositePolyDataMapper* mapper);
 
  void extractRequiredFields(Json::Value& extractedFields, vtkMapper* mapper, vtkDataSet* dataSet);
};
 
VTK_ABI_NAMESPACE_END
#endif