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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkConeLayoutStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	Layout () override
	Perform the layout. More...


virtual void	SetCompactness (float)
	Determine the compactness, the ratio between the average width of a cone in the tree, and the height of the cone. More...

virtual float	GetCompactness ()
	Determine the compactness, the ratio between the average width of a cone in the tree, and the height of the cone. More...


virtual void	SetCompression (vtkTypeBool)
	Determine if layout should be compressed, i.e. More...

virtual vtkTypeBool	GetCompression ()
	Determine if layout should be compressed, i.e. More...

virtual void	CompressionOn ()
	Determine if layout should be compressed, i.e. More...

virtual void	CompressionOff ()
	Determine if layout should be compressed, i.e. More...


virtual void	SetSpacing (float)
	Set the spacing parameter that affects space between layers of the tree. More...

virtual float	GetSpacing ()
	Set the spacing parameter that affects space between layers of the tree. More...

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

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	SetGraph (vtkGraph *graph)
	Setting the graph for the layout strategy. More...

virtual void	Initialize ()
	This method allows the layout strategy to do initialization of data structures or whatever else it might want to do. More...

virtual int	IsLayoutComplete ()
	If your concrete class is iterative than you should overload IsLayoutComplete() otherwise it simply returns 1 by default;. More...

virtual void	SetWeightEdges (bool state)
	Whether to use edge weights in the layout or not. More...

virtual bool	GetWeightEdges ()
	Whether to use edge weights in the layout or not. More...

virtual void	SetEdgeWeightField (const char *field)
	Set/Get the field to use for the edge weights. More...

virtual char *	GetEdgeWeightField ()
	Set/Get the field to use for the edge weights. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkConeLayoutStrategy *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkConeLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

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

static vtkGraphLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkConeLayoutStrategy ()

	~vtkConeLayoutStrategy () override

double	LocalPlacement (vtkIdType root, vtkPoints *points)
	Helper operations for tree layout. More...

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

Protected Member Functions inherited from vtkGraphLayoutStrategy
	vtkGraphLayoutStrategy ()

	~vtkGraphLayoutStrategy () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

vtkTypeBool	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 57 of file vtkConeLayoutStrategy.h.

Member Typedef Documentation

typedef vtkGraphLayoutStrategy vtkConeLayoutStrategy::Superclass

Definition at line 62 of file vtkConeLayoutStrategy.h.

Constructor & Destructor Documentation

vtkConeLayoutStrategy::vtkConeLayoutStrategy ( )

protected

vtkConeLayoutStrategy::~vtkConeLayoutStrategy ( )

overrideprotected

Member Function Documentation

static vtkConeLayoutStrategy* vtkConeLayoutStrategy::New ( )

static

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

static

virtual vtkTypeBool 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
	)

overridevirtual

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 ( vtkTypeBool )

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 vtkTypeBool 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 ( )

overridevirtual

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 129 of file vtkConeLayoutStrategy.h.

vtkTypeBool vtkConeLayoutStrategy::Compression

protected

Definition at line 130 of file vtkConeLayoutStrategy.h.

float vtkConeLayoutStrategy::Spacing

protected

Definition at line 131 of file vtkConeLayoutStrategy.h.

double vtkConeLayoutStrategy::MinRadius

protected

Definition at line 134 of file vtkConeLayoutStrategy.h.

double vtkConeLayoutStrategy::MaxRadius

protected

Definition at line 135 of file vtkConeLayoutStrategy.h.

int vtkConeLayoutStrategy::NrCones

protected

Definition at line 136 of file vtkConeLayoutStrategy.h.

double vtkConeLayoutStrategy::SumOfRadii

protected

Definition at line 137 of file vtkConeLayoutStrategy.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/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