File: v-sim-dumpToSVG.html

package info (click to toggle)
v-sim 3.7.2-8
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 19,760 kB
  • sloc: ansic: 88,929; sh: 11,194; python: 810; makefile: 691; cpp: 349; xml: 142
file content (147 lines) | stat: -rw-r--r-- 8,750 bytes parent folder | download | duplicates (3) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>dumpToSVG</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="ch05.html" title="Methods to export to other formats">
<link rel="prev" href="v-sim-dumpToPsAndPdf.html" title="dumpToPsAndPdf">
<link rel="next" href="v-sim-dumpToABINIT.html" title="dumpToABINIT">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="v-sim-dumpToPsAndPdf.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="v-sim-dumpToABINIT.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-dumpToSVG.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#v-sim-dumpToSVG.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="v-sim-dumpToSVG"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-dumpToSVG.top_of_page"></a>dumpToSVG</span></h2>
<p>dumpToSVG — add an export capability into SVG files.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="v-sim-dumpToSVG.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;extensions/box.h&gt;
#include &lt;extensions/axes.h&gt;
#include &lt;visu_pairs.h and visu_data.h&gt;

<span class="returnvalue">void</span>                (<a class="link" href="v-sim-dumpToSVG.html#VisuDumpCairoAdd" title="VisuDumpCairoAdd ()">*VisuDumpCairoAdd</a>)                 (<em class="parameter"><code><span class="type">cairo_t</span> *cr</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);
const <a class="link" href="v-sim-visu-dump.html#VisuDump"><span class="returnvalue">VisuDump</span></a> *    <a class="link" href="v-sim-dumpToSVG.html#visu-dump-cairo-pdf-getStatic" title="visu_dump_cairo_pdf_getStatic ()">visu_dump_cairo_pdf_getStatic</a>       ();
<span class="returnvalue">void</span>                <a class="link" href="v-sim-dumpToSVG.html#visu-dump-cairo-setPostFunc" title="visu_dump_cairo_setPostFunc ()">visu_dump_cairo_setPostFunc</a>         (<em class="parameter"><code><a class="link" href="v-sim-dumpToSVG.html#VisuDumpCairoAdd" title="VisuDumpCairoAdd ()"><span class="type">VisuDumpCairoAdd</span></a> func</code></em>);
const <a class="link" href="v-sim-visu-dump.html#VisuDump"><span class="returnvalue">VisuDump</span></a> *    <a class="link" href="v-sim-dumpToSVG.html#visu-dump-cairo-svg-getStatic" title="visu_dump_cairo_svg_getStatic ()">visu_dump_cairo_svg_getStatic</a>       ();
</pre>
</div>
<div class="refsect1">
<a name="v-sim-dumpToSVG.description"></a><h2>Description</h2>
<p>
This provides a write routine to export V_Sim views into SVG
files. Currently, this is an experimental feature. Not all V_Sim
elements are rendered, only the nodes, the box, the pairs and the
axes. All the characteristics are not used (no line stipple for
instance). In spin mode, nodes are only atomic.
</p>
</div>
<div class="refsect1">
<a name="v-sim-dumpToSVG.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="VisuDumpCairoAdd"></a><h3>VisuDumpCairoAdd ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                (*VisuDumpCairoAdd)                 (<em class="parameter"><code><span class="type">cairo_t</span> *cr</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);</pre>
<p>
A method to be called by V_Sim after exportation to allow post-processing.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cr</code></em> :</span></p></td>
<td>a <span class="type">cairo_t</span> context.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>width of the surface.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>height of the surface.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="visu-dump-cairo-pdf-getStatic"></a><h3>visu_dump_cairo_pdf_getStatic ()</h3>
<pre class="programlisting">const <a class="link" href="v-sim-visu-dump.html#VisuDump"><span class="returnvalue">VisuDump</span></a> *    visu_dump_cairo_pdf_getStatic       ();</pre>
<p>
This routine returns the dump object to PDF format.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly created dump object to create SVG files. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="visu-dump-cairo-setPostFunc"></a><h3>visu_dump_cairo_setPostFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                visu_dump_cairo_setPostFunc         (<em class="parameter"><code><a class="link" href="v-sim-dumpToSVG.html#VisuDumpCairoAdd" title="VisuDumpCairoAdd ()"><span class="type">VisuDumpCairoAdd</span></a> func</code></em>);</pre>
<p>
Allow to add a function that will be called on every Cairo
exportation after V_Sim rendering to allow post-processing.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-dumpToSVG.html#VisuDumpCairoAdd" title="VisuDumpCairoAdd ()"><span class="type">VisuDumpCairoAdd</span></a> function or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.7</p>
</div>
<hr>
<div class="refsect2">
<a name="visu-dump-cairo-svg-getStatic"></a><h3>visu_dump_cairo_svg_getStatic ()</h3>
<pre class="programlisting">const <a class="link" href="v-sim-visu-dump.html#VisuDump"><span class="returnvalue">VisuDump</span></a> *    visu_dump_cairo_svg_getStatic       ();</pre>
<p>
This routine returns the dump object to SVG format.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly created dump object to create SVG files. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>