Superclass for algorithms that produce only Tree as output. More...
#include <vtkTreeAlgorithm.h>
Detailed Description
Superclass for algorithms that produce only Tree as output.
vtkTreeAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition old algorithms to the new pipeline edgehitecture. There 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 class constructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be Tree. If that isn't the case then please override this method in your subclass.
- Tests:
- vtkTreeAlgorithm (Tests)
Definition at line 47 of file vtkTreeAlgorithm.h.
Member Typedef Documentation
Reimplemented from vtkAlgorithm.
Reimplemented in vtkXMLTreeReader, vtkCirclePackLayout, vtkBoostPrimMinimumSpanningTree, vtkTreeMapLayout, vtkStrahlerMetric, vtkBoostBreadthFirstSearchTree, vtkTreeFieldAggregator, vtkTreeLevelsFilter, vtkAreaLayout, vtkTableToTreeFilter, vtkNetworkHierarchy, vtkExtractSelectedTree, vtkGroupLeafVertices, and vtkPruneTreeFilter.
Definition at line 51 of file vtkTreeAlgorithm.h.
Constructor & Destructor Documentation
| vtkTreeAlgorithm::vtkTreeAlgorithm | ( | ) | [protected] |
| vtkTreeAlgorithm::~vtkTreeAlgorithm | ( | ) | [protected] |
Member Function Documentation
| static vtkTreeAlgorithm* vtkTreeAlgorithm::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkXMLTreeReader, vtkCirclePackLayout, vtkBoostPrimMinimumSpanningTree, vtkTreeMapLayout, vtkStrahlerMetric, vtkBoostBreadthFirstSearchTree, vtkTreeFieldAggregator, vtkTreeLevelsFilter, vtkAreaLayout, vtkTableToTreeFilter, vtkNetworkHierarchy, vtkExtractSelectedTree, vtkGroupLeafVertices, and vtkPruneTreeFilter.
| static int vtkTreeAlgorithm::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 vtkAlgorithm.
Reimplemented in vtkXMLTreeReader, vtkCirclePackLayout, vtkBoostPrimMinimumSpanningTree, vtkTreeMapLayout, vtkStrahlerMetric, vtkBoostBreadthFirstSearchTree, vtkTreeFieldAggregator, vtkTreeLevelsFilter, vtkAreaLayout, vtkTableToTreeFilter, vtkNetworkHierarchy, vtkExtractSelectedTree, vtkGroupLeafVertices, and vtkPruneTreeFilter.
| virtual int vtkTreeAlgorithm::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 vtkAlgorithm.
Reimplemented in vtkXMLTreeReader, vtkCirclePackLayout, vtkBoostPrimMinimumSpanningTree, vtkTreeMapLayout, vtkStrahlerMetric, vtkBoostBreadthFirstSearchTree, vtkTreeFieldAggregator, vtkTreeLevelsFilter, vtkAreaLayout, vtkTableToTreeFilter, vtkNetworkHierarchy, vtkExtractSelectedTree, vtkGroupLeafVertices, and vtkPruneTreeFilter.
| static vtkTreeAlgorithm* vtkTreeAlgorithm::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkXMLTreeReader, vtkCirclePackLayout, vtkBoostPrimMinimumSpanningTree, vtkTreeMapLayout, vtkStrahlerMetric, vtkBoostBreadthFirstSearchTree, vtkTreeFieldAggregator, vtkTreeLevelsFilter, vtkAreaLayout, vtkTableToTreeFilter, vtkNetworkHierarchy, vtkExtractSelectedTree, vtkGroupLeafVertices, and vtkPruneTreeFilter.
| virtual vtkObjectBase* vtkTreeAlgorithm::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkXMLTreeReader, vtkCirclePackLayout, vtkBoostPrimMinimumSpanningTree, vtkTreeMapLayout, vtkStrahlerMetric, vtkBoostBreadthFirstSearchTree, vtkTreeFieldAggregator, vtkTreeLevelsFilter, vtkAreaLayout, vtkTableToTreeFilter, vtkNetworkHierarchy, vtkExtractSelectedTree, vtkGroupLeafVertices, and vtkPruneTreeFilter.
| vtkTreeAlgorithm* vtkTreeAlgorithm::NewInstance | ( | ) | const |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkXMLTreeReader, vtkCirclePackLayout, vtkBoostPrimMinimumSpanningTree, vtkTreeMapLayout, vtkStrahlerMetric, vtkBoostBreadthFirstSearchTree, vtkTreeFieldAggregator, vtkTreeLevelsFilter, vtkAreaLayout, vtkTableToTreeFilter, vtkNetworkHierarchy, vtkExtractSelectedTree, vtkGroupLeafVertices, and vtkPruneTreeFilter.
| void vtkTreeAlgorithm::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 vtkXMLTreeReader, vtkCirclePackLayout, vtkBoostPrimMinimumSpanningTree, vtkTreeMapLayout, vtkStrahlerMetric, vtkBoostBreadthFirstSearchTree, vtkNetworkHierarchy, vtkTreeFieldAggregator, vtkTreeLevelsFilter, vtkAreaLayout, vtkTableToTreeFilter, vtkExtractSelectedTree, vtkGroupLeafVertices, and vtkPruneTreeFilter.
| virtual int vtkTreeAlgorithm::ProcessRequest | ( | vtkInformation * | , |
| vtkInformationVector ** | , | ||
| vtkInformationVector * | |||
| ) | [virtual] |
see vtkAlgorithm for details
Reimplemented from vtkAlgorithm.
| vtkTree* vtkTreeAlgorithm::GetOutput | ( | ) | [inline] |
Get the output data object for a port on this algorithm.
Definition at line 63 of file vtkTreeAlgorithm.h.
| vtkTree* vtkTreeAlgorithm::GetOutput | ( | int | index | ) |
Get the output data object for a port on this algorithm.
| void vtkTreeAlgorithm::SetInputData | ( | vtkDataObject * | obj | ) | [inline] |
Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.
Definition at line 71 of file vtkTreeAlgorithm.h.
| void vtkTreeAlgorithm::SetInputData | ( | int | index, |
| vtkDataObject * | obj | ||
| ) |
Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.
| virtual int vtkTreeAlgorithm::RequestInformation | ( | vtkInformation * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [protected, virtual] |
| virtual int vtkTreeAlgorithm::RequestData | ( | vtkInformation * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented in vtkXMLTreeReader, vtkBoostPrimMinimumSpanningTree, vtkCirclePackLayout, vtkAreaLayout, vtkTreeMapLayout, vtkBoostBreadthFirstSearchTree, vtkTreeFieldAggregator, vtkStrahlerMetric, vtkPruneTreeFilter, vtkGroupLeafVertices, vtkNetworkHierarchy, vtkExtractSelectedTree, vtkTableToTreeFilter, and vtkTreeLevelsFilter.
| virtual int vtkTreeAlgorithm::RequestUpdateExtent | ( | vtkInformation * | , |
| vtkInformationVector ** | , | ||
| vtkInformationVector * | |||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
| virtual int vtkTreeAlgorithm::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 vtkTreeAlgorithm::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.
Reimplemented in vtkBoostPrimMinimumSpanningTree, vtkBoostBreadthFirstSearchTree, and vtkExtractSelectedTree.
The documentation for this class was generated from the following file:
- dox/Common/ExecutionModel/vtkTreeAlgorithm.h
