VTK
vtkLabeledContourPolyDataItem.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkLabeledContourPolyDataItem.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 =========================================================================*/
24 #ifndef vtkLabeledContourPolyDataItem_h
25 #define vtkLabeledContourPolyDataItem_h
26 
27 #include "vtkRect.h" // For vtkRect/vtkVector/vtkTuple
28 #include "vtkRenderingContext2DModule.h" // For export macro
29 #include "vtkPolyDataItem.h"
30 #include "vtkSmartPointer.h" // For vtkSmartPointer
31 
32 class vtkActor;
33 class vtkContext2D;
34 class vtkDoubleArray;
35 class vtkRenderer;
36 class vtkTextActor3D;
37 class vtkTextProperty;
39 struct LabelHelper;
40 
41 class VTKRENDERINGCONTEXT2D_EXPORT vtkLabeledContourPolyDataItem : public vtkPolyDataItem
42 {
43 public:
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
48 
52  bool Paint(vtkContext2D* painter) override;
53 
61  virtual void SetTextProperty(vtkTextProperty *tprop);
62 
64 
84 
86 
93  virtual void SetTextPropertyMapping(vtkDoubleArray *mapping);
95 
97 
102  vtkSetMacro(LabelVisibility, bool)
103  vtkGetMacro(LabelVisibility, bool)
104  vtkBooleanMacro(LabelVisibility, bool)
106 
108 
112  vtkSetMacro(SkipDistance, double)
113  vtkGetMacro(SkipDistance, double)
115 
116 protected:
119 
120  virtual void ComputeBounds();
121 
122  void Reset();
123 
124  bool CheckInputs();
125  bool CheckRebuild();
126  bool PrepareRender();
127  bool PlaceLabels();
128  bool ResolveLabels();
129  virtual bool CreateLabels();
130  bool RenderBackgrounds(vtkContext2D* painter);
131  bool RenderLabels(vtkContext2D* painter);
132 
133  bool AllocateTextActors(vtkIdType num);
134  bool FreeTextActors();
135 
136  double SkipDistance;
137 
138  bool LabelVisibility;
139  vtkIdType NumberOfTextActors;
140  vtkIdType NumberOfUsedTextActors;
141  vtkTextActor3D **TextActors;
142 
143  LabelHelper** LabelHelpers;
144 
146  vtkSmartPointer<vtkDoubleArray> TextPropertyMapping;
147 
148  vtkTimeStamp LabelBuildTime;
149 
150 private:
152  void operator=(const vtkLabeledContourPolyDataItem&) = delete;
153 
154  struct Private;
155  Private *Internal;
156 };
157 
158 #endif
vtkPolyDataItem.h
vtkLabeledContourPolyDataItem::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkLabeledContourPolyDataItem::SetTextProperties
virtual void SetTextProperties(vtkTextPropertyCollection *coll)
The text properties used to label the lines.
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkTextActor3D
An actor that displays text.
Definition: vtkTextActor3D.h:48
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:36
vtkSmartPointer
Hold a reference to a vtkObjectBase instance.
Definition: vtkSmartPointer.h:37
vtkTextPropertyCollection
an ordered list of vtkTextProperty objects.
Definition: vtkTextPropertyCollection.h:37
vtkLabeledContourPolyDataItem::New
static vtkLabeledContourPolyDataItem * New()
vtkContext2D
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:59
vtkLabeledContourPolyDataItem::SetTextProperty
virtual void SetTextProperty(vtkTextProperty *tprop)
The text property used to label the lines.
vtkLabeledContourPolyDataItem::SetTextPropertyMapping
virtual void SetTextPropertyMapping(vtkDoubleArray *mapping)
vtkLabeledContourPolyDataItem::Paint
bool Paint(vtkContext2D *painter) override
Paint event for the item.
vtkLabeledContourPolyDataItem::GetTextPropertyMapping
virtual vtkDoubleArray * GetTextPropertyMapping()
Values in this array correspond to vtkTextProperty objects in the TextProperties collection.
vtkPolyDataItem
Filter that translate a vtkPolyData 2D mesh into vtkContextItems.
Definition: vtkPolyDataItem.h:35
vtkRect.h
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:52
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkLabeledContourPolyDataItem::GetTextProperties
virtual vtkTextPropertyCollection * GetTextProperties()
vtkSmartPointer.h
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:40
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:64
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:42
vtkLabeledContourPolyDataItem
Filter that translate a vtkPolyData 2D mesh into vtkContextItems.
Definition: vtkLabeledContourPolyDataItem.h:42