VTK  9.3.0
vtkHyperTreeGridSource.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
36#ifndef vtkHyperTreeGridSource_h
37#define vtkHyperTreeGridSource_h
38
39#include "vtkFiltersSourcesModule.h" // For export macro
41
42#include <map> // STL Header
43#include <string> // STL Header
44#include <vector> // STL Header
45
46VTK_ABI_NAMESPACE_BEGIN
47class vtkBitArray;
48class vtkDataArray;
50class vtkIdTypeArray;
53class vtkQuadric;
54
55class VTKFILTERSSOURCES_EXPORT vtkHyperTreeGridSource : public vtkHyperTreeGridAlgorithm
56{
57public:
59 void PrintSelf(ostream& os, vtkIndent indent) override;
60
62
67 unsigned int GetMaxDepth();
68
75 void SetMaxDepth(unsigned int levels);
76
78
81 vtkSetVector3Macro(Origin, double);
82 vtkGetVector3Macro(Origin, double);
84
86
89 vtkSetVector3Macro(GridScale, double);
90 vtkGetVector3Macro(GridScale, double);
91 void SetGridScale(double scale) { this->SetGridScale(scale, scale, scale); }
93
95
98 void SetDimensions(const unsigned int* dims);
99 void SetDimensions(unsigned int, unsigned int, unsigned int);
100 vtkGetVector3Macro(Dimensions, unsigned int);
102
104
108 vtkSetMacro(TransposedRootIndexing, bool);
109 vtkGetMacro(TransposedRootIndexing, bool);
113
115
118 vtkGetMacro(Orientation, unsigned int);
120
122
125 vtkSetClampMacro(BranchFactor, unsigned int, 2, 3);
126 vtkGetMacro(BranchFactor, unsigned int);
128
130
135 vtkSetMacro(UseDescriptor, bool);
136 vtkGetMacro(UseDescriptor, bool);
137 vtkBooleanMacro(UseDescriptor, bool);
139
141
146 vtkSetMacro(UseMask, bool);
147 vtkGetMacro(UseMask, bool);
148 vtkBooleanMacro(UseMask, bool);
150
152
157 vtkSetMacro(GenerateInterfaceFields, bool);
158 vtkGetMacro(GenerateInterfaceFields, bool);
159 vtkBooleanMacro(GenerateInterfaceFields, bool);
161
163
166 vtkSetStringMacro(Descriptor);
167 vtkGetStringMacro(Descriptor);
169
171
174 vtkSetStringMacro(Mask);
175 vtkGetStringMacro(Mask);
177
179
183 vtkGetObjectMacro(DescriptorBits, vtkBitArray);
185
190
192
195 virtual void SetMaskBits(vtkBitArray*);
196 vtkGetObjectMacro(MaskBits, vtkBitArray);
198
200
203 virtual void SetQuadric(vtkQuadric*);
204 vtkGetObjectMacro(Quadric, vtkQuadric);
206
208
211 void SetQuadricCoefficients(double[10]);
212 void GetQuadricCoefficients(double[10]);
215
220
222
228
229protected:
232
234
236
238
243
248
253
258 vtkHyperTreeGrid* output, vtkHyperTreeGridNonOrientedCursor* cursor, int treeIdx, int idx[3]);
259
264 vtkHyperTreeGridNonOrientedCursor* cursor, unsigned int level, int treeIdx, int childIdx,
265 int idx[3], int parentPos);
266
271 vtkHyperTreeGridNonOrientedCursor* cursor, unsigned int level, int treeIdx, int childIdx,
272 int idx[3], int parentPos);
273
278 unsigned int level, int treeIdx, const int idx[3], double origin[3], double size[3]);
279
283 double EvaluateQuadric(double[3]);
284
285 double Origin[3];
286 double GridScale[3];
287 unsigned int Dimension;
288
289 unsigned int Dimensions[3];
291 unsigned int MaxDepth;
292
293 unsigned int Orientation;
294 unsigned int BranchFactor;
295 unsigned int BlockSize;
299
303
305 char* Mask;
306 std::vector<std::string> LevelDescriptors;
307 std::vector<std::string> LevelMasks;
308
311 std::vector<vtkIdType> LevelBitsIndex;
312 std::vector<vtkIdType> LevelBitsIndexCnt;
313
315 std::map<vtkIdType, vtkIdType> LevelZeroMaterialMap;
316
317 std::vector<int> LevelCounters;
318
320
322
323private:
325 void operator=(const vtkHyperTreeGridSource&) = delete;
326};
327
328VTK_ABI_NAMESPACE_END
329#endif
dynamic, self-adjusting array of bits
Definition vtkBitArray.h:29
abstract superclass for arrays of numeric data
general representation of visualization data
Superclass for algorithms that produce a hyper tree grid as output.
Objects for traversal a HyperTreeGrid.
Create a synthetic grid of hypertrees.
void SetDimensions(const unsigned int *dims)
Set/Get the number of root cells + 1 in each dimension of the grid.
void SetIndexingModeToIJK()
Specify whether indexing mode of grid root cells must be transposed to x-axis first,...
virtual void SetQuadric(vtkQuadric *)
Set/Get the quadric function.
virtual void SetMaskBits(vtkBitArray *)
Set/Get the bitarray used as a material mask.
std::vector< vtkIdType > LevelBitsIndex
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
int InitializeFromStringDescriptor()
Initialize grid from descriptor string when it is to be used.
static vtkHyperTreeGridSource * New()
void SetGridScale(double scale)
Set/Get the scale to be applied to root cells in each dimension of the grid.
vtkMTimeType GetMTime() override
Override GetMTime because we delegate to a vtkQuadric.
virtual void SetLevelZeroMaterialIndex(vtkIdTypeArray *)
Set the index array used to as a material mask.
double EvaluateQuadric(double[3])
Evaluate quadric at given point coordinates.
int FillOutputPortInformation(int, vtkInformation *) override
Define default input and output port types.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
std::vector< vtkIdType > LevelBitsIndexCnt
unsigned int GetMaxDepth()
Return the maximum number of levels of the hypertree.
void SetDimensions(unsigned int, unsigned int, unsigned int)
Set/Get the number of root cells + 1 in each dimension of the grid.
void SetIndexingModeToKJI()
Specify whether indexing mode of grid root cells must be transposed to x-axis first,...
vtkBitArray * ConvertDescriptorStringToBitArray(const std::string &)
Helpers to convert string descriptors & mask to bit arrays.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdTypeArray * LevelZeroMaterialIndex
std::vector< std::string > LevelMasks
void SubdivideFromBitsDescriptor(vtkHyperTreeGrid *output, vtkHyperTreeGridNonOrientedCursor *cursor, unsigned int level, int treeIdx, int childIdx, int idx[3], int parentPos)
Subdivide grid from descriptor string when it is to be used.
vtkBitArray * ConvertMaskStringToBitArray(const std::string &)
Helpers to convert string descriptors & mask to bit arrays.
int InitializeFromBitsDescriptor()
Initialize grid from bit array descriptors when it is to be used.
~vtkHyperTreeGridSource() override
void SubdivideFromQuadric(vtkHyperTreeGrid *output, vtkHyperTreeGridNonOrientedCursor *cursor, unsigned int level, int treeIdx, const int idx[3], double origin[3], double size[3])
Subdivide grid from quadric when descriptor is not used.
void SubdivideFromStringDescriptor(vtkHyperTreeGrid *output, vtkHyperTreeGridNonOrientedCursor *cursor, unsigned int level, int treeIdx, int childIdx, int idx[3], int parentPos)
Subdivide grid from descriptor string when it is to be used.
void SetMaxDepth(unsigned int levels)
Set the maximum number of levels of the hypertrees.
double * GetQuadricCoefficients()
Helpers to set/get the 10 coefficients of the quadric function.
std::map< vtkIdType, vtkIdType > LevelZeroMaterialMap
void InitTreeFromDescriptor(vtkHyperTreeGrid *output, vtkHyperTreeGridNonOrientedCursor *cursor, int treeIdx, int idx[3])
Initialize tree grid from descriptor and call subdivide if needed.
void GetQuadricCoefficients(double[10])
Helpers to set/get the 10 coefficients of the quadric function.
std::vector< std::string > LevelDescriptors
int ProcessTrees(vtkHyperTreeGrid *, vtkDataObject *) override
Main routine to process individual trees in the grid.
void SetQuadricCoefficients(double[10])
Helpers to set/get the 10 coefficients of the quadric function.
virtual void SetDescriptorBits(vtkBitArray *)
Set/Get the bitarray used to describe the grid.
A dataset containing a grid of vtkHyperTree instances arranged as a rectilinear grid.
dynamic, self-adjusting array of vtkIdType
abstract interface for implicit functions
a simple class to control print indentation
Definition vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
evaluate implicit quadric function
Definition vtkQuadric.h:23
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270