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
vtkAreaLayout Class Reference

layout a vtkTree into a tree map More...

#include <vtkAreaLayout.h>

Inherits vtkTreeAlgorithm.

Collaboration diagram for vtkAreaLayout:
[legend]

Public Types

typedef vtkTreeAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkAreaLayoutNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual unsigned long GetMTime ()
 
vtkIdType FindVertex (float pnt[2])
 
void GetBoundingArea (vtkIdType id, float *sinfo)
 
virtual void SetSizeArrayName (const char *name)
 
virtual char * GetAreaArrayName ()
 
virtual void SetAreaArrayName (const char *)
 
virtual bool GetEdgeRoutingPoints ()
 
virtual void SetEdgeRoutingPoints (bool)
 
virtual void EdgeRoutingPointsOn ()
 
virtual void EdgeRoutingPointsOff ()
 
virtual vtkAreaLayoutStrategyGetLayoutStrategy ()
 
void SetLayoutStrategy (vtkAreaLayoutStrategy *strategy)
 

Static Public Member Functions

static vtkAreaLayoutNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAreaLayoutSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkAreaLayout ()
 
 ~vtkAreaLayout ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

char * AreaArrayName
 
bool EdgeRoutingPoints
 
char * EdgeRoutingPointsArrayName
 
vtkAreaLayoutStrategyLayoutStrategy
 

Detailed Description

layout a vtkTree into a tree map

vtkAreaLayout assigns sector regions to each vertex in the tree, creating a tree ring. The data is added as a data array with four components per tuple representing the location and size of the sector using the format (StartAngle, EndAngle, innerRadius, outerRadius).

This algorithm relies on a helper class to perform the actual layout. This helper class is a subclass of vtkAreaLayoutStrategy.

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

Definition at line 45 of file vtkAreaLayout.h.

Member Typedef Documentation

typedef vtkTreeAlgorithm vtkAreaLayout::Superclass

Definition at line 49 of file vtkAreaLayout.h.

Constructor & Destructor Documentation

vtkAreaLayout::vtkAreaLayout ( )
protected
vtkAreaLayout::~vtkAreaLayout ( )
protected

Member Function Documentation

static vtkAreaLayout* vtkAreaLayout::New ( )
static
static int vtkAreaLayout::IsTypeOf ( const char *  type)
static
virtual int vtkAreaLayout::IsA ( const char *  type)
virtual
static vtkAreaLayout* vtkAreaLayout::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkAreaLayout::NewInstanceInternal ( ) const
protectedvirtual
vtkAreaLayout* vtkAreaLayout::NewInstance ( ) const
void vtkAreaLayout::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkAreaLayout::SetSizeArrayName ( const char *  name)
inlinevirtual

The array name to use for retrieving the relative size of each vertex. If this array is not found, use constant size for each vertex.

Definition at line 56 of file vtkAreaLayout.h.

virtual char* vtkAreaLayout::GetAreaArrayName ( )
virtual

The name for the array created for the area for each vertex. The rectangles are stored in a quadruple float array (startAngle, endAngle, innerRadius, outerRadius). For rectangular layouts, this is (minx, maxx, miny, maxy).

virtual void vtkAreaLayout::SetAreaArrayName ( const char *  )
virtual

The name for the array created for the area for each vertex. The rectangles are stored in a quadruple float array (startAngle, endAngle, innerRadius, outerRadius). For rectangular layouts, this is (minx, maxx, miny, maxy).

virtual bool vtkAreaLayout::GetEdgeRoutingPoints ( )
virtual

Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.

virtual void vtkAreaLayout::SetEdgeRoutingPoints ( bool  )
virtual

Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.

virtual void vtkAreaLayout::EdgeRoutingPointsOn ( )
virtual

Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.

virtual void vtkAreaLayout::EdgeRoutingPointsOff ( )
virtual

Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.

virtual vtkAreaLayoutStrategy* vtkAreaLayout::GetLayoutStrategy ( )
virtual

The strategy to use when laying out the tree map.

void vtkAreaLayout::SetLayoutStrategy ( vtkAreaLayoutStrategy strategy)

The strategy to use when laying out the tree map.

virtual unsigned long vtkAreaLayout::GetMTime ( )
virtual

Get the modification time of the layout algorithm.

vtkIdType vtkAreaLayout::FindVertex ( float  pnt[2])

Get the vertex whose area contains the point, or return -1 if no vertex area covers the point.

void vtkAreaLayout::GetBoundingArea ( vtkIdType  id,
float *  sinfo 
)

The bounding area information for a certain vertex id.

int vtkAreaLayout::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

Member Data Documentation

char* vtkAreaLayout::AreaArrayName
protected

Definition at line 97 of file vtkAreaLayout.h.

bool vtkAreaLayout::EdgeRoutingPoints
protected

Definition at line 98 of file vtkAreaLayout.h.

char* vtkAreaLayout::EdgeRoutingPointsArrayName
protected

Definition at line 99 of file vtkAreaLayout.h.

vtkAreaLayoutStrategy* vtkAreaLayout::LayoutStrategy
protected

Definition at line 100 of file vtkAreaLayout.h.


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