VTK  9.2.6
vtkMatplotlibMathTextUtilities.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkMatplotlibMathTextUtilities.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=========================================================================*/
45
46#ifndef vtkMatplotlibMathTextUtilities_h
47#define vtkMatplotlibMathTextUtilities_h
48
50#include "vtkRenderingMatplotlibModule.h" // For export macro
51
52#include <vector> // for std::vector
53
54struct _object;
55typedef struct _object PyObject;
56class vtkSmartPyObject;
57class vtkImageData;
58class vtkPath;
59class vtkPythonInterpreter;
60class vtkTextProperty;
61struct TextColors;
62
63class VTKRENDERINGMATPLOTLIB_EXPORT vtkMatplotlibMathTextUtilities : public vtkMathTextUtilities
64{
65public:
67 void PrintSelf(ostream& os, vtkIndent indent) override;
68
70
71 bool IsAvailable() override;
72
80 bool GetBoundingBox(vtkTextProperty* tprop, const char* str, int dpi, int bbox[4]) override;
81
83 vtkTextProperty* tprop, const char* str, int dpi, vtkTextRenderer::Metrics& metrics) override;
84
96 bool RenderString(const char* str, vtkImageData* image, vtkTextProperty* tprop, int dpi,
97 int textDims[2] = nullptr) override;
98
106 bool StringToPath(const char* str, vtkPath* path, vtkTextProperty* tprop, int dpi) override;
107
109
114 void SetScaleToPowerOfTwo(bool val) override;
115 bool GetScaleToPowerOfTwo() override;
117
118protected:
121
125
127 bool CheckForError(PyObject* object);
128
135 std::string& str, const std::string& strToFind, const std::string& replacementStr);
136
137 static constexpr const char* PipeProtectString = "VTK_PROTECT_PIPE";
138
143 void ComputeTextColors(vtkTextProperty* tprop, TextColors& tcolors);
144
149
155
162
163 vtkPythonInterpreter* Interpreter;
167
168 static void GetJustifiedBBox(int rows, int cols, vtkTextProperty* tprop, int bbox[4]);
169
170 // Rotate the 4 2D corner points by the specified angle (degrees) around the
171 // origin and calculate the bounding box
172 static void RotateCorners(double angleDeg, double corners[4][2], double bbox[4]);
173
175 bool PrepareImageData(vtkImageData* data, int bbox[4]);
176
177 std::vector<int> VerticalLinesPosition;
178 std::vector<int> HorizontalLinesPosition;
179
180private:
182 void operator=(const vtkMatplotlibMathTextUtilities&) = delete;
183
188 enum Availability
189 {
190 NOT_TESTED = 0,
191 AVAILABLE,
192 UNAVAILABLE
193 };
194
201 static Availability CheckMPLAvailability();
202
204
207 static Availability MPLMathTextAvailable;
209
210 typedef std::vector<std::vector<std::string>> GridOfStrings;
211
218 bool ParseString(const char* str, GridOfStrings& strGrid, std::size_t& maxNumberOfCells);
219
226 bool ComputeRowsAndCols(const GridOfStrings& strGrid, const std::size_t& maxNumberOfCells,
227 vtkTextProperty* tprop, PyObject* pyFontProp, int dpi, std::uint64_t& rows,
228 std::uint64_t& cols);
229
235 bool ComputeCellRowsAndCols(const char* cellStr, PyObject* pyFontProp, int dpi,
236 std::uint64_t& rows, std::uint64_t& cols, vtkSmartPyObject* list);
237
243 bool RenderOneCell(vtkImageData* image, int bbox[4], const std::int64_t rowStart,
244 const std::int64_t colStart, vtkSmartPyObject& pythonData, const std::uint64_t pythonRows,
245 const std::uint64_t pythonCols, const std::uint64_t cellRows, const std::uint64_t cellCols,
246 vtkTextProperty* tprop, const TextColors& tcolors);
247
251 bool DrawInteriorLines(vtkImageData* image, int bbox[4], vtkTextProperty* tprop);
252};
253
254#endif
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:34
PyObject * GetFontProperties(vtkTextProperty *tprop)
Returns a matplotlib.font_manager.FontProperties PyObject, initialized from the vtkTextProperty tprop...
bool GetBoundingBox(vtkTextProperty *tprop, const char *str, int dpi, int bbox[4]) override
Given a text property and a string, get the bounding box {xmin, xmax, ymin, ymax} of the rendered str...
bool GetMetrics(vtkTextProperty *tprop, const char *str, int dpi, vtkTextRenderer::Metrics &metrics) override
Return the metrics for the rendered str, tprop, and dpi.
void ComputeTextColors(vtkTextProperty *tprop, TextColors &tcolors)
Compute rgba values of the foreground, background and frame of the text property.
void FindAndReplaceInString(std::string &str, const std::string &strToFind, const std::string &replacementStr)
Replace each occurrence of strToFind in str by replacementStr.
bool SetMathTextFont(vtkTextProperty *tprop)
Modify matplotlib.rcParams to customize math text font.
static void GetJustifiedBBox(int rows, int cols, vtkTextProperty *tprop, int bbox[4])
bool CheckForError(PyObject *object)
void CleanupPythonObjects()
Cleanup and destroy any python objects.
bool RenderString(const char *str, vtkImageData *image, vtkTextProperty *tprop, int dpi, int textDims[2]=nullptr) override
Render the given string str into the vtkImageData image with a resolution of dpi.
static vtkMatplotlibMathTextUtilities * New()
bool StringToPath(const char *str, vtkPath *path, vtkTextProperty *tprop, int dpi) override
Parse the MathText expression in str and fill path with a contour of the glyphs.
bool IsAvailable() override
Returns true if mathtext rendering is available.
static void RotateCorners(double angleDeg, double corners[4][2], double bbox[4])
~vtkMatplotlibMathTextUtilities() override
static constexpr const char * PipeProtectString
void SetScaleToPowerOfTwo(bool val) override
Set to true if the graphics implementation requires texture image dimensions to be a power of two.
bool PrepareImageData(vtkImageData *data, int bbox[4])
bool GetScaleToPowerOfTwo() override
Set to true if the graphics implementation requires texture image dimensions to be a power of two.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
concrete dataset representing a path defined by Bezier curves.
Definition vtkPath.h:33
represent text properties.
struct _object PyObject