VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkExtractBlock Class Reference

extracts blocks from a multiblock dataset. More...

#include <vtkExtractBlock.h>

Inherits vtkMultiBlockDataSetAlgorithm.

Public Types

typedef
vtkMultiBlockDataSetAlgorithm 
Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkExtractBlockNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void AddIndex (unsigned int index)
 
void RemoveIndex (unsigned int index)
 
void RemoveAllIndices ()
 
virtual void SetPruneOutput (int)
 
virtual int GetPruneOutput ()
 
virtual void PruneOutputOn ()
 
virtual void PruneOutputOff ()
 
virtual void SetMaintainStructure (int)
 
virtual int GetMaintainStructure ()
 
virtual void MaintainStructureOn ()
 
virtual void MaintainStructureOff ()
 

Static Public Member Functions

static vtkExtractBlockNew ()
 
static int IsTypeOf (const char *type)
 
static vtkExtractBlockSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkExtractBlock ()
 
 ~vtkExtractBlock ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Implementation of the algorithm. More...
 
void CopySubTree (vtkDataObjectTreeIterator *loc, vtkMultiBlockDataSet *output, vtkMultiBlockDataSet *input)
 Extract subtree. More...
 
bool Prune (vtkMultiBlockDataSet *mblock)
 
bool Prune (vtkMultiPieceDataSet *mblock)
 
bool Prune (vtkDataObject *mblock)
 

Static Protected Member Functions

static vtkInformationIntegerKey * DONT_PRUNE ()
 

Protected Attributes

int PruneOutput
 
int MaintainStructure
 

Detailed Description

extracts blocks from a multiblock dataset.

vtkExtractBlock is a filter that extracts blocks from a multiblock dataset. Each node in the multi-block tree is identified by an index. The index can be obtained by performing a preorder traversal of the tree (including empty nodes). eg. A(B (D, E), C(F, G)). Inorder traversal yields: A, B, D, E, C, F, G Index of A is 0, while index of C is 4.

Tests:
vtkExtractBlock (Tests)

Definition at line 38 of file vtkExtractBlock.h.

Member Typedef Documentation

typedef vtkMultiBlockDataSetAlgorithm vtkExtractBlock::Superclass

Definition at line 42 of file vtkExtractBlock.h.

Constructor & Destructor Documentation

vtkExtractBlock::vtkExtractBlock ( )
protected
vtkExtractBlock::~vtkExtractBlock ( )
protected

Member Function Documentation

static vtkExtractBlock* vtkExtractBlock::New ( )
static
static int vtkExtractBlock::IsTypeOf ( const char *  type)
static
virtual int vtkExtractBlock::IsA ( const char *  type)
virtual
static vtkExtractBlock* vtkExtractBlock::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkExtractBlock::NewInstanceInternal ( ) const
protectedvirtual
vtkExtractBlock* vtkExtractBlock::NewInstance ( ) const
void vtkExtractBlock::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
void vtkExtractBlock::AddIndex ( unsigned int  index)

Select the block indices to extract. Each node in the multi-block tree is identified by an index. The index can be obtained by performing a preorder traversal of the tree (including empty nodes). eg. A(B (D, E), C(F, G)). Inorder traversal yields: A, B, D, E, C, F, G Index of A is 0, while index of C is 4.

void vtkExtractBlock::RemoveIndex ( unsigned int  index)

Select the block indices to extract. Each node in the multi-block tree is identified by an index. The index can be obtained by performing a preorder traversal of the tree (including empty nodes). eg. A(B (D, E), C(F, G)). Inorder traversal yields: A, B, D, E, C, F, G Index of A is 0, while index of C is 4.

void vtkExtractBlock::RemoveAllIndices ( )

Select the block indices to extract. Each node in the multi-block tree is identified by an index. The index can be obtained by performing a preorder traversal of the tree (including empty nodes). eg. A(B (D, E), C(F, G)). Inorder traversal yields: A, B, D, E, C, F, G Index of A is 0, while index of C is 4.

virtual void vtkExtractBlock::SetPruneOutput ( int  )
virtual

When set, the output mutliblock dataset will be pruned to remove empty nodes. On by default.

virtual int vtkExtractBlock::GetPruneOutput ( )
virtual

When set, the output mutliblock dataset will be pruned to remove empty nodes. On by default.

virtual void vtkExtractBlock::PruneOutputOn ( )
virtual

When set, the output mutliblock dataset will be pruned to remove empty nodes. On by default.

virtual void vtkExtractBlock::PruneOutputOff ( )
virtual

When set, the output mutliblock dataset will be pruned to remove empty nodes. On by default.

virtual void vtkExtractBlock::SetMaintainStructure ( int  )
virtual

This is used only when PruneOutput is ON. By default, when pruning the output i.e. remove empty blocks, if node has only 1 non-null child block, then that node is removed. To preserve these parent nodes, set this flag to true. Off by default.

virtual int vtkExtractBlock::GetMaintainStructure ( )
virtual

This is used only when PruneOutput is ON. By default, when pruning the output i.e. remove empty blocks, if node has only 1 non-null child block, then that node is removed. To preserve these parent nodes, set this flag to true. Off by default.

virtual void vtkExtractBlock::MaintainStructureOn ( )
virtual

This is used only when PruneOutput is ON. By default, when pruning the output i.e. remove empty blocks, if node has only 1 non-null child block, then that node is removed. To preserve these parent nodes, set this flag to true. Off by default.

virtual void vtkExtractBlock::MaintainStructureOff ( )
virtual

This is used only when PruneOutput is ON. By default, when pruning the output i.e. remove empty blocks, if node has only 1 non-null child block, then that node is removed. To preserve these parent nodes, set this flag to true. Off by default.

static vtkInformationIntegerKey* vtkExtractBlock::DONT_PRUNE ( )
staticprotected

Internal key, used to avoid pruning of a branch.

virtual int vtkExtractBlock::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Implementation of the algorithm.

void vtkExtractBlock::CopySubTree ( vtkDataObjectTreeIterator *  loc,
vtkMultiBlockDataSet *  output,
vtkMultiBlockDataSet *  input 
)
protected

Extract subtree.

bool vtkExtractBlock::Prune ( vtkMultiBlockDataSet *  mblock)
protected
bool vtkExtractBlock::Prune ( vtkMultiPieceDataSet *  mblock)
protected
bool vtkExtractBlock::Prune ( vtkDataObject *  mblock)
protected

Member Data Documentation

int vtkExtractBlock::PruneOutput
protected

Definition at line 95 of file vtkExtractBlock.h.

int vtkExtractBlock::MaintainStructure
protected

Definition at line 96 of file vtkExtractBlock.h.


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