VTK  9.3.0
vtkAreaLayout.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
22 #ifndef vtkAreaLayout_h
23 #define vtkAreaLayout_h
24 
25 #include "vtkInfovisLayoutModule.h" // For export macro
26 #include "vtkTreeAlgorithm.h"
27 
28 VTK_ABI_NAMESPACE_BEGIN
30 
31 class VTKINFOVISLAYOUT_EXPORT vtkAreaLayout : public vtkTreeAlgorithm
32 {
33 public:
34  static vtkAreaLayout* New();
36  void PrintSelf(ostream& os, vtkIndent indent) override;
37 
42  virtual void SetSizeArrayName(const char* name)
43  {
45  }
46 
48 
54  vtkGetStringMacro(AreaArrayName);
55  vtkSetStringMacro(AreaArrayName);
57 
59 
63  vtkGetMacro(EdgeRoutingPoints, bool);
64  vtkSetMacro(EdgeRoutingPoints, bool);
65  vtkBooleanMacro(EdgeRoutingPoints, bool);
67 
69 
72  vtkGetObjectMacro(LayoutStrategy, vtkAreaLayoutStrategy);
75 
79  vtkMTimeType GetMTime() override;
80 
85  vtkIdType FindVertex(float pnt[2]);
86 
90  void GetBoundingArea(vtkIdType id, float* sinfo);
91 
92 protected:
94  ~vtkAreaLayout() override;
95 
100 
102 
103 private:
104  vtkAreaLayout(const vtkAreaLayout&) = delete;
105  void operator=(const vtkAreaLayout&) = delete;
106 };
107 
108 VTK_ABI_NAMESPACE_END
109 #endif
virtual void SetInputArrayToProcess(int idx, int port, int connection, int fieldAssociation, const char *name)
Set the input data arrays that this algorithm will process.
abstract superclass for all area layout strategies
layout a vtkTree into a tree map
Definition: vtkAreaLayout.h:32
char * AreaArrayName
Definition: vtkAreaLayout.h:96
vtkMTimeType GetMTime() override
Get the modification time of the layout algorithm.
void SetLayoutStrategy(vtkAreaLayoutStrategy *strategy)
The strategy to use when laying out the tree map.
bool EdgeRoutingPoints
Definition: vtkAreaLayout.h:97
vtkIdType FindVertex(float pnt[2])
Get the vertex whose area contains the point, or return -1 if no vertex area covers the point.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
void GetBoundingArea(vtkIdType id, float *sinfo)
The bounding area information for a certain vertex id.
~vtkAreaLayout() override
static vtkAreaLayout * New()
vtkAreaLayoutStrategy * LayoutStrategy
Definition: vtkAreaLayout.h:99
char * EdgeRoutingPointsArrayName
Definition: vtkAreaLayout.h:98
virtual void SetSizeArrayName(const char *name)
The array name to use for retrieving the relative size of each vertex.
Definition: vtkAreaLayout.h:42
@ FIELD_ASSOCIATION_VERTICES
a simple class to control print indentation
Definition: vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Superclass for algorithms that produce only Tree as output.
@ name
Definition: vtkX3D.h:219
int vtkIdType
Definition: vtkType.h:315
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270