VTK  9.2.6
vtkHyperTreeGridSource.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkHyperTreeGridSource.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
67 #ifndef vtkHyperTreeGridSource_h
68 #define vtkHyperTreeGridSource_h
69 
70 #include "vtkFiltersSourcesModule.h" // For export macro
72 
73 #include <map> // STL Header
74 #include <string> // STL Header
75 #include <vector> // STL Header
76 
77 class vtkBitArray;
78 class vtkDataArray;
80 class vtkIdTypeArray;
82 class vtkHyperTreeGrid;
83 class vtkQuadric;
84 
85 class VTKFILTERSSOURCES_EXPORT vtkHyperTreeGridSource : public vtkHyperTreeGridAlgorithm
86 {
87 public:
89  void PrintSelf(ostream& os, vtkIndent indent) override;
90 
92 
97  unsigned int GetMaxDepth();
98 
105  void SetMaxDepth(unsigned int levels);
106 
108 
111  vtkSetVector3Macro(Origin, double);
112  vtkGetVector3Macro(Origin, double);
114 
116 
119  vtkSetVector3Macro(GridScale, double);
120  vtkGetVector3Macro(GridScale, double);
121  void SetGridScale(double scale) { this->SetGridScale(scale, scale, scale); }
123 
125 
128  void SetDimensions(const unsigned int* dims);
129  void SetDimensions(unsigned int, unsigned int, unsigned int);
130  vtkGetVector3Macro(Dimensions, unsigned int);
132 
134 
138  vtkSetMacro(TransposedRootIndexing, bool);
139  vtkGetMacro(TransposedRootIndexing, bool);
143 
145 
148  vtkGetMacro(Orientation, unsigned int);
150 
152 
155  vtkSetClampMacro(BranchFactor, unsigned int, 2, 3);
156  vtkGetMacro(BranchFactor, unsigned int);
158 
160 
165  vtkSetMacro(UseDescriptor, bool);
166  vtkGetMacro(UseDescriptor, bool);
167  vtkBooleanMacro(UseDescriptor, bool);
169 
171 
176  vtkSetMacro(UseMask, bool);
177  vtkGetMacro(UseMask, bool);
178  vtkBooleanMacro(UseMask, bool);
180 
182 
187  vtkSetMacro(GenerateInterfaceFields, bool);
188  vtkGetMacro(GenerateInterfaceFields, bool);
189  vtkBooleanMacro(GenerateInterfaceFields, bool);
191 
193 
196  vtkSetStringMacro(Descriptor);
197  vtkGetStringMacro(Descriptor);
199 
201 
204  vtkSetStringMacro(Mask);
205  vtkGetStringMacro(Mask);
207 
209 
213  vtkGetObjectMacro(DescriptorBits, vtkBitArray);
215 
220 
222 
225  virtual void SetMaskBits(vtkBitArray*);
226  vtkGetObjectMacro(MaskBits, vtkBitArray);
228 
230 
233  virtual void SetQuadric(vtkQuadric*);
234  vtkGetObjectMacro(Quadric, vtkQuadric);
236 
238 
241  void SetQuadricCoefficients(double[10]);
242  void GetQuadricCoefficients(double[10]);
245 
249  vtkMTimeType GetMTime() override;
250 
252 
258 
259 protected:
262 
264 
266 
268 
273 
278 
283 
288  vtkHyperTreeGrid* output, vtkHyperTreeGridNonOrientedCursor* cursor, int treeIdx, int idx[3]);
289 
294  vtkHyperTreeGridNonOrientedCursor* cursor, unsigned int level, int treeIdx, int childIdx,
295  int idx[3], int parentPos);
296 
301  vtkHyperTreeGridNonOrientedCursor* cursor, unsigned int level, int treeIdx, int childIdx,
302  int idx[3], int parentPos);
303 
308  unsigned int level, int treeIdx, const int idx[3], double origin[3], double size[3]);
309 
313  double EvaluateQuadric(double[3]);
314 
315  double Origin[3];
316  double GridScale[3];
317  unsigned int Dimension;
318 
319 protected:
320  unsigned int Dimensions[3];
322  unsigned int MaxDepth;
323 
324  unsigned int Orientation;
325  unsigned int BranchFactor;
326  unsigned int BlockSize;
328  bool UseMask;
330 
334 
335  char* Descriptor;
336  char* Mask;
337  std::vector<std::string> LevelDescriptors;
338  std::vector<std::string> LevelMasks;
339 
342  std::vector<vtkIdType> LevelBitsIndex;
343  std::vector<vtkIdType> LevelBitsIndexCnt;
344 
346  std::map<vtkIdType, vtkIdType> LevelZeroMaterialMap;
347 
348  std::vector<int> LevelCounters;
349 
351 
353 
354 private:
356  void operator=(const vtkHyperTreeGridSource&) = delete;
357 };
358 
359 #endif
dynamic, self-adjusting array of bits
Definition: vtkBitArray.h:37
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:165
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
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:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
evaluate implicit quadric function
Definition: vtkQuadric.h:123
@ level
Definition: vtkX3D.h:401
@ scale
Definition: vtkX3D.h:235
@ size
Definition: vtkX3D.h:259
@ string
Definition: vtkX3D.h:496
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287