File: vtkOpenVDBWriter.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 (153 lines) | stat: -rw-r--r-- 4,026 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkOpenVDBWriter.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   vtkOpenVDBWriter
 * @brief   OpenVDB writer for vtkImageData or vtkPointSet
 * Writes a vtkImageData or vtkPointSet as a VDB file.
 */

#ifndef vtkOpenVDBWriter_h
#define vtkOpenVDBWriter_h

#include "vtkIOOpenVDBModule.h" //needed for exports
#include "vtkSmartPointer.h"    // For protected ivars
#include "vtkWriter.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkDataSetAttributes;
class vtkImageData;
class vtkMultiProcessController;
class vtkOpenVDBWriterInternals;
class vtkPointSet;
class vtkScalarsToColors;
class vtkUnsignedCharArray;

class VTKIOOPENVDB_EXPORT vtkOpenVDBWriter : public vtkWriter
{
public:
  static vtkOpenVDBWriter* New();
  vtkTypeMacro(vtkOpenVDBWriter, vtkWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  ///@{
  /**
   * Get/Set the filename for the file.
   */
  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);
  ///@}

  ///@{
  /**
   * Get/Set whether or not to save all time steps or
   * just the current time step. Default is false
   * (save only the current time step).
   */
  vtkSetMacro(WriteAllTimeSteps, bool);
  vtkGetMacro(WriteAllTimeSteps, bool);
  ///@}

  ///@{
  /**
   * A lookup table can be specified in order to convert data arrays to
   * RGBA colors.
   */
  virtual void SetLookupTable(vtkScalarsToColors*);
  vtkGetObjectMacro(LookupTable, vtkScalarsToColors);
  ///@}

  ///@{
  /**
   * Enable coloring channel output based on LookupTable. The output
   * channel will be named 'color'.
   */
  vtkSetMacro(EnableColoring, bool);
  vtkGetMacro(EnableColoring, bool);
  ///@}

  ///@{
  /**
   * Enable alpha channel output based on LookupTable. The output
   * channel will be name 'alpha'.
   */
  vtkSetMacro(EnableAlpha, bool);
  vtkGetMacro(EnableAlpha, bool);
  ///@}

  ///@{
  /**
   * Get/Set the controller to use. By default,
   * `vtkMultiProcessController::GetGlobalController` will be used.
   */
  void SetController(vtkMultiProcessController*);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);
  ///@}

protected:
  vtkOpenVDBWriter();
  ~vtkOpenVDBWriter() override;

  void WriteData() override;

  void WriteImageData(vtkImageData* imageData);
  void WritePointSet(vtkPointSet* pointSet);

  // see algorithm for more info.
  // This writer takes in vtkTable, vtkDataSet or vtkCompositeDataSet.
  int FillInputPortInformation(int port, vtkInformation* info) override;

  // see algorithm for more info. needed here so we can request pieces.
  int ProcessRequest(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  void SetRGBA(vtkIdType num, vtkUnsignedCharArray* rgba, vtkDataSetAttributes* attributes);

  char* FileName;

  ///@{
  /**
   * Whether or not to write out all time steps.
   * The default is to not write out all time steps.
   */
  bool WriteAllTimeSteps;
  ///@}

  ///@{
  /**
   * For outputting the Lookup Table in the VDB file.
   * Copying what's done in vtkPLYWriter.
   */
  vtkScalarsToColors* LookupTable;
  bool EnableColoring;
  bool EnableAlpha;
  ///@}

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

  ///@{
  /**
   * The controller for the writer to work in parallel.
   */
  vtkMultiProcessController* Controller;
  ///@}

  vtkOpenVDBWriterInternals* Internals;
  friend class vtkOpenVDBWriterInternals;
};

VTK_ABI_NAMESPACE_END
#endif