VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkHyperTreeGridSource Class Reference

Create a synthetic grid of hypertrees. More...

#include <vtkHyperTreeGridSource.h>

Inheritance diagram for vtkHyperTreeGridSource:
Inheritance graph
[legend]
Collaboration diagram for vtkHyperTreeGridSource:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkHyperTreeGridAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkHyperTreeGridSourceNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
unsigned int GetMaximumLevel ()
void SetMaximumLevel (unsigned int levels)
virtual void SetLevelZeroMaterialIndex (vtkIdTypeArray *)
unsigned long GetMTime ()
virtual void SetOrigin (double, double, double)
virtual void SetOrigin (double[3])
virtual doubleGetOrigin ()
virtual void GetOrigin (double &, double &, double &)
virtual void GetOrigin (double[3])
virtual void SetGridScale (double, double, double)
virtual void SetGridScale (double[3])
virtual doubleGetGridScale ()
virtual void GetGridScale (double &, double &, double &)
virtual void GetGridScale (double[3])
virtual void SetGridSize (unsigned int, unsigned int, unsigned int)
virtual void SetGridSize (unsigned int[3])
virtual unsigned intGetGridSize ()
virtual void GetGridSize (unsigned int &, unsigned int &, unsigned int &)
virtual void GetGridSize (unsigned int[3])
virtual void SetTransposedRootIndexing (bool)
virtual bool GetTransposedRootIndexing ()
void SetIndexingModeToKJI ()
void SetIndexingModeToIJK ()
virtual void SetBranchFactor (unsigned int)
virtual unsigned int GetBranchFactor ()
virtual void SetDimension (unsigned int)
virtual unsigned int GetDimension ()
virtual void SetUseDescriptor (bool)
virtual bool GetUseDescriptor ()
virtual void UseDescriptorOn ()
virtual void UseDescriptorOff ()
virtual void SetUseMaterialMask (bool)
virtual bool GetUseMaterialMask ()
virtual void UseMaterialMaskOn ()
virtual void UseMaterialMaskOff ()
virtual void SetDescriptor (const char *)
virtual char * GetDescriptor ()
virtual void SetMaterialMask (const char *)
virtual char * GetMaterialMask ()
virtual void SetDescriptorBits (vtkBitArray *)
virtual vtkBitArrayGetDescriptorBits ()
virtual void SetMaterialMaskBits (vtkBitArray *)
virtual vtkBitArrayGetMaterialMaskBits ()
virtual void SetQuadric (vtkQuadric *)
virtual vtkQuadricGetQuadric ()
void SetQuadricCoefficients (double[10])
void GetQuadricCoefficients (double[10])
doubleGetQuadricCoefficients ()
vtkBitArrayConvertDescriptorStringToBitArray (const vtkStdString &)
vtkBitArrayConvertMaterialMaskStringToBitArray (const vtkStdString &)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkHyperTreeGridSourceSafeDownCast (vtkObjectBase *o)
static vtkHyperTreeGridSourceNew ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkHyperTreeGridSource ()
 ~vtkHyperTreeGridSource ()
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int InitializeFromStringDescriptor ()
int InitializeFromBitsDescriptor ()
double EvaluateQuadric (double[3])
void InitTreeFromDescriptor (vtkHyperTreeCursor *cursor, int treeIdx, int idx[3])
void SubdivideFromStringDescriptor (vtkHyperTreeCursor *cursor, unsigned int level, int treeIdx, int childIdx, int idx[3], int parentPos)
void SubdivideFromBitsDescriptor (vtkHyperTreeCursor *cursor, unsigned int level, int treeIdx, int childIdx, int idx[3], int parentPos)
void SubdivideFromQuadric (vtkHyperTreeCursor *cursor, unsigned int level, int treeIdx, int idx[3], double origin[3], double size[3])

Protected Attributes

double Origin [3]
double GridScale [3]
unsigned int GridSize [3]
bool TransposedRootIndexing
unsigned int MaximumLevel
unsigned int Dimension
unsigned int BranchFactor
unsigned int BlockSize
bool UseDescriptor
bool UseMaterialMask
vtkDataArrayXCoordinates
vtkDataArrayYCoordinates
vtkDataArrayZCoordinates
char * Descriptor
char * MaterialMask
std::vector< vtkStdStringLevelDescriptors
std::vector< vtkStdStringLevelMaterialMasks
vtkBitArrayDescriptorBits
vtkBitArrayMaterialMaskBits
std::vector< vtkIdTypeLevelBitsIndex
std::vector< vtkIdTypeLevelBitsIndexCnt
vtkIdTypeArrayLevelZeroMaterialIndex
std::map< vtkIdType, vtkIdTypeLevelZeroMaterialMap
std::vector< intLevelCounters
vtkQuadricQuadric
vtkHyperTreeGridOutput

Detailed Description

Create a synthetic grid of hypertrees.

This class uses input parameters, most notably a string descriptor, to generate a vtkHyperTreeGrid instance representing the corresponding tree-based AMR grid. This descriptor uses the following conventions, e.g., to describe a 1-D ternary subdivision with 2 root cells L0 L1 L2 RR | .R. ... | ... For this tree: /* L2: c c c

Definition at line 58 of file vtkHyperTreeGridSource.h.


Member Typedef Documentation

Reimplemented from vtkHyperTreeGridAlgorithm.

Definition at line 61 of file vtkHyperTreeGridSource.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkHyperTreeGridSource::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkHyperTreeGridAlgorithm.

virtual int vtkHyperTreeGridSource::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkHyperTreeGridAlgorithm.

Reimplemented from vtkHyperTreeGridAlgorithm.

virtual vtkObjectBase* vtkHyperTreeGridSource::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkHyperTreeGridAlgorithm.

Reimplemented from vtkHyperTreeGridAlgorithm.

void vtkHyperTreeGridSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkHyperTreeGridAlgorithm.

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

Return the maximum number of levels of the hypertree.

Postcondition:
positive_result: result>=1
void vtkHyperTreeGridSource::SetMaximumLevel ( unsigned int  levels)

Set the maximum number of levels of the hypertree.

Precondition:
positive_levels: levels>=1
Postcondition:
is_set: this->GetLevels()==levels
virtual void vtkHyperTreeGridSource::SetOrigin ( double  ,
double  ,
double   
) [virtual]

Set/Get the origin of the grid

virtual void vtkHyperTreeGridSource::SetOrigin ( double  [3]) [virtual]

Set/Get the origin of the grid

virtual double* vtkHyperTreeGridSource::GetOrigin ( ) [virtual]

Set/Get the origin of the grid

virtual void vtkHyperTreeGridSource::GetOrigin ( double ,
double ,
double  
) [virtual]

Set/Get the origin of the grid

virtual void vtkHyperTreeGridSource::GetOrigin ( double  [3]) [virtual]

Set/Get the origin of the grid

virtual void vtkHyperTreeGridSource::SetGridScale ( double  ,
double  ,
double   
) [virtual]

Set/Get the scale to be applied to root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::SetGridScale ( double  [3]) [virtual]

Set/Get the scale to be applied to root cells in each dimension of the grid

Set/Get the scale to be applied to root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::GetGridScale ( double ,
double ,
double  
) [virtual]

Set/Get the scale to be applied to root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::GetGridScale ( double  [3]) [virtual]

Set/Get the scale to be applied to root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::SetGridSize ( unsigned  int,
unsigned  int,
unsigned  int 
) [virtual]

Set/Get the number of root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::SetGridSize ( unsigned  int[3]) [virtual]

Set/Get the number of root cells in each dimension of the grid

virtual unsigned int* vtkHyperTreeGridSource::GetGridSize ( ) [virtual]

Set/Get the number of root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::GetGridSize ( unsigned int ,
unsigned int ,
unsigned int  
) [virtual]

Set/Get the number of root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::GetGridSize ( unsigned  int[3]) [virtual]

Set/Get the number of root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::SetTransposedRootIndexing ( bool  ) [virtual]

Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last

Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last

Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last

Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last

virtual void vtkHyperTreeGridSource::SetBranchFactor ( unsigned  int) [virtual]

Set/Get the subdivision factor in the grid refinement scheme

virtual unsigned int vtkHyperTreeGridSource::GetBranchFactor ( ) [virtual]

Set/Get the subdivision factor in the grid refinement scheme

virtual void vtkHyperTreeGridSource::SetDimension ( unsigned  int) [virtual]

Set/Get the dimensionality of the grid

virtual unsigned int vtkHyperTreeGridSource::GetDimension ( ) [virtual]

Set/Get the dimensionality of the grid

virtual void vtkHyperTreeGridSource::SetUseDescriptor ( bool  ) [virtual]

Set/get whether the descriptor string should be used. NB: Otherwise a quadric definition is expected. Default: true

virtual bool vtkHyperTreeGridSource::GetUseDescriptor ( ) [virtual]

Set/get whether the descriptor string should be used. NB: Otherwise a quadric definition is expected. Default: true

virtual void vtkHyperTreeGridSource::UseDescriptorOn ( ) [virtual]

Set/get whether the descriptor string should be used. NB: Otherwise a quadric definition is expected. Default: true

virtual void vtkHyperTreeGridSource::UseDescriptorOff ( ) [virtual]

Set/get whether the descriptor string should be used. NB: Otherwise a quadric definition is expected. Default: true

virtual void vtkHyperTreeGridSource::SetUseMaterialMask ( bool  ) [virtual]

Set/get whether the material mask should be used. NB: This is only used when UseDescriptor is ON Default: false

virtual bool vtkHyperTreeGridSource::GetUseMaterialMask ( ) [virtual]

Set/get whether the material mask should be used. NB: This is only used when UseDescriptor is ON Default: false

virtual void vtkHyperTreeGridSource::UseMaterialMaskOn ( ) [virtual]

Set/get whether the material mask should be used. NB: This is only used when UseDescriptor is ON Default: false

virtual void vtkHyperTreeGridSource::UseMaterialMaskOff ( ) [virtual]

Set/get whether the material mask should be used. NB: This is only used when UseDescriptor is ON Default: false

virtual void vtkHyperTreeGridSource::SetDescriptor ( const char *  ) [virtual]

Set/Get the string used to describe the grid

virtual char* vtkHyperTreeGridSource::GetDescriptor ( ) [virtual]

Set/Get the string used to describe the grid

virtual void vtkHyperTreeGridSource::SetMaterialMask ( const char *  ) [virtual]

Set/Get the string used to as a material mask

virtual char* vtkHyperTreeGridSource::GetMaterialMask ( ) [virtual]

Set/Get the string used to as a material mask

Set/Get the bitarray used to describe the grid

Set/Get the bitarray used to describe the grid

Set the index array used to as a material mask

Set/Get the bitarray used as a material mask

Set/Get the bitarray used as a material mask

virtual void vtkHyperTreeGridSource::SetQuadric ( vtkQuadric ) [virtual]

Set/Get the quadric function

Set/Get the quadric function

Helpers to set/get the 10 coefficients of the quadric function

Helpers to set/get the 10 coefficients of the quadric function

Helpers to set/get the 10 coefficients of the quadric function

unsigned long vtkHyperTreeGridSource::GetMTime ( ) [virtual]

Override GetMTime because we delegate to a vtkQuadric

Reimplemented from vtkObject.

Helpers to convert string descriptors & mask to bit arrays

Helpers to convert string descriptors & mask to bit arrays

Reimplemented from vtkHyperTreeGridAlgorithm.

virtual int vtkHyperTreeGridSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkHyperTreeGridAlgorithm.

Initialize grid from descriptor string when it is to be used

Initialize grid from bit array descriptors when it is to be used

void vtkHyperTreeGridSource::InitTreeFromDescriptor ( vtkHyperTreeCursor cursor,
int  treeIdx,
int  idx[3] 
) [protected]

Initialize tree grid from descriptor and call subdivide if needed

void vtkHyperTreeGridSource::SubdivideFromStringDescriptor ( vtkHyperTreeCursor cursor,
unsigned int  level,
int  treeIdx,
int  childIdx,
int  idx[3],
int  parentPos 
) [protected]

Subdivide grid from descriptor string when it is to be used

void vtkHyperTreeGridSource::SubdivideFromBitsDescriptor ( vtkHyperTreeCursor cursor,
unsigned int  level,
int  treeIdx,
int  childIdx,
int  idx[3],
int  parentPos 
) [protected]

Subdivide grid from descriptor string when it is to be used

void vtkHyperTreeGridSource::SubdivideFromQuadric ( vtkHyperTreeCursor cursor,
unsigned int  level,
int  treeIdx,
int  idx[3],
double  origin[3],
double  size[3] 
) [protected]

Subdivide grid from quadric when descriptor is not used

Evaluate quadric at given point coordinates


Member Data Documentation

Definition at line 238 of file vtkHyperTreeGridSource.h.

Definition at line 239 of file vtkHyperTreeGridSource.h.

unsigned int vtkHyperTreeGridSource::GridSize[3] [protected]

Definition at line 240 of file vtkHyperTreeGridSource.h.

Definition at line 241 of file vtkHyperTreeGridSource.h.

Definition at line 242 of file vtkHyperTreeGridSource.h.

unsigned int vtkHyperTreeGridSource::Dimension [protected]

Definition at line 243 of file vtkHyperTreeGridSource.h.

Definition at line 244 of file vtkHyperTreeGridSource.h.

unsigned int vtkHyperTreeGridSource::BlockSize [protected]

Definition at line 245 of file vtkHyperTreeGridSource.h.

Definition at line 246 of file vtkHyperTreeGridSource.h.

Definition at line 247 of file vtkHyperTreeGridSource.h.

Definition at line 249 of file vtkHyperTreeGridSource.h.

Definition at line 250 of file vtkHyperTreeGridSource.h.

Definition at line 251 of file vtkHyperTreeGridSource.h.

Definition at line 253 of file vtkHyperTreeGridSource.h.

Definition at line 254 of file vtkHyperTreeGridSource.h.

Definition at line 255 of file vtkHyperTreeGridSource.h.

Definition at line 256 of file vtkHyperTreeGridSource.h.

Definition at line 258 of file vtkHyperTreeGridSource.h.

Definition at line 259 of file vtkHyperTreeGridSource.h.

Definition at line 260 of file vtkHyperTreeGridSource.h.

Definition at line 261 of file vtkHyperTreeGridSource.h.

Definition at line 263 of file vtkHyperTreeGridSource.h.

Definition at line 264 of file vtkHyperTreeGridSource.h.

std::vector<int> vtkHyperTreeGridSource::LevelCounters [protected]

Definition at line 266 of file vtkHyperTreeGridSource.h.

Definition at line 268 of file vtkHyperTreeGridSource.h.

Definition at line 270 of file vtkHyperTreeGridSource.h.


The documentation for this class was generated from the following file: