You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tools/Win64/VTK/include/vtk-9.0/vtkTextRendererStringToImage.h

93 lines
3.3 KiB
C

/*=========================================================================
Program: Visualization Toolkit
Module: vtkTextRendererStringToImage.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkTextRendererStringToImage
* @brief uses vtkTextRenderer to render the
* supplied text to an image.
*/
#ifndef vtkTextRendererStringToImage_h
#define vtkTextRendererStringToImage_h
#include "vtkRenderingFreeTypeModule.h" // For export macro
#include "vtkStringToImage.h"
class VTKRENDERINGFREETYPE_EXPORT vtkTextRendererStringToImage : public vtkStringToImage
{
public:
vtkTypeMacro(vtkTextRendererStringToImage, vtkStringToImage);
void PrintSelf(ostream& os, vtkIndent indent) override;
static vtkTextRendererStringToImage* New();
//@{
/**
* Given a text property and a string, get the bounding box [xmin, xmax] x
* [ymin, ymax]. Note that this is the bounding box of the area
* where actual pixels will be written, given a text/pen/baseline location
* of (0,0).
* For example, if the string starts with a 'space', or depending on the
* orientation, you can end up with a [-20, -10] x [5, 10] bbox (the math
* to get the real bbox is straightforward).
* Return 1 on success, 0 otherwise.
* You can use IsBoundingBoxValid() to test if the computed bbox
* is valid (it may not if GetBoundingBox() failed or if the string
* was empty).
*/
vtkVector2i GetBounds(
vtkTextProperty* property, const vtkUnicodeString& string, int dpi) override;
vtkVector2i GetBounds(vtkTextProperty* property, const vtkStdString& string, int dpi) override;
//@}
//@{
/**
* Given a text property and a string, this function initializes the
* vtkImageData *data and renders it in a vtkImageData. textDims, if provided,
* will be overwritten by the pixel width and height of the rendered string.
* This is useful when ScaleToPowerOfTwo is true, and the image dimensions may
* not match the dimensions of the rendered text.
*/
int RenderString(vtkTextProperty* property, const vtkUnicodeString& string, int dpi,
vtkImageData* data, int textDims[2] = nullptr) override;
int RenderString(vtkTextProperty* property, const vtkStdString& string, int dpi,
vtkImageData* data, int textDims[2] = nullptr) override;
//@}
/**
* Should we produce images at powers of 2, makes rendering on old OpenGL
* hardware easier. Default is false.
*/
void SetScaleToPowerOfTwo(bool scale) override;
/**
* Make a deep copy of the supplied utility class.
*/
void DeepCopy(vtkTextRendererStringToImage* utility);
protected:
vtkTextRendererStringToImage();
~vtkTextRendererStringToImage() override;
class Internals;
Internals* Implementation;
private:
vtkTextRendererStringToImage(const vtkTextRendererStringToImage&) = delete;
void operator=(const vtkTextRendererStringToImage&) = delete;
};
#endif // vtkTextRendererStringToImage_h