VTK  9.1.0
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=========================================================================*/
47#ifndef vtkMatplotlibMathTextUtilities_h
48#define vtkMatplotlibMathTextUtilities_h
49
51#include "vtkRenderingMatplotlibModule.h" // For export macro
52
53#include <vector> // for std::vector
54
55struct _object;
56typedef struct _object PyObject;
57class vtkSmartPyObject;
58class vtkImageData;
59class vtkPath;
60class vtkPythonInterpreter;
61class vtkTextProperty;
62struct TextColors;
63
64class VTKRENDERINGMATPLOTLIB_EXPORT vtkMatplotlibMathTextUtilities : public vtkMathTextUtilities
65{
66public:
68 void PrintSelf(ostream& os, vtkIndent indent) override;
69
71
72 bool IsAvailable() override;
73
81 bool GetBoundingBox(vtkTextProperty* tprop, const char* str, int dpi, int bbox[4]) override;
82
84 vtkTextProperty* tprop, const char* str, int dpi, vtkTextRenderer::Metrics& metrics) override;
85
97 bool RenderString(const char* str, vtkImageData* image, vtkTextProperty* tprop, int dpi,
98 int textDims[2] = nullptr) override;
99
107 bool StringToPath(const char* str, vtkPath* path, vtkTextProperty* tprop, int dpi) override;
108
110
115 void SetScaleToPowerOfTwo(bool val) override;
116 bool GetScaleToPowerOfTwo() override;
118
119protected:
122
126
128 bool CheckForError(PyObject* object);
129
136 std::string& str, const std::string& strToFind, const std::string& replacementStr);
137
138 static constexpr const char* PipeProtectString = "VTK_PROTECT_PIPE";
139
144 void ComputeTextColors(vtkTextProperty* tprop, TextColors& tcolors);
145
150
156
163
164 vtkPythonInterpreter* Interpreter;
168
169 static void GetJustifiedBBox(int rows, int cols, vtkTextProperty* tprop, int bbox[4]);
170
171 // Rotate the 4 2D corner points by the specified angle (degrees) around the
172 // origin and calculate the bounding box
173 static void RotateCorners(double angleDeg, double corners[4][2], double bbox[4]);
174
176 bool PrepareImageData(vtkImageData* data, int bbox[4]);
177
178private:
180 void operator=(const vtkMatplotlibMathTextUtilities&) = delete;
181
186 enum Availability
187 {
188 NOT_TESTED = 0,
189 AVAILABLE,
190 UNAVAILABLE
191 };
192
199 static Availability CheckMPLAvailability();
200
202
205 static Availability MPLMathTextAvailable;
207
208 typedef std::vector<std::vector<std::string>> GridOfStrings;
209
216 bool ParseString(const char* str, GridOfStrings& strGrid, std::size_t& maxNumberOfCells);
217
224 bool ComputeRowsAndCols(const GridOfStrings& strGrid, const std::size_t& maxNumberOfCells,
225 vtkTextProperty* tprop, PyObject* pyFontProp, int dpi, std::uint64_t& rows,
226 std::uint64_t& cols);
227
233 bool ComputeCellRowsAndCols(const char* cellStr, PyObject* pyFontProp, int dpi,
234 std::uint64_t& rows, std::uint64_t& cols, vtkSmartPyObject* list);
235
241 bool RenderOneCell(vtkImageData* image, int bbox[4], const std::int64_t rowStart,
242 const std::int64_t colStart, vtkSmartPyObject& pythonData, const std::uint64_t pythonRows,
243 const std::uint64_t pythonCols, const std::uint64_t cellRows, const std::uint64_t cellCols,
244 vtkTextProperty* tprop, const TextColors& tcolors);
245};
246
247#endif
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
a simple class to control print indentation
Definition: vtkIndent.h:113
Abstract interface to equation rendering.
Access to MatPlotLib MathText rendering.
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 occurence 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
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