VTK  9.3.20240612
vtkContext2D.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
3
40#ifndef vtkContext2D_h
41#define vtkContext2D_h
42
43#include "vtkObject.h"
44#include "vtkRenderingContext2DModule.h" // For export macro
45
46#include <cstdint> // For std::uintptr_t
47
48VTK_ABI_NAMESPACE_BEGIN
49class vtkWindow;
50
51class vtkContext3D;
52class vtkStdString;
53class vtkTextProperty;
54
55class vtkPoints2D;
56class vtkDataArray;
57class vtkVector2f;
58class vtkRectf;
61class vtkPen;
62class vtkBrush;
63class vtkImageData;
64class vtkPolyData;
65class vtkTransform2D;
67
68class VTKRENDERINGCONTEXT2D_EXPORT vtkContext2D : public vtkObject
69{
70public:
71 vtkTypeMacro(vtkContext2D, vtkObject);
72 void PrintSelf(ostream& os, vtkIndent indent) override;
73
77 static vtkContext2D* New();
78
85
86 vtkGetObjectMacro(Device, vtkContextDevice2D);
87
93 bool End();
94
98 bool GetBufferIdMode() const;
99
107
115
119 void DrawLine(float x1, float y1, float x2, float y2);
120
124 void DrawLine(float p[4]);
125
130 void DrawLine(vtkPoints2D* points);
131
135 void DrawPoly(float* x, float* y, int n);
136
141 void DrawPoly(vtkPoints2D* points);
142
148 void DrawPoly(float* points, int n);
149
156 void DrawPoly(float* points, int n, unsigned char* colors, int nc_comps);
157
162 void DrawLines(vtkPoints2D* points);
163
168 void DrawLines(float* points, int n);
169
173 void DrawPoint(float x, float y);
174
178 void DrawPoints(float* x, float* y, int n);
179
184 void DrawPoints(vtkPoints2D* points);
186 vtkDataArray* positions, vtkUnsignedCharArray* colors, std::uintptr_t cacheIdentifier);
187
193 void DrawPoints(float* points, int n);
194
201
203
211 vtkImageData* sprite, float* points, int n, unsigned char* colors, int nc_comps);
213 std::uintptr_t cacheIdentifier);
215
221 void DrawPointSprites(vtkImageData* sprite, float* points, int n);
222
224
240 virtual void DrawMarkers(
241 int shape, bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
242 virtual void DrawMarkers(int shape, bool highlight, float* points, int n);
243 virtual void DrawMarkers(int shape, bool highlight, vtkPoints2D* points);
244 virtual void DrawMarkers(
245 int shape, bool highlight, vtkPoints2D* points, vtkUnsignedCharArray* colors);
247
251 virtual void DrawMarkers(int shape, bool highlight, vtkDataArray* positions,
252 vtkUnsignedCharArray* colors, std::uintptr_t cacheIdentifier);
253
257 void DrawRect(float x, float y, float w, float h);
258
260
263 void DrawQuad(float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4);
264 void DrawQuad(float* p);
266
268
272 void DrawQuadStrip(float* p, int n);
274
279 void DrawPolygon(float* x, float* y, int n);
280
286
292 void DrawPolygon(float* points, int n);
293
298 void DrawPolygon(float* x, float* y, int n, unsigned char* color, int nc_comps);
299
304 void DrawPolygon(vtkPoints2D* points, unsigned char* color, int nc_comps);
305
311 void DrawPolygon(float* points, int n, unsigned char* color, int nc_comps);
312
318 void DrawEllipse(float x, float y, float rx, float ry);
319
329 float x, float y, float outRadius, float inRadius, float startAngle, float stopAngle);
330
342 void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy,
343 float startAngle, float stopAngle);
344
350 void DrawArc(float x, float y, float r, float startAngle, float stopAngle);
351
358 void DrawEllipticArc(float x, float y, float rX, float rY, float startAngle, float stopAngle);
359
363 void DrawImage(float x, float y, vtkImageData* image);
364
369 void DrawImage(float x, float y, float scale, vtkImageData* image);
370
376 void DrawImage(const vtkRectf& pos, vtkImageData* image);
377
383 float x, float y, vtkPolyData* polyData, vtkUnsignedCharArray* colors, int scalarMode);
384
386
391 void DrawStringRect(vtkPoints2D* rect, const vtkStdString& string);
392 void DrawStringRect(vtkPoints2D* rect, const char* string);
393 void DrawStringRect(const float rect[4], const vtkStdString& string);
394 void DrawStringRect(const float rect[4], const char* string);
396
398
401 void DrawString(vtkPoints2D* point, const vtkStdString& string);
402 void DrawString(float x, float y, const vtkStdString& string);
403 void DrawString(vtkPoints2D* point, const char* string);
404 void DrawString(float x, float y, const char* string);
406
408
417 void ComputeStringBounds(const vtkStdString& string, vtkPoints2D* bounds);
418 void ComputeStringBounds(const vtkStdString& string, float bounds[4]);
419 void ComputeStringBounds(const char* string, vtkPoints2D* bounds);
420 void ComputeStringBounds(const char* string, float bounds[4]);
422
427 void ComputeJustifiedStringBounds(const char* string, float bounds[4]);
428
435 int ComputeFontSizeForBoundedString(const vtkStdString& string, float width, float height);
436
438
445 void DrawMathTextString(vtkPoints2D* point, const vtkStdString& string);
446 void DrawMathTextString(float x, float y, const vtkStdString& string);
447 void DrawMathTextString(vtkPoints2D* point, const char* string);
448 void DrawMathTextString(float x, float y, const char* string);
450
452
461 vtkPoints2D* point, const vtkStdString& string, const vtkStdString& fallback);
463 float x, float y, const vtkStdString& string, const vtkStdString& fallback);
464 void DrawMathTextString(vtkPoints2D* point, const char* string, const char* fallback);
465 void DrawMathTextString(float x, float y, const char* string, const char* fallback);
467
472
478 void ApplyPen(vtkPen* pen);
479
486
492 void ApplyBrush(vtkBrush* brush);
493
499
506
511
517 void SetTransform(vtkTransform2D* transform);
518
523
531
533
538 void PopMatrix();
540
545
551 static int FloatToInt(float x);
552
554
558 vtkGetObjectMacro(Context3D, vtkContext3D);
559 virtual void SetContext3D(vtkContext3D* context);
561
562protected:
564 ~vtkContext2D() override;
565
566 vtkContextDevice2D* Device; // The underlying device
567 vtkTransform2D* Transform; // Current transform
568
570 vtkContext3D* Context3D; // May be very temporary - get at a 3D version.
571
572private:
573 vtkContext2D(const vtkContext2D&) = delete;
574 void operator=(const vtkContext2D&) = delete;
575
582 vtkVector2f CalculateTextPosition(vtkPoints2D* rect);
583
590 vtkVector2f CalculateTextPosition(const float rect[4]);
591};
592
593inline int vtkContext2D::FloatToInt(float x)
594{
595 // Use a tolerance of 1/256 of a pixel when converting.
596 // A float has only 24 bits of precision, so we cannot
597 // make the tolerance too small. For example, a tolerance
598 // of 2^-8 means that the tolerance will be significant
599 // for float values up to 2^16 or 65536.0. But a
600 // tolerance of 2^-16 would only be significant for
601 // float values up to 2^8 or 256.0. A small tolerance
602 // disappears into insignificance when added to a large float.
603 float tol = 0.00390625; // 1.0/256.0
604 tol = (x >= 0 ? tol : -tol);
605 return static_cast<int>(x + tol);
606}
607
608VTK_ABI_NAMESPACE_END
609#endif // vtkContext2D_h
2D array of ids, used for picking.
provides a brush that fills shapes drawn by vtkContext2D.
Definition vtkBrush.h:90
Class for drawing 2D primitives to a graphical context.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void DrawString(float x, float y, const vtkStdString &string)
Draw some text to the screen.
static int FloatToInt(float x)
Float to int conversion, performs truncation but with a rounding tolerance for float values that are ...
void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy, float startAngle, float stopAngle)
Draw an elliptic wedge with center at x, y, outer radii outRx, outRy, inner radii inRx,...
virtual void DrawMarkers(int shape, bool highlight, vtkDataArray *positions, vtkUnsignedCharArray *colors, std::uintptr_t cacheIdentifier)
Cached draw command for markers.
~vtkContext2D() override
void DrawPoints(vtkDataArray *positions, vtkUnsignedCharArray *colors, std::uintptr_t cacheIdentifier)
void SetTransform(vtkTransform2D *transform)
Set the transform for the context, the underlying device will use the matrix of the transform.
void DrawString(float x, float y, const char *string)
Draw some text to the screen.
void DrawMathTextString(vtkPoints2D *point, const vtkStdString &string)
Draw a MathText formatted equation to the screen.
void DrawArc(float x, float y, float r, float startAngle, float stopAngle)
Draw a circular arc with center at x,y with radius r between angles startAngle and stopAngle (express...
void DrawPoly(float *x, float *y, int n)
Draw a poly line between the specified points.
void DrawStringRect(vtkPoints2D *rect, const vtkStdString &string)
Draw some text to the screen in a bounding rectangle with the alignment of the text properties respec...
vtkBrush * GetBrush()
Get the pen which controls the outlines of shapes as well as lines, points and related primitives.
void DrawPoints(float *points, int n)
Draw a poly line between the specified points, where the float array is of size 2*n and the points ar...
void DrawQuadStrip(vtkPoints2D *points)
Draw a strip of quads.
vtkPen * GetPen()
Get the pen which controls the outlines of shapes, as well as lines, points and related primitives.
void ComputeStringBounds(const char *string, vtkPoints2D *bounds)
Compute the bounds of the supplied string.
void DrawMathTextString(float x, float y, const vtkStdString &string)
Draw a MathText formatted equation to the screen.
void DrawPointSprites(vtkImageData *sprite, vtkPoints2D *points)
Draw a series of point sprites, images centred at the points supplied.
void DrawPoint(float x, float y)
Draw a point at the supplied x and y coordinate.
void DrawPolygon(float *x, float *y, int n, unsigned char *color, int nc_comps)
Draw a polygon specified specified by the points using the x and y arrays supplied.
void DrawWedge(float x, float y, float outRadius, float inRadius, float startAngle, float stopAngle)
Draw a circular wedge with center at x, y, outer radius outRadius, inner radius inRadius between angl...
void DrawPointSprites(vtkImageData *sprite, vtkPoints2D *points, vtkUnsignedCharArray *colors)
Draw a series of point sprites, images centred at the points supplied.
bool GetBufferIdMode() const
Tell if the context is in BufferId creation mode.
vtkTransform2D * Transform
void ApplyPen(vtkPen *pen)
Apply the supplied pen which controls the outlines of shapes, as well as lines, points and related pr...
void AppendTransform(vtkTransform2D *transform)
Append the transform for the context, the underlying device will use the matrix of the transform.
void ApplyId(vtkIdType id)
Apply id as a color.
void PushMatrix()
Push/pop the transformation matrix for the painter (sets the underlying matrix for the device when av...
bool Begin(vtkContextDevice2D *device)
Begin painting on a vtkContextDevice2D, no painting can occur before this call has been made.
void DrawString(vtkPoints2D *point, const vtkStdString &string)
Draw some text to the screen.
void DrawEllipticArc(float x, float y, float rX, float rY, float startAngle, float stopAngle)
Draw an elliptic arc with center at x,y with radii rX and rY between angles startAngle and stopAngle ...
void ComputeStringBounds(const char *string, float bounds[4])
Compute the bounds of the supplied string.
void DrawQuad(float *p)
Draw a quadrilateral at the specified points (4 points, 8 floats in x, y).
void DrawRect(float x, float y, float w, float h)
Draw a rectangle with origin at x, y and width w, height h.
static vtkContext2D * New()
Creates a 2D Painter object.
vtkTextProperty * GetTextProp()
Get the text properties object for the vtkContext2D.
void DrawPoly(float *points, int n, unsigned char *colors, int nc_comps)
Draw a poly line between the specified points, where the float array is of size 2*n and the points ar...
bool End()
Ends painting on the device, you would not usually need to call this as it should be called by the de...
vtkTransform2D * GetTransform()
Compute the current transform applied to the context.
void DrawStringRect(const float rect[4], const vtkStdString &string)
Draw some text to the screen in a bounding rectangle with the alignment of the text properties respec...
void DrawImage(const vtkRectf &pos, vtkImageData *image)
Draw the supplied image at the given position.
void DrawMathTextString(vtkPoints2D *point, const char *string)
Draw a MathText formatted equation to the screen.
void DrawImage(float x, float y, vtkImageData *image)
Draw the supplied image at the given x, y location (bottom corner).
void DrawMathTextString(float x, float y, const char *string)
Draw a MathText formatted equation to the screen.
void DrawPolygon(float *points, int n)
Draw a polygon defined by the specified points, where the float array is of size 2*n and the points a...
void DrawPolygon(float *points, int n, unsigned char *color, int nc_comps)
Draw a polygon defined by the specified points, where the float array is of size 2*n and the points a...
int ComputeFontSizeForBoundedString(const vtkStdString &string, float width, float height)
Calculate the largest possible font size where the supplied string will fit within the specified boun...
void DrawPointSprites(vtkImageData *sprite, float *points, int n)
Draw a series of point sprites, images centred at the points supplied.
void ComputeStringBounds(const vtkStdString &string, float bounds[4])
Compute the bounds of the supplied string.
void DrawPoints(float *x, float *y, int n)
Draw the specified number of points using the x and y arrays supplied.
virtual void DrawMarkers(int shape, bool highlight, vtkPoints2D *points)
Draw a series of markers centered at the points supplied.
void DrawPolygon(float *x, float *y, int n)
Draw a polygon specified specified by the points using the x and y arrays supplied.
void BufferIdModeBegin(vtkAbstractContextBufferId *bufferId)
Start BufferId creation Mode.
void DrawStringRect(const float rect[4], const char *string)
Draw some text to the screen in a bounding rectangle with the alignment of the text properties respec...
bool MathTextIsSupported()
Return true if MathText rendering available on the current device.
void DrawPoly(vtkPoints2D *points)
Draw a poly line between the specified points - fastest code path due to memory layout of the coordin...
void DrawMathTextString(vtkPoints2D *point, const char *string, const char *fallback)
Draw a MathText formatted equation to the screen.
void ApplyTextProp(vtkTextProperty *prop)
Apply the supplied text property which controls how text is rendered.
void DrawPointSprites(vtkImageData *sprite, float *points, int n, unsigned char *colors, int nc_comps)
Draw a series of point sprites, images centred at the points supplied.
virtual void DrawMarkers(int shape, bool highlight, float *points, int n)
Draw a series of markers centered at the points supplied.
void DrawLine(float p[4])
Draw a line between the specified points.
void DrawMathTextString(float x, float y, const char *string, const char *fallback)
Draw a MathText formatted equation to the screen.
void ComputeJustifiedStringBounds(const char *string, float bounds[4])
Compute the bounds of the supplied string while taking into account the justification and rotation of...
void DrawPolygon(vtkPoints2D *points)
Draw a polygon defined by the specified points - fastest code path due to memory layout of the coordi...
vtkAbstractContextBufferId * BufferId
void DrawLine(vtkPoints2D *points)
Draw a line between the specified points.
virtual void SetContext3D(vtkContext3D *context)
Get the vtkContext3D device, in order to do some 3D rendering.
void ApplyBrush(vtkBrush *brush)
Apply the supplied brush which controls the outlines of shapes, as well as lines, points and related ...
void DrawStringRect(vtkPoints2D *rect, const char *string)
Draw some text to the screen in a bounding rectangle with the alignment of the text properties respec...
void ComputeStringBounds(const vtkStdString &string, vtkPoints2D *bounds)
Compute the bounds of the supplied string.
void DrawImage(float x, float y, float scale, vtkImageData *image)
Draw the supplied image at the given x, y location (bottom corner).
void BufferIdModeEnd()
Finalize BufferId creation Mode.
void DrawQuad(float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4)
Draw a quadrilateral at the specified points (4 points, 8 floats in x, y).
void DrawQuadStrip(float *p, int n)
Draw a strip of quads.
void DrawPoly(float *points, int n)
Draw a poly line between the specified points, where the float array is of size 2*n and the points ar...
vtkContextDevice2D * Device
void DrawEllipse(float x, float y, float rx, float ry)
Draw an ellipse with center at x, y and radii rx, ry.
void DrawLines(float *points, int n)
Draw multiple lines between the specified pairs of points.
void DrawMathTextString(vtkPoints2D *point, const vtkStdString &string, const vtkStdString &fallback)
Draw a MathText formatted equation to the screen.
void DrawLines(vtkPoints2D *points)
Draw multiple lines between the specified pairs of points.
void DrawMathTextString(float x, float y, const vtkStdString &string, const vtkStdString &fallback)
Draw a MathText formatted equation to the screen.
void DrawPoints(vtkPoints2D *points)
Draw a poly line between the specified points - fastest code path due to memory layout of the coordin...
vtkContext3D * Context3D
virtual void DrawMarkers(int shape, bool highlight, vtkPoints2D *points, vtkUnsignedCharArray *colors)
Draw a series of markers centered at the points supplied.
void DrawPolyData(float x, float y, vtkPolyData *polyData, vtkUnsignedCharArray *colors, int scalarMode)
Draw the supplied polyData at the given x, y position (bottom corner).
void DrawLine(float x1, float y1, float x2, float y2)
Draw a line between the specified points.
void DrawPointSprites(vtkImageData *sprite, vtkDataArray *positions, vtkUnsignedCharArray *colors, std::uintptr_t cacheIdentifier)
Draw a series of point sprites, images centred at the points supplied.
void DrawString(vtkPoints2D *point, const char *string)
Draw some text to the screen.
virtual void DrawMarkers(int shape, bool highlight, float *points, int n, unsigned char *colors, int nc_comps)
Draw a series of markers centered at the points supplied.
void DrawPolygon(vtkPoints2D *points, unsigned char *color, int nc_comps)
Draw a polygon defined by the specified points - fastest code path due to memory layout of the coordi...
void PopMatrix()
Push/pop the transformation matrix for the painter (sets the underlying matrix for the device when av...
Class for drawing 3D primitives to a graphical context.
Abstract class for drawing 2D primitives.
abstract superclass for arrays of numeric data
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:108
abstract base class for most VTK objects
Definition vtkObject.h:162
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition vtkPen.h:79
represent and manipulate 2D points
Definition vtkPoints2D.h:27
concrete dataset represents vertices, lines, polygons, and triangle strips
Computes the portion of a dataset which is inside a selection.
Wrapper around std::string to keep symbols short.
represent text properties.
describes linear transformations via a 3x3 matrix
dynamic, self-adjusting array of unsigned char
window superclass for vtkRenderWindow
Definition vtkWindow.h:48
int vtkIdType
Definition vtkType.h:315