VTK  9.1.20211115
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 =========================================================================*/
55 #ifndef vtkCaptionRepresentation_h
56 #define vtkCaptionRepresentation_h
57 
59 #include "vtkInteractionWidgetsModule.h" // For export macro
60 
61 class vtkRenderer;
62 class vtkCaptionActor2D;
63 class vtkConeSource;
65 
66 class VTKINTERACTIONWIDGETS_EXPORT vtkCaptionRepresentation : public vtkBorderRepresentation
67 {
68 public:
73 
75 
79  void PrintSelf(ostream& os, vtkIndent indent) override;
81 
83 
87  void SetAnchorPosition(double pos[3]);
88  void GetAnchorPosition(double pos[3]);
90 
92 
96  void SetCaptionActor2D(vtkCaptionActor2D* captionActor);
97  vtkGetObjectMacro(CaptionActor2D, vtkCaptionActor2D);
99 
101 
107  vtkGetObjectMacro(AnchorRepresentation, vtkPointHandleRepresentation3D);
109 
113  void BuildRepresentation() override;
114  void GetSize(double size[2]) override
115  {
116  size[0] = 2.0;
117  size[1] = 2.0;
118  }
119 
121 
127  int RenderOverlay(vtkViewport*) override;
132 
134 
138  vtkSetClampMacro(FontFactor, double, 0.1, 10.0);
139  vtkGetMacro(FontFactor, double);
141 
142 protected:
145 
146  // the text to manage
149 
151  int DisplayAttachmentPoint[2];
152  double FontFactor;
153 
154  // Internal representation for the anchor
156 
157  // Check and adjust boundaries according to the size of the caption text
158  virtual void AdjustCaptionBoundary();
159 
160 private:
162  void operator=(const vtkCaptionRepresentation&) = delete;
163 };
164 
165 #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:113
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:47
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
@ size
Definition: vtkX3D.h:259
int vtkTypeBool
Definition: vtkABI.h:69