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
45 #ifndef vtkHyperTreeGridSource_h
46 #define vtkHyperTreeGridSource_h
47 
48 #include "vtkFiltersSourcesModule.h" // For export macro
50 
51 #include <map> // STL Header
52 #include <string> // STL Header
53 #include <vector> // STL Header
54 
55 VTK_ABI_NAMESPACE_BEGIN
56 class vtkBitArray;
57 class vtkDataArray;
59 class vtkIdTypeArray;
61 class vtkHyperTreeGrid;
62 class vtkQuadric;
63 
64 class VTKFILTERSSOURCES_EXPORT vtkHyperTreeGridSource : public vtkHyperTreeGridAlgorithm
65 {
66 public:
68  void PrintSelf(ostream& os, vtkIndent indent) override;
69 
71 
76  unsigned int GetMaxDepth();
77 
84  void SetMaxDepth(unsigned int levels);
85 
87 
90  vtkSetVector3Macro(Origin, double);
91  vtkGetVector3Macro(Origin, double);
93 
95 
98  vtkSetVector3Macro(GridScale, double);
99  vtkGetVector3Macro(GridScale, double);
100  void SetGridScale(double scale) { this->SetGridScale(scale, scale, scale); }
102 
104 
107  void SetDimensions(const unsigned int* dims);
108  void SetDimensions(unsigned int, unsigned int, unsigned int);
109  vtkGetVector3Macro(Dimensions, unsigned int);
111 
113 
117  vtkSetMacro(TransposedRootIndexing, bool);
118  vtkGetMacro(TransposedRootIndexing, bool);
122 
124 
127  vtkGetMacro(Orientation, unsigned int);
129 
131 
134  vtkSetClampMacro(BranchFactor, unsigned int, 2, 3);
135  vtkGetMacro(BranchFactor, unsigned int);
137 
139 
144  vtkSetMacro(UseDescriptor, bool);
145  vtkGetMacro(UseDescriptor, bool);
146  vtkBooleanMacro(UseDescriptor, bool);
148 
150 
155  vtkSetMacro(UseMask, bool);
156  vtkGetMacro(UseMask, bool);
157  vtkBooleanMacro(UseMask, bool);
159 
161 
166  vtkSetMacro(GenerateInterfaceFields, bool);
167  vtkGetMacro(GenerateInterfaceFields, bool);
168  vtkBooleanMacro(GenerateInterfaceFields, bool);
170 
172 
175  vtkSetStringMacro(Descriptor);
176  vtkGetStringMacro(Descriptor);
178 
180 
183  vtkSetStringMacro(Mask);
184  vtkGetStringMacro(Mask);
186 
188 
192  vtkGetObjectMacro(DescriptorBits, vtkBitArray);
194 
199 
201 
204  virtual void SetMaskBits(vtkBitArray*);
205  vtkGetObjectMacro(MaskBits, vtkBitArray);
207 
209 
212  virtual void SetQuadric(vtkQuadric*);
213  vtkGetObjectMacro(Quadric, vtkQuadric);
215 
217 
220  void SetQuadricCoefficients(double[10]);
221  void GetQuadricCoefficients(double[10]);
224 
228  vtkMTimeType GetMTime() override;
229 
231 
237 
238 protected:
241 
243 
245 
247 
252 
257 
262 
267  vtkHyperTreeGrid* output, vtkHyperTreeGridNonOrientedCursor* cursor, int treeIdx, int idx[3]);
268 
273  vtkHyperTreeGridNonOrientedCursor* cursor, unsigned int level, int treeIdx, int childIdx,
274  int idx[3], int parentPos);
275 
280  vtkHyperTreeGridNonOrientedCursor* cursor, unsigned int level, int treeIdx, int childIdx,
281  int idx[3], int parentPos);
282 
287  unsigned int level, int treeIdx, const int idx[3], double origin[3], double size[3]);
288 
292  double EvaluateQuadric(double[3]);
293 
294  double Origin[3];
295  double GridScale[3];
296  unsigned int Dimension;
297 
298  unsigned int Dimensions[3];
300  unsigned int MaxDepth;
301 
302  unsigned int Orientation;
303  unsigned int BranchFactor;
304  unsigned int BlockSize;
306  bool UseMask;
308 
312 
313  char* Descriptor;
314  char* Mask;
315  std::vector<std::string> LevelDescriptors;
316  std::vector<std::string> LevelMasks;
317 
320  std::vector<vtkIdType> LevelBitsIndex;
321  std::vector<vtkIdType> LevelBitsIndexCnt;
322 
324  std::map<vtkIdType, vtkIdType> LevelZeroMaterialMap;
325 
326  std::vector<int> LevelCounters;
327 
329 
331 
332 private:
334  void operator=(const vtkHyperTreeGridSource&) = delete;
335 };
336 
337 VTK_ABI_NAMESPACE_END
338 #endif
dynamic, self-adjusting array of bits
Definition: vtkBitArray.h:29
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
general representation of visualization data
Definition: vtkDataObject.h:64
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
vtkBitArray * ConvertDescriptorStringToBitArray(const std::string &)
Helpers to convert string descriptors & mask to bit arrays.
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,...
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
std::vector< int > LevelCounters
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.
int InitializeFromBitsDescriptor()
Initialize grid from bit array descriptors when it is to be used.
~vtkHyperTreeGridSource() override
vtkBitArray * ConvertMaskStringToBitArray(const std::string &)
Helpers to convert string descriptors & mask to bit arrays.
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:38
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
evaluate implicit quadric function
Definition: vtkQuadric.h:32
@ level
Definition: vtkX3D.h:395
@ scale
Definition: vtkX3D.h:229
@ size
Definition: vtkX3D.h:253
@ string
Definition: vtkX3D.h:490
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270