VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkHierarchicalGraphView Class Reference

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

#include <vtkHierarchicalGraphView.h>

Inheritance diagram for vtkHierarchicalGraphView:
[legend]
Collaboration diagram for vtkHierarchicalGraphView:
[legend]

List of all members.

Public Types

typedef vtkGraphLayoutView Superclass
- Public Types inherited from vtkGraphLayoutView
- 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 }
- Public Types inherited from vtkRenderViewBase
- Public Types inherited from vtkView
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetGraphEdgeColorToSplineFraction ()
vtkDataRepresentationSetHierarchyFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationSetHierarchyFromInput (vtkDataObject *input)
vtkDataRepresentationSetGraphFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationSetGraphFromInput (vtkDataObject *input)
virtual void SetGraphEdgeLabelArrayName (const char *name)
virtual const char * GetGraphEdgeLabelArrayName ()
virtual void SetGraphEdgeLabelVisibility (bool vis)
virtual bool GetGraphEdgeLabelVisibility ()
virtual void GraphEdgeLabelVisibilityOn ()
virtual void GraphEdgeLabelVisibilityOff ()
virtual void SetGraphEdgeColorArrayName (const char *name)
virtual const char * GetGraphEdgeColorArrayName ()
virtual void SetColorGraphEdgesByArray (bool vis)
virtual bool GetColorGraphEdgesByArray ()
virtual void ColorGraphEdgesByArrayOn ()
virtual void ColorGraphEdgesByArrayOff ()
virtual void SetBundlingStrength (double strength)
virtual double GetBundlingStrength ()
virtual void SetGraphVisibility (bool b)
virtual bool GetGraphVisibility ()
virtual void GraphVisibilityOn ()
virtual void GraphVisibilityOff ()
virtual void SetGraphEdgeLabelFontSize (const int size)
virtual int GetGraphEdgeLabelFontSize ()
- Public Member Functions inherited from vtkGraphLayoutView
void AddIconType (char *type, int index)
void ClearIconTypes ()
void SetIconAlignment (int alignment)
void ZoomToSelection ()
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 ()
virtual void VertexLabelVisibilityOn ()
virtual void VertexLabelVisibilityOff ()
void SetHideVertexLabelsOnInteraction (bool vis)
bool GetHideVertexLabelsOnInteraction ()
virtual void HideVertexLabelsOnInteractionOn ()
virtual void HideVertexLabelsOnInteractionOff ()
void SetEdgeVisibility (bool vis)
bool GetEdgeVisibility ()
virtual void EdgeVisibilityOn ()
virtual void EdgeVisibilityOff ()
void SetEdgeLabelVisibility (bool vis)
bool GetEdgeLabelVisibility ()
virtual void EdgeLabelVisibilityOn ()
virtual void EdgeLabelVisibilityOff ()
void SetHideEdgeLabelsOnInteraction (bool vis)
bool GetHideEdgeLabelsOnInteraction ()
virtual void HideEdgeLabelsOnInteractionOn ()
virtual void HideEdgeLabelsOnInteractionOff ()
void SetVertexColorArrayName (const char *name)
const char * GetVertexColorArrayName ()
void SetColorVertices (bool vis)
bool GetColorVertices ()
virtual void ColorVerticesOn ()
virtual void ColorVerticesOff ()
void SetEdgeColorArrayName (const char *name)
const char * GetEdgeColorArrayName ()
void SetColorEdges (bool vis)
bool GetColorEdges ()
virtual void ColorEdgesOn ()
virtual void ColorEdgesOff ()
void SetEdgeSelection (bool vis)
bool GetEdgeSelection ()
virtual void EdgeSelectionOn ()
virtual void EdgeSelectionOff ()
void SetEnabledEdgesArrayName (const char *name)
const char * GetEnabledEdgesArrayName ()
void SetEnableEdgesByArray (bool vis)
int GetEnableEdgesByArray ()
void SetEnabledVerticesArrayName (const char *name)
const char * GetEnabledVerticesArrayName ()
void SetEnableVerticesByArray (bool vis)
int GetEnableVerticesByArray ()
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 ()
void SetLayoutStrategyToTree ()
void SetLayoutStrategyToCosmicTree ()
void SetLayoutStrategyToCone ()
void SetLayoutStrategyToSpanTree ()
const char * GetLayoutStrategyName ()
vtkGraphLayoutStrategyGetLayoutStrategy ()
void SetLayoutStrategy (vtkGraphLayoutStrategy *s)
void SetEdgeLayoutStrategy (const char *name)
void SetEdgeLayoutStrategyToArcParallel ()
void SetEdgeLayoutStrategyToPassThrough ()
const char * GetEdgeLayoutStrategyName ()
vtkEdgeLayoutStrategyGetEdgeLayoutStrategy ()
void SetEdgeLayoutStrategy (vtkEdgeLayoutStrategy *s)
void SetIconVisibility (bool b)
bool GetIconVisibility ()
virtual void IconVisibilityOn ()
virtual void IconVisibilityOff ()
void SetIconArrayName (const char *name)
const char * GetIconArrayName ()
void SetGlyphType (int type)
int GetGlyphType ()
virtual void SetVertexLabelFontSize (const int size)
virtual int GetVertexLabelFontSize ()
virtual void SetEdgeLabelFontSize (const int size)
virtual int GetEdgeLabelFontSize ()
void SetEdgeScalarBarVisibility (bool vis)
bool GetEdgeScalarBarVisibility ()
void SetVertexScalarBarVisibility (bool vis)
bool GetVertexScalarBarVisibility ()
- Public Member Functions inherited from vtkRenderView
virtual void SetInteractor (vtkRenderWindowInteractor *interactor)
virtual void SetInteractorStyle (vtkInteractorObserver *style)
virtual vtkInteractorObserverGetInteractorStyle ()
virtual void SetRenderWindow (vtkRenderWindow *win)
void SetInteractionMode (int mode)
virtual int GetInteractionMode ()
virtual void Render ()
virtual void ApplyViewTheme (vtkViewTheme *theme)
virtual void AddLabels (vtkAlgorithmOutput *conn)
virtual void RemoveLabels (vtkAlgorithmOutput *conn)
virtual void SetInteractionModeTo2D ()
virtual void SetInteractionModeTo3D ()
virtual void SetTransform (vtkAbstractTransform *transform)
virtual vtkAbstractTransformGetTransform ()
virtual void SetDisplayHoverText (bool b)
virtual bool GetDisplayHoverText ()
virtual void DisplayHoverTextOn ()
virtual void DisplayHoverTextOff ()
virtual void SetSelectionMode (int)
virtual int GetSelectionMode ()
void SetSelectionModeToSurface ()
void SetSelectionModeToFrustum ()
virtual void SetIconTexture (vtkTexture *texture)
virtual vtkTextureGetIconTexture ()
virtual void SetIconSize (int, int)
void SetIconSize (int[2])
virtual int * GetIconSize ()
virtual void GetIconSize (int &, int &)
virtual void GetIconSize (int[2])
virtual void SetDisplaySize (int, int)
void SetDisplaySize (int[2])
int * GetDisplaySize ()
void GetDisplaySize (int &dsx, int &dsy)
virtual void SetLabelPlacementMode (int mode)
virtual int GetLabelPlacementMode ()
virtual void SetLabelPlacementModeToNoOverlap ()
virtual void SetLabelPlacementModeToAll ()
virtual void SetLabelRenderMode (int mode)
virtual int GetLabelRenderMode ()
virtual void SetLabelRenderModeToFreetype ()
virtual void SetLabelRenderModeToQt ()
void SetRenderOnMouseMove (bool b)
virtual bool GetRenderOnMouseMove ()
virtual void RenderOnMouseMoveOn ()
virtual void RenderOnMouseMoveOff ()
- Public Member Functions inherited from vtkRenderViewBase
virtual vtkRendererGetRenderer ()
virtual void SetRenderer (vtkRenderer *ren)
virtual vtkRenderWindowGetRenderWindow ()
virtual void ResetCamera ()
virtual void ResetCameraClippingRange ()
virtual vtkRenderWindowInteractorGetInteractor ()
- Public Member Functions inherited from vtkView
void AddRepresentation (vtkDataRepresentation *rep)
void SetRepresentation (vtkDataRepresentation *rep)
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationSetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
vtkDataRepresentationSetRepresentationFromInput (vtkDataObject *input)
void RemoveRepresentation (vtkDataRepresentation *rep)
void RemoveRepresentation (vtkAlgorithmOutput *rep)
void RemoveAllRepresentations ()
int GetNumberOfRepresentations ()
vtkDataRepresentationGetRepresentation (int index=0)
bool IsRepresentationPresent (vtkDataRepresentation *rep)
virtual void Update ()
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
vtkCommandGetObserver ()
void RegisterProgress (vtkObject *algorithm, const char *message=NULL)
void UnRegisterProgress (vtkObject *algorithm)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkHierarchicalGraphViewNew ()
static int IsTypeOf (const char *type)
static vtkHierarchicalGraphViewSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkHierarchicalGraphView ()
 ~vtkHierarchicalGraphView ()
virtual vtkDataRepresentationCreateDefaultRepresentation (vtkAlgorithmOutput *conn)
virtual
vtkRenderedGraphRepresentation
GetGraphRepresentation ()
virtual
vtkRenderedHierarchyRepresentation
GetHierarchyRepresentation ()
- Protected Member Functions inherited from vtkGraphLayoutView
 vtkGraphLayoutView ()
 ~vtkGraphLayoutView ()
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
- Protected Member Functions inherited from vtkRenderView
virtual void PrepareForRendering ()
virtual void UpdateHoverText ()
virtual void UpdateHoverWidgetState ()
void UpdatePickRender ()
virtual void GenerateSelection (void *callData, vtkSelection *selection)
 vtkRenderView ()
 ~vtkRenderView ()
- Protected Member Functions inherited from vtkRenderViewBase
 vtkRenderViewBase ()
 ~vtkRenderViewBase ()
- Protected Member Functions inherited from vtkView
 vtkView ()
 ~vtkView ()
virtual void AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void SetReuseSingleRepresentation (bool)
virtual bool GetReuseSingleRepresentation ()
virtual void ReuseSingleRepresentationOn ()
virtual void ReuseSingleRepresentationOff ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

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.

.SEE ALSO vtkGraphLayoutView

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

Definition at line 53 of file vtkHierarchicalGraphView.h.


Member Typedef Documentation

Reimplemented from vtkGraphLayoutView.

Definition at line 57 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 vtkGraphLayoutView.

virtual const char* vtkHierarchicalGraphView::GetClassName ( )
virtual

Reimplemented from vtkGraphLayoutView.

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

Reimplemented from vtkGraphLayoutView.

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

Reimplemented from vtkGraphLayoutView.

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

Reimplemented from vtkGraphLayoutView.

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

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.

virtual void vtkHierarchicalGraphView::SetGraphEdgeLabelArrayName ( const char *  name)
virtual

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

virtual const char* vtkHierarchicalGraphView::GetGraphEdgeLabelArrayName ( )
virtual

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

virtual void vtkHierarchicalGraphView::SetGraphEdgeLabelVisibility ( bool  vis)
virtual

Whether to show edge labels. Default is off.

virtual bool vtkHierarchicalGraphView::GetGraphEdgeLabelVisibility ( )
virtual

Whether to show edge labels. Default is off.

virtual void vtkHierarchicalGraphView::GraphEdgeLabelVisibilityOn ( )
virtual

Whether to show edge labels. Default is off.

virtual void vtkHierarchicalGraphView::GraphEdgeLabelVisibilityOff ( )
virtual

Whether to show edge labels. Default is off.

virtual void vtkHierarchicalGraphView::SetGraphEdgeColorArrayName ( const char *  name)
virtual

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

virtual const char* vtkHierarchicalGraphView::GetGraphEdgeColorArrayName ( )
virtual

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

virtual void vtkHierarchicalGraphView::SetGraphEdgeColorToSplineFraction ( )
virtual

Set the color to be the spline fraction

virtual void vtkHierarchicalGraphView::SetColorGraphEdgesByArray ( bool  vis)
virtual

Whether to color edges. Default is off.

virtual bool vtkHierarchicalGraphView::GetColorGraphEdgesByArray ( )
virtual

Whether to color edges. Default is off.

virtual void vtkHierarchicalGraphView::ColorGraphEdgesByArrayOn ( )
virtual

Whether to color edges. Default is off.

virtual void vtkHierarchicalGraphView::ColorGraphEdgesByArrayOff ( )
virtual

Whether to color edges. Default is off.

virtual void vtkHierarchicalGraphView::SetBundlingStrength ( double  strength)
virtual

Set the bundling strength.

virtual double vtkHierarchicalGraphView::GetBundlingStrength ( )
virtual

Set the bundling strength.

virtual void vtkHierarchicalGraphView::SetGraphVisibility ( bool  b)
virtual

Whether the graph edges are visible (default off).

virtual bool vtkHierarchicalGraphView::GetGraphVisibility ( )
virtual

Whether the graph edges are visible (default off).

virtual void vtkHierarchicalGraphView::GraphVisibilityOn ( )
virtual

Whether the graph edges are visible (default off).

virtual void vtkHierarchicalGraphView::GraphVisibilityOff ( )
virtual

Whether the graph edges are visible (default off).

virtual void vtkHierarchicalGraphView::SetGraphEdgeLabelFontSize ( const int  size)
virtual

The size of the font used for edge labeling

virtual int vtkHierarchicalGraphView::GetGraphEdgeLabelFontSize ( )
virtual

The size of the font used for edge labeling

virtual vtkDataRepresentation* vtkHierarchicalGraphView::CreateDefaultRepresentation ( vtkAlgorithmOutput conn)
protectedvirtual

Overrides behavior in vtkGraphLayoutView to create a vtkRenderedHierarchyRepresentation by default.

Reimplemented from vtkGraphLayoutView.

virtual vtkRenderedGraphRepresentation* vtkHierarchicalGraphView::GetGraphRepresentation ( )
protectedvirtual

Overrides behavior in vtkGraphLayoutView to create a vtkRenderedHierarchyRepresentation by default.

Reimplemented from vtkGraphLayoutView.

virtual vtkRenderedHierarchyRepresentation* vtkHierarchicalGraphView::GetHierarchyRepresentation ( )
protectedvirtual

Overrides behavior in vtkGraphLayoutView to create a vtkRenderedHierarchyRepresentation by default.


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