VTK  9.2.6
vtkTextActor.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkTextActor.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=========================================================================*/
40
41#ifndef vtkTextActor_h
42#define vtkTextActor_h
43
44#include "vtkRenderingCoreModule.h" // For export macro
45#include "vtkTexturedActor2D.h"
46
47class vtkImageData;
48class vtkPoints;
49class vtkPolyData;
51class vtkProperty2D;
52class vtkTextProperty;
53class vtkTextRenderer;
54class vtkTransform;
55
56class VTKRENDERINGCORE_EXPORT vtkTextActor : public vtkTexturedActor2D
57{
58public:
60 void PrintSelf(ostream& os, vtkIndent indent) override;
61
66 static vtkTextActor* New();
67
72 void ShallowCopy(vtkProp* prop) override;
73
75
81 void SetInput(const char* inputString);
82 char* GetInput();
84
86
91 vtkSetVector2Macro(MinimumSize, int);
92 vtkGetVector2Macro(MinimumSize, int);
94
96
102 vtkSetMacro(MaximumLineHeight, float);
103 vtkGetMacro(MaximumLineHeight, float);
105
107
117 vtkGetMacro(TextScaleMode, int);
122
123 enum
124 {
128 };
129
131
138 vtkBooleanMacro(UseBorderAlign, vtkTypeBool);
140
142
157 void SetAlignmentPoint(int point);
160
162
169 void SetOrientation(float orientation);
170 vtkGetMacro(Orientation, float);
172
174
178 vtkGetObjectMacro(TextProperty, vtkTextProperty);
180
186 virtual void GetBoundingBox(vtkViewport* vport, double bbox[4]);
187
191 virtual void GetSize(vtkViewport* vport, double size[2]);
192
194
199 virtual int SetConstrainedFontSize(vtkViewport*, int targetWidth, int targetHeight);
200 static int SetConstrainedFontSize(vtkTextActor*, vtkViewport*, int targetWidth, int targetHeight);
202
209 static int SetMultipleConstrainedFontSize(vtkViewport*, int targetWidth, int targetHeight,
210 vtkTextActor** actors, int nbOfActors, int* maxResultingSize);
211
221 virtual void SetNonLinearFontScale(double exponent, int target);
222
227 void SpecifiedToDisplay(double* pos, vtkViewport* vport, int specified);
228
233 void DisplayToSpecified(double* pos, vtkViewport* vport, int specified);
234
239 virtual void ComputeScaledFont(vtkViewport* viewport);
240
242
248
256 static float GetFontScale(vtkViewport* viewport);
257
266
268
273 int RenderOpaqueGeometry(vtkViewport* viewport) override;
275 int RenderOverlay(vtkViewport* viewport) override;
277
282
283protected:
287 virtual bool RenderImage(vtkTextProperty* tprop, vtkViewport* viewport);
288
292 virtual bool GetImageBoundingBox(vtkTextProperty* tprop, vtkViewport* viewport, int bbox[4]);
293
295 ~vtkTextActor() override;
296
303
309 int LastSize[2];
311 char* Input;
315
317
318 // Stuff needed to display the image text as a texture map.
321
322 virtual void ComputeRectangle(vtkViewport* viewport);
323
337 virtual int UpdateRectangle(vtkViewport* viewport);
338
339private:
340 vtkTextActor(const vtkTextActor&) = delete;
341 void operator=(const vtkTextActor&) = delete;
342};
343
344#endif
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:40
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
represent surface properties of a 2D image
vtkTextProperty * TextProperty
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some translucent polygonal geometry?
static int SetConstrainedFontSize(vtkTextActor *, vtkViewport *, int targetWidth, int targetHeight)
Set and return the font size required to make this mapper fit in a given target rectangle (width x he...
static vtkTextActor * New()
Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8,...
int GetAlignmentPoint()
This method is being deprecated.
double FormerOrientation
void SetOrientation(float orientation)
Counterclockwise rotation around the Alignment point.
float MaximumLineHeight
void ShallowCopy(vtkProp *prop) override
Shallow copy of this text actor.
int RenderOverlay(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
virtual bool RenderImage(vtkTextProperty *tprop, vtkViewport *viewport)
Render Input to Image using the supplied font property.
vtkTransform * Transform
vtkTextProperty * ScaledTextProperty
int RenderOpaqueGeometry(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
char * GetInput()
Set the text string to be displayed.
void SetInput(const char *inputString)
Set the text string to be displayed.
virtual int UpdateRectangle(vtkViewport *viewport)
Ensure that Rectangle and RectanglePoints are valid and up-to-date.
void SetAlignmentPoint(int point)
This method is being deprecated.
virtual bool GetImageBoundingBox(vtkTextProperty *tprop, vtkViewport *viewport, int bbox[4])
Get the bounding box for Input using the supplied font property.
~vtkTextActor() override
int LastOrigin[2]
vtkImageData * ImageData
vtkTextRenderer * TextRenderer
vtkPolyData * Rectangle
vtkTimeStamp BuildTime
virtual void ComputeRectangle(vtkViewport *viewport)
double FontScaleExponent
void SetTextScaleModeToProp()
Set how text should be scaled.
virtual void SetNonLinearFontScale(double exponent, int target)
Enable non-linear scaling of font sizes.
virtual void GetSize(vtkViewport *vport, double size[2])
Syntactic sugar to get the size of text instead of the entire bounding box.
void SetTextScaleModeToViewport()
Set how text should be scaled.
vtkPoints * RectanglePoints
virtual void SetTextScaleMode(int)
Set how text should be scaled.
static float GetFontScale(vtkViewport *viewport)
Provide a font scaling based on a viewport.
virtual void SetTextProperty(vtkTextProperty *p)
Set/Get the text property.
vtkTypeBool UseBorderAlign
virtual int SetConstrainedFontSize(vtkViewport *, int targetWidth, int targetHeight)
Set and return the font size required to make this mapper fit in a given target rectangle (width x he...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetTextScaleModeToNone()
Set how text should be scaled.
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
static int SetMultipleConstrainedFontSize(vtkViewport *, int targetWidth, int targetHeight, vtkTextActor **actors, int nbOfActors, int *maxResultingSize)
Set and return the font size required to make each element of an array of mappers fit in a given rect...
int MinimumSize[2]
void SpecifiedToDisplay(double *pos, vtkViewport *vport, int specified)
This is just a simple coordinate conversion method used in the render process.
void DisplayToSpecified(double *pos, vtkViewport *vport, int specified)
This is just a simple coordinate conversion method used in the render process.
virtual void ComputeScaledFont(vtkViewport *viewport)
Compute the scale the font should be given the viewport.
virtual void GetBoundingBox(vtkViewport *vport, double bbox[4])
Return the bounding box coordinates of the text in pixels.
represent text properties.
Interface for generating images and path data from string data, using multiple backends.
record modification and/or execution time
describes linear transformations via a 4x4 matrix
abstract specification for Viewports
Definition vtkViewport.h:56
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
int vtkTypeBool
Definition vtkABI.h:69
boost::graph_traits< vtkGraph * >::vertex_descriptor target(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)