VTK  9.2.6
vtkPDFContextDevice2D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPDFContextDevice2D.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 =========================================================================*/
25 #ifndef vtkPDFContextDevice2D_h
26 #define vtkPDFContextDevice2D_h
27 
28 #include "vtkContextDevice2D.h"
29 #include "vtkIOExportPDFModule.h" // For export macro
30 #include "vtkNew.h" // For vtkNew!
31 
32 class vtkColor3ub;
33 class vtkPath;
34 class vtkRenderer;
35 class vtkTransform;
36 
37 class VTKIOEXPORTPDF_EXPORT vtkPDFContextDevice2D : public vtkContextDevice2D
38 {
39 public:
40  static vtkPDFContextDevice2D* New();
42  void PrintSelf(ostream& os, vtkIndent indent) override;
43 
49  void SetHaruObjects(void* doc, void* page);
50 
51  void SetRenderer(vtkRenderer*);
52 
53  void DrawPoly(float* points, int n, unsigned char* colors = nullptr, int nc_comps = 0) override;
54  void DrawLines(float* f, int n, unsigned char* colors = nullptr, int nc_comps = 0) override;
55  void DrawPoints(float* points, int n, unsigned char* colors = nullptr, int nc_comps = 0) override;
56  void DrawPointSprites(vtkImageData* sprite, float* points, int n, unsigned char* colors = nullptr,
57  int nc_comps = 0) override;
58  void DrawMarkers(int shape, bool highlight, float* points, int n, unsigned char* colors = nullptr,
59  int nc_comps = 0) override;
60  void DrawQuad(float*, int) override;
61  void DrawQuadStrip(float*, int) override;
62  void DrawPolygon(float*, int) override;
63  void DrawColoredPolygon(
64  float* points, int numPoints, unsigned char* colors = nullptr, int nc_comps = 0) override;
65  void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy,
66  float startAngle, float stopAngle) override;
67  void DrawEllipticArc(
68  float x, float y, float rX, float rY, float startAngle, float stopAngle) override;
69  void DrawString(float* point, const vtkStdString& string) override;
70  void ComputeStringBounds(const vtkStdString& string, float bounds[4]) override;
71  void ComputeJustifiedStringBounds(const char* string, float bounds[4]) override;
72  void DrawMathTextString(float* point, const vtkStdString& str) override;
73  void DrawImage(float p[2], float scale, vtkImageData* image) override;
74  void DrawImage(const vtkRectf& pos, vtkImageData* image) override;
75  void SetColor4(unsigned char color[4]) override;
76  void SetTexture(vtkImageData* image, int properties) override;
77  void SetPointSize(float size) override;
78  void SetLineWidth(float width) override;
79  void DrawPolyData(float p[2], float scale, vtkPolyData* polyData, vtkUnsignedCharArray* colors,
80  int scalarMode) override;
81 
82  void SetLineType(int type) override;
83  void SetMatrix(vtkMatrix3x3* m) override;
84  void GetMatrix(vtkMatrix3x3* m) override;
85  void MultiplyMatrix(vtkMatrix3x3* m) override;
86  void PushMatrix() override;
87  void PopMatrix() override;
88  void SetClipping(int* x) override;
89  void EnableClipping(bool enable) override;
90 
91 protected:
93  ~vtkPDFContextDevice2D() override;
94 
95  void PushGraphicsState();
96  void PopGraphicsState();
97 
98  void ApplyPenState();
99  void ApplyStrokeColor(unsigned char* color, int numComps);
100  void ApplyLineWidth(float width);
101  void ApplyLineType(int type);
102  void Stroke();
103 
104  void ApplyPenStateAsFill();
105  void ApplyBrushState();
106  void ApplyTextPropertyState();
107  void ApplyFillColor(unsigned char* color, int numComps);
108  void ApplyFillAlpha(unsigned char alpha);
109  void Fill(bool stroke = false);
110  void FillEvenOdd(bool stroke = false);
111 
112  void BeginClipPathForTexture();
113  void RegisterTexturePoints(float* data, int numPoints);
114  void FillTexture();
115 
116  // converts input to RGB if needed. Call Delete() on the returned object when
117  // finished with it.
118  vtkImageData* PrepareImageData(vtkImageData* in);
119 
120  void DrawEllipticArcSegments(
121  float x, float y, float rX, float rY, float startAngle, float stopAngle, bool startPath);
122  int GetNumberOfArcIterations(float rX, float rY, float startAngle, float stopAngle);
123 
124  void DrawCrossMarkers(bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
125  void DrawPlusMarkers(bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
126  void DrawSquareMarkers(bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
127  void DrawCircleMarkers(bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
128  void DrawDiamondMarkers(
129  bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
130 
131  void DrawPath(vtkPath* path, float x, float y);
132 
133  void ApplyTransform();
134 
135  // This is weird, but the pen width must not be affected by the transform's
136  // scaling factors. This function returns the unscaled x/y components of
137  // the pen width.
138  vtkVector2f GetUnscaledPenWidth();
139 
140  // Converts a 2D transform matrix into a 3D transform matrix, or vice versa
141  static void Matrix3ToMatrix4(vtkMatrix3x3* mat3, double mat4[16]);
142  static void Matrix4ToMatrix3(double mat4[16], vtkMatrix3x3* mat3);
143  static void Matrix4ToMatrix3(double mat4[16], double mat3[9]);
144 
145  // Convert a 3D transform matrix to an HPDF transformation.
146  // trans = {a, b, c, d, x, y}, which define the transform:
147  // | a b x |
148  // | c d y |
149  // | 0 0 1 |
150  static void Matrix4ToHPDFTransform(const double mat4[16], float hpdfMat[6]);
151  static void Matrix3ToHPDFTransform(const double mat3[9], float hpdfMat[6]);
152  static void HPDFTransformToMatrix3(
153  float a, float b, float c, float d, float x, float y, double mat3[9]);
154 
155  struct Details;
156  Details* Impl;
157 
158  // This is a 3D transform, the 2D version doesn't support push/pop.
160 
162  float PointSize;
163  float ClipBox[4]; // x, y, w, h
164 
166  float TextureBounds[4]; // xmin, xmax, ymin, ymax; used for placing textures
167 
168 private:
170  void operator=(const vtkPDFContextDevice2D&) = delete;
171 };
172 
173 #endif // vtkPDFContextDevice2D_h
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:38
virtual void SetMatrix(vtkMatrix3x3 *m)=0
Set the model view matrix for the display.
virtual void DrawPointSprites(vtkImageData *sprite, float *points, int n, unsigned char *colors=nullptr, int nc_comps=0)=0
Draw a series of point sprites, images centred at the points supplied.
virtual void SetClipping(int *x)=0
Supply an int array of length 4 with x1, y1, width, height specifying clipping region for the device ...
virtual void ComputeJustifiedStringBounds(const char *string, float bounds[4])=0
Compute the bounds of the supplied string while taking into account the justification of the currentl...
virtual void DrawPoly(float *points, int n, unsigned char *colors=nullptr, int nc_comps=0)=0
Draw a poly line using the points - fastest code path due to memory layout of the coordinates...
concrete dataset representing a path defined by Bezier curves.
Definition: vtkPath.h:35
virtual void DrawPolygon(float *p, int n)
Draw a polygon using the specified number of points.
abstract specification for renderers
Definition: vtkRenderer.h:72
static vtkContextDevice2D * New()
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:60
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:90
virtual void DrawPolyData(float p[2], float scale, vtkPolyData *polyData, vtkUnsignedCharArray *colors, int scalarMode)
Draw the supplied PolyData at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1...
virtual void SetColor4(unsigned char color[4])=0
Set the color for the device using unsigned char of length 4, RGBA.
virtual void EnableClipping(bool enable)=0
Enable or disable the clipping of the scene.
virtual void SetLineWidth(float width)=0
Set the line width.
virtual void DrawPoints(float *points, int n, unsigned char *colors=nullptr, int nc_comps=0)=0
Draw a series of points - fastest code path due to memory layout of the coordinates.
Some derived classes for the different colors commonly used.
Definition: vtkColor.h:194
a simple class to control print indentation
Definition: vtkIndent.h:39
virtual void DrawMarkers(int shape, bool highlight, float *points, int n, unsigned char *colors=nullptr, int nc_comps=0)
Draw a series of markers centered at the points supplied.
topologically and geometrically regular array of data
Definition: vtkImageData.h:53
virtual void DrawQuadStrip(float *, int)
Draw a quad using the specified number of points.
Abstract class for drawing 2D primitives.
virtual void PopMatrix()=0
Pop the current matrix off of the stack.
virtual void DrawLines(float *f, int n, unsigned char *colors=nullptr, int nc_comps=0)=0
Draw lines using the points - memory layout is as follows: l1p1,l1p2,l2p1,l2p2... ...
virtual void SetTexture(vtkImageData *image, int properties)=0
Set the texture for the device, it is used to fill the polygons.
vtkContextDevice2D implementation for use with vtkPDFExporter.
virtual void DrawMathTextString(float *point, const vtkStdString &string)=0
Draw text using MathText markup for mathematical equations.
virtual void SetPointSize(float size)=0
Set the point size for glyphs/sprites.
dynamic, self-adjusting array of unsigned char
virtual void DrawQuad(float *, int)
Draw a quad using the specified number of points.
virtual void DrawEllipticArc(float x, float y, float rX, float rY, float startAngle, float stopAngle)=0
Draw an elliptic arc with center at x,y with radii rX and rY between angles startAngle and stopAngle ...
virtual void MultiplyMatrix(vtkMatrix3x3 *m)=0
Multiply the current model view matrix by the supplied one.
virtual void DrawString(float *point, const vtkStdString &string)=0
Draw some text to the screen.
virtual void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy, float startAngle, float stopAngle)=0
Draw an elliptic wedge with center at x, y, outer radii outRx, outRy, inner radii inRx...
virtual void DrawColoredPolygon(float *points, int numPoints, unsigned char *colors=nullptr, int nc_comps=0)
Draw a polygon using the specified number of points.
virtual void GetMatrix(vtkMatrix3x3 *m)=0
Set the model view matrix for the display.
virtual void ComputeStringBounds(const vtkStdString &string, float bounds[4])=0
Compute the bounds of the supplied string.
virtual void PushMatrix()=0
Push the current matrix onto the stack.
virtual void DrawImage(float p[2], float scale, vtkImageData *image)=0
Draw the supplied image at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1...
represent and manipulate 3x3 transformation matrices
Definition: vtkMatrix3x3.h:36
virtual void SetLineType(int type)=0
Set the line type type (using anonymous enum in vtkPen).
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkNew< vtkTransform > Matrix