VTK  9.1.0
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=========================================================================*/
29#ifndef vtkTextMapper_h
30#define vtkTextMapper_h
31
32#include "vtkMapper2D.h"
33#include "vtkRenderingCoreModule.h" // For export macro
34
35#include "vtkNew.h" // For vtkNew
36
37class vtkActor2D;
38class vtkImageData;
39class vtkPoints;
40class vtkPolyData;
42class vtkTextProperty;
43class vtkTexture;
44class vtkTimeStamp;
45class vtkViewport;
46
47class VTKRENDERINGCORE_EXPORT vtkTextMapper : public vtkMapper2D
48{
49public:
50 vtkTypeMacro(vtkTextMapper, vtkMapper2D);
51 void PrintSelf(ostream& os, vtkIndent indent) override;
52
56 static vtkTextMapper* New();
57
59
63 virtual void GetSize(vtkViewport*, int size[2]);
64 virtual int GetWidth(vtkViewport* v);
65 virtual int GetHeight(vtkViewport* v);
67
69
72 vtkSetStringMacro(Input);
73 vtkGetStringMacro(Input);
75
77
81 vtkGetObjectMacro(TextProperty, vtkTextProperty);
83
87 void ShallowCopy(vtkAbstractMapper* m) override;
88
90
96 virtual int SetConstrainedFontSize(vtkViewport*, int targetWidth, int targetHeight);
98 vtkTextMapper*, vtkViewport*, int targetWidth, int targetHeight);
100
108 static int SetMultipleConstrainedFontSize(vtkViewport*, int targetWidth, int targetHeight,
109 vtkTextMapper** mappers, int nbOfMappers, int* maxResultingSize);
110
112
117 vtkTextMapper*, vtkViewport*, const int* winSize, int* stringSize, float sizeFactor = 0.0);
118 static int SetMultipleRelativeFontSize(vtkViewport* viewport, vtkTextMapper** textMappers,
119 int nbOfMappers, int* winSize, int* stringSize, float sizeFactor);
121
125
126protected:
128 ~vtkTextMapper() override;
129
130 char* Input;
132
133private:
134 vtkTextMapper(const vtkTextMapper&) = delete;
135 void operator=(const vtkTextMapper&) = delete;
136
137 void UpdateQuad(vtkActor2D* actor, int dpi);
138 void UpdateImage(int dpi);
139
140 int TextDims[2];
141
142 int RenderedDPI;
143 vtkTimeStamp CoordsTime;
144 vtkTimeStamp TCoordsTime;
146 vtkNew<vtkPoints> Points;
147 vtkNew<vtkPolyData> PolyData;
149 vtkNew<vtkTexture> Texture;
150};
151
152#endif
abstract class specifies interface to map data
a actor that draws 2D data
Definition: vtkActor2D.h:40
topologically and geometrically regular array of data
Definition: vtkImageData.h:48
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract class specifies interface for objects which render 2D actors
Definition: vtkMapper2D.h:36
Allocate and hold a VTK object.
Definition: vtkNew.h:56
represent and manipulate 3D points
Definition: vtkPoints.h:34
draw vtkPolyData onto the image plane
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
2D text annotation
Definition: vtkTextMapper.h:48
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:66
record modification and/or execution time
Definition: vtkTimeStamp.h:33
abstract specification for Viewports
Definition: vtkViewport.h:47
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287