VTK  9.0.1
vtkCaptionRepresentation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCaptionRepresentation.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 =========================================================================*/
36 #ifndef vtkCaptionRepresentation_h
37 #define vtkCaptionRepresentation_h
38 
40 #include "vtkInteractionWidgetsModule.h" // For export macro
41 
42 class vtkRenderer;
43 class vtkCaptionActor2D;
44 class vtkConeSource;
46 
47 class VTKINTERACTIONWIDGETS_EXPORT vtkCaptionRepresentation : public vtkBorderRepresentation
48 {
49 public:
53  static vtkCaptionRepresentation* New();
54 
56 
60  void PrintSelf(ostream& os, vtkIndent indent) override;
62 
64 
68  void SetAnchorPosition(double pos[3]);
69  void GetAnchorPosition(double pos[3]);
71 
73 
77  void SetCaptionActor2D(vtkCaptionActor2D* captionActor);
78  vtkGetObjectMacro(CaptionActor2D, vtkCaptionActor2D);
80 
82 
87  void SetAnchorRepresentation(vtkPointHandleRepresentation3D*);
88  vtkGetObjectMacro(AnchorRepresentation, vtkPointHandleRepresentation3D);
90 
94  void BuildRepresentation() override;
95  void GetSize(double size[2]) override
96  {
97  size[0] = 2.0;
98  size[1] = 2.0;
99  }
100 
102 
106  void GetActors2D(vtkPropCollection*) override;
107  void ReleaseGraphicsResources(vtkWindow*) override;
108  int RenderOverlay(vtkViewport*) override;
109  int RenderOpaqueGeometry(vtkViewport*) override;
113 
115 
119  vtkSetClampMacro(FontFactor, double, 0.1, 10.0);
120  vtkGetMacro(FontFactor, double);
122 
123 protected:
125  ~vtkCaptionRepresentation() override;
126 
127  // the text to manage
130 
132  int DisplayAttachmentPoint[2];
133  double FontFactor;
134 
135  // Internal representation for the anchor
137 
138  // Check and adjust boundaries according to the size of the caption text
139  virtual void AdjustCaptionBoundary();
140 
141 private:
143  void operator=(const vtkCaptionRepresentation&) = delete;
144 };
145 
146 #endif
int RenderOverlay(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
vtkTypeBool HasTranslucentPolygonalGeometry() override
These methods are necessary to make this representation behave as a vtkProp.
represent the position of a point in 3D space
abstract specification for Viewports
Definition: vtkViewport.h:44
void GetSize(double size[2]) override
Subclasses should implement these methods.
int RenderOpaqueGeometry(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
void GetActors2D(vtkPropCollection *) override
These methods are necessary to make this representation behave as a vtkProp.
abstract specification for renderers
Definition: vtkRenderer.h:67
generate polygonal cone
Definition: vtkConeSource.h:38
static vtkBorderRepresentation * New()
Instantiate this class.
an ordered list of Props
void PrintSelf(ostream &os, vtkIndent indent) override
Define standard methods.
int vtkTypeBool
Definition: vtkABI.h:69
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
represents vtkCaptionWidget in the scene
void BuildRepresentation() override
Subclasses should implement these methods.
a simple class to control print indentation
Definition: vtkIndent.h:33
void ReleaseGraphicsResources(vtkWindow *) override
These methods are necessary to make this representation behave as a vtkProp.
represent a vtkBorderWidget
draw text label associated with a point
vtkPointHandleRepresentation3D * AnchorRepresentation