VTK  9.2.5
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 =========================================================================*/
58 #ifndef vtkCaptionRepresentation_h
59 #define vtkCaptionRepresentation_h
60 
62 #include "vtkInteractionWidgetsModule.h" // For export macro
63 
64 class vtkRenderer;
65 class vtkCaptionActor2D;
66 class vtkConeSource;
68 
69 class VTKINTERACTIONWIDGETS_EXPORT vtkCaptionRepresentation : public vtkBorderRepresentation
70 {
71 public:
76 
78 
82  void PrintSelf(ostream& os, vtkIndent indent) override;
84 
86 
90  void SetAnchorPosition(double pos[3]);
91  void GetAnchorPosition(double pos[3]);
93 
95 
99  void SetCaptionActor2D(vtkCaptionActor2D* captionActor);
100  vtkGetObjectMacro(CaptionActor2D, vtkCaptionActor2D);
102 
104 
110  vtkGetObjectMacro(AnchorRepresentation, vtkPointHandleRepresentation3D);
112 
116  void BuildRepresentation() override;
117  void GetSize(double size[2]) override
118  {
119  size[0] = 2.0;
120  size[1] = 2.0;
121  }
122 
124 
130  int RenderOverlay(vtkViewport*) override;
135 
137 
141  vtkSetClampMacro(FontFactor, double, 0.1, 10.0);
142  vtkGetMacro(FontFactor, double);
144 
145 protected:
148 
149  // the text to manage
152 
154  int DisplayAttachmentPoint[2];
155  double FontFactor;
156 
157  // Internal representation for the anchor
159 
160  // Check and adjust boundaries according to the size of the caption text
161  virtual void AdjustCaptionBoundary();
162 
163 private:
165  void operator=(const vtkCaptionRepresentation&) = delete;
166 };
167 
168 #endif
represent a vtkBorderWidget
draw text label associated with a point
represents vtkCaptionWidget in the scene
int RenderOpaqueGeometry(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.
void SetAnchorRepresentation(vtkPointHandleRepresentation3D *)
Set and get the instances of vtkPointHandleRepresention3D used to implement this representation.
void GetActors2D(vtkPropCollection *) override
These methods are necessary to make this representation behave as a vtkProp.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard VTK class methods.
static vtkCaptionRepresentation * New()
Instantiate this class.
virtual void AdjustCaptionBoundary()
vtkPointHandleRepresentation3D * AnchorRepresentation
void ReleaseGraphicsResources(vtkWindow *) override
These methods are necessary to make this representation behave as a vtkProp.
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
void BuildRepresentation() override
Satisfy the superclasses API.
int RenderOverlay(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
void GetAnchorPosition(double pos[3])
Specify the position of the anchor (i.e., the point that the caption is anchored to).
~vtkCaptionRepresentation() override
void SetAnchorPosition(double pos[3])
Specify the position of the anchor (i.e., the point that the caption is anchored to).
void GetSize(double size[2]) override
Subclasses should implement these methods.
void SetCaptionActor2D(vtkCaptionActor2D *captionActor)
Specify the vtkCaptionActor2D to manage.
generate polygonal cone
a simple class to control print indentation
Definition: vtkIndent.h:119
represent the position of a point in 3D space
an ordered list of Props
abstract specification for renderers
Definition: vtkRenderer.h:182
abstract specification for Viewports
Definition: vtkViewport.h:56
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
@ size
Definition: vtkX3D.h:259
int vtkTypeBool
Definition: vtkABI.h:69