vtkTreeMapLayout Class Reference

#include <vtkTreeMapLayout.h>

Inheritance diagram for vtkTreeMapLayout:

Inheritance graph
[legend]
Collaboration diagram for vtkTreeMapLayout:

Collaboration graph
[legend]

List of all members.


Detailed Description

layout a vtkTree into a tree map

vtkTreeMapLayout assigns rectangular regions to each vertex in the tree, creating a tree map. The data is added as a data array with four components per tuple representing the location and size of the rectangle using the format (Xmin, Xmax, Ymin, Ymax).

This algorithm relies on a helper class to perform the actual layout. This helper class is a subclass of vtkTreeMapLayoutStrategy.

Thanks:
Thanks to Brian Wylie and Ken Moreland from Sandia National Laboratories for help developing this class.
Thanks:
Tree map concept comes from: Shneiderman, B. 1992. Tree visualization with tree-maps: 2-d space-filling approach. ACM Trans. Graph. 11, 1 (Jan. 1992), 92-99.
Tests:
vtkTreeMapLayout (Tests)

Definition at line 52 of file vtkTreeMapLayout.h.


Public Types

typedef vtkTreeAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkIdType FindVertex (float pnt[2], float *binfo=0)
void GetBoundingBox (vtkIdType id, float *binfo)
virtual unsigned long GetMTime ()
virtual char * GetRectanglesFieldName ()
virtual void SetRectanglesFieldName (const char *)
virtual void SetSizeArrayName (const char *name)
virtual vtkTreeMapLayoutStrategyGetLayoutStrategy ()
void SetLayoutStrategy (vtkTreeMapLayoutStrategy *strategy)

Static Public Member Functions

static vtkTreeMapLayoutNew ()
static int IsTypeOf (const char *type)
static vtkTreeMapLayoutSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTreeMapLayout ()
 ~vtkTreeMapLayout ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

char * RectanglesFieldName
vtkTreeMapLayoutStrategyLayoutStrategy

Member Typedef Documentation

Reimplemented from vtkTreeAlgorithm.

Definition at line 57 of file vtkTreeMapLayout.h.


Constructor & Destructor Documentation

vtkTreeMapLayout::vtkTreeMapLayout (  )  [protected]

vtkTreeMapLayout::~vtkTreeMapLayout (  )  [protected]


Member Function Documentation

static vtkTreeMapLayout* vtkTreeMapLayout::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkTreeAlgorithm.

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

Reimplemented from vtkTreeAlgorithm.

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

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

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

Reimplemented from vtkTreeAlgorithm.

void vtkTreeMapLayout::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 vtkTreeAlgorithm.

virtual char* vtkTreeMapLayout::GetRectanglesFieldName (  )  [virtual]

The field name to use for storing the rectangles for each vertex. The rectangles are stored in a quadruple float array (minX, maxX, minY, maxY).

virtual void vtkTreeMapLayout::SetRectanglesFieldName ( const char *   )  [virtual]

The field name to use for storing the rectangles for each vertex. The rectangles are stored in a quadruple float array (minX, maxX, minY, maxY).

virtual void vtkTreeMapLayout::SetSizeArrayName ( const char *  name  )  [inline, virtual]

The array to use for the size of each vertex.

Definition at line 70 of file vtkTreeMapLayout.h.

virtual vtkTreeMapLayoutStrategy* vtkTreeMapLayout::GetLayoutStrategy (  )  [virtual]

The strategy to use when laying out the tree map.

void vtkTreeMapLayout::SetLayoutStrategy ( vtkTreeMapLayoutStrategy strategy  ) 

The strategy to use when laying out the tree map.

vtkIdType vtkTreeMapLayout::FindVertex ( float  pnt[2],
float *  binfo = 0 
)

Returns the vertex id that contains pnt (or -1 if no one contains it)

void vtkTreeMapLayout::GetBoundingBox ( vtkIdType  id,
float *  binfo 
)

Return the min and max 2D points of the vertex's bounding box

virtual unsigned long vtkTreeMapLayout::GetMTime (  )  [virtual]

Get the modification time of the layout algorithm.

Reimplemented from vtkObject.

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

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

Reimplemented from vtkTreeAlgorithm.


Member Data Documentation

Definition at line 93 of file vtkTreeMapLayout.h.

Definition at line 94 of file vtkTreeMapLayout.h.


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

Generated on Mon Sep 27 18:57:10 2010 for VTK by  doxygen 1.5.6