VTK  9.2.6
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=========================================================================*/
38
39#ifndef vtkCaptionRepresentation_h
40#define vtkCaptionRepresentation_h
41
43#include "vtkInteractionWidgetsModule.h" // For export macro
44
45class vtkRenderer;
47class vtkConeSource;
49
50class VTKINTERACTIONWIDGETS_EXPORT vtkCaptionRepresentation : public vtkBorderRepresentation
51{
52public:
57
59
63 void PrintSelf(ostream& os, vtkIndent indent) override;
65
67
71 void SetAnchorPosition(double pos[3]);
72 void GetAnchorPosition(double pos[3]);
74
76
81 vtkGetObjectMacro(CaptionActor2D, vtkCaptionActor2D);
83
85
93
97 void BuildRepresentation() override;
98 void GetSize(double size[2]) override
99 {
100 size[0] = 2.0;
101 size[1] = 2.0;
102 }
103
105
116
118
122 vtkSetClampMacro(FontFactor, double, 0.1, 10.0);
123 vtkGetMacro(FontFactor, double);
125
126protected:
129
130 // the text to manage
133
137
138 // Internal representation for the anchor
140
141 // Check and adjust boundaries according to the size of the caption text
142 virtual void AdjustCaptionBoundary();
143
144private:
146 void operator=(const vtkCaptionRepresentation&) = delete;
147};
148
149#endif
draw text label associated with a point
int RenderOpaqueGeometry(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
static vtkCaptionRepresentation * New()
Instantiate this class.
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.
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:40
represent the position of a point in 3D space
an ordered list of Props
abstract specification for renderers
Definition vtkRenderer.h:73
abstract specification for Viewports
Definition vtkViewport.h:56
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
int vtkTypeBool
Definition vtkABI.h:69