dox/Views/vtkHierarchicalGraphView.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkHierarchicalGraphView.h,v $
  
-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/

#ifndef __vtkHierarchicalGraphView_h
#define __vtkHierarchicalGraphView_h

#include "vtkSmartPointer.h"    // Required for smart pointer internal ivars.
#include "vtkRenderView.h"

class vtkActor;
class vtkActor2D;
class vtkAlgorithmOutput;
class vtkCircularLayoutStrategy;
class vtkCoordinate;
class vtkCosmicTreeLayoutStrategy;
class vtkTreeLayoutStrategy;
class vtkDynamic2DLabelMapper;
class vtkEdgeCenters;
class vtkExtractSelectedGraph;
class vtkGlyph3D;
class vtkGraph;
class vtkGraphHierarchicalBundle;
class vtkGraphLayout;
class vtkGraphLayoutStrategy;
class vtkGraphMapper;
class vtkGraphToPolyData;
class vtkGraphToTree;
class vtkKdTreeSelector;
class vtkLookupTable;
class vtkPassThroughLayoutStrategy;
class vtkPolyDataMapper;
class vtkSelection;
class vtkSelectionLink;
class vtkSplineFilter;
class vtkTexture;
class vtkTree;
class vtkTreeFieldAggregator;
class vtkVertexDegree;
class vtkVertexGlyphFilter;
class vtkViewTheme;
class vtkHardwareSelector;


class VTK_VIEWS_EXPORT vtkHierarchicalGraphView : public vtkRenderView
{
public:
  static vtkHierarchicalGraphView *New();
  vtkTypeRevisionMacro(vtkHierarchicalGraphView, vtkRenderView);
  void PrintSelf(ostream& os, vtkIndent indent);
  

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

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

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

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

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

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

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

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

  void SetColorEdges(bool vis);
  bool GetColorEdges();
  void ColorEdgesOn();
  void ColorEdgesOff();
  
  void SetRadialLayout(bool radial);
  
  void SetRadialAngle(int angle);
  
  void SetLogSpacingFactor(double spacing);
  
  void SetLeafSpacing(double spacing);
  
  void SetBundlingStrength(double strength);
   
  virtual vtkDataRepresentation* GetTreeVisibilityRepresentation();


  virtual vtkDataRepresentation* GetGraphRepresentation()
    { return this->GetRepresentation(1, 0); }
  virtual vtkDataRepresentation* GetTreeRepresentation()
    { return this->GetRepresentation(0, 0); }

  void SetIconTexture(vtkTexture *texture);

  void AddIconType(char *type, int index);

  void ClearIconTypes();

  void SetIconSize(int *size);

  void SetIconAlignment(int alignment);


  void SetIconVisibility(bool b);
  bool GetIconVisibility();
  vtkBooleanMacro(IconVisibility, bool);


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

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

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

  void SetScaledGlyphs(bool arg);
  bool GetScaledGlyphs();
  vtkBooleanMacro(ScaledGlyphs, bool);
  

  void SetLayoutStrategy(const char* name);
  void SetLayoutStrategyToTree()          { this->SetLayoutStrategy("Tree"); }
  void SetLayoutStrategyToCosmicTree()    { this->SetLayoutStrategy("CosmicTree"); }
  const char* GetLayoutStrategyName()     { return this->GetLayoutStrategyNameInternal(); }


  vtkGetObjectMacro(LayoutStrategy,vtkGraphLayoutStrategy);
  void SetLayoutStrategy(vtkGraphLayoutStrategy *s);
  
  virtual void SetupRenderWindow(vtkRenderWindow* win);
  
  virtual void ApplyViewTheme(vtkViewTheme* theme);
  

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

  virtual void SetEdgeLabelFontSize(const int size);
  virtual int GetEdgeLabelFontSize();

protected:
  vtkHierarchicalGraphView();
  ~vtkHierarchicalGraphView();


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

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


  virtual void RemoveInputConnection( int port, int item,
    vtkAlgorithmOutput* conn, vtkAlgorithmOutput* selectConn);
  
  virtual void PrepareForRendering();

  void MapToXYPlane(double displayX, double displayY, double &x, double &y);
  

  vtkGetStringMacro(LayoutStrategyNameInternal);
  vtkSetStringMacro(LayoutStrategyNameInternal);
  char* LayoutStrategyNameInternal;
  
  vtkGraphLayoutStrategy* LayoutStrategy;
  

  vtkGetStringMacro(IconArrayNameInternal);
  vtkSetStringMacro(IconArrayNameInternal);
  char* IconArrayNameInternal;
  //BTX
  
  // Processing objects
  vtkSmartPointer<vtkCoordinate>                   Coordinate;
  vtkSmartPointer<vtkGraphLayout>                  GraphLayout;
  vtkSmartPointer<vtkCircularLayoutStrategy>       CircularStrategy;
  vtkSmartPointer<vtkTreeLayoutStrategy>           TreeStrategy;
  vtkSmartPointer<vtkCosmicTreeLayoutStrategy>     CosmicTreeStrategy;
  vtkSmartPointer<vtkPassThroughLayoutStrategy>    PassThroughStrategy;
  vtkSmartPointer<vtkGraphHierarchicalBundle>      HBundle;
  vtkSmartPointer<vtkSplineFilter>                 Spline;
  vtkSmartPointer<vtkVertexDegree>                 VertexDegree;
  vtkSmartPointer<vtkEdgeCenters>                  EdgeCenters;
  vtkSmartPointer<vtkTreeFieldAggregator>          TreeAggregation;
  vtkSmartPointer<vtkExtractSelectedGraph>         ExtractSelectedTree;
  vtkSmartPointer<vtkGraphMapper>                  SelectedTreeMapper;
  vtkSmartPointer<vtkActor>                        SelectedTreeActor;
  
  // Representation objects
  vtkSmartPointer<vtkActor>                        TreeActor;
  vtkSmartPointer<vtkGraphMapper>                  TreeMapper;
  vtkSmartPointer<vtkDynamic2DLabelMapper>         VertexLabelMapper;
  vtkSmartPointer<vtkActor2D>                      VertexLabelActor;
  vtkSmartPointer<vtkDynamic2DLabelMapper>         EdgeLabelMapper;
  vtkSmartPointer<vtkActor2D>                      EdgeLabelActor;
  vtkSmartPointer<vtkPolyDataMapper>               GraphEdgeMapper;
  vtkSmartPointer<vtkActor>                        GraphEdgeActor;
  vtkSmartPointer<vtkDataRepresentation>           TreeVisibilityRepresentation;
  
  // Selection objects
  vtkSmartPointer<vtkSelection>                    EmptySelection;
  vtkSmartPointer<vtkKdTreeSelector>               KdTreeSelector;
  vtkSmartPointer<vtkHardwareSelector>             HardwareSelector;
  vtkSmartPointer<vtkExtractSelectedGraph>         ExtractSelectedGraph;
  vtkSmartPointer<vtkGraphHierarchicalBundle>      SelectedGraphHBundle;
  vtkSmartPointer<vtkSplineFilter>                 SelectedGraphSpline;
  vtkSmartPointer<vtkActor>                        SelectedGraphActor;
  vtkSmartPointer<vtkPolyDataMapper>               SelectedGraphMapper;
  //ETX

private:

  bool Radial;
  
  int Angle;
  
  float LogSpacing;
  
  float LeafSpacing;
  
  float BundlingStrength;


  int GraphRepresentationIndex;
  int TreeRepresentationIndex;
  
  vtkHierarchicalGraphView(const vtkHierarchicalGraphView&);  // Not implemented.
  void operator=(const vtkHierarchicalGraphView&);  // Not implemented.
};

#endif

---