VTK  9.0.20210616
Public Member Functions | Public Attributes | List of all members
vtkTextRenderer::Metrics Struct Reference

#include <vtkTextRenderer.h>

Collaboration diagram for vtkTextRenderer::Metrics:
[legend]

Public Member Functions

 Metrics ()
 Construct a Metrics object with all members initialized to 0. More...
 

Public Attributes

vtkTuple< int, 4 > BoundingBox
 The axis-aligned bounding box of the rendered text and background, in pixels. More...
 
vtkVector2i TopLeft
 The corners of the rendered text (or background, if applicable), in pixels. More...
 
vtkVector2i TopRight
 The corners of the rendered text (or background, if applicable), in pixels. More...
 
vtkVector2i BottomLeft
 The corners of the rendered text (or background, if applicable), in pixels. More...
 
vtkVector2i BottomRight
 The corners of the rendered text (or background, if applicable), in pixels. More...
 
vtkVector2i Ascent
 Vectors representing the rotated ascent and descent of the text. More...
 
vtkVector2i Descent
 Vectors representing the rotated ascent and descent of the text. More...
 

Detailed Description

Definition at line 77 of file vtkTextRenderer.h.

Constructor & Destructor Documentation

◆ Metrics()

vtkTextRenderer::Metrics::Metrics ( )
inline

Construct a Metrics object with all members initialized to 0.

Definition at line 82 of file vtkTextRenderer.h.

Member Data Documentation

◆ BoundingBox

vtkTuple<int, 4> vtkTextRenderer::Metrics::BoundingBox

The axis-aligned bounding box of the rendered text and background, in pixels.

The origin of the bounding box is the anchor point of the data when considering justification. Layout is { xMin, xMax, yMin, yMax }.

Definition at line 98 of file vtkTextRenderer.h.

◆ TopLeft

vtkVector2i vtkTextRenderer::Metrics::TopLeft

The corners of the rendered text (or background, if applicable), in pixels.

Uses the same origin as BoundingBox.

Definition at line 105 of file vtkTextRenderer.h.

◆ TopRight

vtkVector2i vtkTextRenderer::Metrics::TopRight

The corners of the rendered text (or background, if applicable), in pixels.

Uses the same origin as BoundingBox.

Definition at line 106 of file vtkTextRenderer.h.

◆ BottomLeft

vtkVector2i vtkTextRenderer::Metrics::BottomLeft

The corners of the rendered text (or background, if applicable), in pixels.

Uses the same origin as BoundingBox.

Definition at line 107 of file vtkTextRenderer.h.

◆ BottomRight

vtkVector2i vtkTextRenderer::Metrics::BottomRight

The corners of the rendered text (or background, if applicable), in pixels.

Uses the same origin as BoundingBox.

Definition at line 108 of file vtkTextRenderer.h.

◆ Ascent

vtkVector2i vtkTextRenderer::Metrics::Ascent

Vectors representing the rotated ascent and descent of the text.

This is the distance above or below the baseline. Not all backends support this, and may leave these vectors set to 0.

Definition at line 117 of file vtkTextRenderer.h.

◆ Descent

vtkVector2i vtkTextRenderer::Metrics::Descent

Vectors representing the rotated ascent and descent of the text.

This is the distance above or below the baseline. Not all backends support this, and may leave these vectors set to 0.

Definition at line 118 of file vtkTextRenderer.h.


The documentation for this struct was generated from the following file: