VTK
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 "vtkRenderingContext2DModule.h" // For export macro
37 #include "vtkObject.h"
38 
39 class vtkWindow;
40 
41 class vtkContext3D;
42 class vtkStdString;
43 class vtkUnicodeString;
44 class vtkTextProperty;
45 
46 class vtkPoints2D;
47 class vtkVector2f;
48 class vtkRectf;
50 class vtkContextDevice2D;
51 class vtkPen;
52 class vtkBrush;
53 class vtkImageData;
54 class vtkTransform2D;
56 
57 class VTKRENDERINGCONTEXT2D_EXPORT vtkContext2D : public vtkObject
58 {
59 public:
60  vtkTypeMacro(vtkContext2D, vtkObject);
61  virtual void PrintSelf(ostream &os, vtkIndent indent);
62 
66  static vtkContext2D *New();
67 
73  bool Begin(vtkContextDevice2D *device);
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 
120 
124  void DrawPoly(float *x, float *y, int n);
125 
131 
137  void DrawPoly(float *points, int n);
138 
145  void DrawPoly(float *points, int n,
146  unsigned char *colors, int nc_comps);
147 
153 
158  void DrawLines(float *points, int n);
159 
163  void DrawPoint(float x, float y);
164 
168  void DrawPoints(float *x, float *y, int n);
169 
175 
181  void DrawPoints(float *points, int n);
182 
189 
191 
198  vtkUnsignedCharArray *colors);
199  void DrawPointSprites(vtkImageData *sprite, float *points, int n,
200  unsigned char *colors, int nc_comps);
202 
208  void DrawPointSprites(vtkImageData *sprite, float *points, int n);
209 
211 
223  virtual void DrawMarkers(int shape, bool highlight, float *points, int n,
224  unsigned char *colors, int nc_comps);
225  virtual void DrawMarkers(int shape, bool highlight, float *points, int n);
226  virtual void DrawMarkers(int shape, bool highlight, vtkPoints2D *points);
227  virtual void DrawMarkers(int shape, bool highlight, vtkPoints2D *points,
228  vtkUnsignedCharArray *colors);
230 
234  void DrawRect(float x, float y, float w, float h);
235 
237 
240  void DrawQuad(float x1, float y1, float x2, float y2,
241  float x3, float y3, float x4, float y4);
242  void DrawQuad(float *p);
244 
246 
250  void DrawQuadStrip(float *p, int n);
252 
257  void DrawPolygon(float *x, float *y, int n);
258 
264 
270  void DrawPolygon(float *points, int n);
271 
277  void DrawEllipse(float x, float y, float rx, float ry);
278 
287  void DrawWedge(float x, float y, float outRadius,
288  float inRadius,float startAngle,
289  float stopAngle);
290 
302  void DrawEllipseWedge(float x, float y, float outRx, float outRy,
303  float inRx, float inRy, float startAngle,
304  float stopAngle);
305 
306 
312  void DrawArc(float x, float y, float r, float startAngle,
313  float stopAngle);
314 
321  void DrawEllipticArc(float x, float y, float rX, float rY, float startAngle,
322  float stopAngle);
323 
324 
328  void DrawImage(float x, float y, vtkImageData *image);
329 
334  void DrawImage(float x, float y, float scale, vtkImageData *image);
335 
341  void DrawImage(const vtkRectf& pos, vtkImageData *image);
342 
344 
349  void DrawStringRect(vtkPoints2D *rect, const vtkStdString &string);
350  void DrawStringRect(vtkPoints2D *rect, const vtkUnicodeString &string);
351  void DrawStringRect(vtkPoints2D *rect, const char* string);
353 
355 
358  void DrawString(vtkPoints2D *point, const vtkStdString &string);
359  void DrawString(float x, float y, const vtkStdString &string);
361  void DrawString(float x, float y, const vtkUnicodeString &string);
362  void DrawString(vtkPoints2D *point, const char* string);
363  void DrawString(float x, float y, const char* string);
365 
367 
376  void ComputeStringBounds(const vtkStdString &string, vtkPoints2D *bounds);
377  void ComputeStringBounds(const vtkStdString &string, float bounds[4]);
378  void ComputeStringBounds(const vtkUnicodeString &string, vtkPoints2D *bounds);
379  void ComputeStringBounds(const vtkUnicodeString &string, float bounds[4]);
380  void ComputeStringBounds(const char* string, vtkPoints2D *bounds);
381  void ComputeStringBounds(const char* string, float bounds[4]);
383 
389  void ComputeJustifiedStringBounds(const char* string, float bounds[4]);
390 
397  int ComputeFontSizeForBoundedString(const vtkStdString &string, float width,
398  float height);
399 
401 
409  void DrawMathTextString(float x, float y, const vtkStdString &string);
410  void DrawMathTextString(vtkPoints2D *point, const char *string);
411  void DrawMathTextString(float x, float y, const char *string);
413 
415 
424  const vtkStdString &fallback);
425  void DrawMathTextString(float x, float y, const vtkStdString &string,
426  const vtkStdString &fallback);
427  void DrawMathTextString(vtkPoints2D *point, const char *string,
428  const char *fallback);
429  void DrawMathTextString(float x, float y, const char *string,
430  const char *fallback);
432 
433 
438 
444  void ApplyPen(vtkPen *pen);
445 
452 
458  void ApplyBrush(vtkBrush *brush);
459 
465 
472 
477 
483  void SetTransform(vtkTransform2D *transform);
484 
489 
496  void AppendTransform(vtkTransform2D *transform);
497 
499 
503  void PushMatrix();
504  void PopMatrix();
506 
510  void ApplyId(vtkIdType id);
511 
517  static int FloatToInt(float x);
518 
520 
524  vtkGetObjectMacro(Context3D, vtkContext3D)
525  virtual void SetContext3D(vtkContext3D *context);
527 
528 protected:
531 
532  vtkContextDevice2D *Device; // The underlying device
533  vtkTransform2D *Transform; // Current transform
534 
536  vtkContext3D *Context3D; // May be very temporary - get at a 3D version.
537 
538 private:
539  vtkContext2D(const vtkContext2D &) VTK_DELETE_FUNCTION;
540  void operator=(const vtkContext2D &) VTK_DELETE_FUNCTION;
541 
548  vtkVector2f CalculateTextPosition(vtkPoints2D* rect);
549 
556  vtkVector2f CalculateTextPosition(float rect[4]);
557 
558 };
559 
560 inline int vtkContext2D::FloatToInt(float x)
561 {
562  // Use a tolerance of 1/256 of a pixel when converting.
563  // A float has only 24 bits of precision, so we cannot
564  // make the tolerance too small. For example, a tolerance
565  // of 2^-8 means that the tolerance will be significant
566  // for float values up to 2^16 or 65536.0. But a
567  // tolerance of 2^-16 would only be significant for
568  // float values up to 2^8 or 256.0. A small tolerance
569  // disappears into insignificance when added to a large float.
570  float tol = 0.00390625; // 1.0/256.0
571  tol = (x >= 0 ? tol : -tol);
572  return static_cast<int>(x + tol);
573 }
574 
575 #endif //vtkContext2D_h
vtkBrush
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:38
vtkPoints2D
represent and manipulate 2D points
Definition: vtkPoints2D.h:37
vtkContext2D::DrawWedge
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...
vtkContext2D::DrawArc
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...
vtkContext2D::DrawPolygon
void DrawPolygon(vtkPoints2D *points)
Draw a polygon defined by the specified points - fastest code path due to memory layout of the coordi...
vtkContext2D::DrawPoints
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...
vtkContext2D::DrawQuad
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).
vtkContext2D::DrawMathTextString
void DrawMathTextString(vtkPoints2D *point, const vtkStdString &string, const vtkStdString &fallback)
Draw a MathText formatted equation to the screen.
vtkContext2D::DrawLine
void DrawLine(float x1, float y1, float x2, float y2)
Draw a line between the specified points.
vtkContext2D::ComputeStringBounds
void ComputeStringBounds(const vtkStdString &string, vtkPoints2D *bounds)
Compute the bounds of the supplied string.
vtkContext2D::DrawStringRect
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...
vtkX3D::scale
@ scale
Definition: vtkX3D.h:229
vtkContext2D::DrawPolygon
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...
vtkContext2D::ApplyPen
void ApplyPen(vtkPen *pen)
Apply the supplied pen which controls the outlines of shapes, as well as lines, points and related pr...
vtkIdType
int vtkIdType
Definition: vtkType.h:287
vtkContext2D::DrawString
void DrawString(vtkPoints2D *point, const char *string)
vtkContext2D::PopMatrix
void PopMatrix()
vtkContext2D::New
static vtkContext2D * New()
Creates a 2D Painter object.
vtkTransform2D
describes linear transformations via a 3x3 matrix
Definition: vtkTransform2D.h:52
vtkContext2D::DrawLines
void DrawLines(vtkPoints2D *points)
Draw multiple lines between the specified pairs of points.
vtkContext2D::DrawPoly
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...
vtkContext2D::DrawString
void DrawString(vtkPoints2D *point, const vtkUnicodeString &string)
vtkX3D::image
@ image
Definition: vtkX3D.h:374
vtkContext2D::DrawMarkers
virtual void DrawMarkers(int shape, bool highlight, vtkPoints2D *points)
vtkUnsignedCharArray
dynamic, self-adjusting array of unsigned char
Definition: vtkUnsignedCharArray.h:42
vtkContext2D::DrawMathTextString
void DrawMathTextString(float x, float y, const vtkStdString &string, const vtkStdString &fallback)
vtkContext2D::DrawEllipticArc
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 ...
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkContext2D::ComputeFontSizeForBoundedString
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...
vtkContext2D::ApplyId
void ApplyId(vtkIdType id)
Apply id as a color.
vtkContext2D::DrawMathTextString
void DrawMathTextString(float x, float y, const char *string)
vtkContext2D::DrawPoint
void DrawPoint(float x, float y)
Draw a point at the supplied x and y coordinate.
vtkContext2D
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:58
vtkContext2D::ComputeStringBounds
void ComputeStringBounds(const vtkUnicodeString &string, vtkPoints2D *bounds)
vtkContext2D::ApplyBrush
void ApplyBrush(vtkBrush *brush)
Apply the supplied brush which controls the outlines of shapes, as well as lines, points and related ...
vtkContext2D::MathTextIsSupported
bool MathTextIsSupported()
Return true if MathText rendering available on the current device.
vtkContext2D::DrawLine
void DrawLine(float p[4])
Draw a line between the specified points.
vtkContext2D::SetTransform
void SetTransform(vtkTransform2D *transform)
Set the transform for the context, the underlying device will use the matrix of the transform.
vtkContext2D::ComputeStringBounds
void ComputeStringBounds(const char *string, float bounds[4])
vtkContext2D::DrawPoints
void DrawPoints(vtkPoints2D *points)
Draw a poly line between the specified points - fastest code path due to memory layout of the coordin...
vtkContext2D::DrawStringRect
void DrawStringRect(vtkPoints2D *rect, const char *string)
vtkContext2D::GetTransform
vtkTransform2D * GetTransform()
Compute the current transform applied to the context.
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:35
vtkContext2D::Begin
bool Begin(vtkContextDevice2D *device)
Begin painting on a vtkContextDevice2D, no painting can occur before this call has been made.
vtkContext2D::DrawMathTextString
void DrawMathTextString(float x, float y, const char *string, const char *fallback)
vtkContext2D::DrawRect
void DrawRect(float x, float y, float w, float h)
Draw a rectangle with origin at x, y and width w, height h.
vtkAbstractContextBufferId
2D array of ids, used for picking.
Definition: vtkAbstractContextBufferId.h:47
vtkContext2D::DrawString
void DrawString(float x, float y, const vtkStdString &string)
vtkX3D::points
@ points
Definition: vtkX3D.h:446
vtkX3D::point
@ point
Definition: vtkX3D.h:236
vtkContext2D::ComputeStringBounds
void ComputeStringBounds(const vtkStdString &string, float bounds[4])
vtkContext2D::DrawLine
void DrawLine(vtkPoints2D *points)
Draw a line between the specified points.
vtkContext2D::DrawQuadStrip
void DrawQuadStrip(vtkPoints2D *points)
Draw a strip of quads.
vtkContext2D::DrawLines
void DrawLines(float *points, int n)
Draw multiple lines between the specified pairs of points.
vtkContext2D::PrintSelf
virtual void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkX3D::height
@ height
Definition: vtkX3D.h:254
vtkContext2D::DrawPolygon
void DrawPolygon(float *x, float *y, int n)
Draw a polygon specified specified by the points using the x and y arrays supplied.
vtkContext2D::DrawPoints
void DrawPoints(float *x, float *y, int n)
Draw the specified number of points using the x and y arrays supplied.
ADIOS::Transform
Transform
Definition: ADIOSDefs.h:40
vtkContext2D::DrawPoly
void DrawPoly(vtkPoints2D *points)
Draw a poly line between the specified points - fastest code path due to memory layout of the coordin...
vtkContext2D::DrawEllipseWedge
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::DrawMathTextString
void DrawMathTextString(vtkPoints2D *point, const char *string, const char *fallback)
vtkContext2D::GetTextProp
vtkTextProperty * GetTextProp()
Get the text properties object for the vtkContext2D.
vtkContext2D::DrawPoly
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...
vtkContext2D::DrawString
void DrawString(float x, float y, const vtkUnicodeString &string)
vtkContext2D::DrawMarkers
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.
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:46
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkUnicodeString
String class that stores Unicode text.
Definition: vtkUnicodeString.h:73
vtkContext2D::DrawString
void DrawString(vtkPoints2D *point, const vtkStdString &string)
Draw some text to the screen.
vtkContext2D::AppendTransform
void AppendTransform(vtkTransform2D *transform)
Append the transform for the context, the underlying device will use the matrix of the transform.
vtkContext2D::DrawMarkers
virtual void DrawMarkers(int shape, bool highlight, float *points, int n)
vtkX3D::startAngle
@ startAngle
Definition: vtkX3D.h:486
vtkContext2D::DrawMarkers
virtual void DrawMarkers(int shape, bool highlight, vtkPoints2D *points, vtkUnsignedCharArray *colors)
vtkContext2D::DrawImage
void DrawImage(float x, float y, vtkImageData *image)
Draw the supplied image at the given x, y location (bottom corner).
vtkContext2D::BufferIdModeEnd
void BufferIdModeEnd()
Finalize BufferId creation Mode.
vtkObject.h
vtkContext2D::DrawMathTextString
void DrawMathTextString(float x, float y, const vtkStdString &string)
vtkContextDevice2D
Abstract class for drawing 2D primitives.
Definition: vtkContextDevice2D.h:49
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:40
vtkContext2D::DrawEllipse
void DrawEllipse(float x, float y, float rx, float ry)
Draw an ellipse with center at x, y and radii rx, ry.
vtkContext2D::GetBrush
vtkBrush * GetBrush()
Get the pen which controls the outlines of shapes as well as lines, points and related primitives.
vtkContext2D::ComputeJustifiedStringBounds
void ComputeJustifiedStringBounds(const char *string, float bounds[4])
Compute the bounds of the supplied string while taking into account the justification of the currentl...
vtkContext2D::GetPen
vtkPen * GetPen()
Get the pen which controls the outlines of shapes, as well as lines, points and related primitives.
vtkContext2D::DrawMathTextString
void DrawMathTextString(vtkPoints2D *point, const char *string)
vtkContext2D::ComputeStringBounds
void ComputeStringBounds(const char *string, vtkPoints2D *bounds)
vtkContext2D::DrawPointSprites
void DrawPointSprites(vtkImageData *sprite, vtkPoints2D *points)
Draw a series of point sprites, images centred at the points supplied.
vtkContext2D::DrawStringRect
void DrawStringRect(vtkPoints2D *rect, const vtkUnicodeString &string)
vtkContext2D::DrawString
void DrawString(float x, float y, const char *string)
vtkContext3D
Class for drawing 3D primitives to a graphical context.
Definition: vtkContext3D.h:41
vtkContext2D::DrawMathTextString
void DrawMathTextString(vtkPoints2D *point, const vtkStdString &string)
Draw a MathText formatted equation to the screen.
vtkPen
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:40
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:49
vtkContext2D::ApplyTextProp
void ApplyTextProp(vtkTextProperty *prop)
Apply the supplied text property which controls how text is rendered.
vtkContext2D::ComputeStringBounds
void ComputeStringBounds(const vtkUnicodeString &string, float bounds[4])
vtkContext2D::DrawQuad
void DrawQuad(float *p)
vtkContext2D::DrawPointSprites
void DrawPointSprites(vtkImageData *sprite, vtkPoints2D *points, vtkUnsignedCharArray *colors)
Draw a series of point sprites, images centred at the points supplied.
vtkContext2D::DrawQuadStrip
void DrawQuadStrip(float *p, int n)
vtkContext2D::DrawPoly
void DrawPoly(float *x, float *y, int n)
Draw a poly line between the specified points.
vtkContext2D::DrawImage
void DrawImage(float x, float y, float scale, vtkImageData *image)
Draw the supplied image at the given x, y location (bottom corner).
vtkContext2D::GetBufferIdMode
bool GetBufferIdMode() const
Tell if the context is in BufferId creation mode.
vtkRectf
Definition: vtkRect.h:297
vtkContext2D::DrawPointSprites
void DrawPointSprites(vtkImageData *sprite, float *points, int n, unsigned char *colors, int nc_comps)
vtkContext2D::DrawImage
void DrawImage(const vtkRectf &pos, vtkImageData *image)
Draw the supplied image at the given position.
vtkVector2f
Definition: vtkVector.h:338
vtkContext2D::DrawPointSprites
void DrawPointSprites(vtkImageData *sprite, float *points, int n)
Draw a series of point sprites, images centred at the points supplied.
vtkContext2D::PushMatrix
void PushMatrix()
Push/pop the transformation matrix for the painter (sets the underlying matrix for the device when av...
vtkContext2D::End
bool End()
Ends painting on the device, you would not usually need to call this as it should be called by the de...
vtkContext2D::BufferIdModeBegin
void BufferIdModeBegin(vtkAbstractContextBufferId *bufferId)
Start BufferId creation Mode.