vtkDendrogramItem.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkDendrogramItem_h
#define vtkDendrogramItem_h

#include "vtkContextItem.h"
#include "vtkViewsInfovisModule.h" // For export macro

#include "vtkNew.h"           // For vtkNew ivars
#include "vtkSmartPointer.h"  // For vtkSmartPointer ivars
#include "vtkStdString.h"     // For SetGet ivars
#include "vtkVector.h"        // For vtkVector2f ivar
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkColorLegend;
class vtkDoubleArray;
class vtkGraphLayout;
class vtkLookupTable;
class vtkPruneTreeFilter;
class vtkTree;

class VTKVIEWSINFOVIS_EXPORT VTK_MARSHALAUTO vtkDendrogramItem : public vtkContextItem
{
public:
  static vtkDendrogramItem* New();
  vtkTypeMacro(vtkDendrogramItem, vtkContextItem);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void SetTree(vtkTree* tree);

  vtkTree* GetTree();

  void CollapseToNumberOfLeafNodes(unsigned int n);

  vtkTree* GetPrunedTree();

  void SetColorArray(const char* arrayName);


  vtkSetMacro(ExtendLeafNodes, bool);
  vtkGetMacro(ExtendLeafNodes, bool);
  vtkBooleanMacro(ExtendLeafNodes, bool);

  void SetOrientation(int orientation);

  int GetOrientation();

  double GetAngleForOrientation(int orientation);

  double GetTextAngleForOrientation(int orientation);


  vtkSetMacro(DrawLabels, bool);
  vtkGetMacro(DrawLabels, bool);
  vtkBooleanMacro(DrawLabels, bool);


  vtkSetVector2Macro(Position, float);
  void SetPosition(const vtkVector2f& pos);


  vtkGetVector2Macro(Position, float);
  vtkVector2f GetPositionVector();


  vtkGetMacro(LeafSpacing, double);
  vtkSetMacro(LeafSpacing, double);

  void PrepareToPaint(vtkContext2D* painter);

  virtual void GetBounds(double bounds[4]);

  void ComputeLabelWidth(vtkContext2D* painter);

  float GetLabelWidth();

  bool GetPositionOfVertex(const std::string& vertexName, double position[2]);

  bool Paint(vtkContext2D* painter) override;


  vtkGetMacro(LineWidth, float);
  vtkSetMacro(LineWidth, float);


  vtkSetMacro(DisplayNumberOfCollapsedLeafNodes, bool);
  vtkGetMacro(DisplayNumberOfCollapsedLeafNodes, bool);
  vtkBooleanMacro(DisplayNumberOfCollapsedLeafNodes, bool);


  vtkGetMacro(DistanceArrayName, vtkStdString);
  vtkSetMacro(DistanceArrayName, vtkStdString);


  vtkGetMacro(VertexNameArrayName, vtkStdString);
  vtkSetMacro(VertexNameArrayName, vtkStdString);

  // this struct & class allow us to generate a priority queue of vertices.
  struct WeightedVertex
  {
    vtkIdType ID;
    double weight;
  };
  class CompareWeightedVertices
  {
  public:
    // Returns true if v2 is higher priority than v1
    bool operator()(WeightedVertex& v1, WeightedVertex& v2)
    {
      if (v1.weight <= v2.weight)
      {
        return false;
      }
      return true;
    }
  };

  enum
  {
    LEFT_TO_RIGHT,
    UP_TO_DOWN,
    RIGHT_TO_LEFT,
    DOWN_TO_UP
  };

  bool Hit(const vtkContextMouseEvent& mouse) override;

  bool MouseDoubleClickEvent(const vtkContextMouseEvent& event) override;

protected:
  vtkDendrogramItem();
  ~vtkDendrogramItem() override;

  vtkVector2f PositionVector;
  float* Position;

  virtual void RebuildBuffers();

  virtual void PaintBuffers(vtkContext2D* painter);

  virtual bool IsDirty();

  void ComputeMultipliers();

  void ComputeBounds();

  void CountLeafNodes();

  int CountLeafNodes(vtkIdType vertex);

  vtkIdType GetClosestVertex(double x, double y);

  void CollapseSubTree(vtkIdType vertex);

  void ExpandSubTree(vtkIdType vertex);

  vtkIdType GetOriginalId(vtkIdType vertex);

  vtkIdType GetPrunedIdForOriginalId(vtkIdType originalId);

  vtkIdType GetClickedCollapsedSubTree(double x, double y);

  void UpdateVisibleSceneExtent(vtkContext2D* painter);

  bool LineIsVisible(double x0, double y0, double x1, double y1);

  void SetOrientation(vtkTree* tree, int orientation);

  // Setup the position, size, and orientation of this dendrogram's color
  // legend based on the dendrogram's current orientation.
  void PositionColorLegend();

  vtkSmartPointer<vtkTree> Tree;
  vtkSmartPointer<vtkTree> LayoutTree;

private:
  vtkDendrogramItem(const vtkDendrogramItem&) = delete;
  void operator=(const vtkDendrogramItem&) = delete;

  vtkSmartPointer<vtkTree> PrunedTree;
  vtkMTimeType DendrogramBuildTime;
  vtkNew<vtkGraphLayout> Layout;
  vtkNew<vtkPruneTreeFilter> PruneFilter;
  vtkNew<vtkLookupTable> TriangleLookupTable;
  vtkNew<vtkLookupTable> TreeLookupTable;
  vtkNew<vtkColorLegend> ColorLegend;
  vtkDoubleArray* ColorArray;
  double MultiplierX;
  double MultiplierY;
  int NumberOfLeafNodes;
  double LeafSpacing;

  double MinX;
  double MinY;
  double MaxX;
  double MaxY;
  double SceneBottomLeft[3];
  double SceneTopRight[3];
  float LabelWidth;
  float LineWidth;
  bool ColorTree;
  bool ExtendLeafNodes;
  bool DrawLabels;
  bool DisplayNumberOfCollapsedLeafNodes;
  bool LegendPositionSet;
  vtkStdString DistanceArrayName;
  vtkStdString VertexNameArrayName;
};

VTK_ABI_NAMESPACE_END
#endif