VTK
vtkConeLayoutStrategy.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkConeLayoutStrategy.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 //-------------------------------------------------------------------------
16 //Copyright 2008 Sandia Corporation.
17 //Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18 //the U.S. Government retains certain rights in this software.
19 //-------------------------------------------------------------------------
20 
46 #ifndef vtkConeLayoutStrategy_h
47 #define vtkConeLayoutStrategy_h
48 
49 #include "vtkInfovisLayoutModule.h" // For export macro
50 #include "vtkGraphLayoutStrategy.h"
51 
52 class vtkPoints;
53 
54 class VTKINFOVISLAYOUT_EXPORT vtkConeLayoutStrategy : public vtkGraphLayoutStrategy
55 {
56 public:
57  static vtkConeLayoutStrategy *New();
58 
60  void PrintSelf(ostream& os, vtkIndent indent) override;
61 
63 
70  vtkSetMacro(Compactness, float);
71  vtkGetMacro(Compactness, float);
73 
75 
82  vtkSetMacro(Compression, vtkTypeBool);
83  vtkGetMacro(Compression, vtkTypeBool);
84  vtkBooleanMacro(Compression, vtkTypeBool);
86 
88 
95  vtkSetMacro(Spacing, float);
96  vtkGetMacro(Spacing, float);
98 
99 
103  void Layout() override;
104 
105 protected:
107  ~vtkConeLayoutStrategy() override;
108 
117  double LocalPlacement(vtkIdType root, vtkPoints *points);
118 
119  void GlobalPlacement(
120  vtkIdType root,
121  vtkPoints *points,
122  double refX, // absolute x-y coordinate of
123  double refY, // parent node; z coordinate
124  double level ); // derived from level.
125 
126  float Compactness; // factor used in mapping layer to Z
127  vtkTypeBool Compression; // force a compact layout?
128  float Spacing; // Scale vertical spacing of cones.
129 
130  // Values accumulated for possible statistical use
131  double MinRadius;
132  double MaxRadius;
133  int NrCones;
134  double SumOfRadii;
135 
136 private:
138  void operator=(const vtkConeLayoutStrategy&) = delete;
139 };
140 
141 #endif
142 
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int vtkIdType
Definition: vtkType.h:347
abstract superclass for all graph layout strategies
int vtkTypeBool
Definition: vtkABI.h:69
a simple class to control print indentation
Definition: vtkIndent.h:33
produce a cone-tree layout for a forest
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
represent and manipulate 3D points
Definition: vtkPoints.h:33
virtual void Layout()=0
This is the layout method where the graph that was set in SetGraph() is laid out.