hierarchical layout More...

#include <vtkTreeLayoutStrategy.h>

Inheritance diagram for vtkTreeLayoutStrategy:

Collaboration diagram for vtkTreeLayoutStrategy:

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

vtkTreeLayoutStrategy *	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 tree layout. More...


virtual void	SetAngle (double)
	The sweep angle of the tree. More...

virtual double	GetAngle ()
	The sweep angle of the tree. More...


virtual void	SetRadial (bool)
	If set, the tree is laid out with levels on concentric circles around the root. More...

virtual bool	GetRadial ()
	If set, the tree is laid out with levels on concentric circles around the root. More...

virtual void	RadialOn ()
	If set, the tree is laid out with levels on concentric circles around the root. More...

virtual void	RadialOff ()
	If set, the tree is laid out with levels on concentric circles around the root. More...


virtual void	SetLogSpacingValue (double)
	The spacing of tree levels. More...

virtual double	GetLogSpacingValue ()
	The spacing of tree levels. More...


virtual void	SetLeafSpacing (double)
	The spacing of leaves. More...

virtual double	GetLeafSpacing ()
	The spacing of leaves. More...


virtual void	SetDistanceArrayName (const char *)
	Get/Set the array to use to determine the distance from the root. More...

virtual char *	GetDistanceArrayName ()
	Get/Set the array to use to determine the distance from the root. More...


virtual void	SetRotation (double)
	The amount of counter-clockwise rotation to apply after the layout. More...

virtual double	GetRotation ()
	The amount of counter-clockwise rotation to apply after the layout. More...


virtual void	SetReverseEdges (bool)
	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. More...

virtual bool	GetReverseEdges ()
	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. More...

virtual void	ReverseEdgesOn ()
	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. More...

virtual void	ReverseEdgesOff ()
	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. More...

Public Member Functions inherited from vtkGraphLayoutStrategy
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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 void	Layout ()=0
	This is the layout method where the graph that was set in SetGraph() is laid out. 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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkTreeLayoutStrategy *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkTreeLayoutStrategy *	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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTreeLayoutStrategy ()

	~vtkTreeLayoutStrategy () override

Protected Member Functions inherited from vtkGraphLayoutStrategy
virtual vtkObjectBase *	NewInstanceInternal () const

	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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	Angle

bool	Radial

double	LogSpacingValue

double	LeafSpacing

char *	DistanceArrayName

double	Rotation

bool	ReverseEdges

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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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.

Definition at line 49 of file vtkTreeLayoutStrategy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkGraphLayoutStrategy vtkTreeLayoutStrategy::Superclass

Definition at line 54 of file vtkTreeLayoutStrategy.h.

Constructor & Destructor Documentation

◆ vtkTreeLayoutStrategy()

vtkTreeLayoutStrategy::vtkTreeLayoutStrategy ( )

protected

◆ ~vtkTreeLayoutStrategy()

vtkTreeLayoutStrategy::~vtkTreeLayoutStrategy ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkTreeLayoutStrategy * vtkTreeLayoutStrategy::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkTreeLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

◆ NewInstance()

vtkTreeLayoutStrategy * vtkTreeLayoutStrategy::NewInstance ( ) const

◆ PrintSelf()

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

◆ Layout()

void vtkTreeLayoutStrategy::Layout ( )

overridevirtual

Perform the tree layout.

Implements vtkGraphLayoutStrategy.

◆ SetAngle()

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.

◆ GetAngle()

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.

◆ SetRadial()

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.

◆ GetRadial()

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.

◆ RadialOn()

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.

◆ RadialOff()

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.

◆ SetLogSpacingValue()

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.

◆ GetLogSpacingValue()

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.

◆ SetLeafSpacing()

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.

◆ GetLeafSpacing()

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.

◆ SetDistanceArrayName()

virtual void vtkTreeLayoutStrategy::SetDistanceArrayName ( const char * )

virtual

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

◆ GetDistanceArrayName()

virtual char * vtkTreeLayoutStrategy::GetDistanceArrayName ( )

virtual

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

◆ SetRotation()

virtual void vtkTreeLayoutStrategy::SetRotation ( double )

virtual

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

◆ GetRotation()

virtual double vtkTreeLayoutStrategy::GetRotation ( )

virtual

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

◆ SetReverseEdges()

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.

◆ GetReverseEdges()

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.

◆ ReverseEdgesOn()

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.

◆ ReverseEdgesOff()

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.

Member Data Documentation

◆ Angle

double vtkTreeLayoutStrategy::Angle

protected

Definition at line 137 of file vtkTreeLayoutStrategy.h.

◆ Radial

bool vtkTreeLayoutStrategy::Radial

protected

Definition at line 138 of file vtkTreeLayoutStrategy.h.

◆ LogSpacingValue

double vtkTreeLayoutStrategy::LogSpacingValue

protected

Definition at line 139 of file vtkTreeLayoutStrategy.h.

◆ LeafSpacing

double vtkTreeLayoutStrategy::LeafSpacing

protected

Definition at line 140 of file vtkTreeLayoutStrategy.h.

◆ DistanceArrayName

char* vtkTreeLayoutStrategy::DistanceArrayName

protected

Definition at line 141 of file vtkTreeLayoutStrategy.h.

◆ Rotation

double vtkTreeLayoutStrategy::Rotation

protected

Definition at line 142 of file vtkTreeLayoutStrategy.h.

◆ ReverseEdges

bool vtkTreeLayoutStrategy::ReverseEdges

protected

Definition at line 143 of file vtkTreeLayoutStrategy.h.

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

Infovis/Layout/vtkTreeLayoutStrategy.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkTreeLayoutStrategy()

◆ ~vtkTreeLayoutStrategy()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Layout()

◆ SetAngle()

◆ GetAngle()

◆ SetRadial()

◆ GetRadial()

◆ RadialOn()

◆ RadialOff()

◆ SetLogSpacingValue()

◆ GetLogSpacingValue()

◆ SetLeafSpacing()

◆ GetLeafSpacing()

◆ SetDistanceArrayName()

◆ GetDistanceArrayName()

◆ SetRotation()

◆ GetRotation()

◆ SetReverseEdges()

◆ GetReverseEdges()

◆ ReverseEdgesOn()

◆ ReverseEdgesOff()

Member Data Documentation

◆ Angle

◆ Radial

◆ LogSpacingValue

◆ LeafSpacing

◆ DistanceArrayName

◆ Rotation

◆ ReverseEdges