dox/Views/vtkTreeAreaView.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkTreeAreaView.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 __vtkTreeAreaView_h
#define __vtkTreeAreaView_h

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

class vtkActor;
class vtkActor2D;
class vtkAlgorithmOutput;
class vtkAreaLayout;
class vtkAreaLayoutStrategy;
class vtkConvertSelection;
class vtkCoordinate;
class vtkDynamic2DLabelMapper;
class vtkEdgeCenters;
class vtkExtractSelectedGraph;
class vtkExtractSelectedPolyDataIds;
class vtkGraph;
class vtkGraphHierarchicalBundle;
class vtkGraphMapper;
class vtkTransferAttributes;
class vtkKdTreeSelector;
class vtkLabeledDataMapper;
class vtkLookupTable;
class vtkPolyDataAlgorithm;
class vtkPolyDataMapper;
class vtkSelection;
class vtkSelectionLink;
class vtkSplineFilter;
class vtkTexture;
class vtkTree;
class vtkTreeFieldAggregator;
class vtkTreeLevelsFilter;
class vtkVertexDegree;
class vtkViewTheme;
class vtkHardwareSelector;

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


  vtkDataRepresentation* SetTreeFromInputConnection(vtkAlgorithmOutput* conn);
  vtkDataRepresentation* SetTreeFromInput(vtkTree* input);
  vtkDataRepresentation* SetGraphFromInputConnection(vtkAlgorithmOutput* conn);
  vtkDataRepresentation* SetGraphFromInput(vtkGraph* input);


  void SetAreaLabelArrayName(const char* name);
  const char* GetAreaLabelArrayName();

  void SetAreaSizeArrayName(const char* name);

  void SetLabelPriorityArrayName(const char* name);


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


  void SetAreaHoverArrayName(const char* name);
  const char* GetAreaHoverArrayName();


  void SetAreaLabelVisibility(bool vis);
  bool GetAreaLabelVisibility();
  void AreaLabelVisibilityOn();
  void AreaLabelVisibilityOff();


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

  void SetAreaColorArrayName(const char* name);


  void SetColorVertices(bool vis);
  bool GetColorVertices();
  vtkBooleanMacro(ColorVertices, bool);


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

  void SetEdgeColorToSplineFraction();


  void SetShrinkPercentage(double value);
  double GetShrinkPercentage();


  void SetColorEdges(bool vis);
  bool GetColorEdges();
  vtkBooleanMacro(ColorEdges, bool);

  void SetBundlingStrength(double strength);


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

  virtual void SetupRenderWindow(vtkRenderWindow* win);

  virtual void ApplyViewTheme(vtkViewTheme* theme);


  virtual void SetAreaLabelFontSize(const int size);
  virtual int GetAreaLabelFontSize();


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


  virtual void SetLayoutStrategy(vtkAreaLayoutStrategy* strategy);
  virtual vtkAreaLayoutStrategy* GetLayoutStrategy();


  virtual void SetAreaToPolyData(vtkPolyDataAlgorithm* areaToPoly);
  vtkGetObjectMacro(AreaToPolyData, vtkPolyDataAlgorithm);


  virtual void SetUseRectangularCoordinates(bool rect);
  virtual bool GetUseRectangularCoordinates();
  vtkBooleanMacro(UseRectangularCoordinates, bool);


  virtual void SetAreaLabelMapper(vtkLabeledDataMapper* mapper);
  vtkGetObjectMacro(AreaLabelMapper, vtkLabeledDataMapper);

protected:
  vtkTreeAreaView();
  ~vtkTreeAreaView();


  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);

  //BTX
  // Processing objects
  vtkSmartPointer<vtkCoordinate>                   Coordinate;
  vtkSmartPointer<vtkGraphHierarchicalBundle>      HBundle;
  vtkSmartPointer<vtkSplineFilter>                 Spline;
  vtkSmartPointer<vtkVertexDegree>                 VertexDegree;
  vtkSmartPointer<vtkVertexDegree>                 GraphVertexDegree;
  vtkSmartPointer<vtkEdgeCenters>                  EdgeCenters;
  vtkSmartPointer<vtkTreeFieldAggregator>          TreeAggregation;
  vtkSmartPointer<vtkTransferAttributes>           TransferAttributes;
  vtkSmartPointer<vtkTreeLevelsFilter>             TreeLevels;

  // Representation objects
  vtkSmartPointer<vtkDynamic2DLabelMapper>         EdgeLabelMapper;
  vtkSmartPointer<vtkActor2D>                      EdgeLabelActor;
  vtkSmartPointer<vtkPolyDataMapper>               GraphEdgeMapper;
  vtkSmartPointer<vtkActor>                        GraphEdgeActor;

  // Area objects
  vtkSmartPointer<vtkAreaLayout>                   AreaLayout;
  vtkSmartPointer<vtkPolyDataMapper>               AreaMapper;
  vtkSmartPointer<vtkActor>                        AreaActor;
  vtkSmartPointer<vtkActor2D>                      AreaLabelActor;
  vtkPolyDataAlgorithm*                            AreaToPolyData;
  vtkLabeledDataMapper*                            AreaLabelMapper;

  // Graph edge 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;

  // Area selection objects
  vtkSmartPointer<vtkConvertSelection>             ConvertSelection;
  vtkSmartPointer<vtkExtractSelectedPolyDataIds>   ExtractSelectedAreas;
  vtkSmartPointer<vtkPolyDataMapper>               SelectedAreaMapper;
  vtkSmartPointer<vtkActor>                        SelectedAreaActor;
  //ETX

private:
  vtkTreeAreaView(const vtkTreeAreaView&);  // Not implemented.
  void operator=(const vtkTreeAreaView&);  // Not implemented.
};

#endif

---