vtkTreeMapLayoutStrategy Class Reference

#include <vtkTreeMapLayoutStrategy.h>

Inheritance diagram for vtkTreeMapLayoutStrategy:

Inheritance graph
[legend]
Collaboration diagram for vtkTreeMapLayoutStrategy:

Collaboration graph
[legend]

List of all members.


Detailed Description

abstract superclass for all tree map layout strategies

All subclasses of this class perform a tree map layout on a tree. This involves assigning a rectangular region to each vertex in the tree, and placing that information in a data array with four components per tuple representing (Xmin, Xmax, Ymin, Ymax).

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

Thanks:
Thanks to Brian Wylie and Ken Moreland from Sandia National Laboratories for help developing this class.
Tests:
vtkTreeMapLayoutStrategy (Tests)

Definition at line 49 of file vtkTreeMapLayoutStrategy.h.


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 *rectArray)=0
virtual void SetBorderPercentage (double)
virtual double GetBorderPercentage ()

Static Public Member Functions

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

Protected Member Functions

 vtkTreeMapLayoutStrategy ()
 ~vtkTreeMapLayoutStrategy ()
void AddBorder (float *boxInfo)

Protected Attributes

double BorderPercentage

Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, and vtkSquarifyLayoutStrategy.

Definition at line 52 of file vtkTreeMapLayoutStrategy.h.


Constructor & Destructor Documentation

vtkTreeMapLayoutStrategy::vtkTreeMapLayoutStrategy (  )  [protected]

vtkTreeMapLayoutStrategy::~vtkTreeMapLayoutStrategy (  )  [protected]


Member Function Documentation

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

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

Reimplemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, and vtkSquarifyLayoutStrategy.

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

Reimplemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, and vtkSquarifyLayoutStrategy.

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

void vtkTreeMapLayoutStrategy::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 vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, and vtkSquarifyLayoutStrategy.

virtual void vtkTreeMapLayoutStrategy::Layout ( vtkTree inputTree,
vtkDataArray rectArray 
) [pure virtual]

Perform the layout of the input tree, and store the rectangular bounds of each vertex as a tuple (Xmin, Xmax, Ymin, Ymax) in a data array.

Implemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, and vtkSquarifyLayoutStrategy.

virtual void vtkTreeMapLayoutStrategy::SetBorderPercentage ( double   )  [virtual]

Define the percentage that children vertex regions are inset from the parent vertex region.

virtual double vtkTreeMapLayoutStrategy::GetBorderPercentage (  )  [virtual]

Define the percentage that children vertex regions are inset from the parent vertex region.

void vtkTreeMapLayoutStrategy::AddBorder ( float *  boxInfo  )  [protected]


Member Data Documentation

Definition at line 70 of file vtkTreeMapLayoutStrategy.h.


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

Generated on Sat Dec 27 13:55:20 2008 for VTK by  doxygen 1.5.6