vtkTreeLayoutStrategy Class Reference

#include <vtkTreeLayoutStrategy.h>

Inheritance diagram for vtkTreeLayoutStrategy:

[legend]

Collaboration diagram for vtkTreeLayoutStrategy:

[legend]

List of all members.

Detailed Description

hierarchical layout

Assigns points to the nodes of a tree in either a standard or radial layout. The standard layout places each level on a horizontal line, while the radial layout places each level on a concentric circle. You may specify the sweep angle of the tree which constrains the tree to be contained within a wedge. Also, you may indicate the log scale of the tree, which diminishes the length of arcs at lower levels of the tree. Values near zero give a large proportion of the space to the tree levels near the root, while values near one give nearly equal proportions of space to all tree levels.

The user may also specify an array to use to indicate the distance from the root, either vertically (for standard layout) or radially (for radial layout). You specify this with SetDistanceArrayName().

If the input is not a tree but a general graph, this strategy first extracts a tree from the graph using a breadth-first search starting at vertex ID 0.

Examples:: vtkTreeLayoutStrategy (Examples)

Tests:: vtkTreeLayoutStrategy (Tests)

Definition at line 53 of file vtkTreeLayoutStrategy.h.


Public Types
typedef vtkGraphLayoutStrategy	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	Layout ()

virtual void	SetAngle (double)
virtual double	GetAngle ()

virtual void	SetRadial (bool)
virtual bool	GetRadial ()
virtual void	RadialOn ()
virtual void	RadialOff ()

virtual void	SetLogSpacingValue (double)
virtual double	GetLogSpacingValue ()

virtual void	SetLeafSpacing (double)
virtual double	GetLeafSpacing ()

virtual void	SetDistanceArrayName (const char *)
virtual char *	GetDistanceArrayName ()

virtual void	SetRotation (double)
virtual double	GetRotation ()

virtual void	SetReverseEdges (bool)
virtual bool	GetReverseEdges ()
virtual void	ReverseEdgesOn ()
virtual void	ReverseEdgesOff ()
Static Public Member Functions
static vtkTreeLayoutStrategy *	New ()
static int	IsTypeOf (const char *type)
static vtkTreeLayoutStrategy *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkTreeLayoutStrategy ()
	~vtkTreeLayoutStrategy ()
Protected Attributes
double	Angle
bool	Radial
double	LogSpacingValue
double	LeafSpacing
char *	DistanceArrayName
double	Rotation
bool	ReverseEdges

Member Typedef Documentation

typedef vtkGraphLayoutStrategy vtkTreeLayoutStrategy::Superclass

Reimplemented from vtkGraphLayoutStrategy.

Definition at line 58 of file vtkTreeLayoutStrategy.h.

Constructor & Destructor Documentation

vtkTreeLayoutStrategy::vtkTreeLayoutStrategy ( ) [protected]

vtkTreeLayoutStrategy::~vtkTreeLayoutStrategy ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkObject.

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

Reimplemented from vtkGraphLayoutStrategy.

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

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

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

Reimplemented from vtkGraphLayoutStrategy.

void vtkTreeLayoutStrategy::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 vtkGraphLayoutStrategy.

void vtkTreeLayoutStrategy::Layout ( ) [virtual]

Perform the tree layout.

Implements vtkGraphLayoutStrategy.

virtual void vtkTreeLayoutStrategy::SetAngle ( double ) [virtual]

The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.

virtual double vtkTreeLayoutStrategy::GetAngle ( ) [virtual]

The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.

virtual void vtkTreeLayoutStrategy::SetRadial ( bool ) [virtual]

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

virtual bool vtkTreeLayoutStrategy::GetRadial ( ) [virtual]

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

virtual void vtkTreeLayoutStrategy::RadialOn ( ) [virtual]

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

virtual void vtkTreeLayoutStrategy::RadialOff ( ) [virtual]

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

virtual void vtkTreeLayoutStrategy::SetLogSpacingValue ( double ) [virtual]

The spacing of tree levels. 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 vtkTreeLayoutStrategy::GetLogSpacingValue ( ) [virtual]

The spacing of tree levels. 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 void vtkTreeLayoutStrategy::SetLeafSpacing ( double ) [virtual]

The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.

virtual double vtkTreeLayoutStrategy::GetLeafSpacing ( ) [virtual]

The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.

virtual void vtkTreeLayoutStrategy::SetDistanceArrayName ( const char * ) [virtual]

Get/Set the array to use to determine the distance from the root.

virtual char* vtkTreeLayoutStrategy::GetDistanceArrayName ( ) [virtual]

Get/Set the array to use to determine the distance from the root.

virtual void vtkTreeLayoutStrategy::SetRotation ( double ) [virtual]

The amount of counter-clockwise rotation to apply after the layout.

virtual double vtkTreeLayoutStrategy::GetRotation ( ) [virtual]

The amount of counter-clockwise rotation to apply after the layout.

virtual void vtkTreeLayoutStrategy::SetReverseEdges ( bool ) [virtual]

If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.

virtual bool vtkTreeLayoutStrategy::GetReverseEdges ( ) [virtual]

If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.

virtual void vtkTreeLayoutStrategy::ReverseEdgesOn ( ) [virtual]

If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.

virtual void vtkTreeLayoutStrategy::ReverseEdgesOff ( ) [virtual]

If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.