vtkAreaLayout Class Reference

#include <vtkAreaLayout.h>

Inheritance diagram for vtkAreaLayout:

[legend]

Collaboration diagram for vtkAreaLayout:

[legend]

List of all members.

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 44 of file vtkAreaLayout.h.


Public Types
typedef vtkTreeAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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 vtkAreaLayoutStrategy *	GetLayoutStrategy ()
void	SetLayoutStrategy (vtkAreaLayoutStrategy *strategy)
Static Public Member Functions
static vtkAreaLayout *	New ()
static int	IsTypeOf (const char *type)
static vtkAreaLayout *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkAreaLayout ()
	~vtkAreaLayout ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
char *	AreaArrayName
bool	EdgeRoutingPoints
char *	EdgeRoutingPointsArrayName
vtkAreaLayoutStrategy *	LayoutStrategy

Member Typedef Documentation

typedef vtkTreeAlgorithm vtkAreaLayout::Superclass

Reimplemented from vtkTreeAlgorithm.

Definition at line 48 of file vtkAreaLayout.h.

Constructor & Destructor Documentation

vtkAreaLayout::vtkAreaLayout ( ) [protected]

vtkAreaLayout::~vtkAreaLayout ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkTreeAlgorithm.

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

Reimplemented from vtkTreeAlgorithm.

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

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

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

Reimplemented from vtkTreeAlgorithm.

void vtkAreaLayout::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 vtkTreeAlgorithm.

virtual void vtkAreaLayout::SetSizeArrayName ( const char * name ) [inline, virtual]

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 55 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.

Reimplemented from vtkObject.

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 *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`