produce a cone-tree layout for a forest More...

#include <vtkConeLayoutStrategy.h>

Inheritance diagram for vtkConeLayoutStrategy:

Collaboration diagram for vtkConeLayoutStrategy:

Public Types
typedef vtkGraphLayoutStrategy	Superclass

Public Types inherited from vtkGraphLayoutStrategy
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkConeLayoutStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	Layout ()


virtual void	SetCompactness (float)

virtual float	GetCompactness ()


virtual void	SetCompression (int)

virtual int	GetCompression ()

virtual void	CompressionOn ()

virtual void	CompressionOff ()


virtual void	SetSpacing (float)

virtual float	GetSpacing ()

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

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetGraph (vtkGraph *graph)

virtual void	Initialize ()

virtual int	IsLayoutComplete ()

virtual void	SetWeightEdges (bool state)

virtual bool	GetWeightEdges ()

virtual void	SetEdgeWeightField (const char *field)

virtual char *	GetEdgeWeightField ()

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 vtkConeLayoutStrategy *	New ()

static int	IsTypeOf (const char *type)

static vtkConeLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

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

static vtkGraphLayoutStrategy *	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

	vtkConeLayoutStrategy ()

	~vtkConeLayoutStrategy ()

double	LocalPlacement (vtkIdType root, vtkPoints *points)

void	GlobalPlacement (vtkIdType root, vtkPoints *points, double refX, double refY, double level)

Protected Member Functions inherited from vtkGraphLayoutStrategy
	vtkGraphLayoutStrategy ()

	~vtkGraphLayoutStrategy ()

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	Compactness

int	Compression

float	Spacing

double	MinRadius

double	MaxRadius

int	NrCones

double	SumOfRadii

Protected Attributes inherited from vtkGraphLayoutStrategy
vtkGraph *	Graph

char *	EdgeWeightField

bool	WeightEdges

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

produce a cone-tree layout for a forest

vtkConeLayoutStrategy positions the nodes of a tree(forest) in 3D space based on the cone-tree approach first described by Robertson, Mackinlay and Card in Proc. CHI'91. This implementation incorporates refinements to the layout developed by Carriere and Kazman, and by Auber.

The input graph must be a forest (i.e. a set of trees, or a single tree); in the case of a forest, the input will be converted to a single tree by introducing a new root node, and connecting each root in the input forest to the meta-root. The tree is then laid out, after which the meta-root is removed.

The cones are positioned so that children lie in planes parallel to the X-Y plane, with the axis of cones parallel to Z, and with Z coordinate increasing with distance of nodes from the root.

Thanks:: Thanks to David Duke from the University of Leeds for providing this implementation.

Tests:: vtkConeLayoutStrategy (Tests)

Definition at line 56 of file vtkConeLayoutStrategy.h.

Member Typedef Documentation

typedef vtkGraphLayoutStrategy vtkConeLayoutStrategy::Superclass

Definition at line 61 of file vtkConeLayoutStrategy.h.

Constructor & Destructor Documentation

vtkConeLayoutStrategy::vtkConeLayoutStrategy ( )

protected

vtkConeLayoutStrategy::~vtkConeLayoutStrategy ( )

protected

Member Function Documentation

static vtkConeLayoutStrategy* vtkConeLayoutStrategy::New ( )

static

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

static

virtual int vtkConeLayoutStrategy::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 vtkConeLayoutStrategy* vtkConeLayoutStrategy::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkConeLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

vtkConeLayoutStrategy* vtkConeLayoutStrategy::NewInstance ( ) const

void vtkConeLayoutStrategy::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 vtkObject.

virtual void vtkConeLayoutStrategy::SetCompactness ( float )

virtual

Determine the compactness, the ratio between the average width of a cone in the tree, and the height of the cone. The default setting is 0.75 which (empirically) seems reasonable, but this will need adapting depending on the data.

virtual float vtkConeLayoutStrategy::GetCompactness ( )

virtual

Determine the compactness, the ratio between the average width of a cone in the tree, and the height of the cone. The default setting is 0.75 which (empirically) seems reasonable, but this will need adapting depending on the data.

virtual void vtkConeLayoutStrategy::SetCompression ( int )

virtual

Determine if layout should be compressed, i.e. the layout puts children closer together, possibly allowing sub-trees to overlap. This is useful if the tree is actually the spanning tree of a graph. For "real" trees, non-compressed layout is best, and is the default.

virtual int vtkConeLayoutStrategy::GetCompression ( )

virtual

Determine if layout should be compressed, i.e. the layout puts children closer together, possibly allowing sub-trees to overlap. This is useful if the tree is actually the spanning tree of a graph. For "real" trees, non-compressed layout is best, and is the default.

virtual void vtkConeLayoutStrategy::CompressionOn ( )

virtual

Determine if layout should be compressed, i.e. the layout puts children closer together, possibly allowing sub-trees to overlap. This is useful if the tree is actually the spanning tree of a graph. For "real" trees, non-compressed layout is best, and is the default.

virtual void vtkConeLayoutStrategy::CompressionOff ( )

virtual

Determine if layout should be compressed, i.e. the layout puts children closer together, possibly allowing sub-trees to overlap. This is useful if the tree is actually the spanning tree of a graph. For "real" trees, non-compressed layout is best, and is the default.

virtual void vtkConeLayoutStrategy::SetSpacing ( float )

virtual

Set the spacing parameter that affects space between layers of the tree. If compression is on, Spacing is the actual distance between layers. If compression is off, actual distance also includes a factor of the compactness and maximum cone radius.

virtual float vtkConeLayoutStrategy::GetSpacing ( )

virtual

Set the spacing parameter that affects space between layers of the tree. If compression is on, Spacing is the actual distance between layers. If compression is off, actual distance also includes a factor of the compactness and maximum cone radius.

void vtkConeLayoutStrategy::Layout ( )

virtual

Perform the layout.

Implements vtkGraphLayoutStrategy.

double vtkConeLayoutStrategy::LocalPlacement	(	vtkIdType	root,
		vtkPoints *	points
	)

protected

Helper operations for tree layout. Layout is performed in two traversals of the tree. The first traversal finds the position of child nodes relative to their parent. The second traversal positions each node absolutely, working from the initial position of the root node.

void vtkConeLayoutStrategy::GlobalPlacement	(	vtkIdType	root,
		vtkPoints *	points,
		double	refX,
		double	refY,
		double	level
	)

protected

Member Data Documentation

float vtkConeLayoutStrategy::Compactness

protected

Definition at line 115 of file vtkConeLayoutStrategy.h.

int vtkConeLayoutStrategy::Compression

protected

Definition at line 116 of file vtkConeLayoutStrategy.h.

float vtkConeLayoutStrategy::Spacing

protected

Definition at line 117 of file vtkConeLayoutStrategy.h.

double vtkConeLayoutStrategy::MinRadius

protected

Definition at line 120 of file vtkConeLayoutStrategy.h.

double vtkConeLayoutStrategy::MaxRadius

protected

Definition at line 121 of file vtkConeLayoutStrategy.h.

int vtkConeLayoutStrategy::NrCones

protected

Definition at line 122 of file vtkConeLayoutStrategy.h.

double vtkConeLayoutStrategy::SumOfRadii

protected

Definition at line 123 of file vtkConeLayoutStrategy.h.

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

dox/Infovis/Layout/vtkConeLayoutStrategy.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation