ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkHierarchicalBoxDataSet Class Reference

vtkHierarchicalBoxDataSet - hierarchical dataset of vtkUniformGrids More...

Inheritance diagram for Kitware.VTK.vtkHierarchicalBoxDataSet:
[legend]
Collaboration diagram for Kitware.VTK.vtkHierarchicalBoxDataSet:
[legend]

List of all members.

Public Member Functions

 vtkHierarchicalBoxDataSet (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkHierarchicalBoxDataSet ()
 Undocumented Block.
void GenerateVisibilityArrays ()
 Blank lower level cells if they are overlapped by higher level ones.
override int GetDataObjectType ()
 Return class name of data type (see vtkType.h for definitions).
override vtkDataObject GetDataSet (vtkCompositeDataIterator iter)
 Unhiding superclass method.
uint GetFlatIndex (uint level, uint index)
 Given the level and dataset index, returns the flat index provided level and dataset index are valid.
vtkInformation GetLevelMetaData (uint level)
 Get meta-data associated with a level. This may allocate a new vtkInformation object if none is already present. Use HasLevelMetaData to avoid unnecessary allocations.
vtkInformation GetMetaData (uint level, uint index)
 Get meta-data associated with a dataset. This may allocate a new vtkInformation object if none is already present. Use HasMetaData to avoid unnecessary allocations.
override vtkInformation GetMetaData (vtkCompositeDataIterator iter)
 Unhiding superclass method.
uint GetNumberOfDataSets (uint level)
 Returns the number of data sets available at any level.
uint GetNumberOfLevels ()
 Returns the number of levels.
int GetRefinementRatio (uint level)
 Returns the refinement of a given level.
int GetRefinementRatio (vtkCompositeDataIterator iter)
 Returns the refinement ratio for the position pointed by the iterator.
virtual void GetScalarRange (IntPtr range)
 Copy the cached scalar range into range.
virtual IntPtr GetScalarRange ()
 Return the cached range.
int HasLevelMetaData (uint level)
 Returns if meta-data exists for a given level.
int HasMetaData (uint level, uint index)
 Returns if meta-data exists for a given dataset under a given level.
override int HasMetaData (vtkCompositeDataIterator iter)
 Unhiding superclass method.
override int IsA (string type)
 Undocumented Block.
new vtkHierarchicalBoxDataSet NewInstance ()
 Undocumented Block.
override vtkCompositeDataIterator NewIterator ()
 Return a new iterator (the iterator has to be deleted by user).
override void SetDataSet (vtkCompositeDataIterator iter, vtkDataObject dataObj)
 Sets the data set at the location pointed by the iterator. The iterator does not need to be iterating over this dataset itself. It can be any composite datasite with similar structure (achieve by using CopyStructure). Un-hiding superclass overload.
void SetDataSet (uint level, uint id, IntPtr LoCorner, IntPtr HiCorner, vtkUniformGrid dataSet)
 Set the dataset pointer for a given node. This will resize the number of levels and the number of datasets in the level to fit level, id requested.
void SetNumberOfDataSets (uint level, uint numdatasets)
 Set the number of data set at a given level.
void SetNumberOfLevels (uint numLevels)
 Set the number of refinement levels. This call might cause allocation if the new number of levels is larger than the current one.
void SetRefinementRatio (uint level, int refRatio)
 Sets the refinement of a given level. The spacing at level level+1 is defined as spacing(level+1) = spacing(level)/refRatio(level). Note that currently, this is not enforced by this class however some algorithms might not function properly if the spacing in the blocks (vtkUniformGrid) does not match the one described by the refinement ratio.

Static Public Member Functions

static new
vtkHierarchicalBoxDataSet 
New ()
 Undocumented Block.
static
vtkInformationIntegerVectorKey 
BOX ()
 Blank lower level cells if they are overlapped by higher level ones.
static vtkInformationIntegerKey BOX_DIMENSIONALITY ()
 Blank lower level cells if they are overlapped by higher level ones.
static new
vtkHierarchicalBoxDataSet 
GetData (vtkInformation info)
 Blank lower level cells if they are overlapped by higher level ones.
static new
vtkHierarchicalBoxDataSet 
GetData (vtkInformationVector v, int i)
 Blank lower level cells if they are overlapped by higher level ones.
static new int IsTypeOf (string type)
 Undocumented Block.
static vtkInformationIdTypeKey NUMBER_OF_BLANKED_POINTS ()
 Blank lower level cells if they are overlapped by higher level ones.
static vtkInformationIntegerKey REFINEMENT_RATIO ()
 Blank lower level cells if they are overlapped by higher level ones.
static new
vtkHierarchicalBoxDataSet 
SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkHierarchicalBoxDataSet"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "25vtkHierarchicalBoxDataSet"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkHierarchicalBoxDataSet_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHierarchicalBoxDataSet_BOX_01 (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHierarchicalBoxDataSet_BOX_DIMENSIONALITY_02 (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHierarchicalBoxDataSet_GenerateVisibilityArrays_03 (HandleRef pThis)
static internal IntPtr vtkHierarchicalBoxDataSet_GetData_04 (HandleRef info, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHierarchicalBoxDataSet_GetData_05 (HandleRef v, int i, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkHierarchicalBoxDataSet_GetDataObjectType_06 (HandleRef pThis)
static internal IntPtr vtkHierarchicalBoxDataSet_GetDataSet_07 (HandleRef pThis, HandleRef iter, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkHierarchicalBoxDataSet_GetFlatIndex_08 (HandleRef pThis, uint level, uint index)
static internal IntPtr vtkHierarchicalBoxDataSet_GetLevelMetaData_09 (HandleRef pThis, uint level, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHierarchicalBoxDataSet_GetMetaData_10 (HandleRef pThis, uint level, uint index, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHierarchicalBoxDataSet_GetMetaData_11 (HandleRef pThis, HandleRef iter, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkHierarchicalBoxDataSet_GetNumberOfDataSets_12 (HandleRef pThis, uint level)
static internal uint vtkHierarchicalBoxDataSet_GetNumberOfLevels_13 (HandleRef pThis)
static internal int vtkHierarchicalBoxDataSet_GetRefinementRatio_14 (HandleRef pThis, uint level)
static internal int vtkHierarchicalBoxDataSet_GetRefinementRatio_15 (HandleRef pThis, HandleRef iter)
static internal void vtkHierarchicalBoxDataSet_GetScalarRange_16 (HandleRef pThis, IntPtr range)
static internal IntPtr vtkHierarchicalBoxDataSet_GetScalarRange_17 (HandleRef pThis)
static internal int vtkHierarchicalBoxDataSet_HasLevelMetaData_18 (HandleRef pThis, uint level)
static internal int vtkHierarchicalBoxDataSet_HasMetaData_19 (HandleRef pThis, uint level, uint index)
static internal int vtkHierarchicalBoxDataSet_HasMetaData_20 (HandleRef pThis, HandleRef iter)
static internal int vtkHierarchicalBoxDataSet_IsA_21 (HandleRef pThis, string type)
static internal int vtkHierarchicalBoxDataSet_IsTypeOf_22 (string type)
static internal IntPtr vtkHierarchicalBoxDataSet_NUMBER_OF_BLANKED_POINTS_23 (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHierarchicalBoxDataSet_NewInstance_25 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHierarchicalBoxDataSet_NewIterator_26 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHierarchicalBoxDataSet_REFINEMENT_RATIO_27 (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHierarchicalBoxDataSet_SafeDownCast_28 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHierarchicalBoxDataSet_SetDataSet_29 (HandleRef pThis, HandleRef iter, HandleRef dataObj)
static internal void vtkHierarchicalBoxDataSet_SetDataSet_30 (HandleRef pThis, uint level, uint id, IntPtr LoCorner, IntPtr HiCorner, HandleRef dataSet)
static internal void vtkHierarchicalBoxDataSet_SetNumberOfDataSets_31 (HandleRef pThis, uint level, uint numdatasets)
static internal void vtkHierarchicalBoxDataSet_SetNumberOfLevels_32 (HandleRef pThis, uint numLevels)
static internal void vtkHierarchicalBoxDataSet_SetRefinementRatio_33 (HandleRef pThis, uint level, int refRatio)

Static Private Member Functions

static vtkHierarchicalBoxDataSet ()
 Automatically generated type registration mechanics.

Detailed Description

vtkHierarchicalBoxDataSet - hierarchical dataset of vtkUniformGrids

Description vtkHierarchicalBoxDataSet is a concrete implementation of vtkCompositeDataSet. The dataset type is restricted to vtkUniformGrid. Each dataset has an associated vtkAMRBox that represents it's region (similar to extent) in space.

Warning To compute the cellId of a cell within a vtkUniformGrid with AMRBox=box, you should not use vtkUniformGrid::ComputeCellId( {x,y,z} ) but instead use the following pseudo code: for (int i=0; i<3; i++) { cellDims[i] = box.HiCorner[i] - box.LoCorner[i] + 1; } vtkIdType cellId = (z-box.LoCorner[2])*cellDims[0]*cellDims[1] + (y-box.LoCorner[1])*cellDims[0] + (x-box.LoCorner[0]);

NOTE vtkAMRBox is used to compute cell visibility, therefor it should be dimensioned according to the visible region.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

Blank lower level cells if they are overlapped by higher level ones.

Here is the call graph for this function:

Blank lower level cells if they are overlapped by higher level ones.

Here is the call graph for this function:

override void Kitware.VTK.vtkHierarchicalBoxDataSet.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

Blank lower level cells if they are overlapped by higher level ones.

Blank lower level cells if they are overlapped by higher level ones.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

Here is the call graph for this function:

Blank lower level cells if they are overlapped by higher level ones.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

Here is the call graph for this function:

Return class name of data type (see vtkType.h for definitions).

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

Unhiding superclass method.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

Here is the call graph for this function:

uint Kitware.VTK.vtkHierarchicalBoxDataSet.GetFlatIndex ( uint  level,
uint  index 
)

Given the level and dataset index, returns the flat index provided level and dataset index are valid.

Get meta-data associated with a level. This may allocate a new vtkInformation object if none is already present. Use HasLevelMetaData to avoid unnecessary allocations.

Here is the call graph for this function:

Get meta-data associated with a dataset. This may allocate a new vtkInformation object if none is already present. Use HasMetaData to avoid unnecessary allocations.

Here is the call graph for this function:

Unhiding superclass method.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

Here is the call graph for this function:

Returns the number of data sets available at any level.

Returns the number of levels.

Returns the refinement of a given level.

Returns the refinement ratio for the position pointed by the iterator.

virtual void Kitware.VTK.vtkHierarchicalBoxDataSet.GetScalarRange ( IntPtr  range) [virtual]

Copy the cached scalar range into range.

Return the cached range.

Returns if meta-data exists for a given level.

int Kitware.VTK.vtkHierarchicalBoxDataSet.HasMetaData ( uint  level,
uint  index 
)

Returns if meta-data exists for a given dataset under a given level.

Unhiding superclass method.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

override int Kitware.VTK.vtkHierarchicalBoxDataSet.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

static new int Kitware.VTK.vtkHierarchicalBoxDataSet.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

Return a new iterator (the iterator has to be deleted by user).

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

Here is the call graph for this function:

Blank lower level cells if they are overlapped by higher level ones.

Here is the call graph for this function:

Blank lower level cells if they are overlapped by higher level ones.

Here is the call graph for this function:

Undocumented Block.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

Here is the call graph for this function:

Sets the data set at the location pointed by the iterator. The iterator does not need to be iterating over this dataset itself. It can be any composite datasite with similar structure (achieve by using CopyStructure). Un-hiding superclass overload.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

void Kitware.VTK.vtkHierarchicalBoxDataSet.SetDataSet ( uint  level,
uint  id,
IntPtr  LoCorner,
IntPtr  HiCorner,
vtkUniformGrid  dataSet 
)

Set the dataset pointer for a given node. This will resize the number of levels and the number of datasets in the level to fit level, id requested.

void Kitware.VTK.vtkHierarchicalBoxDataSet.SetNumberOfDataSets ( uint  level,
uint  numdatasets 
)

Set the number of data set at a given level.

Set the number of refinement levels. This call might cause allocation if the new number of levels is larger than the current one.

void Kitware.VTK.vtkHierarchicalBoxDataSet.SetRefinementRatio ( uint  level,
int  refRatio 
)

Sets the refinement of a given level. The spacing at level level+1 is defined as spacing(level+1) = spacing(level)/refRatio(level). Note that currently, this is not enforced by this class however some algorithms might not function properly if the spacing in the blocks (vtkUniformGrid) does not match the one described by the refinement ratio.

static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_BOX_01 ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_BOX_DIMENSIONALITY_02 ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetData_04 ( HandleRef  info,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetData_05 ( HandleRef  v,
int  i,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetDataSet_07 ( HandleRef  pThis,
HandleRef  iter,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetFlatIndex_08 ( HandleRef  pThis,
uint  level,
uint  index 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetLevelMetaData_09 ( HandleRef  pThis,
uint  level,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetMetaData_10 ( HandleRef  pThis,
uint  level,
uint  index,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetMetaData_11 ( HandleRef  pThis,
HandleRef  iter,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetNumberOfDataSets_12 ( HandleRef  pThis,
uint  level 
) [private]
static internal int Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetRefinementRatio_14 ( HandleRef  pThis,
uint  level 
) [private]
static internal int Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetRefinementRatio_15 ( HandleRef  pThis,
HandleRef  iter 
) [private]
static internal void Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetScalarRange_16 ( HandleRef  pThis,
IntPtr  range 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_GetScalarRange_17 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_HasLevelMetaData_18 ( HandleRef  pThis,
uint  level 
) [private]
static internal int Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_HasMetaData_19 ( HandleRef  pThis,
uint  level,
uint  index 
) [private]
static internal int Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_HasMetaData_20 ( HandleRef  pThis,
HandleRef  iter 
) [private]
static internal int Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_IsA_21 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_NewInstance_25 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_NewIterator_26 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_NUMBER_OF_BLANKED_POINTS_23 ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_REFINEMENT_RATIO_27 ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_SafeDownCast_28 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_SetDataSet_29 ( HandleRef  pThis,
HandleRef  iter,
HandleRef  dataObj 
) [private]
static internal void Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_SetDataSet_30 ( HandleRef  pThis,
uint  level,
uint  id,
IntPtr  LoCorner,
IntPtr  HiCorner,
HandleRef  dataSet 
) [private]
static internal void Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_SetNumberOfDataSets_31 ( HandleRef  pThis,
uint  level,
uint  numdatasets 
) [private]
static internal void Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_SetNumberOfLevels_32 ( HandleRef  pThis,
uint  numLevels 
) [private]
static internal void Kitware.VTK.vtkHierarchicalBoxDataSet.vtkHierarchicalBoxDataSet_SetRefinementRatio_33 ( HandleRef  pThis,
uint  level,
int  refRatio 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkHierarchicalBoxDataSet.MRClassNameKey = "25vtkHierarchicalBoxDataSet" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.

new const string Kitware.VTK.vtkHierarchicalBoxDataSet.MRFullTypeName = "Kitware.VTK.vtkHierarchicalBoxDataSet"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkCompositeDataSet.


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