vtkStackedTreeLayoutStrategy Class Reference

#include <vtkStackedTreeLayoutStrategy.h>

Inheritance diagram for vtkStackedTreeLayoutStrategy:

Inheritance graph
[legend]
Collaboration diagram for vtkStackedTreeLayoutStrategy:

Collaboration graph
[legend]

List of all members.


Detailed Description

lays out tree in stacked boxes or rings

Performs a tree ring layout or "icicle" layout on a tree. This involves assigning a sector region to each vertex in the tree, and placing that information in a data array with four components per tuple representing (innerRadius, outerRadius, startAngle, endAngle).

This class may be assigned as the layout strategy to vtkAreaLayout.

Thanks:
Thanks to Jason Shepherd from Sandia National Laboratories for help developing this class.

Definition at line 44 of file vtkStackedTreeLayoutStrategy.h.


Public Types

typedef vtkAreaLayoutStrategy Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkIdType FindVertex (vtkTree *tree, vtkDataArray *array, float pnt[2])
virtual void Layout (vtkTree *inputTree, vtkDataArray *sectorArray, vtkDataArray *sizeArray)
virtual void LayoutEdgePoints (vtkTree *inputTree, vtkDataArray *sectorArray, vtkDataArray *sizeArray, vtkTree *edgeRoutingTree)
virtual void SetInteriorRadius (double)
virtual double GetInteriorRadius ()
virtual void SetRingThickness (double)
virtual double GetRingThickness ()
virtual void SetRootStartAngle (double)
virtual double GetRootStartAngle ()
virtual void SetRootEndAngle (double)
virtual double GetRootEndAngle ()
virtual void SetUseRectangularCoordinates (bool)
virtual bool GetUseRectangularCoordinates ()
virtual void UseRectangularCoordinatesOn ()
virtual void UseRectangularCoordinatesOff ()
virtual void SetReverse (bool)
virtual bool GetReverse ()
virtual void ReverseOn ()
virtual void ReverseOff ()
virtual void SetInteriorLogSpacingValue (double)
virtual double GetInteriorLogSpacingValue ()

Static Public Member Functions

static
vtkStackedTreeLayoutStrategy
New ()
static int IsTypeOf (const char *type)
static
vtkStackedTreeLayoutStrategy
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkStackedTreeLayoutStrategy ()
 ~vtkStackedTreeLayoutStrategy ()
void ComputeEdgeRoutingPoints (vtkTree *inputTree, vtkDataArray *coordsArray, vtkTree *outputTree)
void LayoutChildren (vtkTree *tree, vtkDataArray *coordsArray, vtkDataArray *sizeArray, vtkIdType nchildren, vtkIdType parent, vtkIdType begin, float parentInnerRad, float parentOuterRad, float parentStartAng, float parentEndAng)

Protected Attributes

float InteriorRadius
float RingThickness
float RootStartAngle
float RootEndAngle
bool UseRectangularCoordinates
bool Reverse
double InteriorLogSpacingValue

Member Typedef Documentation

Reimplemented from vtkAreaLayoutStrategy.

Definition at line 49 of file vtkStackedTreeLayoutStrategy.h.


Constructor & Destructor Documentation

vtkStackedTreeLayoutStrategy::vtkStackedTreeLayoutStrategy (  )  [protected]

vtkStackedTreeLayoutStrategy::~vtkStackedTreeLayoutStrategy (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkObject.

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

Reimplemented from vtkAreaLayoutStrategy.

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

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

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

Reimplemented from vtkAreaLayoutStrategy.

void vtkStackedTreeLayoutStrategy::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 vtkAreaLayoutStrategy.

virtual void vtkStackedTreeLayoutStrategy::Layout ( vtkTree inputTree,
vtkDataArray sectorArray,
vtkDataArray sizeArray 
) [virtual]

Perform the layout of the input tree, and store the sector bounds of each vertex as a tuple (innerRadius, outerRadius, startAngle, endAngle) in a data array.

Implements vtkAreaLayoutStrategy.

virtual void vtkStackedTreeLayoutStrategy::LayoutEdgePoints ( vtkTree inputTree,
vtkDataArray sectorArray,
vtkDataArray sizeArray,
vtkTree edgeRoutingTree 
) [virtual]

Fill edgeRoutingTree with points suitable for routing edges of an overlaid graph.

Reimplemented from vtkAreaLayoutStrategy.

virtual void vtkStackedTreeLayoutStrategy::SetInteriorRadius ( double   )  [virtual]

Define the tree ring's interior radius.

virtual double vtkStackedTreeLayoutStrategy::GetInteriorRadius (  )  [virtual]

Define the tree ring's interior radius.

virtual void vtkStackedTreeLayoutStrategy::SetRingThickness ( double   )  [virtual]

Define the thickness of each of the tree rings.

virtual double vtkStackedTreeLayoutStrategy::GetRingThickness (  )  [virtual]

Define the thickness of each of the tree rings.

virtual void vtkStackedTreeLayoutStrategy::SetRootStartAngle ( double   )  [virtual]

Define the start angle for the root node. NOTE: It is assumed that the root end angle is greater than the root start angle and subtends no more than 360 degrees.

virtual double vtkStackedTreeLayoutStrategy::GetRootStartAngle (  )  [virtual]

Define the start angle for the root node. NOTE: It is assumed that the root end angle is greater than the root start angle and subtends no more than 360 degrees.

virtual void vtkStackedTreeLayoutStrategy::SetRootEndAngle ( double   )  [virtual]

Define the end angle for the root node. NOTE: It is assumed that the root end angle is greater than the root start angle and subtends no more than 360 degrees.

virtual double vtkStackedTreeLayoutStrategy::GetRootEndAngle (  )  [virtual]

Define the end angle for the root node. NOTE: It is assumed that the root end angle is greater than the root start angle and subtends no more than 360 degrees.

virtual void vtkStackedTreeLayoutStrategy::SetUseRectangularCoordinates ( bool   )  [virtual]

Define whether or not rectangular coordinates are being used (as opposed to polar coordinates).

virtual bool vtkStackedTreeLayoutStrategy::GetUseRectangularCoordinates (  )  [virtual]

Define whether or not rectangular coordinates are being used (as opposed to polar coordinates).

virtual void vtkStackedTreeLayoutStrategy::UseRectangularCoordinatesOn (  )  [virtual]

Define whether or not rectangular coordinates are being used (as opposed to polar coordinates).

virtual void vtkStackedTreeLayoutStrategy::UseRectangularCoordinatesOff (  )  [virtual]

Define whether or not rectangular coordinates are being used (as opposed to polar coordinates).

virtual void vtkStackedTreeLayoutStrategy::SetReverse ( bool   )  [virtual]

Define whether to reverse the order of the tree stacks from low to high.

virtual bool vtkStackedTreeLayoutStrategy::GetReverse (  )  [virtual]

Define whether to reverse the order of the tree stacks from low to high.

virtual void vtkStackedTreeLayoutStrategy::ReverseOn (  )  [virtual]

Define whether to reverse the order of the tree stacks from low to high.

virtual void vtkStackedTreeLayoutStrategy::ReverseOff (  )  [virtual]

Define whether to reverse the order of the tree stacks from low to high.

virtual void vtkStackedTreeLayoutStrategy::SetInteriorLogSpacingValue ( double   )  [virtual]

The spacing of tree levels in the edge routing tree. Levels near zero give more space to levels near the root, while levels near one (the default) create evenly-spaced levels. Levels above one give more space to levels near the leaves.

virtual double vtkStackedTreeLayoutStrategy::GetInteriorLogSpacingValue (  )  [virtual]

The spacing of tree levels in the edge routing tree. Levels near zero give more space to levels near the root, while levels near one (the default) create evenly-spaced levels. Levels above one give more space to levels near the leaves.

virtual vtkIdType vtkStackedTreeLayoutStrategy::FindVertex ( vtkTree tree,
vtkDataArray array,
float  pnt[2] 
) [virtual]

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

Implements vtkAreaLayoutStrategy.

void vtkStackedTreeLayoutStrategy::ComputeEdgeRoutingPoints ( vtkTree inputTree,
vtkDataArray coordsArray,
vtkTree outputTree 
) [protected]

void vtkStackedTreeLayoutStrategy::LayoutChildren ( vtkTree tree,
vtkDataArray coordsArray,
vtkDataArray sizeArray,
vtkIdType  nchildren,
vtkIdType  parent,
vtkIdType  begin,
float  parentInnerRad,
float  parentOuterRad,
float  parentStartAng,
float  parentEndAng 
) [protected]


Member Data Documentation

Definition at line 128 of file vtkStackedTreeLayoutStrategy.h.

Definition at line 129 of file vtkStackedTreeLayoutStrategy.h.

Definition at line 130 of file vtkStackedTreeLayoutStrategy.h.

Definition at line 131 of file vtkStackedTreeLayoutStrategy.h.

Definition at line 132 of file vtkStackedTreeLayoutStrategy.h.

Definition at line 133 of file vtkStackedTreeLayoutStrategy.h.

Definition at line 134 of file vtkStackedTreeLayoutStrategy.h.


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

Generated on Wed Aug 24 12:08:40 2011 for VTK by  doxygen 1.5.6