vtkLabelHierarchyIterator Class Reference

#include <vtkLabelHierarchyIterator.h>

Inheritance diagram for vtkLabelHierarchyIterator:

[legend]

Collaboration diagram for vtkLabelHierarchyIterator:

[legend]

List of all members.

Detailed Description

iterator over vtkLabelHierarchy

Abstract superclass for iterators over vtkLabelHierarchy.

Definition at line 37 of file vtkLabelHierarchyIterator.h.


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Begin (vtkIdTypeArray *)
virtual void	Next ()
virtual bool	IsAtEnd ()
virtual void	GetPoint (double x[3])
virtual void	GetSize (double sz[2])
virtual int	GetType ()
virtual vtkIdType	GetLabelId ()
virtual void	SetTraversedBounds (vtkPolyData *)
virtual void	GetNodeGeometry (double ctr[3], double &size)=0
virtual void	BoxNode ()
virtual void	BoxAllNodes (vtkPolyData *)

virtual void	SetAllBounds (int)
virtual int	GetAllBounds ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkLabelHierarchyIterator *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkLabelHierarchyIterator ()
virtual	~vtkLabelHierarchyIterator ()
void	BoxNodeInternal3 (const double *ctr, double sz)
void	BoxNodeInternal2 (const double *ctr, double sz)
virtual void	SetHierarchy (vtkLabelHierarchy *h)
Protected Attributes
vtkLabelHierarchy *	Hierarchy
vtkPolyData *	TraversedBounds
double	BoundsFactor
int	AllBounds
int	AllBoundsRecorded

Member Typedef Documentation

typedef vtkObject vtkLabelHierarchyIterator::Superclass

Reimplemented from vtkObject.

Definition at line 40 of file vtkLabelHierarchyIterator.h.

Constructor & Destructor Documentation

vtkLabelHierarchyIterator::vtkLabelHierarchyIterator ( ) [protected]

virtual vtkLabelHierarchyIterator::~vtkLabelHierarchyIterator ( ) [protected, virtual]

Member Function Documentation

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

Reimplemented from vtkObject.

static int vtkLabelHierarchyIterator::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 vtkObject.

virtual int vtkLabelHierarchyIterator::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 vtkObject.

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

Reimplemented from vtkObject.

virtual void vtkLabelHierarchyIterator::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 vtkObject.

virtual void vtkLabelHierarchyIterator::Begin ( vtkIdTypeArray * ) [inline, virtual]

Initializes the iterator. lastLabels is an array holding labels which should be traversed before any other labels in the hierarchy. This could include labels placed during a previous rendering or a label located under the mouse pointer. You may pass a null pointer.

Definition at line 47 of file vtkLabelHierarchyIterator.h.

virtual void vtkLabelHierarchyIterator::Next ( ) [inline, virtual]

Advance the iterator.

Definition at line 50 of file vtkLabelHierarchyIterator.h.

virtual bool vtkLabelHierarchyIterator::IsAtEnd ( ) [inline, virtual]

Returns true if the iterator is at the end.

Definition at line 53 of file vtkLabelHierarchyIterator.h.

virtual void vtkLabelHierarchyIterator::GetPoint ( double x[3] ) [virtual]

Retrieves the current label location.

virtual void vtkLabelHierarchyIterator::GetSize ( double sz[2] ) [virtual]

Retrieves the current label size.

virtual int vtkLabelHierarchyIterator::GetType ( ) [virtual]

Retrieves the current label type.

virtual vtkIdType vtkLabelHierarchyIterator::GetLabelId ( ) [inline, virtual]

Retrieves the current label id.

Definition at line 65 of file vtkLabelHierarchyIterator.h.

virtual void vtkLabelHierarchyIterator::SetTraversedBounds ( vtkPolyData * ) [virtual]

Sets a polydata to fill with geometry representing the bounding boxes of the traversed octree nodes.

virtual void vtkLabelHierarchyIterator::GetNodeGeometry	(	double	ctr[3],
		double &	size
	)			`[pure virtual]`

Retrieve the coordinates of the center of the current hierarchy node and the size of the node. Nodes are n-cubes, so the size is the length of any edge of the cube. This is used by BoxNode().

virtual void vtkLabelHierarchyIterator::BoxNode ( ) [virtual]

Add a representation to TraversedBounds for the current octree node. This should be called by subclasses inside Next(). Does nothing if TraversedBounds is NULL.

virtual void vtkLabelHierarchyIterator::BoxAllNodes ( vtkPolyData * ) [virtual]

Add a representation for all existing octree nodes to the specified polydata. This is equivalent to setting TraversedBounds, iterating over the entire hierarchy, and then resetting TraversedBounds to its original value.

virtual void vtkLabelHierarchyIterator::SetAllBounds ( int ) [virtual]

Set/get whether all nodes in the hierarchy should be added to the TraversedBounds polydata or only those traversed. When non-zero, all nodes will be added. By default, AllBounds is 0.

virtual int vtkLabelHierarchyIterator::GetAllBounds ( ) [virtual]

Set/get whether all nodes in the hierarchy should be added to the TraversedBounds polydata or only those traversed. When non-zero, all nodes will be added. By default, AllBounds is 0.