vtkGraphLayoutView Class Reference

Lays out and displays a graph. More...

#include <vtkGraphLayoutView.h>

Inheritance diagram for vtkGraphLayoutView:

Collaboration diagram for vtkGraphLayoutView:

Public Types
typedef vtkRenderView	Superclass
Public Types inherited from vtkRenderView
enum	{ INTERACTION_MODE_2D , INTERACTION_MODE_3D , INTERACTION_MODE_UNKNOWN }
enum	{ SURFACE = 0 , FRUSTUM = 1 }
enum	{ NO_OVERLAP , ALL }
enum	{ FREETYPE , QT }
typedef vtkRenderViewBase	Superclass
Public Types inherited from vtkRenderViewBase
typedef vtkView	Superclass
Public Types inherited from vtkView
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.
vtkGraphLayoutView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	AddIconType (const 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	ClearIconTypes ()
	Clear all icon mappings.
void	SetIconAlignment (int alignment)
	Specify where the icons should be placed in relation to the vertex.
void	ZoomToSelection ()
	Reset the camera based on the bounds of the selected region.
virtual int	IsLayoutComplete ()
	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	UpdateLayout ()
	This method is useful for when the strategy is iterative and the application wants to show the iterative progress of the graph layout.
void	SetVertexLabelArrayName (const char *name)
	The array to use for vertex labeling.
const char *	GetVertexLabelArrayName ()
	The array to use for vertex labeling.
void	SetEdgeLabelArrayName (const char *name)
	The array to use for edge labeling.
const char *	GetEdgeLabelArrayName ()
	The array to use for edge labeling.
void	SetVertexLabelVisibility (bool vis)
	Whether to show vertex labels.
bool	GetVertexLabelVisibility ()
	Whether to show vertex labels.
virtual void	VertexLabelVisibilityOn ()
	Whether to show vertex labels.
virtual void	VertexLabelVisibilityOff ()
	Whether to show vertex labels.
void	SetHideVertexLabelsOnInteraction (bool vis)
	Whether to hide vertex labels during mouse interactions.
bool	GetHideVertexLabelsOnInteraction ()
	Whether to hide vertex labels during mouse interactions.
virtual void	HideVertexLabelsOnInteractionOn ()
	Whether to hide vertex labels during mouse interactions.
virtual void	HideVertexLabelsOnInteractionOff ()
	Whether to hide vertex labels during mouse interactions.
void	SetEdgeVisibility (bool vis)
	Whether to show the edges at all.
bool	GetEdgeVisibility ()
	Whether to show the edges at all.
virtual void	EdgeVisibilityOn ()
	Whether to show the edges at all.
virtual void	EdgeVisibilityOff ()
	Whether to show the edges at all.
void	SetEdgeLabelVisibility (bool vis)
	Whether to show edge labels.
bool	GetEdgeLabelVisibility ()
	Whether to show edge labels.
virtual void	EdgeLabelVisibilityOn ()
	Whether to show edge labels.
virtual void	EdgeLabelVisibilityOff ()
	Whether to show edge labels.
void	SetHideEdgeLabelsOnInteraction (bool vis)
	Whether to hide edge labels during mouse interactions.
bool	GetHideEdgeLabelsOnInteraction ()
	Whether to hide edge labels during mouse interactions.
virtual void	HideEdgeLabelsOnInteractionOn ()
	Whether to hide edge labels during mouse interactions.
virtual void	HideEdgeLabelsOnInteractionOff ()
	Whether to hide edge labels during mouse interactions.
void	SetVertexColorArrayName (const char *name)
	The array to use for coloring vertices.
const char *	GetVertexColorArrayName ()
	The array to use for coloring vertices.
void	SetColorVertices (bool vis)
	Whether to color vertices.
bool	GetColorVertices ()
	Whether to color vertices.
virtual void	ColorVerticesOn ()
	Whether to color vertices.
virtual void	ColorVerticesOff ()
	Whether to color vertices.
void	SetEdgeColorArrayName (const char *name)
	The array to use for coloring edges.
const char *	GetEdgeColorArrayName ()
	The array to use for coloring edges.
void	SetColorEdges (bool vis)
	Whether to color edges.
bool	GetColorEdges ()
	Whether to color edges.
virtual void	ColorEdgesOn ()
	Whether to color edges.
virtual void	ColorEdgesOff ()
	Whether to color edges.
void	SetEdgeSelection (bool vis)
	Whether edges are selectable.
bool	GetEdgeSelection ()
	Whether edges are selectable.
virtual void	EdgeSelectionOn ()
	Whether edges are selectable.
virtual void	EdgeSelectionOff ()
	Whether edges are selectable.
void	SetEnabledEdgesArrayName (const char *name)
	The array to use for coloring edges.
const char *	GetEnabledEdgesArrayName ()
	The array to use for coloring edges.
void	SetEnableEdgesByArray (bool vis)
	Whether to color edges.
int	GetEnableEdgesByArray ()
	Whether to color edges.
void	SetEnabledVerticesArrayName (const char *name)
	The array to use for coloring vertices.
const char *	GetEnabledVerticesArrayName ()
	The array to use for coloring vertices.
void	SetEnableVerticesByArray (bool vis)
	Whether to color vertices.
int	GetEnableVerticesByArray ()
	Whether to color vertices.
void	SetScalingArrayName (const char *name)
	The array used for scaling (if ScaledGlyphs is ON)
const char *	GetScalingArrayName ()
	The array used for scaling (if ScaledGlyphs is ON)
void	SetScaledGlyphs (bool arg)
	Whether to use scaled glyphs or not.
bool	GetScaledGlyphs ()
	Whether to use scaled glyphs or not.
virtual void	ScaledGlyphsOn ()
	Whether to use scaled glyphs or not.
virtual void	ScaledGlyphsOff ()
	Whether to use scaled glyphs or not.
void	SetLayoutStrategy (const char *name)
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToRandom ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToForceDirected ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToSimple2D ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToClustering2D ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToCommunity2D ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToFast2D ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToPassThrough ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToCircular ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToTree ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToCosmicTree ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToCone ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategyToSpanTree ()
	The layout strategy to use when performing the graph layout.
const char *	GetLayoutStrategyName ()
	The layout strategy to use when performing the graph layout.
vtkGraphLayoutStrategy *	GetLayoutStrategy ()
	The layout strategy to use when performing the graph layout.
void	SetLayoutStrategy (vtkGraphLayoutStrategy *s)
	The layout strategy to use when performing the graph layout.
void	SetEdgeLayoutStrategy (const char *name)
	The layout strategy to use when performing the edge layout.
void	SetEdgeLayoutStrategyToArcParallel ()
	The layout strategy to use when performing the edge layout.
void	SetEdgeLayoutStrategyToPassThrough ()
	The layout strategy to use when performing the edge layout.
const char *	GetEdgeLayoutStrategyName ()
	The layout strategy to use when performing the edge layout.
vtkEdgeLayoutStrategy *	GetEdgeLayoutStrategy ()
	The layout strategy to use when performing the edge layout.
void	SetEdgeLayoutStrategy (vtkEdgeLayoutStrategy *s)
	The layout strategy to use when performing the edge layout.
void	SetIconVisibility (bool b)
	Whether icons are visible (default off).
bool	GetIconVisibility ()
	Whether icons are visible (default off).
virtual void	IconVisibilityOn ()
	Whether icons are visible (default off).
virtual void	IconVisibilityOff ()
	Whether icons are visible (default off).
void	SetIconArrayName (const char *name)
	The array used for assigning icons.
const char *	GetIconArrayName ()
	The array used for assigning icons.
void	SetGlyphType (int type)
	The type of glyph to use for the vertices.
int	GetGlyphType ()
	The type of glyph to use for the vertices.
virtual void	SetVertexLabelFontSize (const int size)
	The size of the font used for vertex labeling.
virtual int	GetVertexLabelFontSize ()
	The size of the font used for vertex labeling.
virtual void	SetEdgeLabelFontSize (const int size)
	The size of the font used for edge labeling.
virtual int	GetEdgeLabelFontSize ()
	The size of the font used for edge labeling.
void	SetEdgeScalarBarVisibility (bool vis)
	Whether the scalar bar for edges is visible.
bool	GetEdgeScalarBarVisibility ()
	Whether the scalar bar for edges is visible.
void	SetVertexScalarBarVisibility (bool vis)
	Whether the scalar bar for vertices is visible.
bool	GetVertexScalarBarVisibility ()
	Whether the scalar bar for vertices is visible.
Public Member Functions inherited from vtkRenderView
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkRenderView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetInteractor (vtkRenderWindowInteractor *interactor) override
	The render window interactor.
virtual void	SetInteractorStyle (vtkInteractorObserver *style)
	The interactor style associated with the render view.
virtual vtkInteractorObserver *	GetInteractorStyle ()
	Get the interactor style associated with the render view.
void	SetRenderWindow (vtkRenderWindow *win) override
	Set the render window for this view.
void	SetInteractionMode (int mode)
virtual int	GetInteractionMode ()
virtual void	SetInteractionModeTo2D ()
	Set the interaction mode for the view.
virtual void	SetInteractionModeTo3D ()
void	Render () override
	Updates the representations, then calls Render() on the render window associated with this view.
void	ApplyViewTheme (vtkViewTheme *theme) override
	Applies a view theme to this view.
virtual void	AddLabels (vtkAlgorithmOutput *conn)
	Add labels from an input connection with an associated text property.
virtual void	RemoveLabels (vtkAlgorithmOutput *conn)
	Remove labels from an input connection.
virtual void	SetTransform (vtkAbstractTransform *transform)
	Set the view's transform.
virtual vtkAbstractTransform *	GetTransform ()
	Set the view's transform.
virtual void	SetDisplayHoverText (bool b)
	Whether the view should display hover text.
virtual bool	GetDisplayHoverText ()
	Whether the view should display hover text.
virtual void	DisplayHoverTextOn ()
	Whether the view should display hover text.
virtual void	DisplayHoverTextOff ()
	Whether the view should display hover text.
virtual void	SetSelectionMode (int)
	Sets the selection mode for the render view.
virtual int	GetSelectionMode ()
	Sets the selection mode for the render view.
void	SetSelectionModeToSurface ()
	Sets the selection mode for the render view.
void	SetSelectionModeToFrustum ()
	Sets the selection mode for the render view.
virtual void	SetIconTexture (vtkTexture *texture)
	Set the icon sheet to use for rendering icons.
virtual vtkTexture *	GetIconTexture ()
	Set the icon sheet to use for rendering icons.
virtual void	SetIconSize (int, int)
	Set the size of each icon in the icon texture.
void	SetIconSize (int[2])
	Set the size of each icon in the icon texture.
virtual int *	GetIconSize ()
	Set the size of each icon in the icon texture.
virtual void	GetIconSize (int &, int &)
	Set the size of each icon in the icon texture.
virtual void	GetIconSize (int[2])
	Set the size of each icon in the icon texture.
virtual void	SetDisplaySize (int, int)
	Set the display size of the icon (which may be different from the icon size).
void	SetDisplaySize (int[2])
	Set the display size of the icon (which may be different from the icon size).
int *	GetDisplaySize ()
	Set the display size of the icon (which may be different from the icon size).
void	GetDisplaySize (int &dsx, int &dsy)
	Set the display size of the icon (which may be different from the icon size).
virtual void	SetLabelPlacementMode (int mode)
	Label placement mode.
virtual int	GetLabelPlacementMode ()
	Label placement mode.
virtual void	SetLabelPlacementModeToNoOverlap ()
	Label placement mode.
virtual void	SetLabelPlacementModeToAll ()
	Label placement mode.
virtual void	SetLabelRenderMode (int mode)
	Label render mode.
virtual int	GetLabelRenderMode ()
	Label render mode.
virtual void	SetLabelRenderModeToFreetype ()
	Label render mode.
virtual void	SetLabelRenderModeToQt ()
	Label render mode.
void	SetRenderOnMouseMove (bool b)
	Whether to render on every mouse move.
virtual bool	GetRenderOnMouseMove ()
	Whether to render on every mouse move.
virtual void	RenderOnMouseMoveOn ()
	Whether to render on every mouse move.
virtual void	RenderOnMouseMoveOff ()
	Whether to render on every mouse move.
Public Member Functions inherited from vtkRenderViewBase
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkRenderViewBase *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkRenderer *	GetRenderer ()
	Gets the renderer for this view.
virtual void	SetRenderer (vtkRenderer *ren)
virtual vtkRenderWindow *	GetRenderWindow ()
	Get a handle to the render window.
virtual void	SetRenderWindow (vtkRenderWindow *win)
	Set the render window for this view.
virtual void	Render ()
	Updates the representations, then calls Render() on the render window associated with this view.
virtual void	ResetCamera ()
	Updates the representations, then calls ResetCamera() on the renderer associated with this view.
virtual void	ResetCameraClippingRange ()
	Updates the representations, then calls ResetCameraClippingRange() on the renderer associated with this view.
virtual vtkRenderWindowInteractor *	GetInteractor ()
	The render window interactor.
Public Member Functions inherited from vtkView
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	AddRepresentation (vtkDataRepresentation *rep)
	Adds the representation to the view.
void	SetRepresentation (vtkDataRepresentation *rep)
	Set the representation to the view.
vtkDataRepresentation *	AddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
	Convenience method which creates a simple representation with the connection and adds it to the view.
vtkDataRepresentation *	SetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
	Convenience method which sets the representation with the connection and adds it to the view.
vtkDataRepresentation *	AddRepresentationFromInput (vtkDataObject *input)
	Convenience method which creates a simple representation with the specified input and adds it to the view.
vtkDataRepresentation *	SetRepresentationFromInput (vtkDataObject *input)
	Convenience method which sets the representation to the specified input and adds it to the view.
void	RemoveRepresentation (vtkDataRepresentation *rep)
	Removes the representation from the view.
void	RemoveRepresentation (vtkAlgorithmOutput *rep)
	Removes any representation with this connection from the view.
void	RemoveAllRepresentations ()
	Removes all representations from the view.
int	GetNumberOfRepresentations ()
	Returns the number of representations from first port(0) in this view.
vtkDataRepresentation *	GetRepresentation (int index=0)
	The representation at a specified index.
bool	IsRepresentationPresent (vtkDataRepresentation *rep)
	Check to see if a representation is present in the view.
virtual void	Update ()
	Update the view.
virtual void	ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
	Apply a theme to the view.
vtkCommand *	GetObserver ()
	Returns the observer that the subclasses can use to listen to additional events.
void	RegisterProgress (vtkObject *algorithm, const char *message=nullptr)
	Meant for use by subclasses and vtkRepresentation subclasses.
void	UnRegisterProgress (vtkObject *algorithm)
	Unregister objects previously registered with RegisterProgress.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
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).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkGraphLayoutView *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkGraphLayoutView *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRenderView
static vtkRenderView *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkRenderView *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRenderViewBase
static vtkRenderViewBase *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkRenderViewBase *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkView
static vtkView *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkView *	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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
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).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGraphLayoutView ()
	~vtkGraphLayoutView () override
vtkDataRepresentation *	CreateDefaultRepresentation (vtkAlgorithmOutput *conn) override
	Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
virtual vtkRenderedGraphRepresentation *	GetGraphRepresentation ()
	Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
void	ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData) override
	Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
Protected Member Functions inherited from vtkRenderView
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRenderView ()
	~vtkRenderView () override
void	ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData) override
	Called to process events.
virtual void	GenerateSelection (void *callData, vtkSelection *selection)
	Generates the selection based on the view event and the selection mode.
void	PrepareForRendering () override
	Called by the view when the renderer is about to render.
virtual void	UpdateHoverText ()
	Called in PrepareForRendering to update the hover text.
virtual void	UpdateHoverWidgetState ()
	Enable or disable hovering based on DisplayHoverText ivar and interaction state.
void	UpdatePickRender ()
	Update the pick render for queries for drag selections or hover ballooons.
Protected Member Functions inherited from vtkRenderViewBase
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRenderViewBase ()
	~vtkRenderViewBase () override
virtual void	PrepareForRendering ()
	Called by the view when the renderer is about to render.
Protected Member Functions inherited from vtkView
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkView ()
	Meant for use by subclasses and vtkRepresentation subclasses.
	~vtkView () override
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual void	AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
	Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed.
virtual void	RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual void	SetReuseSingleRepresentation (bool)
	True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls.
virtual bool	GetReuseSingleRepresentation ()
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual void	ReuseSingleRepresentationOn ()
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual void	ReuseSingleRepresentationOff ()
	Meant for use by subclasses and vtkRepresentation subclasses.
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
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 &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkRenderView
int	SelectionMode
int	LabelRenderMode
bool	DisplayHoverText
bool	Interacting
bool	InHoverTextRender
bool	InPickRender
bool	PickRenderNeedsUpdate
vtkAbstractTransform *	Transform
vtkTexture *	IconTexture
int	IconSize [2]
int	DisplaySize [2]
int	InteractionMode
bool	RenderOnMouseMove
vtkSmartPointer< vtkRenderer >	LabelRenderer
vtkSmartPointer< vtkBalloonRepresentation >	Balloon
vtkSmartPointer< vtkLabelPlacementMapper >	LabelPlacementMapper
vtkSmartPointer< vtkTexturedActor2D >	LabelActor
vtkSmartPointer< vtkHoverWidget >	HoverWidget
vtkSmartPointer< vtkHardwareSelector >	Selector
Protected Attributes inherited from vtkRenderViewBase
vtkSmartPointer< vtkRenderer >	Renderer
vtkSmartPointer< vtkRenderWindow >	RenderWindow
Protected Attributes inherited from vtkView
bool	ReuseSingleRepresentation
	Meant for use by subclasses and vtkRepresentation subclasses.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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

.SEE ALSO vtkFast2DLayoutStrategy vtkSimple2DLayoutStrategy vtkForceDirectedLayoutStrategy

Thanks:

Thanks a bunch to the holographic unfolding pattern.

Online Examples:

ColorEdges

ColorVertexLabels

ConstructTree

CreateTree

RandomGraphSource

ScaleVertices

ShortestPath

SideBySideGraphs

VisualizeDirectedGraph

VisualizeGraph

Definition at line 162 of file vtkGraphLayoutView.h.

Member Typedef Documentation

Superclass

typedef vtkRenderView vtkGraphLayoutView::Superclass

Definition at line 166 of file vtkGraphLayoutView.h.

Constructor & Destructor Documentation

vtkGraphLayoutView()

vtkGraphLayoutView::vtkGraphLayoutView ( )

protected

~vtkGraphLayoutView()

vtkGraphLayoutView::~vtkGraphLayoutView ( )

overrideprotected

Member Function Documentation

New()

static vtkGraphLayoutView * vtkGraphLayoutView::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkRenderView.

Reimplemented in vtkHierarchicalGraphView.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkGraphLayoutView::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderView.

Reimplemented in vtkHierarchicalGraphView.

NewInstance()

vtkGraphLayoutView * vtkGraphLayoutView::NewInstance

(

)

const

PrintSelf()

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

Reimplemented in vtkHierarchicalGraphView.

SetVertexLabelArrayName()

void vtkGraphLayoutView::SetVertexLabelArrayName

(

const char *

name

)

The array to use for vertex labeling.

Default is "VertexDegree".

GetVertexLabelArrayName()

const char * vtkGraphLayoutView::GetVertexLabelArrayName

(

)

The array to use for vertex labeling.

Default is "VertexDegree".

SetEdgeLabelArrayName()

void vtkGraphLayoutView::SetEdgeLabelArrayName

(

const char *

name

)

The array to use for edge labeling.

Default is "LabelText".

GetEdgeLabelArrayName()

const char * vtkGraphLayoutView::GetEdgeLabelArrayName

(

)

The array to use for edge labeling.

Default is "LabelText".

SetVertexLabelVisibility()

void vtkGraphLayoutView::SetVertexLabelVisibility

(

bool

vis

)

Whether to show vertex labels.

Default is off.

GetVertexLabelVisibility()

bool vtkGraphLayoutView::GetVertexLabelVisibility

(

)

Whether to show vertex labels.

Default is off.

VertexLabelVisibilityOn()

virtual void vtkGraphLayoutView::VertexLabelVisibilityOn ( )

virtual

Whether to show vertex labels.

Default is off.

VertexLabelVisibilityOff()

virtual void vtkGraphLayoutView::VertexLabelVisibilityOff ( )

virtual

Whether to show vertex labels.

Default is off.

SetHideVertexLabelsOnInteraction()

void vtkGraphLayoutView::SetHideVertexLabelsOnInteraction

(

bool

vis

)

Whether to hide vertex labels during mouse interactions.

Default is off.

GetHideVertexLabelsOnInteraction()

bool vtkGraphLayoutView::GetHideVertexLabelsOnInteraction

(

)

Whether to hide vertex labels during mouse interactions.

Default is off.

HideVertexLabelsOnInteractionOn()

virtual void vtkGraphLayoutView::HideVertexLabelsOnInteractionOn ( )

virtual

Whether to hide vertex labels during mouse interactions.

Default is off.

HideVertexLabelsOnInteractionOff()

virtual void vtkGraphLayoutView::HideVertexLabelsOnInteractionOff ( )

virtual

Whether to hide vertex labels during mouse interactions.

Default is off.

SetEdgeVisibility()

void vtkGraphLayoutView::SetEdgeVisibility

(

bool

vis

)

Whether to show the edges at all.

Default is on

GetEdgeVisibility()

bool vtkGraphLayoutView::GetEdgeVisibility

(

)

Whether to show the edges at all.

Default is on

EdgeVisibilityOn()

virtual void vtkGraphLayoutView::EdgeVisibilityOn ( )

virtual

Whether to show the edges at all.

Default is on

EdgeVisibilityOff()

virtual void vtkGraphLayoutView::EdgeVisibilityOff ( )

virtual

Whether to show the edges at all.

Default is on

SetEdgeLabelVisibility()

void vtkGraphLayoutView::SetEdgeLabelVisibility

(

bool

vis

)

Whether to show edge labels.

Default is off.

GetEdgeLabelVisibility()

bool vtkGraphLayoutView::GetEdgeLabelVisibility

(

)

Whether to show edge labels.

Default is off.

EdgeLabelVisibilityOn()

virtual void vtkGraphLayoutView::EdgeLabelVisibilityOn ( )

virtual

Whether to show edge labels.

Default is off.

EdgeLabelVisibilityOff()

virtual void vtkGraphLayoutView::EdgeLabelVisibilityOff ( )

virtual

Whether to show edge labels.

Default is off.

SetHideEdgeLabelsOnInteraction()

void vtkGraphLayoutView::SetHideEdgeLabelsOnInteraction

(

bool

vis

)

Whether to hide edge labels during mouse interactions.

Default is off.

GetHideEdgeLabelsOnInteraction()

bool vtkGraphLayoutView::GetHideEdgeLabelsOnInteraction

(

)

Whether to hide edge labels during mouse interactions.

Default is off.

HideEdgeLabelsOnInteractionOn()

virtual void vtkGraphLayoutView::HideEdgeLabelsOnInteractionOn ( )

virtual

Whether to hide edge labels during mouse interactions.

Default is off.

HideEdgeLabelsOnInteractionOff()

virtual void vtkGraphLayoutView::HideEdgeLabelsOnInteractionOff ( )

virtual

Whether to hide edge labels during mouse interactions.

Default is off.

SetVertexColorArrayName()

void vtkGraphLayoutView::SetVertexColorArrayName

(

const char *

name

)

The array to use for coloring vertices.

The default behavior is to color by vertex degree.

GetVertexColorArrayName()

const char * vtkGraphLayoutView::GetVertexColorArrayName

(

)

The array to use for coloring vertices.

The default behavior is to color by vertex degree.

SetColorVertices()

void vtkGraphLayoutView::SetColorVertices

(

bool

vis

)

Whether to color vertices.

Default is off.

GetColorVertices()

bool vtkGraphLayoutView::GetColorVertices

(

)

Whether to color vertices.

Default is off.

ColorVerticesOn()

virtual void vtkGraphLayoutView::ColorVerticesOn ( )

virtual

Whether to color vertices.

Default is off.

ColorVerticesOff()

virtual void vtkGraphLayoutView::ColorVerticesOff ( )

virtual

Whether to color vertices.

Default is off.

SetEdgeColorArrayName()

void vtkGraphLayoutView::SetEdgeColorArrayName

(

const char *

name

)

The array to use for coloring edges.

Default is "color".

GetEdgeColorArrayName()

const char * vtkGraphLayoutView::GetEdgeColorArrayName

(

)

The array to use for coloring edges.

Default is "color".

SetColorEdges()

void vtkGraphLayoutView::SetColorEdges

(

bool

vis

)

Whether to color edges.

Default is off.

GetColorEdges()

bool vtkGraphLayoutView::GetColorEdges

(

)

Whether to color edges.

Default is off.

ColorEdgesOn()

virtual void vtkGraphLayoutView::ColorEdgesOn ( )

virtual

Whether to color edges.

Default is off.

ColorEdgesOff()

virtual void vtkGraphLayoutView::ColorEdgesOff ( )

virtual

Whether to color edges.

Default is off.

SetEdgeSelection()

void vtkGraphLayoutView::SetEdgeSelection

(

bool

vis

)

Whether edges are selectable.

Default is on.

GetEdgeSelection()

bool vtkGraphLayoutView::GetEdgeSelection

(

)

Whether edges are selectable.

Default is on.

EdgeSelectionOn()

virtual void vtkGraphLayoutView::EdgeSelectionOn ( )

virtual

Whether edges are selectable.

Default is on.

EdgeSelectionOff()

virtual void vtkGraphLayoutView::EdgeSelectionOff ( )

virtual

Whether edges are selectable.

Default is on.

SetEnabledEdgesArrayName()

void vtkGraphLayoutView::SetEnabledEdgesArrayName

(

const char *

name

)

The array to use for coloring edges.

GetEnabledEdgesArrayName()

const char * vtkGraphLayoutView::GetEnabledEdgesArrayName

(

)

The array to use for coloring edges.

SetEnableEdgesByArray()

void vtkGraphLayoutView::SetEnableEdgesByArray

(

bool

vis

)

Whether to color edges.

Default is off.

GetEnableEdgesByArray()

int vtkGraphLayoutView::GetEnableEdgesByArray

(

)

Whether to color edges.

Default is off.

SetEnabledVerticesArrayName()

void vtkGraphLayoutView::SetEnabledVerticesArrayName

(

const char *

name

)

The array to use for coloring vertices.

GetEnabledVerticesArrayName()

const char * vtkGraphLayoutView::GetEnabledVerticesArrayName

(

)

The array to use for coloring vertices.

SetEnableVerticesByArray()

void vtkGraphLayoutView::SetEnableVerticesByArray

(

bool

vis

)

Whether to color vertices.

Default is off.

GetEnableVerticesByArray()

int vtkGraphLayoutView::GetEnableVerticesByArray

(

)

Whether to color vertices.

Default is off.

SetScalingArrayName()

void vtkGraphLayoutView::SetScalingArrayName

(

const char *

name

)

The array used for scaling (if ScaledGlyphs is ON)

GetScalingArrayName()

const char * vtkGraphLayoutView::GetScalingArrayName

(

)

The array used for scaling (if ScaledGlyphs is ON)

SetScaledGlyphs()

void vtkGraphLayoutView::SetScaledGlyphs

(

bool

arg

)

Whether to use scaled glyphs or not.

Default is off.

GetScaledGlyphs()

bool vtkGraphLayoutView::GetScaledGlyphs

(

)

Whether to use scaled glyphs or not.

Default is off.

ScaledGlyphsOn()

virtual void vtkGraphLayoutView::ScaledGlyphsOn ( )

virtual

Whether to use scaled glyphs or not.

Default is off.

ScaledGlyphsOff()

virtual void vtkGraphLayoutView::ScaledGlyphsOff ( )

virtual

Whether to use scaled glyphs or not.

Default is off.

SetLayoutStrategy() [1/2]

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

SetLayoutStrategyToRandom()

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 343 of file vtkGraphLayoutView.h.

SetLayoutStrategyToForceDirected()

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 344 of file vtkGraphLayoutView.h.

SetLayoutStrategyToSimple2D()

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 345 of file vtkGraphLayoutView.h.

SetLayoutStrategyToClustering2D()

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 346 of file vtkGraphLayoutView.h.

SetLayoutStrategyToCommunity2D()

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 347 of file vtkGraphLayoutView.h.

SetLayoutStrategyToFast2D()

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 348 of file vtkGraphLayoutView.h.

SetLayoutStrategyToPassThrough()

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 349 of file vtkGraphLayoutView.h.

SetLayoutStrategyToCircular()

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 350 of file vtkGraphLayoutView.h.

SetLayoutStrategyToTree()

void vtkGraphLayoutView::SetLayoutStrategyToTree ( )

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 351 of file vtkGraphLayoutView.h.

SetLayoutStrategyToCosmicTree()

void vtkGraphLayoutView::SetLayoutStrategyToCosmicTree ( )

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 352 of file vtkGraphLayoutView.h.

SetLayoutStrategyToCone()

void vtkGraphLayoutView::SetLayoutStrategyToCone ( )

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 353 of file vtkGraphLayoutView.h.

SetLayoutStrategyToSpanTree()

void vtkGraphLayoutView::SetLayoutStrategyToSpanTree ( )

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

Definition at line 354 of file vtkGraphLayoutView.h.

GetLayoutStrategyName()

const char * vtkGraphLayoutView::GetLayoutStrategyName

(

)

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.
• "Community 2D" A linear-time 2D layout that's just like Fast 2D but looks for and uses a community array to 'accentuate' clusters.
• "Fast 2D" A linear-time 2D layout.
• "Pass Through" Use locations assigned to the input.
• "Circular" Places vertices uniformly on a circle.
• "Cone" Cone tree layout.
• "Span Tree" Span Tree Layout. Default is "Simple 2D".

GetLayoutStrategy()

vtkGraphLayoutStrategy * vtkGraphLayoutView::GetLayoutStrategy

(

)

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.

SetLayoutStrategy() [2/2]

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.

SetEdgeLayoutStrategy() [1/2]

void vtkGraphLayoutView::SetEdgeLayoutStrategy

(

const char *

name

)

The layout strategy to use when performing the edge layout.

The possible strings are: "Arc Parallel" - Arc parallel edges and self loops. "Pass Through" - Use edge routes assigned to the input. Default is "Arc Parallel".

SetEdgeLayoutStrategyToArcParallel()

void vtkGraphLayoutView::SetEdgeLayoutStrategyToArcParallel ( )

inline

The layout strategy to use when performing the edge layout.

The possible strings are: "Arc Parallel" - Arc parallel edges and self loops. "Pass Through" - Use edge routes assigned to the input. Default is "Arc Parallel".

Definition at line 377 of file vtkGraphLayoutView.h.

SetEdgeLayoutStrategyToPassThrough()

void vtkGraphLayoutView::SetEdgeLayoutStrategyToPassThrough ( )

inline

The layout strategy to use when performing the edge layout.

The possible strings are: "Arc Parallel" - Arc parallel edges and self loops. "Pass Through" - Use edge routes assigned to the input. Default is "Arc Parallel".

Definition at line 378 of file vtkGraphLayoutView.h.

GetEdgeLayoutStrategyName()

const char * vtkGraphLayoutView::GetEdgeLayoutStrategyName

(

)

The layout strategy to use when performing the edge layout.

The possible strings are: "Arc Parallel" - Arc parallel edges and self loops. "Pass Through" - Use edge routes assigned to the input. Default is "Arc Parallel".

GetEdgeLayoutStrategy()

vtkEdgeLayoutStrategy * vtkGraphLayoutView::GetEdgeLayoutStrategy

(

)

The layout strategy to use when performing the edge layout.

This signature allows an application to create a layout object directly and simply set the pointer through this method.

SetEdgeLayoutStrategy() [2/2]

void vtkGraphLayoutView::SetEdgeLayoutStrategy

(

vtkEdgeLayoutStrategy *

s

)

The layout strategy to use when performing the edge layout.

This signature allows an application to create a layout object directly and simply set the pointer through this method.

AddIconType()

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

ClearIconTypes()

void vtkGraphLayoutView::ClearIconTypes

(

)

Clear all icon mappings.

SetIconAlignment()

void vtkGraphLayoutView::SetIconAlignment

(

int

alignment

)

Specify where the icons should be placed in relation to the vertex.

See vtkIconGlyphFilter.h for possible values.

SetIconVisibility()

void vtkGraphLayoutView::SetIconVisibility

(

bool

b

)

Whether icons are visible (default off).

GetIconVisibility()

bool vtkGraphLayoutView::GetIconVisibility

(

)

Whether icons are visible (default off).

IconVisibilityOn()

virtual void vtkGraphLayoutView::IconVisibilityOn ( )

virtual

Whether icons are visible (default off).

IconVisibilityOff()

virtual void vtkGraphLayoutView::IconVisibilityOff ( )

virtual

Whether icons are visible (default off).

SetIconArrayName()

void vtkGraphLayoutView::SetIconArrayName

(

const char *

name

)

The array used for assigning icons.

GetIconArrayName()

const char * vtkGraphLayoutView::GetIconArrayName

(

)

The array used for assigning icons.

SetGlyphType()

void vtkGraphLayoutView::SetGlyphType

(

int

type

)

The type of glyph to use for the vertices.

GetGlyphType()

int vtkGraphLayoutView::GetGlyphType

(

)

The type of glyph to use for the vertices.

SetVertexLabelFontSize()

virtual void vtkGraphLayoutView::SetVertexLabelFontSize ( const int  size )

virtual

The size of the font used for vertex labeling.

GetVertexLabelFontSize()

virtual int vtkGraphLayoutView::GetVertexLabelFontSize ( )

virtual

The size of the font used for vertex labeling.

SetEdgeLabelFontSize()

virtual void vtkGraphLayoutView::SetEdgeLabelFontSize ( const int  size )

virtual

The size of the font used for edge labeling.

GetEdgeLabelFontSize()

virtual int vtkGraphLayoutView::GetEdgeLabelFontSize ( )

virtual

The size of the font used for edge labeling.

SetEdgeScalarBarVisibility()

void vtkGraphLayoutView::SetEdgeScalarBarVisibility

(

bool

vis

)

Whether the scalar bar for edges is visible.

Default is off.

GetEdgeScalarBarVisibility()

bool vtkGraphLayoutView::GetEdgeScalarBarVisibility

(

)

Whether the scalar bar for edges is visible.

Default is off.

SetVertexScalarBarVisibility()

void vtkGraphLayoutView::SetVertexScalarBarVisibility

(

bool

vis

)

Whether the scalar bar for vertices is visible.

Default is off.

GetVertexScalarBarVisibility()

bool vtkGraphLayoutView::GetVertexScalarBarVisibility

(

)

Whether the scalar bar for vertices is visible.

Default is off.

ZoomToSelection()

void vtkGraphLayoutView::ZoomToSelection

(

)

Reset the camera based on the bounds of the selected region.

IsLayoutComplete()

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

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

CreateDefaultRepresentation()

vtkDataRepresentation * vtkGraphLayoutView::CreateDefaultRepresentation ( vtkAlgorithmOutput *  conn )

overrideprotectedvirtual

Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.

Reimplemented from vtkView.

Reimplemented in vtkHierarchicalGraphView.

GetGraphRepresentation()

virtual vtkRenderedGraphRepresentation * vtkGraphLayoutView::GetGraphRepresentation ( )

protectedvirtual

Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.

Reimplemented in vtkHierarchicalGraphView.

ProcessEvents()

void vtkGraphLayoutView::ProcessEvents ( vtkObject *  caller, unsigned long  eventId, void *  callData  )

overrideprotectedvirtual

Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.

Reimplemented from vtkView.

---

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

• Views/Infovis/vtkGraphLayoutView.h