vtkHierarchicalGraphView Class Reference

#include <vtkHierarchicalGraphView.h>

Inheritance diagram for vtkHierarchicalGraphView:

[legend]

Collaboration diagram for vtkHierarchicalGraphView:

[legend]

List of all members.

Detailed Description

Accepts a graph and a hierarchy - currently a tree - and provides a hierarchy-aware display. Currently, this means displaying the hierarchy using a tree layout, then rendering the graph vertices as leaves of the tree with curved graph edges between leaves.

Takes a graph and a hierarchy (currently a tree) and lays out the graph vertices based on their categorization within the hierarchy.

Thanks:: Thanks to the turtle with jets for feet, without you this class wouldn't have been possible.

Tests:: vtkHierarchicalGraphView (Tests)

Definition at line 84 of file vtkHierarchicalGraphView.h.


char *	LayoutStrategyNameInternal
virtual char *	GetLayoutStrategyNameInternal ()
virtual void	SetLayoutStrategyNameInternal (const char *)
char *	IconArrayNameInternal
virtual char *	GetIconArrayNameInternal ()
virtual void	SetIconArrayNameInternal (const char *)
Public Types
typedef vtkRenderView	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetEdgeColorToSplineFraction ()
void	SetRadialLayout (bool radial)
void	SetRadialAngle (int angle)
void	SetLogSpacingFactor (double spacing)
void	SetLeafSpacing (double spacing)
void	SetBundlingStrength (double strength)
virtual vtkDataRepresentation *	GetTreeVisibilityRepresentation ()
void	SetIconTexture (vtkTexture *texture)
void	AddIconType (char *type, int index)
void	ClearIconTypes ()
void	SetIconSize (int *size)
void	SetIconAlignment (int alignment)
virtual void	SetupRenderWindow (vtkRenderWindow *win)
virtual void	ApplyViewTheme (vtkViewTheme *theme)

vtkDataRepresentation *	SetHierarchyFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentation *	SetHierarchyFromInput (vtkDataObject *input)
vtkDataRepresentation *	SetGraphFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentation *	SetGraphFromInput (vtkDataObject *input)

void	SetVertexLabelArrayName (const char *name)
const char *	GetVertexLabelArrayName ()

void	SetEdgeLabelArrayName (const char *name)
const char *	GetEdgeLabelArrayName ()

void	SetVertexLabelVisibility (bool vis)
bool	GetVertexLabelVisibility ()
void	VertexLabelVisibilityOn ()
void	VertexLabelVisibilityOff ()

void	SetEdgeLabelVisibility (bool vis)
bool	GetEdgeLabelVisibility ()
void	EdgeLabelVisibilityOn ()
void	EdgeLabelVisibilityOff ()

void	SetVertexColorArrayName (const char *name)
const char *	GetVertexColorArrayName ()

void	SetColorVertices (bool vis)
bool	GetColorVertices ()
void	ColorVerticesOn ()
void	ColorVerticesOff ()

void	SetEdgeColorArrayName (const char *name)
const char *	GetEdgeColorArrayName ()

void	SetColorEdges (bool vis)
bool	GetColorEdges ()
void	ColorEdgesOn ()
void	ColorEdgesOff ()

virtual vtkDataRepresentation *	GetGraphRepresentation ()
virtual vtkDataRepresentation *	GetTreeRepresentation ()

void	SetIconVisibility (bool b)
bool	GetIconVisibility ()
virtual void	IconVisibilityOn ()
virtual void	IconVisibilityOff ()

void	SetIconArrayName (const char *name)
const char *	GetIconArrayName ()

void	SetTreeEdgeVisibility (bool b)
bool	GetTreeEdgeVisibility ()
void	TreeEdgeVisibilityOn ()
void	TreeEdgeVisibilityOff ()

void	SetScalingArrayName (const char *name)
const char *	GetScalingArrayName ()

void	SetScaledGlyphs (bool arg)
bool	GetScaledGlyphs ()
virtual void	ScaledGlyphsOn ()
virtual void	ScaledGlyphsOff ()

void	SetLayoutStrategy (const char *name)
void	SetLayoutStrategyToTree ()
void	SetLayoutStrategyToCosmicTree ()
const char *	GetLayoutStrategyName ()

virtual vtkGraphLayoutStrategy *	GetLayoutStrategy ()
void	SetLayoutStrategy (vtkGraphLayoutStrategy *s)

virtual void	SetVertexLabelFontSize (const int size)
virtual int	GetVertexLabelFontSize ()

virtual void	SetEdgeLabelFontSize (const int size)
virtual int	GetEdgeLabelFontSize ()
Static Public Member Functions
static vtkHierarchicalGraphView *	New ()
static int	IsTypeOf (const char *type)
static vtkHierarchicalGraphView *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkHierarchicalGraphView ()
	~vtkHierarchicalGraphView ()
virtual void	PrepareForRendering ()
void	MapToXYPlane (double displayX, double displayY, double &x, double &y)

virtual void	ProcessEvents (vtkObject caller, unsigned long eventId, void callData)

virtual void	AddInputConnection (int port, int item, vtkAlgorithmOutput conn, vtkAlgorithmOutput selectConn)

virtual void	RemoveInputConnection (int port, int item, vtkAlgorithmOutput conn, vtkAlgorithmOutput selectConn)
Protected Attributes
vtkGraphLayoutStrategy *	LayoutStrategy
vtkSmartPointer< vtkCoordinate >	Coordinate
vtkSmartPointer< vtkGraphLayout >	GraphLayout
vtkSmartPointer < vtkCircularLayoutStrategy >	CircularStrategy
vtkSmartPointer < vtkTreeLayoutStrategy >	TreeStrategy
vtkSmartPointer < vtkCosmicTreeLayoutStrategy >	CosmicTreeStrategy
vtkSmartPointer < vtkPassThroughLayoutStrategy >	PassThroughStrategy
vtkSmartPointer < vtkGraphHierarchicalBundle >	HBundle
vtkSmartPointer< vtkSplineFilter >	Spline
vtkSmartPointer< vtkVertexDegree >	VertexDegree
vtkSmartPointer< vtkEdgeCenters >	EdgeCenters
vtkSmartPointer < vtkTreeFieldAggregator >	TreeAggregation
vtkSmartPointer < vtkExtractSelectedGraph >	ExtractSelectedTree
vtkSmartPointer< vtkGraphMapper >	SelectedTreeMapper
vtkSmartPointer< vtkActor >	SelectedTreeActor
vtkSmartPointer< vtkActor >	TreeActor
vtkSmartPointer< vtkGraphMapper >	TreeMapper
vtkSmartPointer < vtkDynamic2DLabelMapper >	VertexLabelMapper
vtkSmartPointer< vtkActor2D >	VertexLabelActor
vtkSmartPointer < vtkDynamic2DLabelMapper >	EdgeLabelMapper
vtkSmartPointer< vtkActor2D >	EdgeLabelActor
vtkSmartPointer < vtkPolyDataMapper >	GraphEdgeMapper
vtkSmartPointer< vtkActor >	GraphEdgeActor
vtkSmartPointer < vtkDataRepresentation >	TreeVisibilityRepresentation
vtkSmartPointer< vtkSelection >	EmptySelection
vtkSmartPointer < vtkKdTreeSelector >	KdTreeSelector
vtkSmartPointer < vtkHardwareSelector >	HardwareSelector
vtkSmartPointer < vtkExtractSelectedGraph >	ExtractSelectedGraph
vtkSmartPointer < vtkGraphHierarchicalBundle >	SelectedGraphHBundle
vtkSmartPointer< vtkSplineFilter >	SelectedGraphSpline
vtkSmartPointer< vtkActor >	SelectedGraphActor
vtkSmartPointer < vtkPolyDataMapper >	SelectedGraphMapper

Member Typedef Documentation

typedef vtkRenderView vtkHierarchicalGraphView::Superclass

Reimplemented from vtkRenderView.

Definition at line 88 of file vtkHierarchicalGraphView.h.

Constructor & Destructor Documentation

vtkHierarchicalGraphView::vtkHierarchicalGraphView ( ) [protected]

vtkHierarchicalGraphView::~vtkHierarchicalGraphView ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkRenderView.

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

Reimplemented from vtkRenderView.

static int vtkHierarchicalGraphView::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkRenderView.

virtual int vtkHierarchicalGraphView::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkRenderView.

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

Reimplemented from vtkRenderView.

void vtkHierarchicalGraphView::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 vtkRenderView.

vtkDataRepresentation* vtkHierarchicalGraphView::SetHierarchyFromInputConnection ( vtkAlgorithmOutput * conn )

Set the tree and graph representations to the appropriate input ports.

vtkDataRepresentation* vtkHierarchicalGraphView::SetHierarchyFromInput ( vtkDataObject * input )

Set the tree and graph representations to the appropriate input ports.

vtkDataRepresentation* vtkHierarchicalGraphView::SetGraphFromInputConnection ( vtkAlgorithmOutput * conn )

Set the tree and graph representations to the appropriate input ports.

vtkDataRepresentation* vtkHierarchicalGraphView::SetGraphFromInput ( vtkDataObject * input )

Set the tree and graph representations to the appropriate input ports.

void vtkHierarchicalGraphView::SetVertexLabelArrayName ( const char * name )

The array to use for vertex labeling. Default is "label".

const char* vtkHierarchicalGraphView::GetVertexLabelArrayName ( )

The array to use for vertex labeling. Default is "label".

void vtkHierarchicalGraphView::SetEdgeLabelArrayName ( const char * name )

The array to use for edge labeling. Default is "label".

const char* vtkHierarchicalGraphView::GetEdgeLabelArrayName ( )

The array to use for edge labeling. Default is "label".

void vtkHierarchicalGraphView::SetVertexLabelVisibility ( bool vis )

Whether to show vertex labels. Default is off.

bool vtkHierarchicalGraphView::GetVertexLabelVisibility ( )

Whether to show vertex labels. Default is off.

void vtkHierarchicalGraphView::VertexLabelVisibilityOn ( )

Whether to show vertex labels. Default is off.

void vtkHierarchicalGraphView::VertexLabelVisibilityOff ( )

Whether to show vertex labels. Default is off.

void vtkHierarchicalGraphView::SetEdgeLabelVisibility ( bool vis )

Whether to show edge labels. Default is off.

bool vtkHierarchicalGraphView::GetEdgeLabelVisibility ( )

Whether to show edge labels. Default is off.

void vtkHierarchicalGraphView::EdgeLabelVisibilityOn ( )

Whether to show edge labels. Default is off.

void vtkHierarchicalGraphView::EdgeLabelVisibilityOff ( )

Whether to show edge labels. Default is off.

void vtkHierarchicalGraphView::SetVertexColorArrayName ( const char * name )

The array to use for coloring vertices. Default is "color".

const char* vtkHierarchicalGraphView::GetVertexColorArrayName ( )

The array to use for coloring vertices. Default is "color".

void vtkHierarchicalGraphView::SetColorVertices ( bool vis )

Whether to color vertices. Default is off.

bool vtkHierarchicalGraphView::GetColorVertices ( )

Whether to color vertices. Default is off.

void vtkHierarchicalGraphView::ColorVerticesOn ( )

Whether to color vertices. Default is off.

void vtkHierarchicalGraphView::ColorVerticesOff ( )

Whether to color vertices. Default is off.

void vtkHierarchicalGraphView::SetEdgeColorArrayName ( const char * name )

The array to use for coloring edges. Default is "color".

const char* vtkHierarchicalGraphView::GetEdgeColorArrayName ( )

The array to use for coloring edges. Default is "color".

void vtkHierarchicalGraphView::SetEdgeColorToSplineFraction ( )

Set the color to be the spline fraction

void vtkHierarchicalGraphView::SetColorEdges ( bool vis )

Whether to color edges. Default is off.

bool vtkHierarchicalGraphView::GetColorEdges ( )

Whether to color edges. Default is off.

void vtkHierarchicalGraphView::ColorEdgesOn ( )

Whether to color edges. Default is off.

void vtkHierarchicalGraphView::ColorEdgesOff ( )

Whether to color edges. Default is off.

void vtkHierarchicalGraphView::SetRadialLayout ( bool radial )

Set whether to use radial layout.

void vtkHierarchicalGraphView::SetRadialAngle ( int angle )

Set the radial layout angle.

void vtkHierarchicalGraphView::SetLogSpacingFactor ( double spacing )

Set the log spacing for the layout.

void vtkHierarchicalGraphView::SetLeafSpacing ( double spacing )

Set the leaf spacing for the layout.

void vtkHierarchicalGraphView::SetBundlingStrength ( double strength )

Set the bundling strength.

virtual vtkDataRepresentation* vtkHierarchicalGraphView::GetTreeVisibilityRepresentation ( ) [virtual]

Retrieve a special representation whose selection link controls what tree nodes are visible. After extracting the selection, the resulting graph must be a tree or an error will result.

virtual vtkDataRepresentation* vtkHierarchicalGraphView::GetGraphRepresentation ( ) [inline, virtual]

Retrieve the graph and tree representations.

Definition at line 181 of file vtkHierarchicalGraphView.h.

virtual vtkDataRepresentation* vtkHierarchicalGraphView::GetTreeRepresentation ( ) [inline, virtual]

Retrieve the graph and tree representations.

Definition at line 183 of file vtkHierarchicalGraphView.h.

void vtkHierarchicalGraphView::SetIconTexture ( vtkTexture * texture )

The icon sheet to use for textures.

void vtkHierarchicalGraphView::AddIconType	(	char *	type,
		int	index
	)

Associate the icon at index "index" in the vtkTexture to all vertices containing "type" as a value in the vertex attribute array specified by IconArrayName.

void vtkHierarchicalGraphView::ClearIconTypes ( )

Clear all icon mappings.

void vtkHierarchicalGraphView::SetIconSize ( int * size )

Each icon's size on the sheet.

void vtkHierarchicalGraphView::SetIconAlignment ( int alignment )

Specify where the icons should be placed in relation to the vertex. See vtkIconGlyphFilter.h for possible values.

void vtkHierarchicalGraphView::SetIconVisibility ( bool b )

Whether icons are visible (default off).

bool vtkHierarchicalGraphView::GetIconVisibility ( )

Whether icons are visible (default off).

virtual void vtkHierarchicalGraphView::IconVisibilityOn ( ) [virtual]

Whether icons are visible (default off).

virtual void vtkHierarchicalGraphView::IconVisibilityOff ( ) [virtual]

Whether icons are visible (default off).

void vtkHierarchicalGraphView::SetIconArrayName ( const char * name )

The array used for assigning icons

const char* vtkHierarchicalGraphView::GetIconArrayName ( )

The array used for assigning icons

void vtkHierarchicalGraphView::SetTreeEdgeVisibility ( bool b )

Whether the TREE edges are visible (default off).

bool vtkHierarchicalGraphView::GetTreeEdgeVisibility ( )

Whether the TREE edges are visible (default off).

void vtkHierarchicalGraphView::TreeEdgeVisibilityOn ( )

Whether the TREE edges are visible (default off).

void vtkHierarchicalGraphView::TreeEdgeVisibilityOff ( )

Whether the TREE edges are visible (default off).

void vtkHierarchicalGraphView::SetScalingArrayName ( const char * name )

The array used for scaling (if ScaledGlyphs is ON)

const char* vtkHierarchicalGraphView::GetScalingArrayName ( )

The array used for scaling (if ScaledGlyphs is ON)

void vtkHierarchicalGraphView::SetScaledGlyphs ( bool arg )

Whether to use scaled glyphs or not. Default is off.

bool vtkHierarchicalGraphView::GetScaledGlyphs ( )

Whether to use scaled glyphs or not. Default is off.

virtual void vtkHierarchicalGraphView::ScaledGlyphsOn ( ) [virtual]

Whether to use scaled glyphs or not. Default is off.

virtual void vtkHierarchicalGraphView::ScaledGlyphsOff ( ) [virtual]

Whether to use scaled glyphs or not. Default is off.

void vtkHierarchicalGraphView::SetLayoutStrategy ( const char * name )

The layout strategy to use when performing the tree layout. The possible strings are: "Tree" - The regular tree layout. "CosmicTree" - A tree layout using orbits (not well tested) Default is "Tree".

void vtkHierarchicalGraphView::SetLayoutStrategyToTree ( ) [inline]

The layout strategy to use when performing the tree layout. The possible strings are: "Tree" - The regular tree layout. "CosmicTree" - A tree layout using orbits (not well tested) Default is "Tree".

Definition at line 245 of file vtkHierarchicalGraphView.h.

void vtkHierarchicalGraphView::SetLayoutStrategyToCosmicTree ( ) [inline]

The layout strategy to use when performing the tree layout. The possible strings are: "Tree" - The regular tree layout. "CosmicTree" - A tree layout using orbits (not well tested) Default is "Tree".

Definition at line 246 of file vtkHierarchicalGraphView.h.

const char* vtkHierarchicalGraphView::GetLayoutStrategyName ( ) [inline]

The layout strategy to use when performing the tree layout. The possible strings are: "Tree" - The regular tree layout. "CosmicTree" - A tree layout using orbits (not well tested) Default is "Tree".

Definition at line 247 of file vtkHierarchicalGraphView.h.

virtual vtkGraphLayoutStrategy* vtkHierarchicalGraphView::GetLayoutStrategy ( ) [virtual]

The layout strategy to use when performing the graph layout. This signature allows an application to create a layout object directly and simply set the pointer through this method

void vtkHierarchicalGraphView::SetLayoutStrategy ( vtkGraphLayoutStrategy * s )

The layout strategy to use when performing the graph layout. This signature allows an application to create a layout object directly and simply set the pointer through this method

virtual void vtkHierarchicalGraphView::SetupRenderWindow ( vtkRenderWindow * win ) [virtual]

Sets up interactor style.

Reimplemented from vtkRenderView.

virtual void vtkHierarchicalGraphView::ApplyViewTheme ( vtkViewTheme * theme ) [virtual]

Apply the theme to this view.

Reimplemented from vtkRenderView.

virtual void vtkHierarchicalGraphView::SetVertexLabelFontSize ( const int size ) [virtual]

The size of the font used for vertex labeling

virtual int vtkHierarchicalGraphView::GetVertexLabelFontSize ( ) [virtual]

The size of the font used for vertex labeling

virtual void vtkHierarchicalGraphView::SetEdgeLabelFontSize ( const int size ) [virtual]

The size of the font used for edge labeling

virtual int vtkHierarchicalGraphView::GetEdgeLabelFontSize ( ) [virtual]

The size of the font used for edge labeling

virtual void vtkHierarchicalGraphView::ProcessEvents	(	vtkObject *	caller,
		unsigned long	eventId,
		void *	callData
	)			`[protected, virtual]`

Called to process the user event from the interactor style.

Reimplemented from vtkRenderView.

virtual void vtkHierarchicalGraphView::AddInputConnection	(	int	port,
		int	item,
		vtkAlgorithmOutput *	conn,
		vtkAlgorithmOutput *	selectConn
	)			`[protected, virtual]`

Connects the algorithm output to the internal pipelines.

virtual void vtkHierarchicalGraphView::RemoveInputConnection	(	int	port,
		int	item,
		vtkAlgorithmOutput *	conn,
		vtkAlgorithmOutput *	selectConn
	)			`[protected, virtual]`