VTK  9.4.20241202
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkHierarchicalGraphView Class Reference

Accepts a graph and a hierarchy - currently a tree - and provides a hierarchy-aware display. More...

#include <vtkHierarchicalGraphView.h>

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

Public Types

typedef vtkGraphLayoutView Superclass
 
- Public Types inherited from vtkGraphLayoutView
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.
 
vtkHierarchicalGraphViewNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetGraphEdgeColorToSplineFraction ()
 Set the color to be the spline fraction.
 
vtkDataRepresentationSetHierarchyFromInputConnection (vtkAlgorithmOutput *conn)
 Set the tree and graph representations to the appropriate input ports.
 
vtkDataRepresentationSetHierarchyFromInput (vtkDataObject *input)
 Set the tree and graph representations to the appropriate input ports.
 
vtkDataRepresentationSetGraphFromInputConnection (vtkAlgorithmOutput *conn)
 Set the tree and graph representations to the appropriate input ports.
 
vtkDataRepresentationSetGraphFromInput (vtkDataObject *input)
 Set the tree and graph representations to the appropriate input ports.
 
virtual void SetGraphEdgeLabelArrayName (const char *name)
 The array to use for edge labeling.
 
virtual const char * GetGraphEdgeLabelArrayName ()
 The array to use for edge labeling.
 
virtual void SetGraphEdgeLabelVisibility (bool vis)
 Whether to show edge labels.
 
virtual bool GetGraphEdgeLabelVisibility ()
 Whether to show edge labels.
 
virtual void GraphEdgeLabelVisibilityOn ()
 Whether to show edge labels.
 
virtual void GraphEdgeLabelVisibilityOff ()
 Whether to show edge labels.
 
virtual void SetGraphEdgeColorArrayName (const char *name)
 The array to use for coloring edges.
 
virtual const char * GetGraphEdgeColorArrayName ()
 The array to use for coloring edges.
 
virtual void SetColorGraphEdgesByArray (bool vis)
 Whether to color edges.
 
virtual bool GetColorGraphEdgesByArray ()
 Whether to color edges.
 
virtual void ColorGraphEdgesByArrayOn ()
 Whether to color edges.
 
virtual void ColorGraphEdgesByArrayOff ()
 Whether to color edges.
 
virtual void SetBundlingStrength (double strength)
 Set the bundling strength.
 
virtual double GetBundlingStrength ()
 Set the bundling strength.
 
virtual void SetGraphVisibility (bool vis)
 Whether the graph edges are visible (default off).
 
virtual bool GetGraphVisibility ()
 Whether the graph edges are visible (default off).
 
virtual void GraphVisibilityOn ()
 Whether the graph edges are visible (default off).
 
virtual void GraphVisibilityOff ()
 Whether the graph edges are visible (default off).
 
virtual void SetGraphEdgeLabelFontSize (int size)
 The size of the font used for edge labeling.
 
virtual int GetGraphEdgeLabelFontSize ()
 The size of the font used for edge labeling.
 
- Public Member Functions inherited from vtkGraphLayoutView
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkGraphLayoutViewNewInstance () 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.
 
vtkGraphLayoutStrategyGetLayoutStrategy ()
 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.
 
vtkEdgeLayoutStrategyGetEdgeLayoutStrategy ()
 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 (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 (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.
 
vtkRenderViewNewInstance () 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 vtkInteractorObserverGetInteractorStyle ()
 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 vtkAbstractTransformGetTransform ()
 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 vtkTextureGetIconTexture ()
 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.
 
vtkRenderViewBaseNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual vtkRendererGetRenderer ()
 Gets the renderer for this view.
 
virtual void SetRenderer (vtkRenderer *ren)
 
virtual vtkRenderWindowGetRenderWindow ()
 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 vtkRenderWindowInteractorGetInteractor ()
 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.
 
vtkViewNewInstance () 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.
 
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 Convenience method which creates a simple representation with the connection and adds it to the view.
 
vtkDataRepresentationSetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 Convenience method which sets the representation with the connection and adds it to the view.
 
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
 Convenience method which creates a simple representation with the specified input and adds it to the view.
 
vtkDataRepresentationSetRepresentationFromInput (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.
 
vtkDataRepresentationGetRepresentation (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.
 
vtkCommandGetObserver ()
 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
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.
 
vtkCommandGetCommand (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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
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.
 
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.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkHierarchicalGraphViewNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHierarchicalGraphViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGraphLayoutView
static vtkGraphLayoutViewNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGraphLayoutViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderView
static vtkRenderViewNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderViewBase
static vtkRenderViewBaseNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderViewBaseSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkView
static vtkViewNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 (vtkTypeBool 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 vtkTypeBool 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkHierarchicalGraphView ()
 
 ~vtkHierarchicalGraphView () override
 
vtkDataRepresentationCreateDefaultRepresentation (vtkAlgorithmOutput *conn) override
 Overrides behavior in vtkGraphLayoutView to create a vtkRenderedHierarchyRepresentation by default.
 
vtkRenderedGraphRepresentationGetGraphRepresentation () override
 Overrides behavior in vtkGraphLayoutView to create a vtkRenderedHierarchyRepresentation by default.
 
virtual vtkRenderedHierarchyRepresentationGetHierarchyRepresentation ()
 Overrides behavior in vtkGraphLayoutView to create a vtkRenderedHierarchyRepresentation by default.
 
- Protected Member Functions inherited from vtkGraphLayoutView
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGraphLayoutView ()
 
 ~vtkGraphLayoutView () override
 
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 vtkObjectBaseNewInstanceInternal () 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 vtkObjectBaseNewInstanceInternal () 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 vtkObjectBaseNewInstanceInternal () const
 
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 *)
 
virtual void ObjectFinalize ()
 
 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
 
vtkAbstractTransformTransform
 
vtkTextureIconTexture
 
int IconSize [2]
 
int DisplaySize [2]
 
int InteractionMode
 
bool RenderOnMouseMove
 
vtkSmartPointer< vtkRendererLabelRenderer
 
vtkSmartPointer< vtkBalloonRepresentationBalloon
 
vtkSmartPointer< vtkLabelPlacementMapperLabelPlacementMapper
 
vtkSmartPointer< vtkTexturedActor2DLabelActor
 
vtkSmartPointer< vtkHoverWidgetHoverWidget
 
vtkSmartPointer< vtkHardwareSelectorSelector
 
- Protected Attributes inherited from vtkRenderViewBase
vtkSmartPointer< vtkRendererRenderer
 
vtkSmartPointer< vtkRenderWindowRenderWindow
 
- 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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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.
Tests:
vtkHierarchicalGraphView (Tests)

Definition at line 36 of file vtkHierarchicalGraphView.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkHierarchicalGraphView.h.

Constructor & Destructor Documentation

◆ vtkHierarchicalGraphView()

vtkHierarchicalGraphView::vtkHierarchicalGraphView ( )
protected

◆ ~vtkHierarchicalGraphView()

vtkHierarchicalGraphView::~vtkHierarchicalGraphView ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkHierarchicalGraphView * vtkHierarchicalGraphView::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkHierarchicalGraphView::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGraphLayoutView.

◆ NewInstance()

vtkHierarchicalGraphView * vtkHierarchicalGraphView::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetHierarchyFromInputConnection()

vtkDataRepresentation * vtkHierarchicalGraphView::SetHierarchyFromInputConnection ( vtkAlgorithmOutput conn)

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

◆ SetHierarchyFromInput()

vtkDataRepresentation * vtkHierarchicalGraphView::SetHierarchyFromInput ( vtkDataObject input)

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

◆ SetGraphFromInputConnection()

vtkDataRepresentation * vtkHierarchicalGraphView::SetGraphFromInputConnection ( vtkAlgorithmOutput conn)

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

◆ SetGraphFromInput()

vtkDataRepresentation * vtkHierarchicalGraphView::SetGraphFromInput ( vtkDataObject input)

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

◆ SetGraphEdgeLabelArrayName()

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

The array to use for edge labeling.

Default is "label".

◆ GetGraphEdgeLabelArrayName()

virtual const char * vtkHierarchicalGraphView::GetGraphEdgeLabelArrayName ( )
virtual

The array to use for edge labeling.

Default is "label".

◆ SetGraphEdgeLabelVisibility()

virtual void vtkHierarchicalGraphView::SetGraphEdgeLabelVisibility ( bool  vis)
virtual

Whether to show edge labels.

Default is off.

◆ GetGraphEdgeLabelVisibility()

virtual bool vtkHierarchicalGraphView::GetGraphEdgeLabelVisibility ( )
virtual

Whether to show edge labels.

Default is off.

◆ GraphEdgeLabelVisibilityOn()

virtual void vtkHierarchicalGraphView::GraphEdgeLabelVisibilityOn ( )
virtual

Whether to show edge labels.

Default is off.

◆ GraphEdgeLabelVisibilityOff()

virtual void vtkHierarchicalGraphView::GraphEdgeLabelVisibilityOff ( )
virtual

Whether to show edge labels.

Default is off.

◆ SetGraphEdgeColorArrayName()

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

The array to use for coloring edges.

Default is "color".

◆ GetGraphEdgeColorArrayName()

virtual const char * vtkHierarchicalGraphView::GetGraphEdgeColorArrayName ( )
virtual

The array to use for coloring edges.

Default is "color".

◆ SetGraphEdgeColorToSplineFraction()

virtual void vtkHierarchicalGraphView::SetGraphEdgeColorToSplineFraction ( )
virtual

Set the color to be the spline fraction.

◆ SetColorGraphEdgesByArray()

virtual void vtkHierarchicalGraphView::SetColorGraphEdgesByArray ( bool  vis)
virtual

Whether to color edges.

Default is off.

◆ GetColorGraphEdgesByArray()

virtual bool vtkHierarchicalGraphView::GetColorGraphEdgesByArray ( )
virtual

Whether to color edges.

Default is off.

◆ ColorGraphEdgesByArrayOn()

virtual void vtkHierarchicalGraphView::ColorGraphEdgesByArrayOn ( )
virtual

Whether to color edges.

Default is off.

◆ ColorGraphEdgesByArrayOff()

virtual void vtkHierarchicalGraphView::ColorGraphEdgesByArrayOff ( )
virtual

Whether to color edges.

Default is off.

◆ SetBundlingStrength()

virtual void vtkHierarchicalGraphView::SetBundlingStrength ( double  strength)
virtual

Set the bundling strength.

◆ GetBundlingStrength()

virtual double vtkHierarchicalGraphView::GetBundlingStrength ( )
virtual

Set the bundling strength.

◆ SetGraphVisibility()

virtual void vtkHierarchicalGraphView::SetGraphVisibility ( bool  vis)
virtual

Whether the graph edges are visible (default off).

◆ GetGraphVisibility()

virtual bool vtkHierarchicalGraphView::GetGraphVisibility ( )
virtual

Whether the graph edges are visible (default off).

◆ GraphVisibilityOn()

virtual void vtkHierarchicalGraphView::GraphVisibilityOn ( )
virtual

Whether the graph edges are visible (default off).

◆ GraphVisibilityOff()

virtual void vtkHierarchicalGraphView::GraphVisibilityOff ( )
virtual

Whether the graph edges are visible (default off).

◆ SetGraphEdgeLabelFontSize()

virtual void vtkHierarchicalGraphView::SetGraphEdgeLabelFontSize ( int  size)
virtual

The size of the font used for edge labeling.

◆ GetGraphEdgeLabelFontSize()

virtual int vtkHierarchicalGraphView::GetGraphEdgeLabelFontSize ( )
virtual

The size of the font used for edge labeling.

◆ CreateDefaultRepresentation()

vtkDataRepresentation * vtkHierarchicalGraphView::CreateDefaultRepresentation ( vtkAlgorithmOutput conn)
overrideprotectedvirtual

Overrides behavior in vtkGraphLayoutView to create a vtkRenderedHierarchyRepresentation by default.

Reimplemented from vtkGraphLayoutView.

◆ GetGraphRepresentation()

vtkRenderedGraphRepresentation * vtkHierarchicalGraphView::GetGraphRepresentation ( )
overrideprotectedvirtual

Overrides behavior in vtkGraphLayoutView to create a vtkRenderedHierarchyRepresentation by default.

Reimplemented from vtkGraphLayoutView.

◆ GetHierarchyRepresentation()

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: