File: vtkJSONRenderWindowExporter.h

package info (click to toggle)
paraview 5.11.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 497,236 kB
  • sloc: cpp: 3,171,290; ansic: 1,315,072; python: 134,290; xml: 103,324; sql: 65,887; sh: 5,286; javascript: 4,901; yacc: 4,383; java: 3,977; perl: 2,363; lex: 1,909; f90: 1,255; objc: 143; makefile: 119; tcl: 59; pascal: 50; fortran: 29
file content (101 lines) | stat: -rw-r--r-- 2,982 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkJSONRenderWindowExporter.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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.

=========================================================================*/
/**
 * @class   vtkJSONRenderWindowExporter
 * @brief   Exports a render window for vtk-js
 *
 * vtkJSONRenderWindowExporter constructs a scene graph from an input render
 * window and generates an archive for vtk-js. The traversal of the scene graph
 * topology is handled by graph elements constructed by vtkVtkJSViewNodeFactory,
 * the translation from VTK to vtk-js scene elements (renderers, actors,
 * mappers, etc.) is handled by vtkVtkJSSceneGraphSerializer, and the
 * transcription of data is handled by vtkArchiver. The latter two classes are
 * designed to be extensible via inheritance, and derived instances can be used
 * to modify the vtk-js file format and output mode.
 *
 *
 * @sa
 * vtkVtkJSSceneGraphSerializer vtkVtkJSViewNodeFactory
 */

#ifndef vtkJSONRenderWindowExporter_h
#define vtkJSONRenderWindowExporter_h

#include "vtkIOExportModule.h" // For export macro

#include "vtkExporter.h"
#include "vtkNew.h"             // For vtkNew
#include "vtkViewNodeFactory.h" // For vtkViewNodeFactory

VTK_ABI_NAMESPACE_BEGIN
class vtkArchiver;
class vtkVtkJSSceneGraphSerializer;
class vtkVtkJSViewNodeFactory;

class VTKIOEXPORT_EXPORT vtkJSONRenderWindowExporter : public vtkExporter
{
public:
  static vtkJSONRenderWindowExporter* New();
  vtkTypeMacro(vtkJSONRenderWindowExporter, vtkExporter);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  ///@{
  /**
   * Specify the Serializer object
   */
  virtual void SetSerializer(vtkVtkJSSceneGraphSerializer*);
  vtkGetObjectMacro(Serializer, vtkVtkJSSceneGraphSerializer);
  ///@}

  ///@{
  /**
   * Specify the Archiver object
   */
  virtual void SetArchiver(vtkArchiver*);
  vtkGetObjectMacro(Archiver, vtkArchiver);
  ///@}

  ///@{
  /**
   * Write scene data.
   */
  void WriteData() override;
  ///@}

  ///@{
  /**
   * Write scene in compact form (default is true).
   */
  vtkSetMacro(CompactOutput, bool);
  vtkGetMacro(CompactOutput, bool);
  vtkBooleanMacro(CompactOutput, bool);
  ///@}

protected:
  vtkJSONRenderWindowExporter();
  ~vtkJSONRenderWindowExporter() override;

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

  vtkArchiver* Archiver;
  vtkVtkJSSceneGraphSerializer* Serializer;
  vtkVtkJSViewNodeFactory* Factory;
  bool CompactOutput;
};

VTK_ABI_NAMESPACE_END
#endif