lays out tree in stacked boxes or rings More...

#include <vtkStackedTreeLayoutStrategy.h>

Inheritance diagram for vtkStackedTreeLayoutStrategy:

Collaboration diagram for vtkStackedTreeLayoutStrategy:

Public Types
typedef vtkAreaLayoutStrategy	Superclass

Public Types inherited from vtkAreaLayoutStrategy
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkStackedTreeLayoutStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

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


virtual void	Layout (vtkTree inputTree, vtkDataArray sectorArray, vtkDataArray *sizeArray)


virtual void	LayoutEdgePoints (vtkTree inputTree, vtkDataArray sectorArray, vtkDataArray sizeArray, vtkTree edgeRoutingTree)


virtual void	SetInteriorRadius (double)

virtual double	GetInteriorRadius ()


virtual void	SetRingThickness (double)

virtual double	GetRingThickness ()


virtual void	SetRootStartAngle (double)

virtual double	GetRootStartAngle ()


virtual void	SetRootEndAngle (double)

virtual double	GetRootEndAngle ()


virtual void	SetUseRectangularCoordinates (bool)

virtual bool	GetUseRectangularCoordinates ()

virtual void	UseRectangularCoordinatesOn ()

virtual void	UseRectangularCoordinatesOff ()


virtual void	SetReverse (bool)

virtual bool	GetReverse ()

virtual void	ReverseOn ()

virtual void	ReverseOff ()


virtual void	SetInteriorLogSpacingValue (double)

virtual double	GetInteriorLogSpacingValue ()

Public Member Functions inherited from vtkAreaLayoutStrategy
vtkAreaLayoutStrategy *	NewInstance () const

virtual void	SetShrinkPercentage (double)

virtual double	GetShrinkPercentage ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkStackedTreeLayoutStrategy *	New ()

static int	IsTypeOf (const char *type)

static vtkStackedTreeLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAreaLayoutStrategy
static int	IsTypeOf (const char *type)

static vtkAreaLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkStackedTreeLayoutStrategy ()

	~vtkStackedTreeLayoutStrategy ()

void	ComputeEdgeRoutingPoints (vtkTree inputTree, vtkDataArray coordsArray, vtkTree *outputTree)

void	LayoutChildren (vtkTree tree, vtkDataArray coordsArray, vtkDataArray *sizeArray, vtkIdType nchildren, vtkIdType parent, vtkIdType begin, float parentInnerRad, float parentOuterRad, float parentStartAng, float parentEndAng)

Protected Member Functions inherited from vtkAreaLayoutStrategy
	vtkAreaLayoutStrategy ()

	~vtkAreaLayoutStrategy ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
float	InteriorRadius

float	RingThickness

float	RootStartAngle

float	RootEndAngle

bool	UseRectangularCoordinates

bool	Reverse

double	InteriorLogSpacingValue

Protected Attributes inherited from vtkAreaLayoutStrategy
double	ShrinkPercentage

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

lays out tree in stacked boxes or rings

Performs a tree ring layout or "icicle" layout on a tree. This involves assigning a sector 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).

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 45 of file vtkStackedTreeLayoutStrategy.h.

Member Typedef Documentation

typedef vtkAreaLayoutStrategy vtkStackedTreeLayoutStrategy::Superclass

Definition at line 50 of file vtkStackedTreeLayoutStrategy.h.

Constructor & Destructor Documentation

vtkStackedTreeLayoutStrategy::vtkStackedTreeLayoutStrategy ( )

protected

vtkStackedTreeLayoutStrategy::~vtkStackedTreeLayoutStrategy ( )

protected

Member Function Documentation

static vtkStackedTreeLayoutStrategy* vtkStackedTreeLayoutStrategy::New ( )

static

static int vtkStackedTreeLayoutStrategy::IsTypeOf ( const char * type )

static

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

static vtkStackedTreeLayoutStrategy* vtkStackedTreeLayoutStrategy::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkStackedTreeLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAreaLayoutStrategy.

vtkStackedTreeLayoutStrategy* vtkStackedTreeLayoutStrategy::NewInstance ( ) const

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

virtual void vtkStackedTreeLayoutStrategy::Layout	(	vtkTree *	inputTree,
		vtkDataArray *	sectorArray,
		vtkDataArray *	sizeArray
	)

virtual

Perform the layout of the input tree, and store the sector bounds of each vertex as a tuple (innerRadius, outerRadius, startAngle, endAngle) in a data array.

Implements vtkAreaLayoutStrategy.

virtual void vtkStackedTreeLayoutStrategy::LayoutEdgePoints	(	vtkTree *	inputTree,
		vtkDataArray *	sectorArray,
		vtkDataArray *	sizeArray,
		vtkTree *	edgeRoutingTree
	)

virtual

Fill edgeRoutingTree with points suitable for routing edges of an overlaid graph.

Reimplemented from vtkAreaLayoutStrategy.

virtual void vtkStackedTreeLayoutStrategy::SetInteriorRadius ( double )

virtual

Define the tree ring's interior radius.

virtual double vtkStackedTreeLayoutStrategy::GetInteriorRadius ( )

virtual

Define the tree ring's interior radius.

virtual void vtkStackedTreeLayoutStrategy::SetRingThickness ( double )

virtual

Define the thickness of each of the tree rings.

virtual double vtkStackedTreeLayoutStrategy::GetRingThickness ( )

virtual

Define the thickness of each of the tree rings.

virtual void vtkStackedTreeLayoutStrategy::SetRootStartAngle ( double )

virtual

Define the start angle for the root node. NOTE: It is assumed that the root end angle is greater than the root start angle and subtends no more than 360 degrees.

virtual double vtkStackedTreeLayoutStrategy::GetRootStartAngle ( )

virtual

Define the start angle for the root node. NOTE: It is assumed that the root end angle is greater than the root start angle and subtends no more than 360 degrees.

virtual void vtkStackedTreeLayoutStrategy::SetRootEndAngle ( double )

virtual

Define the end angle for the root node. NOTE: It is assumed that the root end angle is greater than the root start angle and subtends no more than 360 degrees.

virtual double vtkStackedTreeLayoutStrategy::GetRootEndAngle ( )

virtual

Define the end angle for the root node. NOTE: It is assumed that the root end angle is greater than the root start angle and subtends no more than 360 degrees.

virtual void vtkStackedTreeLayoutStrategy::SetUseRectangularCoordinates ( bool )

virtual

Define whether or not rectangular coordinates are being used (as opposed to polar coordinates).

virtual bool vtkStackedTreeLayoutStrategy::GetUseRectangularCoordinates ( )

virtual

Define whether or not rectangular coordinates are being used (as opposed to polar coordinates).

virtual void vtkStackedTreeLayoutStrategy::UseRectangularCoordinatesOn ( )

virtual

Define whether or not rectangular coordinates are being used (as opposed to polar coordinates).

virtual void vtkStackedTreeLayoutStrategy::UseRectangularCoordinatesOff ( )

virtual

Define whether or not rectangular coordinates are being used (as opposed to polar coordinates).

virtual void vtkStackedTreeLayoutStrategy::SetReverse ( bool )

virtual

Define whether to reverse the order of the tree stacks from low to high.

virtual bool vtkStackedTreeLayoutStrategy::GetReverse ( )

virtual

Define whether to reverse the order of the tree stacks from low to high.

virtual void vtkStackedTreeLayoutStrategy::ReverseOn ( )

virtual

Define whether to reverse the order of the tree stacks from low to high.

virtual void vtkStackedTreeLayoutStrategy::ReverseOff ( )

virtual

Define whether to reverse the order of the tree stacks from low to high.

virtual void vtkStackedTreeLayoutStrategy::SetInteriorLogSpacingValue ( double )

virtual

The spacing of tree levels in the edge routing tree. 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 vtkStackedTreeLayoutStrategy::GetInteriorLogSpacingValue ( )

virtual

The spacing of tree levels in the edge routing tree. 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 vtkIdType vtkStackedTreeLayoutStrategy::FindVertex	(	vtkTree *	tree,
		vtkDataArray *	array,
		float	pnt[2]
	)

virtual

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

Implements vtkAreaLayoutStrategy.

void vtkStackedTreeLayoutStrategy::ComputeEdgeRoutingPoints	(	vtkTree *	inputTree,
		vtkDataArray *	coordsArray,
		vtkTree *	outputTree
	)

protected

void vtkStackedTreeLayoutStrategy::LayoutChildren	(	vtkTree *	tree,
		vtkDataArray *	coordsArray,
		vtkDataArray *	sizeArray,
		vtkIdType	nchildren,
		vtkIdType	parent,
		vtkIdType	begin,
		float	parentInnerRad,
		float	parentOuterRad,
		float	parentStartAng,
		float	parentEndAng
	)