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

extracts blocks from a multiblock dataset. More...

#include <vtkExtractBlock.h>

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

List of all members.

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 vtkObjectBaseNewInstanceInternal () const
 vtkExtractBlock ()
 ~vtkExtractBlock ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Implementation of the algorithm.
void CopySubTree (vtkDataObjectTreeIterator *loc, vtkMultiBlockDataSet *output, vtkMultiBlockDataSet *input)
 Extract subtree.
bool Prune (vtkMultiBlockDataSet *mblock)
bool Prune (vtkMultiPieceDataSet *mblock)
bool Prune (vtkDataObject *mblock)

Static Protected Member Functions

static vtkInformationIntegerKeyDONT_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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Definition at line 42 of file vtkExtractBlock.h.


Constructor & Destructor Documentation


Member Function Documentation

static vtkExtractBlock* vtkExtractBlock::New ( ) [static]

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

static int vtkExtractBlock::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 vtkMultiBlockDataSetAlgorithm.

virtual int vtkExtractBlock::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 vtkMultiBlockDataSetAlgorithm.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

void vtkExtractBlock::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 vtkMultiBlockDataSetAlgorithm.

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.

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.

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 ( ) [static, protected]

Internal key, used to avoid pruning of a branch.

virtual int vtkExtractBlock::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Implementation of the algorithm.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Extract subtree.

bool vtkExtractBlock::Prune ( vtkMultiBlockDataSet mblock) [protected]
bool vtkExtractBlock::Prune ( vtkMultiPieceDataSet mblock) [protected]
bool vtkExtractBlock::Prune ( vtkDataObject mblock) [protected]

Member Data Documentation

Definition at line 95 of file vtkExtractBlock.h.

Definition at line 96 of file vtkExtractBlock.h.


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