File: glyph.rst

package info (click to toggle)
neuron 8.2.6-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 34,760 kB
  • sloc: cpp: 149,571; python: 58,465; ansic: 50,329; sh: 3,510; xml: 213; pascal: 51; makefile: 35; sed: 5
file content (273 lines) | stat: -rw-r--r-- 3,558 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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273

.. _hoc_glyph:

         
Glyph
-----



.. hoc:class:: Glyph


    Syntax:
        ``g = new Glyph()``


    Description:
        Specification of a drawing. The drawing can be rendered on a Graph 
        as many times as desired using 

        .. code-block::
            none

            graph.glyph(g, x, y, scalex, scaley, angle) 

        The drawing style uses commands reminiscent of postscript. 

    .. seealso::
        :hoc:class:`Graph`, :hoc:meth:`Graph.glyph`

         

----



.. hoc:method:: Glyph.new_path


    Syntax:
        ``g = g.path()``


    Description:
        Begin a new path. 

         

----



.. hoc:method:: Glyph.move_to


    Syntax:
        ``g = g.m(x, y)``


    Description:
        Set the current point to the coordinates. 

         

----



.. hoc:method:: Glyph.line_to


    Syntax:
        ``g = g.l(x, y)``


    Description:
        A line from the current point to the coordinates. 

         

----



.. hoc:method:: Glyph.curve_to


    Syntax:
        ``g = g.curve(x,y, x1,y1, x2,y2)``


    Description:
        Draw a curve from the current point to x,y 

         

----



.. hoc:method:: Glyph.close_path


    Syntax:
        ``g = g.close()``


    Description:
        A line from the current point to the first point of the path. 

         

----



.. hoc:method:: Glyph.circle


    Syntax:
        ``g = g.circle(x, y, r)``


    Description:
        A circle at location x, y and radius r. This is implemented using
        the glyph methods new_path, move_to, curve_to, and close_path.
        Can stroke and/or fill.

    Example:
        Rotated ellipse

        .. code-block::
            none
            
            objref gr, gl
            gr = new Graph()
            
            gl = new Glyph()
            gl.circle(0,0,1)
            gl.fill(3)
            gl.s(2, 3)
            
            gr.glyph(gl, 150, 100, 30, 60, PI/4*DEG)



----



.. hoc:method:: Glyph.stroke


    Syntax:
        ``g = g.s()``

        ``g = g.s(colorindex)``

        ``g = g.s(colorindex, brushindex)``


    Description:
        Render the current path as a line. 

         

----



.. hoc:method:: Glyph.fill


    Syntax:
        ``g = g.fill()``

        ``g = g.fill(colorindex)``


    Description:
        For a closed path, fill the interior with the indicated color. 

         

----



.. hoc:method:: Glyph.control_point


    Syntax:
        ``g = g.cpt(x,y)``


    Description:
        Draw a small open rectangle at the coordinates. Intended to indicate 
        special locations on the glyph which can be selected. Not very useful 
        at this time. 

         

----



.. hoc:method:: Glyph.erase


    Syntax:
        ``g = g.erase()``


    Description:
        The drawing is empty 

         

----



.. hoc:method:: Glyph.label


    Syntax:
        ``g = g.label("string", x, y, fixtype, colorindex)``


    Description:
        Not implemented 

         

----



.. hoc:method:: Glyph.glyph


    Syntax:
        ``g = g.glyph(glyphobject, x, y, scale, angle)``


    Description:
        Not implemented 

         

----



.. hoc:method:: Glyph.gif


    Syntax:
        ``g = g.gif("filename")``


    Description:
        Reads the gif image in the file. All :hoc:class:`Glyph` arguments still work
        when the glyph contains a gif image. The gif image is drawn first so 
        other drawing specs will appear on top of it. 

    .. seealso::
        :hoc:meth:`Graph.gif`, :hoc:meth:`Graph.glyph`