vtkHyperOctreeAlgorithm Class Reference

#include <vtkHyperOctreeAlgorithm.h>

Inheritance diagram for vtkHyperOctreeAlgorithm:

Inheritance graph
[legend]
Collaboration diagram for vtkHyperOctreeAlgorithm:

Collaboration graph
[legend]

List of all members.


Detailed Description

Superclass for algorithms that produce only octree as output.

vtkOctreeAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition old algorithms to the new pipeline architecture. Ther are some assumptions and defaults made by this class you should be aware of. This class defaults such that your filter will have one input port and one output port. If that is not the case simply change it with SetNumberOfInputPorts etc. See this classes constructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be RectilinearGrid. If that isn't the case then please override this method in your subclass. This class breaks out the downstream requests into seperate functions such as ExecuteData and ExecuteInformation. For new algorithms you should implement RequestData( request, inputVec, outputVec) but for older filters there is a default implementation that calls the old ExecuteData(output) signature, for even older filters that don;t implement ExecuteData the default implementation calls the even older Execute() signature.

Definition at line 45 of file vtkHyperOctreeAlgorithm.h.


Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkHyperOctreeGetHyperOctreeInput (int port)
vtkHyperOctreeGetOutput ()
vtkHyperOctreeGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkHyperOctreeAlgorithmSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkHyperOctreeAlgorithm ()
 ~vtkHyperOctreeAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()

Member Typedef Documentation

Reimplemented from vtkAlgorithm.

Reimplemented in vtkHyperOctreeFractalSource, and vtkHyperOctreeSampleFunction.

Definition at line 48 of file vtkHyperOctreeAlgorithm.h.


Constructor & Destructor Documentation

vtkHyperOctreeAlgorithm::vtkHyperOctreeAlgorithm (  )  [protected]

vtkHyperOctreeAlgorithm::~vtkHyperOctreeAlgorithm (  )  [protected]


Member Function Documentation

virtual const char* vtkHyperOctreeAlgorithm::GetClassName (  )  [virtual]

Reimplemented from vtkAlgorithm.

Reimplemented in vtkHyperOctreeFractalSource, and vtkHyperOctreeSampleFunction.

static int vtkHyperOctreeAlgorithm::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkHyperOctreeFractalSource, and vtkHyperOctreeSampleFunction.

virtual int vtkHyperOctreeAlgorithm::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkHyperOctreeFractalSource, and vtkHyperOctreeSampleFunction.

static vtkHyperOctreeAlgorithm* vtkHyperOctreeAlgorithm::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkAlgorithm.

Reimplemented in vtkHyperOctreeFractalSource, and vtkHyperOctreeSampleFunction.

void vtkHyperOctreeAlgorithm::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 vtkAlgorithm.

Reimplemented in vtkHyperOctreeFractalSource, and vtkHyperOctreeSampleFunction.

vtkHyperOctree* vtkHyperOctreeAlgorithm::GetOutput (  ) 

Get the output data object for a port on this algorithm.

vtkHyperOctree* vtkHyperOctreeAlgorithm::GetOutput ( int   ) 

Get the output data object for a port on this algorithm.

virtual void vtkHyperOctreeAlgorithm::SetOutput ( vtkDataObject d  )  [virtual]

Get the output data object for a port on this algorithm.

virtual int vtkHyperOctreeAlgorithm::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [virtual]

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

vtkDataObject* vtkHyperOctreeAlgorithm::GetInput (  ) 

vtkDataObject* vtkHyperOctreeAlgorithm::GetInput ( int  port  ) 

vtkHyperOctree* vtkHyperOctreeAlgorithm::GetHyperOctreeInput ( int  port  ) 

void vtkHyperOctreeAlgorithm::SetInput ( vtkDataObject  ) 

Set an input of this algorithm.

void vtkHyperOctreeAlgorithm::SetInput ( int  ,
vtkDataObject  
)

Set an input of this algorithm.

void vtkHyperOctreeAlgorithm::AddInput ( vtkDataObject  ) 

Add an input of this algorithm.

void vtkHyperOctreeAlgorithm::AddInput ( int  ,
vtkDataObject  
)

Add an input of this algorithm.

virtual int vtkHyperOctreeAlgorithm::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

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

Reimplemented in vtkHyperOctreeFractalSource, and vtkHyperOctreeSampleFunction.

virtual int vtkHyperOctreeAlgorithm::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

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

virtual void vtkHyperOctreeAlgorithm::ExecuteData ( vtkDataObject output  )  [protected, virtual]

This method is the old style execute method

virtual void vtkHyperOctreeAlgorithm::Execute (  )  [protected, virtual]

This method is the old style execute method

virtual int vtkHyperOctreeAlgorithm::FillOutputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

virtual int vtkHyperOctreeAlgorithm::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.


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

Generated on Wed Jun 3 19:07:32 2009 for VTK by  doxygen 1.5.6