VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTreeMapLayout Class Reference

layout a vtkTree into a tree map More...

#include <vtkTreeMapLayout.h>

Inherits vtkTreeAlgorithm.

Collaboration diagram for vtkTreeMapLayout:
[legend]

Public Types

typedef vtkTreeAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTreeMapLayoutNewInstance () const
 
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 (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkTreeMapLayout ()
 
 ~vtkTreeMapLayout ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

char * RectanglesFieldName
 
vtkTreeMapLayoutStrategyLayoutStrategy
 

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 53 of file vtkTreeMapLayout.h.

Member Typedef Documentation

typedef vtkTreeAlgorithm vtkTreeMapLayout::Superclass

Definition at line 58 of file vtkTreeMapLayout.h.

Constructor & Destructor Documentation

vtkTreeMapLayout::vtkTreeMapLayout ( )
protected
vtkTreeMapLayout::~vtkTreeMapLayout ( )
protected

Member Function Documentation

static vtkTreeMapLayout* vtkTreeMapLayout::New ( )
static
static int vtkTreeMapLayout::IsTypeOf ( const char *  type)
static
virtual int vtkTreeMapLayout::IsA ( const char *  type)
virtual
static vtkTreeMapLayout* vtkTreeMapLayout::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkTreeMapLayout::NewInstanceInternal ( ) const
protectedvirtual
vtkTreeMapLayout* vtkTreeMapLayout::NewInstance ( ) const
void vtkTreeMapLayout::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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)
inlinevirtual

The array to use for the size of each vertex.

Definition at line 71 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.

int vtkTreeMapLayout::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

Member Data Documentation

char* vtkTreeMapLayout::RectanglesFieldName
protected

Definition at line 94 of file vtkTreeMapLayout.h.

vtkTreeMapLayoutStrategy* vtkTreeMapLayout::LayoutStrategy
protected

Definition at line 95 of file vtkTreeMapLayout.h.


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