VTK  9.0.1
vtkCaptionActor2D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCaptionActor2D.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 =========================================================================*/
55 #ifndef vtkCaptionActor2D_h
56 #define vtkCaptionActor2D_h
57 
58 #include "vtkActor2D.h"
59 #include "vtkRenderingAnnotationModule.h" // For export macro
60 
61 class vtkActor;
62 class vtkAlgorithmOutput;
63 class vtkAppendPolyData;
64 class vtkCaptionActor2DConnection;
65 class vtkGlyph2D;
66 class vtkGlyph3D;
67 class vtkPolyData;
69 class vtkPolyDataMapper;
70 class vtkTextActor;
71 class vtkTextMapper;
72 class vtkTextProperty;
73 
74 class VTKRENDERINGANNOTATION_EXPORT vtkCaptionActor2D : public vtkActor2D
75 {
76 public:
77  vtkTypeMacro(vtkCaptionActor2D, vtkActor2D);
78  void PrintSelf(ostream& os, vtkIndent indent) override;
79 
80  static vtkCaptionActor2D* New();
81 
83 
87  virtual void SetCaption(const char* caption);
88  virtual char* GetCaption();
90 
92 
97  vtkWorldCoordinateMacro(AttachmentPoint);
99 
101 
104  vtkSetMacro(Border, vtkTypeBool);
105  vtkGetMacro(Border, vtkTypeBool);
106  vtkBooleanMacro(Border, vtkTypeBool);
108 
110 
114  vtkSetMacro(Leader, vtkTypeBool);
115  vtkGetMacro(Leader, vtkTypeBool);
116  vtkBooleanMacro(Leader, vtkTypeBool);
118 
120 
123  vtkSetMacro(ThreeDimensionalLeader, vtkTypeBool);
124  vtkGetMacro(ThreeDimensionalLeader, vtkTypeBool);
125  vtkBooleanMacro(ThreeDimensionalLeader, vtkTypeBool);
127 
129 
137  virtual void SetLeaderGlyphData(vtkPolyData*);
138  virtual void SetLeaderGlyphConnection(vtkAlgorithmOutput*);
139  virtual vtkPolyData* GetLeaderGlyph();
141 
143 
150  vtkSetClampMacro(LeaderGlyphSize, double, 0.0, 0.1);
151  vtkGetMacro(LeaderGlyphSize, double);
153 
155 
160  vtkSetClampMacro(MaximumLeaderGlyphSize, int, 1, 1000);
161  vtkGetMacro(MaximumLeaderGlyphSize, int);
163 
165 
169  vtkSetClampMacro(Padding, int, 0, 50);
170  vtkGetMacro(Padding, int);
172 
174 
178  vtkGetObjectMacro(TextActor, vtkTextActor);
180 
182 
185  virtual void SetCaptionTextProperty(vtkTextProperty* p);
186  vtkGetObjectMacro(CaptionTextProperty, vtkTextProperty);
188 
193  void ShallowCopy(vtkProp* prop) override;
194 
196 
200  vtkSetMacro(AttachEdgeOnly, vtkTypeBool);
201  vtkGetMacro(AttachEdgeOnly, vtkTypeBool);
202  vtkBooleanMacro(AttachEdgeOnly, vtkTypeBool);
204 
212  void ReleaseGraphicsResources(vtkWindow*) override;
213 
215 
220  int RenderOpaqueGeometry(vtkViewport* viewport) override;
221  int RenderTranslucentPolygonalGeometry(vtkViewport*) override { return 0; }
222  int RenderOverlay(vtkViewport* viewport) override;
224 
229 
230 protected:
232  ~vtkCaptionActor2D() override;
233 
235 
241 
242  int Padding;
244 
245 private:
246  vtkTextActor* TextActor;
247  vtkTextProperty* CaptionTextProperty;
248 
249  vtkPolyData* BorderPolyData;
250  vtkPolyDataMapper2D* BorderMapper;
251  vtkActor2D* BorderActor;
252 
253  vtkPolyData* HeadPolyData; // single attachment point for glyphing
254  vtkGlyph3D* HeadGlyph; // for 3D leader
255  vtkPolyData* LeaderPolyData; // line represents the leader
256  vtkAppendPolyData* AppendLeader; // append head and leader
257 
258  // for 2D leader
259  vtkCoordinate* MapperCoordinate2D;
260  vtkPolyDataMapper2D* LeaderMapper2D;
261  vtkActor2D* LeaderActor2D;
262 
263  // for 3D leader
264  vtkPolyDataMapper* LeaderMapper3D;
265  vtkActor* LeaderActor3D;
266 
267  vtkCaptionActor2DConnection* LeaderGlyphConnectionHolder;
268 
269 private:
270  vtkCaptionActor2D(const vtkCaptionActor2D&) = delete;
271  void operator=(const vtkCaptionActor2D&) = delete;
272 };
273 
274 #endif
vtkPolyDataMapper
map vtkPolyData to graphics primitives
Definition: vtkPolyDataMapper.h:36
vtkActor2D::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:44
vtkCaptionActor2D::LeaderGlyphSize
double LeaderGlyphSize
Definition: vtkCaptionActor2D.h:239
vtkActor2D::ShallowCopy
void ShallowCopy(vtkProp *prop) override
Shallow copy of this vtkActor2D.
vtkCaptionActor2D::Padding
int Padding
Definition: vtkCaptionActor2D.h:242
vtkActor2D::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkGlyph2D
copy oriented and scaled glyph geometry to every input point (2D specialization)
Definition: vtkGlyph2D.h:36
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
vtkAppendPolyData
appends one or more polygonal datasets together
Definition: vtkAppendPolyData.h:42
vtkCaptionActor2D::Leader
vtkTypeBool Leader
Definition: vtkCaptionActor2D.h:237
vtkActor2D::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
vtkTextMapper
2D text annotation
Definition: vtkTextMapper.h:47
vtkCaptionActor2D::MaximumLeaderGlyphSize
int MaximumLeaderGlyphSize
Definition: vtkCaptionActor2D.h:240
vtkActor2D::RenderOverlay
int RenderOverlay(vtkViewport *viewport) override
Support the standard render methods.
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:45
vtkTextActor
An actor that displays text. Scaled or unscaled.
Definition: vtkTextActor.h:50
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkCoordinate
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
Definition: vtkCoordinate.h:76
vtkCaptionActor2D::AttachmentPointCoordinate
vtkCoordinate * AttachmentPointCoordinate
Definition: vtkCaptionActor2D.h:234
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:44
vtkCaptionActor2D::ThreeDimensionalLeader
vtkTypeBool ThreeDimensionalLeader
Definition: vtkCaptionActor2D.h:238
vtkGlyph3D
copy oriented and scaled glyph geometry to every input point
Definition: vtkGlyph3D.h:105
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:33
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
vtkCaptionActor2D
draw text label associated with a point
Definition: vtkCaptionActor2D.h:74
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:39
vtkActor2D.h
vtkActor2D::New
static vtkActor2D * New()
Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at la...
vtkCaptionActor2D::Border
vtkTypeBool Border
Definition: vtkCaptionActor2D.h:236
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:36
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:84
vtkCaptionActor2D::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
Definition: vtkCaptionActor2D.h:221
vtkActor2D::HasTranslucentPolygonalGeometry
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some translucent polygonal geometry?
vtkCaptionActor2D::AttachEdgeOnly
vtkTypeBool AttachEdgeOnly
Definition: vtkCaptionActor2D.h:243
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69