vtkAreaLayoutStrategy Class Reference

#include <vtkAreaLayoutStrategy.h>

Inheritance diagram for vtkAreaLayoutStrategy:

Inheritance graph
[legend]
Collaboration diagram for vtkAreaLayoutStrategy:

Collaboration graph
[legend]

List of all members.


Detailed Description

abstract superclass for all area layout strategies

All subclasses of this class perform a area layout on a tree. This involves assigning a 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).

Instances of subclasses of 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 46 of file vtkAreaLayoutStrategy.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void LayoutEdgePoints (vtkTree *inputTree, vtkDataArray *areaArray, vtkDataArray *sizeArray, vtkTree *edgeLayoutTree)
virtual vtkIdType FindVertex (vtkTree *tree, vtkDataArray *array, float pnt[2])=0
virtual void SetShrinkPercentage (double)
virtual double GetShrinkPercentage ()
virtual void Layout (vtkTree *inputTree, vtkDataArray *areaArray, vtkDataArray *sizeArray)=0

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkAreaLayoutStrategySafeDownCast (vtkObject *o)

Protected Member Functions

 vtkAreaLayoutStrategy ()
 ~vtkAreaLayoutStrategy ()

Protected Attributes

double ShrinkPercentage

Member Typedef Documentation


Constructor & Destructor Documentation

vtkAreaLayoutStrategy::vtkAreaLayoutStrategy (  )  [protected]

vtkAreaLayoutStrategy::~vtkAreaLayoutStrategy (  )  [protected]


Member Function Documentation

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

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

Reimplemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, and vtkTreeMapLayoutStrategy.

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

Reimplemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, and vtkTreeMapLayoutStrategy.

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

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

Reimplemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, and vtkTreeMapLayoutStrategy.

virtual void vtkAreaLayoutStrategy::Layout ( vtkTree inputTree,
vtkDataArray areaArray,
vtkDataArray sizeArray 
) [pure virtual]

Perform the layout of the input tree, and store the sector bounds of each vertex as a tuple in a data array. For radial layout, this is (innerRadius, outerRadius, startAngle, endAngle). For rectangular layout, this is (xmin, xmax, ymin, ymax). The sizeArray may be NULL, or may contain the desired size of each vertex in the tree.

Implemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, vtkSquarifyLayoutStrategy, and vtkStackedTreeLayoutStrategy.

virtual void vtkAreaLayoutStrategy::LayoutEdgePoints ( vtkTree inputTree,
vtkDataArray areaArray,
vtkDataArray sizeArray,
vtkTree edgeLayoutTree 
) [virtual]

Reimplemented in vtkStackedTreeLayoutStrategy.

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

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

Implemented in vtkStackedTreeLayoutStrategy, and vtkTreeMapLayoutStrategy.

virtual void vtkAreaLayoutStrategy::SetShrinkPercentage ( double   )  [virtual]

virtual double vtkAreaLayoutStrategy::GetShrinkPercentage (  )  [virtual]


Member Data Documentation

Definition at line 84 of file vtkAreaLayoutStrategy.h.


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

Generated on Wed Jun 3 18:53:27 2009 for VTK by  doxygen 1.5.6