vtkMatplotlibMathTextUtilities.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkMatplotlibMathTextUtilities_h
#define vtkMatplotlibMathTextUtilities_h
 
#include "vtkMathTextUtilities.h"
#include "vtkRenderingMatplotlibModule.h" // For export macro
 
#include <cstdint> // for std::uint64_t
#include <vector>  // for std::vector
 
struct _object;
typedef struct _object PyObject;
 
VTK_ABI_NAMESPACE_BEGIN
class vtkImageData;
class vtkPath;
class vtkPythonInterpreter;
class vtkSmartPyObject;
class vtkTextProperty;
struct TextColors;
 
class VTKRENDERINGMATPLOTLIB_EXPORT vtkMatplotlibMathTextUtilities : public vtkMathTextUtilities
{
public:
  vtkTypeMacro(vtkMatplotlibMathTextUtilities, vtkMathTextUtilities);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkMatplotlibMathTextUtilities* New();
 
  bool IsAvailable() override;
 
  bool GetBoundingBox(vtkTextProperty* tprop, const char* str, int dpi, int bbox[4]) override;
 
  bool GetMetrics(
    vtkTextProperty* tprop, const char* str, int dpi, vtkTextRenderer::Metrics& metrics) override;
 
  bool RenderString(const char* str, vtkImageData* image, vtkTextProperty* tprop, int dpi,
    int textDims[2] = nullptr) override;
 
  bool StringToPath(const char* str, vtkPath* path, vtkTextProperty* tprop, int dpi) override;
 
 
  void SetScaleToPowerOfTwo(bool val) override;
  bool GetScaleToPowerOfTwo() override;
 
protected:
  vtkMatplotlibMathTextUtilities();
  ~vtkMatplotlibMathTextUtilities() override;
 
  bool InitializeMaskParser();
  bool InitializePathParser();
  bool InitializeFontPropertiesClass();
 
  bool CheckForError();
  bool CheckForError(PyObject* object);
 
  void FindAndReplaceInString(
    std::string& str, const std::string& strToFind, const std::string& replacementStr);
 
  static constexpr const char* PipeProtectString = "VTK_PROTECT_PIPE";
 
  void ComputeTextColors(vtkTextProperty* tprop, TextColors& tcolors);
 
  bool SetMathTextFont(vtkTextProperty* tprop);
 
  PyObject* GetFontProperties(vtkTextProperty* tprop);
 
  void CleanupPythonObjects();
 
  vtkPythonInterpreter* Interpreter;
  PyObject* MaskParser;
  PyObject* PathParser;
  PyObject* FontPropertiesClass;
 
  static void GetJustifiedBBox(int rows, int cols, vtkTextProperty* tprop, int bbox[4]);
 
  // Rotate the 4 2D corner points by the specified angle (degrees) around the
  // origin and calculate the bounding box
  static void RotateCorners(double angleDeg, double corners[4][2], double bbox[4]);
 
  bool ScaleToPowerOfTwo;
  bool PrepareImageData(vtkImageData* data, int bbox[4]);
 
  std::vector<int> VerticalLinesPosition;
  std::vector<int> HorizontalLinesPosition;
 
private:
  vtkMatplotlibMathTextUtilities(const vtkMatplotlibMathTextUtilities&) = delete;
  void operator=(const vtkMatplotlibMathTextUtilities&) = delete;
 
  enum Availability
  {
    NOT_TESTED = 0,
    AVAILABLE,
    UNAVAILABLE
  };
 
  static Availability CheckMPLAvailability();
 
 
  static Availability MPLMathTextAvailable;
 
  typedef std::vector<std::vector<std::string>> GridOfStrings;
 
  bool ParseString(const char* str, GridOfStrings& strGrid, std::size_t& maxNumberOfCells);
 
  bool ComputeRowsAndCols(const GridOfStrings& strGrid, const std::size_t& maxNumberOfCells,
    vtkTextProperty* tprop, PyObject* pyFontProp, int dpi, std::uint64_t& rows,
    std::uint64_t& cols);
 
  bool ComputeCellRowsAndCols(const char* cellStr, PyObject* pyFontProp, int dpi,
    std::uint64_t& rows, std::uint64_t& cols, vtkSmartPyObject* list);
 
  bool RenderOneCell(vtkImageData* image, int bbox[4], std::int64_t rowStart, std::int64_t colStart,
    vtkSmartPyObject& pythonData, std::uint64_t pythonRows, std::uint64_t pythonCols,
    std::uint64_t cellRows, std::uint64_t cellCols, vtkTextProperty* tprop,
    const TextColors& tcolors);
 
  bool DrawInteriorLines(vtkImageData* image, int bbox[4], vtkTextProperty* tprop);
};
 
VTK_ABI_NAMESPACE_END
#endif