File: glyph.rst

package info (click to toggle)
fontparts 0.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 2,004 kB
  • sloc: python: 18,702; makefile: 216; javascript: 143
file content (370 lines) | stat: -rw-r--r-- 6,292 bytes parent folder | download | duplicates (4)
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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
.. highlight:: python
.. module:: fontParts.base

#####
Glyph
#####

.. autosummarymethodlist::

	BaseGlyph

***********
Description
***********

The :class:`Glyph <BaseGlyph>` object represents a glyph, its parts and associated data.

:class:`Glyph <BaseGlyph>` can be used as a list of :class:`Contour <BaseContour>` objects.

When a :class:`Glyph <BaseGlyph>` is obtained from a :class:`Font <BaseFont>` object, the font is the parent object of the glyph.

********
Overview
********

Copy
====

.. autosummary::
    :nosignatures:

    BaseGlyph.copy

Parents
=======

.. autosummary::
    :nosignatures:

    BaseGlyph.layer
    BaseGlyph.font

Identification
==============

.. autosummary::
    :nosignatures:

    BaseGlyph.name
    BaseGlyph.unicodes
    BaseGlyph.unicode

Metrics
=======

.. autosummary::
    :nosignatures:

    BaseGlyph.width
    BaseGlyph.leftMargin
    BaseGlyph.rightMargin
    BaseGlyph.height
    BaseGlyph.bottomMargin
    BaseGlyph.topMargin

Queries
=======

.. autosummary::
    :nosignatures:

    BaseGlyph.bounds
    BaseGlyph.pointInside

Pens and Drawing
================

.. autosummary::
    :nosignatures:

    BaseGlyph.getPen
    BaseGlyph.getPointPen
    BaseGlyph.draw
    BaseGlyph.drawPoints

Layers
======

.. autosummary::
    :nosignatures:

    BaseGlyph.layers
    BaseGlyph.getLayer
    BaseGlyph.newLayer
    BaseGlyph.removeLayer

Global
======

.. autosummary::
    :nosignatures:

    BaseGlyph.clear
    BaseGlyph.appendGlyph

Contours
========

.. autosummary::
    :nosignatures:

    BaseGlyph.contours
    BaseGlyph.__len__
    BaseGlyph.__iter__
    BaseGlyph.__getitem__
    BaseGlyph.appendContour
    BaseGlyph.removeContour
    BaseGlyph.clearContours
    BaseGlyph.removeOverlap

Components
==========

.. autosummary::
    :nosignatures:

    BaseGlyph.components
    BaseGlyph.appendComponent
    BaseGlyph.removeComponent
    BaseGlyph.clearComponents
    BaseGlyph.decompose

Anchors
=======

.. autosummary::
    :nosignatures:

    BaseGlyph.anchors
    BaseGlyph.appendAnchor
    BaseGlyph.removeAnchor
    BaseGlyph.clearAnchors

Guidelines
==========

.. autosummary::
    :nosignatures:

    BaseGlyph.guidelines
    BaseGlyph.appendGuideline
    BaseGlyph.removeGuideline
    BaseGlyph.clearGuidelines

Image
=====

.. autosummary::
    :nosignatures:

    BaseGlyph.image
    BaseGlyph.addImage
    BaseGlyph.clearImage

Note
====

.. autosummary::
    :nosignatures:

    BaseGlyph.note
    BaseGlyph.markColor

Sub-Objects
===========

.. autosummary::
    :nosignatures:

    BaseGlyph.lib
    BaseGlyph.tempLib

Transformations
===============

.. autosummary::
    :nosignatures:

    BaseGlyph.transformBy
    BaseGlyph.moveBy
    BaseGlyph.scaleBy
    BaseGlyph.rotateBy
    BaseGlyph.skewBy

Interpolation
=============

.. autosummary::
    :nosignatures:

    BaseGlyph.isCompatible
    BaseGlyph.interpolate

Normalization
=============

.. autosummary::
    :nosignatures:

    BaseGlyph.round
    BaseGlyph.autoUnicodes

Environment
===========

.. autosummary::
    :nosignatures:

    BaseGlyph.naked
    BaseGlyph.changed

*********
Reference
*********

.. autoclass:: BaseGlyph

Copy
====

.. automethod:: BaseGlyph.copy

Parents
=======

.. autoattribute:: BaseGlyph.layer
.. autoattribute:: BaseGlyph.font

Identification
==============

.. autoattribute:: BaseGlyph.name
.. autoattribute:: BaseGlyph.unicodes
.. autoattribute:: BaseGlyph.unicode

Metrics
=======

.. autoattribute:: BaseGlyph.width
.. autoattribute:: BaseGlyph.leftMargin
.. autoattribute:: BaseGlyph.rightMargin
.. autoattribute:: BaseGlyph.height
.. autoattribute:: BaseGlyph.bottomMargin
.. autoattribute:: BaseGlyph.topMargin

Queries
=======

.. autoattribute:: BaseGlyph.bounds
.. automethod:: BaseGlyph.pointInside

Pens and Drawing
================

.. automethod:: BaseGlyph.getPen
.. automethod:: BaseGlyph.getPointPen
.. automethod:: BaseGlyph.draw
.. automethod:: BaseGlyph.drawPoints

Layers
======

Layer interaction in glyphs is very similar to the layer interaction in fonts. When you ask a glyph for a layer, you get a *glyph layer* in return. A glyph layer lets you do anything that you can do to a glyph. In fact a glyph layer is really just a glyph.

    >>> bgdGlyph = glyph.newLayer('background')
    >>> bgdGlyph.appendGlyph(glyph)
    >>> bgdGlyph.appendGuideline((10, 10), 45)

.. autoattribute:: BaseGlyph.layers
.. automethod:: BaseGlyph.getLayer
.. automethod:: BaseGlyph.newLayer
.. automethod:: BaseGlyph.removeLayer

Global
======

.. automethod:: BaseGlyph.clear
.. automethod:: BaseGlyph.appendGlyph

Contours
========

.. autoattribute:: BaseGlyph.contours
.. automethod:: BaseGlyph.__len__
.. automethod:: BaseGlyph.__iter__
.. automethod:: BaseGlyph.__getitem__
.. automethod:: BaseGlyph.appendContour
.. automethod:: BaseGlyph.removeContour
.. automethod:: BaseGlyph.clearContours
.. automethod:: BaseGlyph.removeOverlap

Components
==========

.. autoattribute:: BaseGlyph.components
.. automethod:: BaseGlyph.appendComponent
.. automethod:: BaseGlyph.removeComponent
.. automethod:: BaseGlyph.clearComponents
.. automethod:: BaseGlyph.decompose

Anchors
=======

.. autoattribute:: BaseGlyph.anchors
.. automethod:: BaseGlyph.appendAnchor
.. automethod:: BaseGlyph.removeAnchor
.. automethod:: BaseGlyph.clearAnchors

Guidelines
==========

.. autoattribute:: BaseGlyph.guidelines
.. automethod:: BaseGlyph.appendGuideline
.. automethod:: BaseGlyph.removeGuideline
.. automethod:: BaseGlyph.clearGuidelines

Image
=====

.. autoattribute:: BaseGlyph.image
.. automethod:: BaseGlyph.addImage
.. automethod:: BaseGlyph.clearImage

Note
====

.. autoattribute:: BaseGlyph.note
.. autoattribute:: BaseGlyph.markColor

Sub-Objects
===========

.. autoattribute:: BaseGlyph.lib

Transformations
===============

.. automethod:: BaseGlyph.transformBy
.. automethod:: BaseGlyph.moveBy
.. automethod:: BaseGlyph.scaleBy
.. automethod:: BaseGlyph.rotateBy
.. automethod:: BaseGlyph.skewBy

Interpolation
=============

.. automethod:: BaseGlyph.isCompatible
.. automethod:: BaseGlyph.interpolate

Normalization
=============

.. automethod:: BaseGlyph.round
.. automethod:: BaseGlyph.autoUnicodes

Environment
===========

.. automethod:: BaseGlyph.naked
.. automethod:: BaseGlyph.changed