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
vtkAreaLayoutStrategy Class Referenceabstract

abstract superclass for all area layout strategies More...

#include <vtkAreaLayoutStrategy.h>

Inheritance diagram for vtkAreaLayoutStrategy:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

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

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkAreaLayoutStrategy ()
 
 ~vtkAreaLayoutStrategy ()
 

Protected Attributes

double ShrinkPercentage
 

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 47 of file vtkAreaLayoutStrategy.h.

Member Typedef Documentation

Definition at line 50 of file vtkAreaLayoutStrategy.h.

Constructor & Destructor Documentation

vtkAreaLayoutStrategy::vtkAreaLayoutStrategy ( )
protected
vtkAreaLayoutStrategy::~vtkAreaLayoutStrategy ( )
protected

Member Function Documentation

static int vtkAreaLayoutStrategy::IsTypeOf ( const char *  type)
static
virtual int vtkAreaLayoutStrategy::IsA ( const char *  type)
virtual
static vtkAreaLayoutStrategy* vtkAreaLayoutStrategy::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkAreaLayoutStrategy::NewInstanceInternal ( ) const
protectedvirtual
vtkAreaLayoutStrategy* vtkAreaLayoutStrategy::NewInstance ( ) const
void vtkAreaLayoutStrategy::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, vtkSliceAndDiceLayoutStrategy, and vtkBoxLayoutStrategy.

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

double vtkAreaLayoutStrategy::ShrinkPercentage
protected

Definition at line 85 of file vtkAreaLayoutStrategy.h.


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