VTK  9.2.6
vtkTextMapper.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkTextMapper.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=========================================================================*/
31
32#ifndef vtkTextMapper_h
33#define vtkTextMapper_h
34
35#include "vtkMapper2D.h"
36#include "vtkRenderingCoreModule.h" // For export macro
37
38#include "vtkNew.h" // For vtkNew
39
40class vtkActor2D;
41class vtkImageData;
42class vtkPoints;
43class vtkPolyData;
45class vtkTextProperty;
46class vtkTexture;
47class vtkTimeStamp;
48class vtkViewport;
49
50class VTKRENDERINGCORE_EXPORT vtkTextMapper : public vtkMapper2D
51{
52public:
53 vtkTypeMacro(vtkTextMapper, vtkMapper2D);
54 void PrintSelf(ostream& os, vtkIndent indent) override;
55
59 static vtkTextMapper* New();
60
62
66 virtual void GetSize(vtkViewport*, int size[2]);
67 virtual int GetWidth(vtkViewport* v);
68 virtual int GetHeight(vtkViewport* v);
70
72
75 vtkSetStringMacro(Input);
76 vtkGetStringMacro(Input);
78
80
84 vtkGetObjectMacro(TextProperty, vtkTextProperty);
86
90 void ShallowCopy(vtkAbstractMapper* m) override;
91
93
99 virtual int SetConstrainedFontSize(vtkViewport*, int targetWidth, int targetHeight);
101 vtkTextMapper*, vtkViewport*, int targetWidth, int targetHeight);
103
111 static int SetMultipleConstrainedFontSize(vtkViewport*, int targetWidth, int targetHeight,
112 vtkTextMapper** mappers, int nbOfMappers, int* maxResultingSize);
113
115
120 vtkTextMapper*, vtkViewport*, const int* winSize, int* stringSize, float sizeFactor = 0.0);
121 static int SetMultipleRelativeFontSize(vtkViewport* viewport, vtkTextMapper** textMappers,
122 int nbOfMappers, int* winSize, int* stringSize, float sizeFactor);
124
128
129protected:
131 ~vtkTextMapper() override;
132
133 char* Input;
135
136private:
137 vtkTextMapper(const vtkTextMapper&) = delete;
138 void operator=(const vtkTextMapper&) = delete;
139
140 void UpdateQuad(vtkActor2D* actor, int dpi);
141 void UpdateImage(int dpi);
142
143 int TextDims[2];
144
145 int RenderedDPI;
146 vtkTimeStamp CoordsTime;
147 vtkTimeStamp TCoordsTime;
149 vtkNew<vtkPoints> Points;
150 vtkNew<vtkPolyData> PolyData;
152 vtkNew<vtkTexture> Texture;
153};
154
155#endif
a actor that draws 2D data
Definition vtkActor2D.h:46
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:40
vtkMapper2D()=default
Allocate and hold a VTK object.
Definition vtkNew.h:62
represent and manipulate 3D points
Definition vtkPoints.h:40
draw vtkPolyData onto the image plane
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition vtkPolyData.h:91
static int SetMultipleConstrainedFontSize(vtkViewport *, int targetWidth, int targetHeight, vtkTextMapper **mappers, int nbOfMappers, int *maxResultingSize)
Set and return the font size (in points) required to make each element of an array of mappers fit in ...
static int SetRelativeFontSize(vtkTextMapper *, vtkViewport *, const int *winSize, int *stringSize, float sizeFactor=0.0)
Use these methods when setting font size relative to the renderer's size.
void RenderOverlay(vtkViewport *, vtkActor2D *) override
virtual int GetHeight(vtkViewport *v)
Return the size[2]/width/height of the rectangle required to draw this mapper (in pixels).
vtkMTimeType GetMTime() override
Override Modifiedtime as we have added Clipping planes.
static int SetMultipleRelativeFontSize(vtkViewport *viewport, vtkTextMapper **textMappers, int nbOfMappers, int *winSize, int *stringSize, float sizeFactor)
Use these methods when setting font size relative to the renderer's size.
virtual void SetTextProperty(vtkTextProperty *p)
Set/Get the text property.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void GetSize(vtkViewport *, int size[2])
Return the size[2]/width/height of the rectangle required to draw this mapper (in pixels).
virtual int SetConstrainedFontSize(vtkViewport *, int targetWidth, int targetHeight)
Set and return the font size (in points) required to make this mapper fit in a given target rectangle...
static int SetConstrainedFontSize(vtkTextMapper *, vtkViewport *, int targetWidth, int targetHeight)
Set and return the font size (in points) required to make this mapper fit in a given target rectangle...
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this mapper.
static vtkTextMapper * New()
Creates a new text mapper.
void ShallowCopy(vtkAbstractMapper *m) override
Shallow copy of an actor.
virtual int GetWidth(vtkViewport *v)
Return the size[2]/width/height of the rectangle required to draw this mapper (in pixels).
vtkTextProperty * TextProperty
~vtkTextMapper() override
represent text properties.
handles properties associated with a texture map
Definition vtkTexture.h:69
record modification and/or execution time
abstract specification for Viewports
Definition vtkViewport.h:56
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287