vtkGraphLayoutView Class Reference

#include <vtkGraphLayoutView.h>

Inheritance diagram for vtkGraphLayoutView:

[legend]

Collaboration diagram for vtkGraphLayoutView:

[legend]

List of all members.

Detailed Description

Lays out and displays a graph.

vtkGraphLayoutView performs graph layout and displays a vtkGraph. You may color and label the vertices and edges using fields in the graph. If coordinates are already assigned to the graph vertices in your graph, set the layout strategy to PassThrough in this view. The default layout is Fast2D which is fast but not that good, for better layout set the layout to Simple2D or ForceDirected. There are also tree and circle layout strategies. :)

Thanks:: Thanks a bunch to the holographic unfolding pattern.

Examples:: vtkGraphLayoutView (Examples)

Tests:: vtkGraphLayoutView (Tests)

Definition at line 84 of file vtkGraphLayoutView.h.


char *	LayoutStrategyNameInternal
virtual char *	GetLayoutStrategyNameInternal ()
virtual void	SetLayoutStrategyNameInternal (const char *)
char *	SelectionArrayNameInternal
virtual char *	GetSelectionArrayNameInternal ()
virtual void	SetSelectionArrayNameInternal (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	SetIterationsPerLayout (int iterations)
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)
virtual int	IsLayoutComplete ()
virtual void	UpdateLayout ()

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

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	SetLayoutStrategyToRandom ()
void	SetLayoutStrategyToForceDirected ()
void	SetLayoutStrategyToSimple2D ()
void	SetLayoutStrategyToClustering2D ()
void	SetLayoutStrategyToCommunity2D ()
void	SetLayoutStrategyToFast2D ()
void	SetLayoutStrategyToPassThrough ()
void	SetLayoutStrategyToCircular ()
const char *	GetLayoutStrategyName ()

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

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

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

void	SetSelectionArrayName (const char *name)
const char *	GetSelectionArrayName ()

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

virtual void	SetEdgeLabelFontSize (const int size)
virtual int	GetEdgeLabelFontSize ()
Static Public Member Functions
static vtkGraphLayoutView *	New ()
static int	IsTypeOf (const char *type)
static vtkGraphLayoutView *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkGraphLayoutView ()
	~vtkGraphLayoutView ()
virtual void	AddInputConnection (vtkAlgorithmOutput *conn)
virtual void	RemoveInputConnection (vtkAlgorithmOutput *conn)
virtual void	SetSelectionLink (vtkSelectionLink *link)
virtual void	PrepareForRendering ()
void	MapToXYPlane (double displayX, double displayY, double &x, double &y)

virtual void	ProcessEvents (vtkObject caller, unsigned long eventId, void callData)
Protected Attributes
vtkGraphLayoutStrategy *	LayoutStrategy
vtkSmartPointer< vtkCoordinate >	Coordinate
vtkSmartPointer< vtkGraphLayout >	GraphLayout
vtkSmartPointer < vtkRandomLayoutStrategy >	RandomStrategy
vtkSmartPointer < vtkForceDirectedLayoutStrategy >	ForceDirectedStrategy
vtkSmartPointer < vtkSimple2DLayoutStrategy >	Simple2DStrategy
vtkSmartPointer < vtkClustering2DLayoutStrategy >	Clustering2DStrategy
vtkSmartPointer < vtkCommunity2DLayoutStrategy >	Community2DStrategy
vtkSmartPointer < vtkConstrained2DLayoutStrategy >	Constrained2DStrategy
vtkSmartPointer < vtkFast2DLayoutStrategy >	Fast2DStrategy
vtkSmartPointer < vtkPassThroughLayoutStrategy >	PassThroughStrategy
vtkSmartPointer < vtkCircularLayoutStrategy >	CircularStrategy
vtkSmartPointer< vtkVertexDegree >	VertexDegree
vtkSmartPointer< vtkEdgeCenters >	EdgeCenters
vtkSmartPointer< vtkActor >	GraphActor
vtkSmartPointer< vtkGraphMapper >	GraphMapper
vtkSmartPointer < vtkDynamic2DLabelMapper >	VertexLabelMapper
vtkSmartPointer< vtkActor2D >	VertexLabelActor
vtkSmartPointer < vtkDynamic2DLabelMapper >	EdgeLabelMapper
vtkSmartPointer< vtkActor2D >	EdgeLabelActor
vtkSmartPointer < vtkKdTreeSelector >	KdTreeSelector
vtkSmartPointer < vtkVisibleCellSelector >	VisibleCellSelector
vtkSmartPointer < vtkExtractSelectedGraph >	ExtractSelectedGraph
vtkSmartPointer< vtkActor >	SelectedGraphActor
vtkSmartPointer< vtkGraphMapper >	SelectedGraphMapper

Member Typedef Documentation

typedef vtkRenderView vtkGraphLayoutView::Superclass

Reimplemented from vtkRenderView.

Definition at line 88 of file vtkGraphLayoutView.h.

Constructor & Destructor Documentation

vtkGraphLayoutView::vtkGraphLayoutView ( ) [protected]

vtkGraphLayoutView::~vtkGraphLayoutView ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkRenderView.

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

Reimplemented from vtkRenderView.

static int vtkGraphLayoutView::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 vtkGraphLayoutView::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 vtkGraphLayoutView* vtkGraphLayoutView::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkRenderView.

void vtkGraphLayoutView::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.

void vtkGraphLayoutView::SetVertexLabelArrayName ( const char * name )

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

const char* vtkGraphLayoutView::GetVertexLabelArrayName ( )

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

void vtkGraphLayoutView::SetEdgeLabelArrayName ( const char * name )

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

const char* vtkGraphLayoutView::GetEdgeLabelArrayName ( )

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

void vtkGraphLayoutView::SetVertexLabelVisibility ( bool vis )

Whether to show vertex labels. Default is off.

bool vtkGraphLayoutView::GetVertexLabelVisibility ( )

Whether to show vertex labels. Default is off.

void vtkGraphLayoutView::VertexLabelVisibilityOn ( )

Whether to show vertex labels. Default is off.

void vtkGraphLayoutView::VertexLabelVisibilityOff ( )

Whether to show vertex labels. Default is off.

void vtkGraphLayoutView::SetEdgeLabelVisibility ( bool vis )

Whether to show edge labels. Default is off.

bool vtkGraphLayoutView::GetEdgeLabelVisibility ( )

Whether to show edge labels. Default is off.

void vtkGraphLayoutView::EdgeLabelVisibilityOn ( )

Whether to show edge labels. Default is off.

void vtkGraphLayoutView::EdgeLabelVisibilityOff ( )

Whether to show edge labels. Default is off.

void vtkGraphLayoutView::SetVertexColorArrayName ( const char * name )

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

const char* vtkGraphLayoutView::GetVertexColorArrayName ( )

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

void vtkGraphLayoutView::SetColorVertices ( bool vis )

Whether to color vertices. Default is off.

bool vtkGraphLayoutView::GetColorVertices ( )

Whether to color vertices. Default is off.

void vtkGraphLayoutView::ColorVerticesOn ( )

Whether to color vertices. Default is off.

void vtkGraphLayoutView::ColorVerticesOff ( )

Whether to color vertices. Default is off.

void vtkGraphLayoutView::SetEdgeColorArrayName ( const char * name )

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

const char* vtkGraphLayoutView::GetEdgeColorArrayName ( )

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

void vtkGraphLayoutView::SetColorEdges ( bool vis )

Whether to color edges. Default is off.

bool vtkGraphLayoutView::GetColorEdges ( )

Whether to color edges. Default is off.

void vtkGraphLayoutView::ColorEdgesOn ( )

Whether to color edges. Default is off.

void vtkGraphLayoutView::ColorEdgesOff ( )

Whether to color edges. Default is off.

void vtkGraphLayoutView::SetScalingArrayName ( const char * name )

The array used for scaling (if ScaledGlyphs is ON)

const char* vtkGraphLayoutView::GetScalingArrayName ( )

The array used for scaling (if ScaledGlyphs is ON)

void vtkGraphLayoutView::SetScaledGlyphs ( bool arg )

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

bool vtkGraphLayoutView::GetScaledGlyphs ( )

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

virtual void vtkGraphLayoutView::ScaledGlyphsOn ( ) [virtual]

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

virtual void vtkGraphLayoutView::ScaledGlyphsOff ( ) [virtual]

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

void vtkGraphLayoutView::SetLayoutStrategy ( const char * name )

The layout strategy to use when performing the graph layout. The possible strings are: "Random" - Randomly places vertices in a box. "Force Directed" - A layout in 3D or 2D simulating forces on edges. "Simple 2D" - A simple 2D force directed layout. "Clustering 2D" - A 2D force directed layout that's just like - simple 2D but uses some techniques to cluster better. "Fast 2D"

A linear-time 2D layout. "Pass Through" - Use locations assigned to the input. "Circular" - Places vertices uniformly on a circle. Default is "Simple 2D".

void vtkGraphLayoutView::SetLayoutStrategyToRandom ( ) [inline]

The layout strategy to use when performing the graph layout. The possible strings are: "Random" - Randomly places vertices in a box. "Force Directed" - A layout in 3D or 2D simulating forces on edges. "Simple 2D" - A simple 2D force directed layout. "Clustering 2D" - A 2D force directed layout that's just like - simple 2D but uses some techniques to cluster better. "Fast 2D"

A linear-time 2D layout. "Pass Through" - Use locations assigned to the input. "Circular" - Places vertices uniformly on a circle. Default is "Simple 2D".

Definition at line 171 of file vtkGraphLayoutView.h.

void vtkGraphLayoutView::SetLayoutStrategyToForceDirected ( ) [inline]

The layout strategy to use when performing the graph layout. The possible strings are: "Random" - Randomly places vertices in a box. "Force Directed" - A layout in 3D or 2D simulating forces on edges. "Simple 2D" - A simple 2D force directed layout. "Clustering 2D" - A 2D force directed layout that's just like - simple 2D but uses some techniques to cluster better. "Fast 2D"

A linear-time 2D layout. "Pass Through" - Use locations assigned to the input. "Circular" - Places vertices uniformly on a circle. Default is "Simple 2D".

Definition at line 172 of file vtkGraphLayoutView.h.

void vtkGraphLayoutView::SetLayoutStrategyToSimple2D ( ) [inline]

The layout strategy to use when performing the graph layout. The possible strings are: "Random" - Randomly places vertices in a box. "Force Directed" - A layout in 3D or 2D simulating forces on edges. "Simple 2D" - A simple 2D force directed layout. "Clustering 2D" - A 2D force directed layout that's just like - simple 2D but uses some techniques to cluster better. "Fast 2D"

A linear-time 2D layout. "Pass Through" - Use locations assigned to the input. "Circular" - Places vertices uniformly on a circle. Default is "Simple 2D".

Definition at line 173 of file vtkGraphLayoutView.h.

void vtkGraphLayoutView::SetLayoutStrategyToClustering2D ( ) [inline]

The layout strategy to use when performing the graph layout. The possible strings are: "Random" - Randomly places vertices in a box. "Force Directed" - A layout in 3D or 2D simulating forces on edges. "Simple 2D" - A simple 2D force directed layout. "Clustering 2D" - A 2D force directed layout that's just like - simple 2D but uses some techniques to cluster better. "Fast 2D"

A linear-time 2D layout. "Pass Through" - Use locations assigned to the input. "Circular" - Places vertices uniformly on a circle. Default is "Simple 2D".

Definition at line 174 of file vtkGraphLayoutView.h.

void vtkGraphLayoutView::SetLayoutStrategyToCommunity2D ( ) [inline]

The layout strategy to use when performing the graph layout. The possible strings are: "Random" - Randomly places vertices in a box. "Force Directed" - A layout in 3D or 2D simulating forces on edges. "Simple 2D" - A simple 2D force directed layout. "Clustering 2D" - A 2D force directed layout that's just like - simple 2D but uses some techniques to cluster better. "Fast 2D"

A linear-time 2D layout. "Pass Through" - Use locations assigned to the input. "Circular" - Places vertices uniformly on a circle. Default is "Simple 2D".

Definition at line 175 of file vtkGraphLayoutView.h.

void vtkGraphLayoutView::SetLayoutStrategyToFast2D ( ) [inline]

The layout strategy to use when performing the graph layout. The possible strings are: "Random" - Randomly places vertices in a box. "Force Directed" - A layout in 3D or 2D simulating forces on edges. "Simple 2D" - A simple 2D force directed layout. "Clustering 2D" - A 2D force directed layout that's just like - simple 2D but uses some techniques to cluster better. "Fast 2D"

A linear-time 2D layout. "Pass Through" - Use locations assigned to the input. "Circular" - Places vertices uniformly on a circle. Default is "Simple 2D".

Definition at line 176 of file vtkGraphLayoutView.h.

void vtkGraphLayoutView::SetLayoutStrategyToPassThrough ( ) [inline]

The layout strategy to use when performing the graph layout. The possible strings are: "Random" - Randomly places vertices in a box. "Force Directed" - A layout in 3D or 2D simulating forces on edges. "Simple 2D" - A simple 2D force directed layout. "Clustering 2D" - A 2D force directed layout that's just like - simple 2D but uses some techniques to cluster better. "Fast 2D"

A linear-time 2D layout. "Pass Through" - Use locations assigned to the input. "Circular" - Places vertices uniformly on a circle. Default is "Simple 2D".

Definition at line 177 of file vtkGraphLayoutView.h.

void vtkGraphLayoutView::SetLayoutStrategyToCircular ( ) [inline]

The layout strategy to use when performing the graph layout. The possible strings are: "Random" - Randomly places vertices in a box. "Force Directed" - A layout in 3D or 2D simulating forces on edges. "Simple 2D" - A simple 2D force directed layout. "Clustering 2D" - A 2D force directed layout that's just like - simple 2D but uses some techniques to cluster better. "Fast 2D"

A linear-time 2D layout. "Pass Through" - Use locations assigned to the input. "Circular" - Places vertices uniformly on a circle. Default is "Simple 2D".

Definition at line 178 of file vtkGraphLayoutView.h.

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

The layout strategy to use when performing the graph layout. The possible strings are: "Random" - Randomly places vertices in a box. "Force Directed" - A layout in 3D or 2D simulating forces on edges. "Simple 2D" - A simple 2D force directed layout. "Clustering 2D" - A 2D force directed layout that's just like - simple 2D but uses some techniques to cluster better. "Fast 2D"

A linear-time 2D layout. "Pass Through" - Use locations assigned to the input. "Circular" - Places vertices uniformly on a circle. Default is "Simple 2D".

Definition at line 179 of file vtkGraphLayoutView.h.

virtual vtkGraphLayoutStrategy* vtkGraphLayoutView::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 vtkGraphLayoutView::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

void vtkGraphLayoutView::SetIterationsPerLayout ( int iterations )

Set the number of iterations per refresh (defaults to all) In other words, the default is to do the entire layout and then do a visual refresh. Changing this variable to something like '1', will enable an application to see the layout as it progresses.

void vtkGraphLayoutView::SetIconTexture ( vtkTexture * texture )

The icon sheet to use for textures.

void vtkGraphLayoutView::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 vtkGraphLayoutView::ClearIconTypes ( )

Clear all icon mappings.

void vtkGraphLayoutView::SetIconSize ( int * size )

Each icon's size on the sheet.

void vtkGraphLayoutView::SetIconAlignment ( int alignment )

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

void vtkGraphLayoutView::SetIconVisibility ( bool b )

Whether icons are visible (default off).

bool vtkGraphLayoutView::GetIconVisibility ( )

Whether icons are visible (default off).

virtual void vtkGraphLayoutView::IconVisibilityOn ( ) [virtual]

Whether icons are visible (default off).

virtual void vtkGraphLayoutView::IconVisibilityOff ( ) [virtual]

Whether icons are visible (default off).

void vtkGraphLayoutView::SetIconArrayName ( const char * name )

The array used for assigning icons

const char* vtkGraphLayoutView::GetIconArrayName ( )

The array used for assigning icons

void vtkGraphLayoutView::SetSelectionArrayName ( const char * name )

The array used for populating the selection list

const char* vtkGraphLayoutView::GetSelectionArrayName ( )

The array used for populating the selection list

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

Sets up interactor style.

Reimplemented from vtkRenderView.

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

Apply the theme to this view.

Reimplemented from vtkRenderView.

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

The size of the font used for vertex labeling

virtual int vtkGraphLayoutView::GetVertexLabelFontSize ( ) [virtual]

The size of the font used for vertex labeling

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

The size of the font used for edge labeling

virtual int vtkGraphLayoutView::GetEdgeLabelFontSize ( ) [virtual]

The size of the font used for edge labeling

virtual int vtkGraphLayoutView::IsLayoutComplete ( ) [virtual]

Is the graph layout complete? This method is useful for when the strategy is iterative and the application wants to show the iterative progress of the graph layout See Also: UpdateLayout();

virtual void vtkGraphLayoutView::UpdateLayout ( ) [virtual]

This method is useful for when the strategy is iterative and the application wants to show the iterative progress of the graph layout. The application would have something like while(!IsLayoutComplete()) { UpdateLayout(); } See Also: IsLayoutComplete();