vtkTreeAreaView Class Reference

#include <vtkTreeAreaView.h>

Inheritance diagram for vtkTreeAreaView:

Inheritance graph
[legend]
Collaboration diagram for vtkTreeAreaView:

Collaboration graph
[legend]

List of all members.


Detailed Description

Accepts a graph and a hierarchy - currently a tree - and provides a hierarchy-aware display. Currently, this means displaying the hierarchy using a tree ring layout, then rendering the graph vertices as leaves of the tree with curved graph edges between leaves.

Takes a graph and a hierarchy (currently a tree) and lays out the graph vertices based on their categorization within the hierarchy.

.SEE ALSO vtkGraphLayoutView

Thanks:
Thanks to Jason Shepherd for implementing this class

Definition at line 51 of file vtkTreeAreaView.h.


Public Types

typedef vtkRenderView Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetEdgeColorToSplineFraction ()
vtkDataRepresentationSetTreeFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationSetTreeFromInput (vtkTree *input)
vtkDataRepresentationSetGraphFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationSetGraphFromInput (vtkGraph *input)
void SetAreaLabelArrayName (const char *name)
const char * GetAreaLabelArrayName ()
void SetAreaSizeArrayName (const char *name)
const char * GetAreaSizeArrayName ()
void SetLabelPriorityArrayName (const char *name)
const char * GetLabelPriorityArrayName ()
void SetEdgeLabelArrayName (const char *name)
const char * GetEdgeLabelArrayName ()
void SetAreaHoverArrayName (const char *name)
const char * GetAreaHoverArrayName ()
void SetAreaLabelVisibility (bool vis)
bool GetAreaLabelVisibility ()
virtual void AreaLabelVisibilityOn ()
virtual void AreaLabelVisibilityOff ()
void SetEdgeLabelVisibility (bool vis)
bool GetEdgeLabelVisibility ()
virtual void EdgeLabelVisibilityOn ()
virtual void EdgeLabelVisibilityOff ()
void SetAreaColorArrayName (const char *name)
const char * GetAreaColorArrayName ()
void SetColorAreas (bool vis)
bool GetColorAreas ()
virtual void ColorAreasOn ()
virtual void ColorAreasOff ()
void SetEdgeColorArrayName (const char *name)
const char * GetEdgeColorArrayName ()
void SetShrinkPercentage (double value)
double GetShrinkPercentage ()
void SetColorEdges (bool vis)
bool GetColorEdges ()
virtual void ColorEdgesOn ()
virtual void ColorEdgesOff ()
void SetBundlingStrength (double strength)
double GetBundlingStrength ()
virtual void SetAreaLabelFontSize (const int size)
virtual int GetAreaLabelFontSize ()
virtual void SetEdgeLabelFontSize (const int size)
virtual int GetEdgeLabelFontSize ()
virtual void SetLayoutStrategy (vtkAreaLayoutStrategy *strategy)
virtual vtkAreaLayoutStrategyGetLayoutStrategy ()
virtual void SetUseRectangularCoordinates (bool rect)
virtual bool GetUseRectangularCoordinates ()
virtual void UseRectangularCoordinatesOn ()
virtual void UseRectangularCoordinatesOff ()
virtual void SetEdgeScalarBarVisibility (bool b)
virtual bool GetEdgeScalarBarVisibility ()

Static Public Member Functions

static vtkTreeAreaViewNew ()
static int IsTypeOf (const char *type)
static vtkTreeAreaViewSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTreeAreaView ()
 ~vtkTreeAreaView ()
virtual void SetAreaToPolyData (vtkPolyDataAlgorithm *areaToPoly)
virtual vtkPolyDataAlgorithmGetAreaToPolyData ()
virtual void SetAreaLabelMapper (vtkLabeledDataMapper *mapper)
virtual vtkLabeledDataMapperGetAreaLabelMapper ()
virtual vtkDataRepresentationCreateDefaultRepresentation (vtkAlgorithmOutput *conn)
virtual
vtkRenderedTreeAreaRepresentation
GetTreeAreaRepresentation ()

Member Typedef Documentation

Reimplemented from vtkRenderView.

Reimplemented in vtkIcicleView, vtkTreeMapView, and vtkTreeRingView.

Definition at line 55 of file vtkTreeAreaView.h.


Constructor & Destructor Documentation

vtkTreeAreaView::vtkTreeAreaView (  )  [protected]

vtkTreeAreaView::~vtkTreeAreaView (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkRenderView.

Reimplemented in vtkIcicleView, vtkTreeMapView, and vtkTreeRingView.

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

Reimplemented from vtkRenderView.

Reimplemented in vtkIcicleView, vtkTreeMapView, and vtkTreeRingView.

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

Reimplemented in vtkIcicleView, vtkTreeMapView, and vtkTreeRingView.

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

Reimplemented in vtkIcicleView, vtkTreeMapView, and vtkTreeRingView.

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

Reimplemented from vtkRenderView.

Reimplemented in vtkIcicleView, vtkTreeMapView, and vtkTreeRingView.

void vtkTreeAreaView::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 vtkRenderView.

Reimplemented in vtkIcicleView, vtkTreeMapView, and vtkTreeRingView.

vtkDataRepresentation* vtkTreeAreaView::SetTreeFromInputConnection ( vtkAlgorithmOutput conn  ) 

Set the tree and graph representations to the appropriate input ports.

vtkDataRepresentation* vtkTreeAreaView::SetTreeFromInput ( vtkTree input  ) 

Set the tree and graph representations to the appropriate input ports.

vtkDataRepresentation* vtkTreeAreaView::SetGraphFromInputConnection ( vtkAlgorithmOutput conn  ) 

Set the tree and graph representations to the appropriate input ports.

vtkDataRepresentation* vtkTreeAreaView::SetGraphFromInput ( vtkGraph input  ) 

Set the tree and graph representations to the appropriate input ports.

void vtkTreeAreaView::SetAreaLabelArrayName ( const char *  name  ) 

The array to use for area labeling. Default is "label".

const char* vtkTreeAreaView::GetAreaLabelArrayName (  ) 

The array to use for area labeling. Default is "label".

void vtkTreeAreaView::SetAreaSizeArrayName ( const char *  name  ) 

The array to use for area sizes. Default is "size".

const char* vtkTreeAreaView::GetAreaSizeArrayName (  ) 

The array to use for area sizes. Default is "size".

void vtkTreeAreaView::SetLabelPriorityArrayName ( const char *  name  ) 

The array to use for area labeling priority. Default is "GraphVertexDegree".

const char* vtkTreeAreaView::GetLabelPriorityArrayName (  ) 

The array to use for area labeling priority. Default is "GraphVertexDegree".

void vtkTreeAreaView::SetEdgeLabelArrayName ( const char *  name  ) 

The array to use for edge labeling. Default is "label".

const char* vtkTreeAreaView::GetEdgeLabelArrayName (  ) 

The array to use for edge labeling. Default is "label".

void vtkTreeAreaView::SetAreaHoverArrayName ( const char *  name  ) 

The name of the array whose value appears when the mouse hovers over a rectangle in the treemap. This must be a string array.

const char* vtkTreeAreaView::GetAreaHoverArrayName (  ) 

The name of the array whose value appears when the mouse hovers over a rectangle in the treemap. This must be a string array.

void vtkTreeAreaView::SetAreaLabelVisibility ( bool  vis  ) 

Whether to show area labels. Default is off.

bool vtkTreeAreaView::GetAreaLabelVisibility (  ) 

Whether to show area labels. Default is off.

virtual void vtkTreeAreaView::AreaLabelVisibilityOn (  )  [virtual]

Whether to show area labels. Default is off.

virtual void vtkTreeAreaView::AreaLabelVisibilityOff (  )  [virtual]

Whether to show area labels. Default is off.

void vtkTreeAreaView::SetEdgeLabelVisibility ( bool  vis  ) 

Whether to show edge labels. Default is off.

bool vtkTreeAreaView::GetEdgeLabelVisibility (  ) 

Whether to show edge labels. Default is off.

virtual void vtkTreeAreaView::EdgeLabelVisibilityOn (  )  [virtual]

Whether to show edge labels. Default is off.

virtual void vtkTreeAreaView::EdgeLabelVisibilityOff (  )  [virtual]

Whether to show edge labels. Default is off.

void vtkTreeAreaView::SetAreaColorArrayName ( const char *  name  ) 

The array to use for coloring vertices. Default is "color".

const char* vtkTreeAreaView::GetAreaColorArrayName (  ) 

The array to use for coloring vertices. Default is "color".

void vtkTreeAreaView::SetColorAreas ( bool  vis  ) 

Whether to color vertices. Default is off.

bool vtkTreeAreaView::GetColorAreas (  ) 

Whether to color vertices. Default is off.

virtual void vtkTreeAreaView::ColorAreasOn (  )  [virtual]

Whether to color vertices. Default is off.

virtual void vtkTreeAreaView::ColorAreasOff (  )  [virtual]

Whether to color vertices. Default is off.

void vtkTreeAreaView::SetEdgeColorArrayName ( const char *  name  ) 

The array to use for coloring edges. Default is "color".

const char* vtkTreeAreaView::GetEdgeColorArrayName (  ) 

The array to use for coloring edges. Default is "color".

void vtkTreeAreaView::SetEdgeColorToSplineFraction (  ) 

Set the color to be the spline fraction

void vtkTreeAreaView::SetShrinkPercentage ( double  value  ) 

Set the region shrink percentage between 0.0 and 1.0.

double vtkTreeAreaView::GetShrinkPercentage (  ) 

Set the region shrink percentage between 0.0 and 1.0.

void vtkTreeAreaView::SetColorEdges ( bool  vis  ) 

Whether to color edges. Default is off.

bool vtkTreeAreaView::GetColorEdges (  ) 

Whether to color edges. Default is off.

virtual void vtkTreeAreaView::ColorEdgesOn (  )  [virtual]

Whether to color edges. Default is off.

virtual void vtkTreeAreaView::ColorEdgesOff (  )  [virtual]

Whether to color edges. Default is off.

void vtkTreeAreaView::SetBundlingStrength ( double  strength  ) 

Set the bundling strength.

double vtkTreeAreaView::GetBundlingStrength (  ) 

Set the bundling strength.

virtual void vtkTreeAreaView::SetAreaLabelFontSize ( const int  size  )  [virtual]

The size of the font used for area labeling

virtual int vtkTreeAreaView::GetAreaLabelFontSize (  )  [virtual]

The size of the font used for area labeling

virtual void vtkTreeAreaView::SetEdgeLabelFontSize ( const int  size  )  [virtual]

The size of the font used for edge labeling

virtual int vtkTreeAreaView::GetEdgeLabelFontSize (  )  [virtual]

The size of the font used for edge labeling

virtual void vtkTreeAreaView::SetLayoutStrategy ( vtkAreaLayoutStrategy strategy  )  [virtual]

The layout strategy for producing spatial regions for the tree.

Reimplemented in vtkTreeMapView.

virtual vtkAreaLayoutStrategy* vtkTreeAreaView::GetLayoutStrategy (  )  [virtual]

The layout strategy for producing spatial regions for the tree.

virtual void vtkTreeAreaView::SetUseRectangularCoordinates ( bool  rect  )  [virtual]

Whether the area represents radial or rectangular coordinates.

virtual bool vtkTreeAreaView::GetUseRectangularCoordinates (  )  [virtual]

Whether the area represents radial or rectangular coordinates.

virtual void vtkTreeAreaView::UseRectangularCoordinatesOn (  )  [virtual]

Whether the area represents radial or rectangular coordinates.

virtual void vtkTreeAreaView::UseRectangularCoordinatesOff (  )  [virtual]

Whether the area represents radial or rectangular coordinates.

virtual void vtkTreeAreaView::SetEdgeScalarBarVisibility ( bool  b  )  [virtual]

Visibility of scalar bar actor for edges.

virtual bool vtkTreeAreaView::GetEdgeScalarBarVisibility (  )  [virtual]

Visibility of scalar bar actor for edges.

virtual void vtkTreeAreaView::SetAreaToPolyData ( vtkPolyDataAlgorithm areaToPoly  )  [protected, virtual]

The filter for converting areas to polydata. This may e.g. be vtkTreeMapToPolyData or vtkTreeRingToPolyData. The filter must take a vtkTree as input and produce vtkPolyData.

virtual vtkPolyDataAlgorithm* vtkTreeAreaView::GetAreaToPolyData (  )  [protected, virtual]

The filter for converting areas to polydata. This may e.g. be vtkTreeMapToPolyData or vtkTreeRingToPolyData. The filter must take a vtkTree as input and produce vtkPolyData.

virtual void vtkTreeAreaView::SetAreaLabelMapper ( vtkLabeledDataMapper mapper  )  [protected, virtual]

The mapper for rendering labels on areas. This may e.g. be vtkDynamic2DLabelMapper or vtkTreeMapLabelMapper.

virtual vtkLabeledDataMapper* vtkTreeAreaView::GetAreaLabelMapper (  )  [protected, virtual]

The mapper for rendering labels on areas. This may e.g. be vtkDynamic2DLabelMapper or vtkTreeMapLabelMapper.

virtual vtkDataRepresentation* vtkTreeAreaView::CreateDefaultRepresentation ( vtkAlgorithmOutput conn  )  [protected, virtual]

Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.

Reimplemented from vtkView.

virtual vtkRenderedTreeAreaRepresentation* vtkTreeAreaView::GetTreeAreaRepresentation (  )  [protected, virtual]

Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.


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

Generated on Wed Aug 24 12:14:37 2011 for VTK by  doxygen 1.5.6