VTK  9.0.1
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 =========================================================================*/
28 #ifndef vtkMatplotlibMathTextUtilities_h
29 #define vtkMatplotlibMathTextUtilities_h
30 
31 #include "vtkMathTextUtilities.h"
32 #include "vtkRenderingMatplotlibModule.h" // For export macro
33 
34 struct _object;
35 typedef struct _object PyObject;
36 class vtkImageData;
37 class vtkPath;
38 class vtkPythonInterpreter;
39 class vtkTextProperty;
40 
41 class VTKRENDERINGMATPLOTLIB_EXPORT vtkMatplotlibMathTextUtilities : public vtkMathTextUtilities
42 {
43 public:
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
48 
49  bool IsAvailable() override;
50 
58  bool GetBoundingBox(vtkTextProperty* tprop, const char* str, int dpi, int bbox[4]) override;
59 
60  bool GetMetrics(
61  vtkTextProperty* tprop, const char* str, int dpi, vtkTextRenderer::Metrics& metrics) override;
62 
73  bool RenderString(const char* str, vtkImageData* data, vtkTextProperty* tprop, int dpi,
74  int textDims[2] = NULL) override;
75 
82  bool StringToPath(const char* str, vtkPath* path, vtkTextProperty* tprop, int dpi) override;
83 
85 
90  void SetScaleToPowerOfTwo(bool val) override;
91  bool GetScaleToPowerOfTwo() override;
93 
94 protected:
97 
98  bool InitializeMaskParser();
99  bool InitializePathParser();
100  bool InitializeFontPropertiesClass();
101 
102  bool CheckForError();
103  bool CheckForError(PyObject* object);
104 
109  PyObject* GetFontProperties(vtkTextProperty* tprop);
110 
116  void CleanupPythonObjects();
117 
118  vtkPythonInterpreter* Interpreter;
122 
123  static void GetJustifiedBBox(int rows, int cols, vtkTextProperty* tprop, int bbox[4]);
124 
125  // Rotate the 4 2D corner points by the specified angle (degrees) around the
126  // origin and calculate the bounding box
127  static void RotateCorners(double angleDeg, double corners[4][2], double bbox[4]);
128 
130  bool PrepareImageData(vtkImageData* data, int bbox[4]);
131 
132 private:
134  void operator=(const vtkMatplotlibMathTextUtilities&) = delete;
135 
140  enum Availability
141  {
142  NOT_TESTED = 0,
143  AVAILABLE,
144  UNAVAILABLE
145  };
146 
153  static Availability CheckMPLAvailability();
154 
156 
159  static Availability MPLMathTextAvailable;
161 };
162 
163 #endif
vtkMathTextUtilities::IsAvailable
virtual bool IsAvailable()
Returns true if mathtext rendering is available.
Definition: vtkMathTextUtilities.h:60
vtkMatplotlibMathTextUtilities
Access to MatPlotLib MathText rendering.
Definition: vtkMatplotlibMathTextUtilities.h:41
vtkMathTextUtilities::GetMetrics
virtual bool GetMetrics(vtkTextProperty *tprop, const char *str, int dpi, vtkTextRenderer::Metrics &metrics)=0
Return the metrics for the rendered str, tprop, and dpi.
vtkX3D::data
@ data
Definition: vtkX3D.h:321
vtkPath
concrete dataset representing a path defined by Bezier curves.
Definition: vtkPath.h:32
vtkMatplotlibMathTextUtilities::MaskParser
PyObject * MaskParser
Definition: vtkMatplotlibMathTextUtilities.h:119
vtkMathTextUtilities
Abstract interface to equation rendering.
Definition: vtkMathTextUtilities.h:51
PyObject
struct _object PyObject
Definition: vtkMatplotlibMathTextUtilities.h:35
vtkMathTextUtilities::GetScaleToPowerOfTwo
virtual bool GetScaleToPowerOfTwo()=0
Set to true if the graphics implementation requires texture image dimensions to be a power of two.
vtkMathTextUtilities::StringToPath
virtual bool StringToPath(const char *str, vtkPath *path, vtkTextProperty *tprop, int dpi)=0
Parse the MathText expression in str and fill path with a contour of the glyphs.
vtkMathTextUtilities::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:41
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkMatplotlibMathTextUtilities::FontPropertiesClass
PyObject * FontPropertiesClass
Definition: vtkMatplotlibMathTextUtilities.h:121
vtkMatplotlibMathTextUtilities::PathParser
PyObject * PathParser
Definition: vtkMatplotlibMathTextUtilities.h:120
vtkMathTextUtilities::GetBoundingBox
virtual bool GetBoundingBox(vtkTextProperty *tprop, const char *str, int dpi, int bbox[4])=0
Determine the dimensions of the image that RenderString will produce for a given str,...
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:33
vtkMathTextUtilities.h
vtkMathTextUtilities::SetScaleToPowerOfTwo
virtual void SetScaleToPowerOfTwo(bool scale)=0
vtkMathTextUtilities::New
static vtkMathTextUtilities * New()
This is a singleton pattern New.
vtkTextRenderer::Metrics
Definition: vtkTextRenderer.h:76
vtkMatplotlibMathTextUtilities::Interpreter
vtkPythonInterpreter * Interpreter
Definition: vtkMatplotlibMathTextUtilities.h:118
vtkMatplotlibMathTextUtilities::ScaleToPowerOfTwo
bool ScaleToPowerOfTwo
Definition: vtkMatplotlibMathTextUtilities.h:129
vtkMathTextUtilities::RenderString
virtual bool RenderString(const char *str, vtkImageData *data, vtkTextProperty *tprop, int dpi, int textDims[2]=nullptr)=0
Render the given string str into the vtkImageData data with a resolution of dpi.