VTK  9.2.5
vtkContext2D.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkContext2D.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
15
33#ifndef vtkContext2D_h
34#define vtkContext2D_h
35
36#include "vtkObject.h"
37#include "vtkRenderingContext2DModule.h" // For export macro
38
39class vtkWindow;
40
41class vtkContext3D;
42class vtkStdString;
43class vtkTextProperty;
44
45class vtkPoints2D;
46class vtkVector2f;
47class vtkRectf;
50class vtkPen;
51class vtkBrush;
52class vtkImageData;
53class vtkPolyData;
54class vtkTransform2D;
56
57class VTKRENDERINGCONTEXT2D_EXPORT vtkContext2D : public vtkObject
58{
59public:
60 vtkTypeMacro(vtkContext2D, vtkObject);
61 void PrintSelf(ostream& os, vtkIndent indent) override;
62
66 static vtkContext2D* New();
67
74
75 vtkGetObjectMacro(Device, vtkContextDevice2D);
76
82 bool End();
83
87 bool GetBufferIdMode() const;
88
96
104
108 void DrawLine(float x1, float y1, float x2, float y2);
109
113 void DrawLine(float p[4]);
114
119 void DrawLine(vtkPoints2D* points);
120
124 void DrawPoly(float* x, float* y, int n);
125
130 void DrawPoly(vtkPoints2D* points);
131
137 void DrawPoly(float* points, int n);
138
145 void DrawPoly(float* points, int n, unsigned char* colors, int nc_comps);
146
151 void DrawLines(vtkPoints2D* points);
152
157 void DrawLines(float* points, int n);
158
162 void DrawPoint(float x, float y);
163
167 void DrawPoints(float* x, float* y, int n);
168
173 void DrawPoints(vtkPoints2D* points);
174
180 void DrawPoints(float* points, int n);
181
188
190
198 vtkImageData* sprite, float* points, int n, unsigned char* colors, int nc_comps);
200
206 void DrawPointSprites(vtkImageData* sprite, float* points, int n);
207
209
225 virtual void DrawMarkers(
226 int shape, bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
227 virtual void DrawMarkers(int shape, bool highlight, float* points, int n);
228 virtual void DrawMarkers(int shape, bool highlight, vtkPoints2D* points);
229 virtual void DrawMarkers(
230 int shape, bool highlight, vtkPoints2D* points, vtkUnsignedCharArray* colors);
232
236 void DrawRect(float x, float y, float w, float h);
237
239
242 void DrawQuad(float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4);
243 void DrawQuad(float* p);
245
247
251 void DrawQuadStrip(float* p, int n);
253
258 void DrawPolygon(float* x, float* y, int n);
259
265
271 void DrawPolygon(float* points, int n);
272
277 void DrawPolygon(float* x, float* y, int n, unsigned char* color, int nc_comps);
278
283 void DrawPolygon(vtkPoints2D* points, unsigned char* color, int nc_comps);
284
290 void DrawPolygon(float* points, int n, unsigned char* color, int nc_comps);
291
297 void DrawEllipse(float x, float y, float rx, float ry);
298
308 float x, float y, float outRadius, float inRadius, float startAngle, float stopAngle);
309
321 void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy,
322 float startAngle, float stopAngle);
323
329 void DrawArc(float x, float y, float r, float startAngle, float stopAngle);
330
337 void DrawEllipticArc(float x, float y, float rX, float rY, float startAngle, float stopAngle);
338
342 void DrawImage(float x, float y, vtkImageData* image);
343
348 void DrawImage(float x, float y, float scale, vtkImageData* image);
349
355 void DrawImage(const vtkRectf& pos, vtkImageData* image);
356
362 float x, float y, vtkPolyData* polyData, vtkUnsignedCharArray* colors, int scalarMode);
363
365
370 void DrawStringRect(vtkPoints2D* rect, const vtkStdString& string);
371 void DrawStringRect(vtkPoints2D* rect, const char* string);
372 void DrawStringRect(const float rect[4], const vtkStdString& string);
373 void DrawStringRect(const float rect[4], const char* string);
375
377
380 void DrawString(vtkPoints2D* point, const vtkStdString& string);
381 void DrawString(float x, float y, const vtkStdString& string);
382 void DrawString(vtkPoints2D* point, const char* string);
383 void DrawString(float x, float y, const char* string);
385
387
396 void ComputeStringBounds(const vtkStdString& string, vtkPoints2D* bounds);
397 void ComputeStringBounds(const vtkStdString& string, float bounds[4]);
398 void ComputeStringBounds(const char* string, vtkPoints2D* bounds);
399 void ComputeStringBounds(const char* string, float bounds[4]);
401
406 void ComputeJustifiedStringBounds(const char* string, float bounds[4]);
407
414 int ComputeFontSizeForBoundedString(const vtkStdString& string, float width, float height);
415
417
424 void DrawMathTextString(vtkPoints2D* point, const vtkStdString& string);
425 void DrawMathTextString(float x, float y, const vtkStdString& string);
426 void DrawMathTextString(vtkPoints2D* point, const char* string);
427 void DrawMathTextString(float x, float y, const char* string);
429
431
440 vtkPoints2D* point, const vtkStdString& string, const vtkStdString& fallback);
442 float x, float y, const vtkStdString& string, const vtkStdString& fallback);
443 void DrawMathTextString(vtkPoints2D* point, const char* string, const char* fallback);
444 void DrawMathTextString(float x, float y, const char* string, const char* fallback);
446
451
457 void ApplyPen(vtkPen* pen);
458
465
471 void ApplyBrush(vtkBrush* brush);
472
478
485
490
496 void SetTransform(vtkTransform2D* transform);
497
502
510
512
517 void PopMatrix();
519
524
530 static int FloatToInt(float x);
531
533
537 vtkGetObjectMacro(Context3D, vtkContext3D);
538 virtual void SetContext3D(vtkContext3D* context);
540
541protected:
543 ~vtkContext2D() override;
544
545 vtkContextDevice2D* Device; // The underlying device
546 vtkTransform2D* Transform; // Current transform
547
549 vtkContext3D* Context3D; // May be very temporary - get at a 3D version.
550
551private:
552 vtkContext2D(const vtkContext2D&) = delete;
553 void operator=(const vtkContext2D&) = delete;
554
561 vtkVector2f CalculateTextPosition(vtkPoints2D* rect);
562
569 vtkVector2f CalculateTextPosition(const float rect[4]);
570};
571
572inline int vtkContext2D::FloatToInt(float x)
573{
574 // Use a tolerance of 1/256 of a pixel when converting.
575 // A float has only 24 bits of precision, so we cannot
576 // make the tolerance too small. For example, a tolerance
577 // of 2^-8 means that the tolerance will be significant
578 // for float values up to 2^16 or 65536.0. But a
579 // tolerance of 2^-16 would only be significant for
580 // float values up to 2^8 or 256.0. A small tolerance
581 // disappears into insignificance when added to a large float.
582 float tol = 0.00390625; // 1.0/256.0
583 tol = (x >= 0 ? tol : -tol);
584 return static_cast<int>(x + tol);
585}
586
587#endif // vtkContext2D_h
2D array of ids, used for picking.
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:41
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:58
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:572
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,...
~vtkContext2D() override
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
Definition: vtkContext2D.h:546
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
Definition: vtkContext2D.h:548
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:545
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:549
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 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:41
Abstract class for drawing 2D primitives.
topologically and geometrically regular array of data
Definition: vtkImageData.h:54
a simple class to control print indentation
Definition: vtkIndent.h:40
abstract base class for most VTK objects
Definition: vtkObject.h:63
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:40
represent and manipulate 2D points
Definition: vtkPoints2D.h:37
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:91
Computes the portion of a dataset which is inside a selection.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:39
represent text properties.
describes linear transformations via a 3x3 matrix
dynamic, self-adjusting array of unsigned char
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
int vtkIdType
Definition: vtkType.h:332