VTK  9.3.0
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 
21 #ifndef vtkContext2D_h
22 #define vtkContext2D_h
23 
24 #include "vtkObject.h"
25 #include "vtkRenderingContext2DModule.h" // For export macro
26 
27 #include <cstdint> // For std::uintptr_t
28 
29 VTK_ABI_NAMESPACE_BEGIN
30 class vtkWindow;
31 
32 class vtkContext3D;
33 class vtkStdString;
34 class vtkTextProperty;
35 
36 class vtkPoints2D;
37 class vtkDataArray;
38 class vtkVector2f;
39 class vtkRectf;
41 class vtkContextDevice2D;
42 class vtkPen;
43 class vtkBrush;
44 class vtkImageData;
45 class vtkPolyData;
46 class vtkTransform2D;
48 
49 class VTKRENDERINGCONTEXT2D_EXPORT vtkContext2D : public vtkObject
50 {
51 public:
52  vtkTypeMacro(vtkContext2D, vtkObject);
53  void PrintSelf(ostream& os, vtkIndent indent) override;
54 
58  static vtkContext2D* New();
59 
65  bool Begin(vtkContextDevice2D* device);
66 
67  vtkGetObjectMacro(Device, vtkContextDevice2D);
68 
74  bool End();
75 
79  bool GetBufferIdMode() const;
80 
88 
96 
100  void DrawLine(float x1, float y1, float x2, float y2);
101 
105  void DrawLine(float p[4]);
106 
112 
116  void DrawPoly(float* x, float* y, int n);
117 
123 
129  void DrawPoly(float* points, int n);
130 
137  void DrawPoly(float* points, int n, unsigned char* colors, int nc_comps);
138 
144 
149  void DrawLines(float* points, int n);
150 
154  void DrawPoint(float x, float y);
155 
159  void DrawPoints(float* x, float* y, int n);
160 
167  vtkDataArray* positions, vtkUnsignedCharArray* colors, std::uintptr_t cacheIdentifier);
168 
174  void DrawPoints(float* points, int n);
175 
182 
184 
192  vtkImageData* sprite, float* points, int n, unsigned char* colors, int nc_comps);
194  std::uintptr_t cacheIdentifier);
196 
202  void DrawPointSprites(vtkImageData* sprite, float* points, int n);
203 
205 
221  virtual void DrawMarkers(
222  int shape, bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
223  virtual void DrawMarkers(int shape, bool highlight, float* points, int n);
224  virtual void DrawMarkers(int shape, bool highlight, vtkPoints2D* points);
225  virtual void DrawMarkers(
226  int shape, bool highlight, vtkPoints2D* points, vtkUnsignedCharArray* colors);
228 
232  virtual void DrawMarkers(int shape, bool highlight, vtkDataArray* positions,
233  vtkUnsignedCharArray* colors, std::uintptr_t cacheIdentifier);
234 
238  void DrawRect(float x, float y, float w, float h);
239 
241 
244  void DrawQuad(float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4);
245  void DrawQuad(float* p);
247 
249 
253  void DrawQuadStrip(float* p, int n);
255 
260  void DrawPolygon(float* x, float* y, int n);
261 
267 
273  void DrawPolygon(float* points, int n);
274 
279  void DrawPolygon(float* x, float* y, int n, unsigned char* color, int nc_comps);
280 
285  void DrawPolygon(vtkPoints2D* points, unsigned char* color, int nc_comps);
286 
292  void DrawPolygon(float* points, int n, unsigned char* color, int nc_comps);
293 
299  void DrawEllipse(float x, float y, float rx, float ry);
300 
309  void DrawWedge(
310  float x, float y, float outRadius, float inRadius, float startAngle, float stopAngle);
311 
323  void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy,
324  float startAngle, float stopAngle);
325 
331  void DrawArc(float x, float y, float r, float startAngle, float stopAngle);
332 
339  void DrawEllipticArc(float x, float y, float rX, float rY, float startAngle, float stopAngle);
340 
344  void DrawImage(float x, float y, vtkImageData* image);
345 
350  void DrawImage(float x, float y, float scale, vtkImageData* image);
351 
357  void DrawImage(const vtkRectf& pos, vtkImageData* image);
358 
364  float x, float y, vtkPolyData* polyData, vtkUnsignedCharArray* colors, int scalarMode);
365 
367 
372  void DrawStringRect(vtkPoints2D* rect, const vtkStdString& string);
373  void DrawStringRect(vtkPoints2D* rect, const char* string);
374  void DrawStringRect(const float rect[4], const vtkStdString& string);
375  void DrawStringRect(const float rect[4], const char* string);
377 
379 
382  void DrawString(vtkPoints2D* point, const vtkStdString& string);
383  void DrawString(float x, float y, const vtkStdString& string);
384  void DrawString(vtkPoints2D* point, const char* string);
385  void DrawString(float x, float y, const char* string);
387 
389 
398  void ComputeStringBounds(const vtkStdString& string, vtkPoints2D* bounds);
399  void ComputeStringBounds(const vtkStdString& string, float bounds[4]);
400  void ComputeStringBounds(const char* string, vtkPoints2D* bounds);
401  void ComputeStringBounds(const char* string, float bounds[4]);
403 
408  void ComputeJustifiedStringBounds(const char* string, float bounds[4]);
409 
416  int ComputeFontSizeForBoundedString(const vtkStdString& string, float width, float height);
417 
419 
427  void DrawMathTextString(float x, float y, const vtkStdString& string);
428  void DrawMathTextString(vtkPoints2D* point, const char* string);
429  void DrawMathTextString(float x, float y, const char* string);
431 
433 
442  vtkPoints2D* point, const vtkStdString& string, const vtkStdString& fallback);
444  float x, float y, const vtkStdString& string, const vtkStdString& fallback);
445  void DrawMathTextString(vtkPoints2D* point, const char* string, const char* fallback);
446  void DrawMathTextString(float x, float y, const char* string, const char* fallback);
448 
453 
459  void ApplyPen(vtkPen* pen);
460 
467 
473  void ApplyBrush(vtkBrush* brush);
474 
480 
487 
492 
498  void SetTransform(vtkTransform2D* transform);
499 
504 
511  void AppendTransform(vtkTransform2D* transform);
512 
514 
518  void PushMatrix();
519  void PopMatrix();
521 
525  void ApplyId(vtkIdType id);
526 
532  static int FloatToInt(float x);
533 
535 
539  vtkGetObjectMacro(Context3D, vtkContext3D);
540  virtual void SetContext3D(vtkContext3D* context);
542 
543 protected:
545  ~vtkContext2D() override;
546 
547  vtkContextDevice2D* Device; // The underlying device
548  vtkTransform2D* Transform; // Current transform
549 
551  vtkContext3D* Context3D; // May be very temporary - get at a 3D version.
552 
553 private:
554  vtkContext2D(const vtkContext2D&) = delete;
555  void operator=(const vtkContext2D&) = delete;
556 
563  vtkVector2f CalculateTextPosition(vtkPoints2D* rect);
564 
571  vtkVector2f CalculateTextPosition(const float rect[4]);
572 };
573 
574 inline int vtkContext2D::FloatToInt(float x)
575 {
576  // Use a tolerance of 1/256 of a pixel when converting.
577  // A float has only 24 bits of precision, so we cannot
578  // make the tolerance too small. For example, a tolerance
579  // of 2^-8 means that the tolerance will be significant
580  // for float values up to 2^16 or 65536.0. But a
581  // tolerance of 2^-16 would only be significant for
582  // float values up to 2^8 or 256.0. A small tolerance
583  // disappears into insignificance when added to a large float.
584  float tol = 0.00390625; // 1.0/256.0
585  tol = (x >= 0 ? tol : -tol);
586  return static_cast<int>(x + tol);
587 }
588 
589 VTK_ABI_NAMESPACE_END
590 #endif // vtkContext2D_h
2D array of ids, used for picking.
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:30
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:50
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 ...
Definition: vtkContext2D.h:574
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...
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.
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
Definition: vtkContext2D.h:548
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.
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...
vtkPen * GetPen()
Get the pen which controls the outlines of shapes, as well as lines, points and related primitives.
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.
vtkTransform2D * GetTransform()
Compute the current transform applied to the context.
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.
static vtkContext2D * New()
Creates a 2D Painter object.
void DrawPoly(vtkPoints2D *points)
Draw a poly line between the specified points - fastest code path due to memory layout of the coordin...
vtkBrush * GetBrush()
Get the pen which controls the outlines of shapes as well as lines, points and related primitives.
vtkTextProperty * GetTextProp()
Get the text properties object for the vtkContext2D.
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
Definition: vtkContext2D.h:550
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
Definition: vtkContext2D.h:547
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
Definition: vtkContext2D.h:551
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.
Definition: vtkContext3D.h:34
Abstract class for drawing 2D primitives.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:45
topologically and geometrically regular array of data
Definition: vtkImageData.h:43
a simple class to control print indentation
Definition: vtkIndent.h:29
abstract base class for most VTK objects
Definition: vtkObject.h:52
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:29
represent and manipulate 2D points
Definition: vtkPoints2D.h:26
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:80
Computes the portion of a dataset which is inside a selection.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:29
represent text properties.
describes linear transformations via a 3x3 matrix
dynamic, self-adjusting array of unsigned char
window superclass for vtkRenderWindow
Definition: vtkWindow.h:28
@ point
Definition: vtkX3D.h:236
@ points
Definition: vtkX3D.h:446
@ startAngle
Definition: vtkX3D.h:486
@ scale
Definition: vtkX3D.h:229
@ color
Definition: vtkX3D.h:221
@ height
Definition: vtkX3D.h:254
@ image
Definition: vtkX3D.h:374
int vtkIdType
Definition: vtkType.h:315