VTK  9.3.1
vtkSVGContextDevice2D.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
27 #ifndef vtkSVGContextDevice2D_h
28 #define vtkSVGContextDevice2D_h
29 
30 #include "vtkContextDevice2D.h"
31 #include "vtkIOExportModule.h" // For export macro
32 #include "vtkNew.h" // For vtkNew!
33 
34 #include <array> // For std::array!
35 
36 VTK_ABI_NAMESPACE_BEGIN
37 class vtkColor3ub;
38 class vtkColor4ub;
39 class vtkPath;
40 class vtkRenderer;
41 class vtkTransform;
42 class vtkVector3f;
43 class vtkXMLDataElement;
44 
45 class VTKIOEXPORT_EXPORT vtkSVGContextDevice2D : public vtkContextDevice2D
46 {
47 public:
48  static vtkSVGContextDevice2D* New();
50  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
54  void SetSVGContext(vtkXMLDataElement* context, vtkXMLDataElement* defs);
55 
66  vtkSetMacro(EmbedFonts, bool);
67  vtkGetMacro(EmbedFonts, bool);
68  vtkBooleanMacro(EmbedFonts, bool);
86  vtkSetMacro(TextAsPath, bool);
87  vtkGetMacro(TextAsPath, bool);
88  vtkBooleanMacro(TextAsPath, bool);
106  vtkSetMacro(SubdivisionThreshold, float);
107  vtkGetMacro(SubdivisionThreshold, float);
114  void GenerateDefinitions();
115 
116  void Begin(vtkViewport*) override;
117  void End() override;
118 
119  void DrawPoly(float* points, int n, unsigned char* colors = nullptr, int nc_comps = 0) override;
120  void DrawLines(float* f, int n, unsigned char* colors = nullptr, int nc_comps = 0) override;
121  void DrawPoints(float* points, int n, unsigned char* colors = nullptr, int nc_comps = 0) override;
122  void DrawPointSprites(vtkImageData* sprite, float* points, int n, unsigned char* colors = nullptr,
123  int nc_comps = 0) override;
124  void DrawMarkers(int shape, bool highlight, float* points, int n, unsigned char* colors = nullptr,
125  int nc_comps = 0) override;
126  void DrawQuad(float*, int) override;
127  void DrawQuadStrip(float*, int) override;
128  void DrawPolygon(float*, int) override;
129  void DrawColoredPolygon(
130  float* points, int numPoints, unsigned char* colors = nullptr, int nc_comps = 0) override;
131  void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy,
132  float startAngle, float stopAngle) override;
133  void DrawEllipticArc(
134  float x, float y, float rX, float rY, float startAngle, float stopAngle) override;
135  void DrawString(float* point, const vtkStdString& string) override;
136  void ComputeStringBounds(const vtkStdString& string, float bounds[4]) override;
137  void ComputeJustifiedStringBounds(const char* string, float bounds[4]) override;
138  void DrawMathTextString(float* point, const vtkStdString& str) override;
139  void DrawImage(float p[2], float scale, vtkImageData* image) override;
140  void DrawImage(const vtkRectf& pos, vtkImageData* image) override;
141  void SetColor4(unsigned char color[4]) override;
142  void SetTexture(vtkImageData* image, int properties) override;
143  void SetPointSize(float size) override;
144  void SetLineWidth(float width) override;
145 
146  void SetLineType(int type) override;
147  void SetMatrix(vtkMatrix3x3* m) override;
148  void GetMatrix(vtkMatrix3x3* m) override;
149  void MultiplyMatrix(vtkMatrix3x3* m) override;
150  void PushMatrix() override;
151  void PopMatrix() override;
152  void SetClipping(int* x) override;
153  void EnableClipping(bool enable) override;
154 
155 protected:
157  ~vtkSVGContextDevice2D() override;
158 
159  void SetViewport(vtkViewport*);
160 
161  void PushGraphicsState();
162  void PopGraphicsState();
163 
164  // Apply clipping and transform information current active node.
165  void SetupClippingAndTransform();
166 
167  // pen -> stroke state
168  void ApplyPenStateToNode(vtkXMLDataElement* node);
169  void ApplyPenColorToNode(vtkXMLDataElement* node);
170  void ApplyPenOpacityToNode(vtkXMLDataElement* node);
171  void ApplyPenWidthToNode(vtkXMLDataElement* node);
172  void ApplyPenStippleToNode(vtkXMLDataElement* node);
173 
174  // pen -> fill state
175  void ApplyPenAsFillColorToNode(vtkXMLDataElement* node);
176  void ApplyPenAsFillOpacityToNode(vtkXMLDataElement* node);
177 
178  // brush -> fill state
179  void ApplyBrushStateToNode(vtkXMLDataElement* node);
180  void ApplyBrushColorToNode(vtkXMLDataElement* node);
181  void ApplyBrushOpacityToNode(vtkXMLDataElement* node);
182  void ApplyBrushTextureToNode(vtkXMLDataElement* node);
183 
184  // tprop --> text state
185  void ApplyTextPropertyStateToNode(vtkXMLDataElement* node, float x, float y);
186  void ApplyTextPropertyStateToNodeForPath(vtkXMLDataElement* node, float x, float y);
187 
188  void ApplyTransform();
189 
190  // Add marker symbols to defs, return symbol id.
191  std::string AddCrossSymbol(bool highlight);
192  std::string AddPlusSymbol(bool highlight);
193  std::string AddSquareSymbol(bool highlight);
194  std::string AddCircleSymbol(bool highlight);
195  std::string AddDiamondSymbol(bool highlight);
196 
197  void DrawPath(vtkPath* path, std::ostream& out);
198 
199  void DrawLineGradient(const vtkVector2f& p1, const vtkColor4ub& c1, const vtkVector2f& p2,
200  const vtkColor4ub& c2, bool useAlpha);
201  void DrawTriangleGradient(const vtkVector2f& p1, const vtkColor4ub& c1, const vtkVector2f& p2,
202  const vtkColor4ub& c2, const vtkVector2f& p3, const vtkColor4ub& c3, bool useAlpha);
203 
204  // Used by the Draw*Gradient methods to prevent subdividing triangles / lines
205  // that are already really small.
206  bool AreaLessThanTolerance(const vtkVector2f& p1, const vtkVector2f& p2, const vtkVector2f& p3);
207  bool LengthLessThanTolerance(const vtkVector2f& p1, const vtkVector2f& p2);
208 
209  bool ColorsAreClose(const vtkColor4ub& c1, const vtkColor4ub& c2, bool useAlpha);
210  bool ColorsAreClose(
211  const vtkColor4ub& c1, const vtkColor4ub& c2, const vtkColor4ub& c3, bool useAlpha);
212 
213  void WriteFonts();
214  void WriteImages();
215  void WritePatterns();
216  void WriteClipRects();
217 
218  void AdjustMatrixForSVG(const double in[9], double out[9]);
219  void GetSVGMatrix(double svg[9]);
220  static bool Transform2DEqual(const double mat3[9], const double mat4[16]);
221  static void Matrix3ToMatrix4(const double mat3[9], double mat4[16]);
222  static void Matrix4ToMatrix3(const double mat4[16], double mat3[9]);
223 
224  float GetScaledPenWidth();
225  void GetScaledPenWidth(float& x, float& y);
226  void TransformSize(float& x, float& y);
227 
228  vtkImageData* PreparePointSprite(vtkImageData* in);
229 
230  struct Details;
231  Details* Impl;
232 
237 
238  // This is a 3D transform, the 2D version doesn't support push/pop.
240  std::array<double, 9> ActiveNodeTransform;
241 
242  std::array<int, 4> ClipRect; // x, y, w, h
243  std::array<int, 4> ActiveNodeClipRect; // x, y, w, h
244 
245  float CanvasHeight; // Used in y coordinate conversions.
251 
252 private:
254  void operator=(const vtkSVGContextDevice2D&) = delete;
255 };
256 
257 VTK_ABI_NAMESPACE_END
258 #endif // vtkSVGContextDevice2D_h
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:28
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 ...
Represents an XML element and those nested inside.
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:24
abstract specification for Viewports
Definition: vtkViewport.h:44
virtual void DrawPolygon(float *p, int n)
Draw a polygon using the specified number of points.
std::array< int, 4 > ActiveNodeClipRect
vtkContextDevice2D implementation for use with vtkSVGExporter.
vtkXMLDataElement * DefinitionNode
std::array< double, 9 > ActiveNodeTransform
abstract specification for renderers
Definition: vtkRenderer.h:61
static vtkContextDevice2D * New()
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:49
virtual void Begin(vtkViewport *)
Begin drawing, pass in the viewport to set up the view.
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:183
a simple class to control print indentation
Definition: vtkIndent.h:28
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:42
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.
vtkNew< vtkTransform > Matrix
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.
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.
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 End()
End drawing, clean up the view.
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...
std::array< int, 4 > ClipRect
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.
vtkXMLDataElement * ContextNode
vtkXMLDataElement * ActiveNode
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:25
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.