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=========================================================================*/
48#ifndef vtkHyperTreeGridSource_h
49#define vtkHyperTreeGridSource_h
50
51#include "vtkFiltersSourcesModule.h" // For export macro
53
54#include <map> // STL Header
55#include <string> // STL Header
56#include <vector> // STL Header
57
58class vtkBitArray;
59class vtkDataArray;
61class vtkIdTypeArray;
64class vtkQuadric;
65
66class VTKFILTERSSOURCES_EXPORT vtkHyperTreeGridSource : public vtkHyperTreeGridAlgorithm
67{
68public:
70 void PrintSelf(ostream& os, vtkIndent indent) override;
71
73
78 unsigned int GetMaxDepth();
79
86 void SetMaxDepth(unsigned int levels);
87
89
92 vtkSetVector3Macro(Origin, double);
93 vtkGetVector3Macro(Origin, double);
95
97
100 vtkSetVector3Macro(GridScale, double);
101 vtkGetVector3Macro(GridScale, double);
102 void SetGridScale(double scale) { this->SetGridScale(scale, scale, scale); }
104
106
109 void SetDimensions(const unsigned int* dims);
110 void SetDimensions(unsigned int, unsigned int, unsigned int);
111 vtkGetVector3Macro(Dimensions, unsigned int);
113
115
119 vtkSetMacro(TransposedRootIndexing, bool);
120 vtkGetMacro(TransposedRootIndexing, bool);
124
126
129 vtkGetMacro(Orientation, unsigned int);
131
133
136 vtkSetClampMacro(BranchFactor, unsigned int, 2, 3);
137 vtkGetMacro(BranchFactor, unsigned int);
139
141
146 vtkSetMacro(UseDescriptor, bool);
147 vtkGetMacro(UseDescriptor, bool);
148 vtkBooleanMacro(UseDescriptor, bool);
150
152
157 vtkSetMacro(UseMask, bool);
158 vtkGetMacro(UseMask, bool);
159 vtkBooleanMacro(UseMask, bool);
161
163
168 vtkSetMacro(GenerateInterfaceFields, bool);
169 vtkGetMacro(GenerateInterfaceFields, bool);
170 vtkBooleanMacro(GenerateInterfaceFields, bool);
172
174
177 vtkSetStringMacro(Descriptor);
178 vtkGetStringMacro(Descriptor);
180
182
185 vtkSetStringMacro(Mask);
186 vtkGetStringMacro(Mask);
188
190
194 vtkGetObjectMacro(DescriptorBits, vtkBitArray);
196
201
203
206 virtual void SetMaskBits(vtkBitArray*);
207 vtkGetObjectMacro(MaskBits, vtkBitArray);
209
211
214 virtual void SetQuadric(vtkQuadric*);
215 vtkGetObjectMacro(Quadric, vtkQuadric);
217
219
222 void SetQuadricCoefficients(double[10]);
223 void GetQuadricCoefficients(double[10]);
226
231
233
239
240protected:
243
245
247
249
254
259
264
269 vtkHyperTreeGrid* output, vtkHyperTreeGridNonOrientedCursor* cursor, int treeIdx, int idx[3]);
270
275 vtkHyperTreeGridNonOrientedCursor* cursor, unsigned int level, int treeIdx, int childIdx,
276 int idx[3], int parentPos);
277
282 vtkHyperTreeGridNonOrientedCursor* cursor, unsigned int level, int treeIdx, int childIdx,
283 int idx[3], int parentPos);
284
289 unsigned int level, int treeIdx, const int idx[3], double origin[3], double size[3]);
290
294 double EvaluateQuadric(double[3]);
295
296 double Origin[3];
297 double GridScale[3];
298 unsigned int Dimension;
299
300protected:
301 unsigned int Dimensions[3];
303 unsigned int MaxDepth;
304
305 unsigned int Orientation;
306 unsigned int BranchFactor;
307 unsigned int BlockSize;
311
315
317 char* Mask;
318 std::vector<std::string> LevelDescriptors;
319 std::vector<std::string> LevelMasks;
320
323 std::vector<vtkIdType> LevelBitsIndex;
324 std::vector<vtkIdType> LevelBitsIndexCnt;
325
327 std::map<vtkIdType, vtkIdType> LevelZeroMaterialMap;
328
329 std::vector<int> LevelCounters;
330
332
334
335private:
337 void operator=(const vtkHyperTreeGridSource&) = delete;
338};
339
340#endif
dynamic, self-adjusting array of bits
Definition vtkBitArray.h:37
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:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
evaluate implicit quadric function
Definition vtkQuadric.h:34
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287