vtkGraphLayoutView.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
#ifndef vtkGraphLayoutView_h
#define vtkGraphLayoutView_h
 
#include "vtkRenderView.h"
#include "vtkViewsInfovisModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkEdgeLayoutStrategy;
class vtkGraphLayoutStrategy;
class vtkRenderedGraphRepresentation;
class vtkViewTheme;
 
class VTKVIEWSINFOVIS_EXPORT vtkGraphLayoutView : public vtkRenderView
{
public:
  static vtkGraphLayoutView* New();
  vtkTypeMacro(vtkGraphLayoutView, vtkRenderView);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void SetVertexLabelArrayName(const char* name);
  const char* GetVertexLabelArrayName();
 
 
  void SetEdgeLabelArrayName(const char* name);
  const char* GetEdgeLabelArrayName();
 
 
  void SetVertexLabelVisibility(bool vis);
  bool GetVertexLabelVisibility();
  vtkBooleanMacro(VertexLabelVisibility, bool);
 
 
  void SetHideVertexLabelsOnInteraction(bool vis);
  bool GetHideVertexLabelsOnInteraction();
  vtkBooleanMacro(HideVertexLabelsOnInteraction, bool);
 
 
  void SetEdgeVisibility(bool vis);
  bool GetEdgeVisibility();
  vtkBooleanMacro(EdgeVisibility, bool);
 
 
  void SetEdgeLabelVisibility(bool vis);
  bool GetEdgeLabelVisibility();
  vtkBooleanMacro(EdgeLabelVisibility, bool);
 
 
  void SetHideEdgeLabelsOnInteraction(bool vis);
  bool GetHideEdgeLabelsOnInteraction();
  vtkBooleanMacro(HideEdgeLabelsOnInteraction, bool);
 
 
  void SetVertexColorArrayName(const char* name);
  const char* GetVertexColorArrayName();
 
 
  void SetColorVertices(bool vis);
  bool GetColorVertices();
  vtkBooleanMacro(ColorVertices, bool);
 
 
  void SetEdgeColorArrayName(const char* name);
  const char* GetEdgeColorArrayName();
 
 
  void SetColorEdges(bool vis);
  bool GetColorEdges();
  vtkBooleanMacro(ColorEdges, bool);
 
 
  void SetEdgeSelection(bool vis);
  bool GetEdgeSelection();
  vtkBooleanMacro(EdgeSelection, bool);
 
 
  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();
  vtkBooleanMacro(ScaledGlyphs, bool);
 
 
  void SetLayoutStrategy(const char* name);
  void SetLayoutStrategyToRandom() { this->SetLayoutStrategy("Random"); }
  void SetLayoutStrategyToForceDirected() { this->SetLayoutStrategy("Force Directed"); }
  void SetLayoutStrategyToSimple2D() { this->SetLayoutStrategy("Simple 2D"); }
  void SetLayoutStrategyToClustering2D() { this->SetLayoutStrategy("Clustering 2D"); }
  void SetLayoutStrategyToCommunity2D() { this->SetLayoutStrategy("Community 2D"); }
  void SetLayoutStrategyToFast2D() { this->SetLayoutStrategy("Fast 2D"); }
  void SetLayoutStrategyToPassThrough() { this->SetLayoutStrategy("Pass Through"); }
  void SetLayoutStrategyToCircular() { this->SetLayoutStrategy("Circular"); }
  void SetLayoutStrategyToTree() { this->SetLayoutStrategy("Tree"); }
  void SetLayoutStrategyToCosmicTree() { this->SetLayoutStrategy("Cosmic Tree"); }
  void SetLayoutStrategyToCone() { this->SetLayoutStrategy("Cone"); }
  void SetLayoutStrategyToSpanTree() { this->SetLayoutStrategy("Span Tree"); }
  const char* GetLayoutStrategyName();
 
 
  vtkGraphLayoutStrategy* GetLayoutStrategy();
  void SetLayoutStrategy(vtkGraphLayoutStrategy* s);
 
 
  void SetEdgeLayoutStrategy(const char* name);
  void SetEdgeLayoutStrategyToArcParallel() { this->SetEdgeLayoutStrategy("Arc Parallel"); }
  void SetEdgeLayoutStrategyToPassThrough() { this->SetEdgeLayoutStrategy("Pass Through"); }
  const char* GetEdgeLayoutStrategyName();
 
 
  vtkEdgeLayoutStrategy* GetEdgeLayoutStrategy();
  void SetEdgeLayoutStrategy(vtkEdgeLayoutStrategy* s);
 
  void AddIconType(const char* type, int index);
 
  void ClearIconTypes();
 
  void SetIconAlignment(int alignment);
 
 
  void SetIconVisibility(bool b);
  bool GetIconVisibility();
  vtkBooleanMacro(IconVisibility, bool);
 
 
  void SetIconArrayName(const char* name);
  const char* GetIconArrayName();
 
 
  void SetGlyphType(int type);
  int GetGlyphType();
 
 
  virtual void SetVertexLabelFontSize(int size);
  virtual int GetVertexLabelFontSize();
 
 
  virtual void SetEdgeLabelFontSize(int size);
  virtual int GetEdgeLabelFontSize();
 
 
  void SetEdgeScalarBarVisibility(bool vis);
  bool GetEdgeScalarBarVisibility();
 
 
  void SetVertexScalarBarVisibility(bool vis);
  bool GetVertexScalarBarVisibility();
 
  void ZoomToSelection();
 
  virtual int IsLayoutComplete();
 
  virtual void UpdateLayout();
 
protected:
  vtkGraphLayoutView();
  ~vtkGraphLayoutView() override;
 
 
  vtkDataRepresentation* CreateDefaultRepresentation(vtkAlgorithmOutput* conn) override;
  virtual vtkRenderedGraphRepresentation* GetGraphRepresentation();
  // Called to process events.  Overrides behavior in vtkRenderView.
  void ProcessEvents(vtkObject* caller, unsigned long eventId, void* callData) override;
 
private:
  vtkGraphLayoutView(const vtkGraphLayoutView&) = delete;
  void operator=(const vtkGraphLayoutView&) = delete;
  bool VertexLabelsRequested;
  bool EdgeLabelsRequested;
};
 
VTK_ABI_NAMESPACE_END
#endif