VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkCirclePackLayoutStrategy Class Reference

abstract superclass for all circle packing layout strategies. More...

#include <vtkCirclePackLayoutStrategy.h>

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

List of all members.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Layout (vtkTree *inputTree, vtkDataArray *areaArray, vtkDataArray *sizeArray)=0

Static Public Member Functions

static int IsTypeOf (const char *type)
static
vtkCirclePackLayoutStrategy
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkCirclePackLayoutStrategy ()
 ~vtkCirclePackLayoutStrategy ()

Detailed Description

abstract superclass for all circle packing layout strategies.

All subclasses of this class perform a circle packing layout on a vtkTree. This involves assigning a circle to each vertex in the tree, and placing that information in a data array with three components per tuple representing (Xcenter, Ycenter, Radius).

Instances of subclasses of this class may be assigned as the layout strategy to vtkCirclePackLayout

Thanks:
Thanks to Thomas Otahal from Sandia National Laboratories for help developing this class.
Tests:
vtkCirclePackLayoutStrategy (Tests)

Definition at line 50 of file vtkCirclePackLayoutStrategy.h.


Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkCirclePackFrontChainLayoutStrategy.

Definition at line 53 of file vtkCirclePackLayoutStrategy.h.


Constructor & Destructor Documentation

vtkCirclePackLayoutStrategy::vtkCirclePackLayoutStrategy ( ) [protected]
vtkCirclePackLayoutStrategy::~vtkCirclePackLayoutStrategy ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkObject.

Reimplemented in vtkCirclePackFrontChainLayoutStrategy.

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

Reimplemented in vtkCirclePackFrontChainLayoutStrategy.

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

Reimplemented in vtkCirclePackFrontChainLayoutStrategy.

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

Reimplemented from vtkObject.

Reimplemented in vtkCirclePackFrontChainLayoutStrategy.

void vtkCirclePackLayoutStrategy::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.

Reimplemented in vtkCirclePackFrontChainLayoutStrategy.

virtual void vtkCirclePackLayoutStrategy::Layout ( vtkTree inputTree,
vtkDataArray areaArray,
vtkDataArray sizeArray 
) [pure virtual]

Perform the layout of the input tree, and store the circle bounds of each vertex as a tuple in a data array. (Xcenter, Ycenter, Radius). The sizeArray may be NULL, or may contain the desired size of each vertex in the tree.

Implemented in vtkCirclePackFrontChainLayoutStrategy.


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