vtkTreeMapViewer Class Reference

#include <vtkTreeMapViewer.h>

Inheritance diagram for vtkTreeMapViewer:

Inheritance graph
[legend]
Collaboration diagram for vtkTreeMapViewer:

Collaboration graph
[legend]

List of all members.


Detailed Description

Display a 2D TreeMap.

vtkTreeMapViewer is a convenience class for displaying a 2D TreeMap. It packages up the functionality found in vtkRenderWindow, vtkRenderer, and vtkActor into a single easy to use class. This class also creates an image interactor style(vtkInteractorStyleImage) that allows zooming and panning of the tree map.

See also:
vtkGraphLayoutViewer
Thanks:
Thanks to Brian Wylie from Sandia National Laboratories for conceptualizing and implementing this class.
Examples:
vtkTreeMapViewer (Examples)
Tests:
vtkTreeMapViewer (Tests)

Definition at line 70 of file vtkTreeMapViewer.h.

static const char * GetLayoutStrategyName (int strategy)
virtual void SetLayoutStrategy (const char *layoutType)

Public Types

enum  { BOX_LAYOUT, SLICE_AND_DICE_LAYOUT, SQUARIFY_LAYOUT, NUMBER_OF_LAYOUTS }
typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetInput (vtkTree *arg)
virtual void SetFontSizeRange (const int maxSize, const int minSize)
void HighLightItem (vtkIdType id)
virtual void SetRenderWindow (vtkRenderWindow *arg)
virtual vtkRenderWindowGetRenderWindow ()
virtual void SetAggregationFieldName (const char *field)
virtual char * GetAggregationFieldName ()
virtual
vtkInteractorStyleTreeMapHover
GetInteractorStyle ()
virtual void SetLayoutStrategy (int strategy)
void SetLayoutStrategyToBox ()
void SetLayoutStrategyToSliceAndDice ()
void SetLayoutStrategyToSquarify ()
virtual int GetLayoutStrategy ()
void SetBorderPercentage (double pcent)
double GetBorderPercentage ()
virtual void SetColorFieldName (const char *field)
virtual char * GetColorFieldName ()
virtual void SetLabelFieldName (const char *field)
virtual char * GetLabelFieldName ()
bool GetLogScale ()
void SetLogScale (bool value)
void SetLabelLevelRange (int start, int end)
void GetLabelLevelRange (int range[2])
void SetDynamicLabelLevel (int level)
int GetDynamicLabelLevel ()
void SetChildLabelMotion (int mode)
int GetChildLabelMotion ()
void SetLabelClipMode (int mode)
int GetLabelClipMode ()

Static Public Member Functions

static vtkTreeMapViewerNew ()
static int IsTypeOf (const char *type)
static vtkTreeMapViewerSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTreeMapViewer ()
 ~vtkTreeMapViewer ()
virtual void SetupPipeline ()

Protected Attributes

vtkTreeInput
vtkRenderWindowRenderWindow
vtkInteractorStyleTreeMapHoverInteractorStyle
vtkSmartPointer
< vtkTreeLevelsFilter
TreeLevelsFilter
vtkSmartPointer
< vtkTreeFieldAggregator
TreeFieldAggregator
vtkSmartPointer< vtkTreeMapLayoutTreeMapLayout
vtkSmartPointer
< vtkTreeMapToPolyData
TreeMapToPolyData
vtkSmartPointer
< vtkPolyDataMapper
PolyDataMapper
vtkSmartPointer< vtkRendererRenderer
vtkSmartPointer< vtkActorActor
vtkSmartPointer< vtkActor2DLabelActor
vtkSmartPointer< vtkLookupTableColorLUT
vtkSmartPointer
< vtkLabeledTreeMapDataMapper
LabeledDataMapper

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 74 of file vtkTreeMapViewer.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
BOX_LAYOUT 
SLICE_AND_DICE_LAYOUT 
SQUARIFY_LAYOUT 
NUMBER_OF_LAYOUTS 

Definition at line 99 of file vtkTreeMapViewer.h.


Constructor & Destructor Documentation

vtkTreeMapViewer::vtkTreeMapViewer (  )  [protected]

vtkTreeMapViewer::~vtkTreeMapViewer (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

static int vtkTreeMapViewer::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 vtkTreeMapViewer::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 vtkTreeMapViewer* vtkTreeMapViewer::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

void vtkTreeMapViewer::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 vtkTreeMapViewer::SetInput ( vtkTree arg  )  [virtual]

Set the input data to the viewer.

virtual void vtkTreeMapViewer::SetRenderWindow ( vtkRenderWindow arg  )  [virtual]

Set your own renderwindow

virtual vtkRenderWindow* vtkTreeMapViewer::GetRenderWindow (  )  [virtual]

Set your own renderwindow

virtual void vtkTreeMapViewer::SetAggregationFieldName ( const char *  field  )  [virtual]

Set the aggregration field (defaults to "size")

virtual char* vtkTreeMapViewer::GetAggregationFieldName (  )  [virtual]

Set the aggregration field (defaults to "size")

virtual vtkInteractorStyleTreeMapHover* vtkTreeMapViewer::GetInteractorStyle (  )  [virtual]

Get the Interactor Style object pointer

virtual void vtkTreeMapViewer::SetLayoutStrategy ( int  strategy  )  [virtual]

Set layout strategy for the tree map

void vtkTreeMapViewer::SetLayoutStrategyToBox (  )  [inline]

Set layout strategy for the tree map

Definition at line 110 of file vtkTreeMapViewer.h.

void vtkTreeMapViewer::SetLayoutStrategyToSliceAndDice (  )  [inline]

Set layout strategy for the tree map

Definition at line 111 of file vtkTreeMapViewer.h.

void vtkTreeMapViewer::SetLayoutStrategyToSquarify (  )  [inline]

Set layout strategy for the tree map

Definition at line 114 of file vtkTreeMapViewer.h.

virtual int vtkTreeMapViewer::GetLayoutStrategy (  )  [virtual]

Set layout strategy for the tree map

void vtkTreeMapViewer::SetBorderPercentage ( double  pcent  ) 

Get/Set the fraction of the treemap box to use in the border.

double vtkTreeMapViewer::GetBorderPercentage (  ) 

Get/Set the fraction of the treemap box to use in the border.

virtual void vtkTreeMapViewer::SetLayoutStrategy ( const char *  layoutType  )  [virtual]

These convenience functions use strings for use in GUIs and scripts.

static const char* vtkTreeMapViewer::GetLayoutStrategyName ( int  strategy  )  [static]

These convenience functions use strings for use in GUIs and scripts.

virtual void vtkTreeMapViewer::SetColorFieldName ( const char *  field  )  [virtual]

The name of the field used for coloring the data

virtual char* vtkTreeMapViewer::GetColorFieldName (  )  [virtual]

The name of the field used for coloring the data

virtual void vtkTreeMapViewer::SetLabelFieldName ( const char *  field  )  [virtual]

The name of the field used for labeling

virtual char* vtkTreeMapViewer::GetLabelFieldName (  )  [virtual]

The name of the field used for labeling

virtual void vtkTreeMapViewer::SetFontSizeRange ( const int  maxSize,
const int  minSize 
) [virtual]

The sizes of the fonts used for labeling

bool vtkTreeMapViewer::GetLogScale (  ) 

Set whether the tree map uses a logarithmic scaling of sizes.

void vtkTreeMapViewer::SetLogScale ( bool  value  ) 

Set whether the tree map uses a logarithmic scaling of sizes.

void vtkTreeMapViewer::HighLightItem ( vtkIdType  id  ) 

Highlight the tree item that matches the pedigree id

void vtkTreeMapViewer::SetLabelLevelRange ( int  start,
int  end 
)

Get/Set the range of levels to attempt to label. The level of a vertex is the length of the path to the root (the root has level 0).

void vtkTreeMapViewer::GetLabelLevelRange ( int  range[2]  ) 

Get/Set the range of levels to attempt to label. The level of a vertex is the length of the path to the root (the root has level 0).

void vtkTreeMapViewer::SetDynamicLabelLevel ( int  level  ) 

Get/Set the level at which treemap labeling is dynamic.

int vtkTreeMapViewer::GetDynamicLabelLevel (  ) 

Get/Set the level at which treemap labeling is dynamic.

void vtkTreeMapViewer::SetChildLabelMotion ( int  mode  ) 

Get/Set whether the label may be moved by its ancestors.

int vtkTreeMapViewer::GetChildLabelMotion (  ) 

Get/Set whether the label may be moved by its ancestors.

void vtkTreeMapViewer::SetLabelClipMode ( int  mode  ) 

Get/Set if the label can be displayed clipped by the window. 0 - ok to clip labels 1 - auto center labels w/r to the area of the vertex's clipped region

int vtkTreeMapViewer::GetLabelClipMode (  ) 

Get/Set if the label can be displayed clipped by the window. 0 - ok to clip labels 1 - auto center labels w/r to the area of the vertex's clipped region

virtual void vtkTreeMapViewer::SetupPipeline (  )  [protected, virtual]

Setup the internal pipeline for the tree map view


Member Data Documentation

Definition at line 192 of file vtkTreeMapViewer.h.

Definition at line 193 of file vtkTreeMapViewer.h.

Definition at line 194 of file vtkTreeMapViewer.h.

Definition at line 196 of file vtkTreeMapViewer.h.

Definition at line 197 of file vtkTreeMapViewer.h.

Definition at line 198 of file vtkTreeMapViewer.h.

Definition at line 199 of file vtkTreeMapViewer.h.

Definition at line 200 of file vtkTreeMapViewer.h.

Definition at line 201 of file vtkTreeMapViewer.h.

Definition at line 202 of file vtkTreeMapViewer.h.

Definition at line 203 of file vtkTreeMapViewer.h.

Definition at line 204 of file vtkTreeMapViewer.h.

Definition at line 205 of file vtkTreeMapViewer.h.


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

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