vtkGLTFExporter.h 3.46 KB
Newer Older
Ken Martin's avatar
Ken Martin committed
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
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkGLTFExporter.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   vtkGLTFExporter
 * @brief   export a scene into GLTF 2.0 format.
 *
 * vtkGLTFExporter is a concrete subclass of vtkExporter that writes GLTF 2.0
 * files. It currently only supports a very small subset of what VTK can do
 * including polygonal meshes with optional vertex colors. Over time the class
 * can be expanded to support more and more of what VTK renders.
 *
 * It should be noted that gltf is a format for rendering data. As such
 * it stores what the VTK scene renders as, not the underlying data. For
 * example it currently does not support quads or higher sided polygons
 * although VTK does. As such taking an exported gltf file and then selecting
 * wireframe in a viewer will give all triangles where VTK's rendering
 * would correctly draw the original polygons. etc.
 *
 * @sa
 * vtkExporter
33
 */
Ken Martin's avatar
Ken Martin committed
34
35
36
37
38

#ifndef vtkGLTFExporter_h
#define vtkGLTFExporter_h

#include "vtkExporter.h"
39
#include "vtkIOExportModule.h" // For export macro
Ken Martin's avatar
Ken Martin committed
40

41
42
#include <string> // for std::string

Ken Martin's avatar
Ken Martin committed
43
44
45
class VTKIOEXPORT_EXPORT vtkGLTFExporter : public vtkExporter
{
public:
46
47
  static vtkGLTFExporter* New();
  vtkTypeMacro(vtkGLTFExporter, vtkExporter);
Ken Martin's avatar
Ken Martin committed
48
49
  void PrintSelf(ostream& os, vtkIndent indent) override;

50
  ///@{
Ken Martin's avatar
Ken Martin committed
51
52
53
  /**
   * Specify the name of the GLTF file to write.
   */
54
55
  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);
56
  ///@}
Ken Martin's avatar
Ken Martin committed
57

58
  ///@{
59
60
61
62
63
64
65
  /**
   * Should the binary data be included in the json file as a base64
   * string.
   */
  vtkGetMacro(InlineData, bool);
  vtkSetMacro(InlineData, bool);
  vtkBooleanMacro(InlineData, bool);
66
  ///@}
67

68
  ///@{
69
70
71
72
73
74
75
76
77
78
  /**
   * It looks for a point array called
   * NORMAL in the data and it saves it in the
   * GLTF file if found.
   * NORMAL is the vertex normal. Cesium needs this to render buildings correctly
   * if there is no texture.
   */
  vtkGetMacro(SaveNormal, bool);
  vtkSetMacro(SaveNormal, bool);
  vtkBooleanMacro(SaveNormal, bool);
79
  ///@}
80

81
  ///@{
82
83
84
85
86
87
88
89
90
91
92
93
94
  /**
   * It looks for point arrays called
   * _BATCHID in the data and it saves it in the
   * GLTF file if found.
   * _BATCHID is an index used in 3D Tiles b3dm format. This format stores
   * a binary gltf with a mesh that has several objects (buildings).
   * Objects are indexed from 0 to number of objects - 1, all points
   * of an objects have the same index. These index values are stored
   * in _BATCHID
   */
  vtkGetMacro(SaveBatchId, bool);
  vtkSetMacro(SaveBatchId, bool);
  vtkBooleanMacro(SaveBatchId, bool);
95
  ///@}
96

97
98
99
  /**
   * Write the result to a string instead of a file
   */
100
  std::string WriteToString();
101
102
103
104

  /**
   * Write the result to a provided ostream
   */
105
  void WriteToStream(ostream& out);
106

Ken Martin's avatar
Ken Martin committed
107
108
109
110
111
112
protected:
  vtkGLTFExporter();
  ~vtkGLTFExporter() override;

  void WriteData() override;

113
  char* FileName;
114
  bool InlineData;
115
116
  bool SaveNormal;
  bool SaveBatchId;
Ken Martin's avatar
Ken Martin committed
117
118
119
120
121
122
123

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

#endif