recordingPen

Pen recording operations that can be accessed or replayed.

class fontTools.pens.recordingPen.DecomposingRecordingPen(glyphSet)[source]

Same as RecordingPen, except that it doesn’t keep components as references, but draws them decomposed as regular contours.

The constructor takes a single ‘glyphSet’ positional argument, a dictionary of glyph objects (i.e. with a ‘draw’ method) keyed by thir name.

>>> class SimpleGlyph(object):
...     def draw(self, pen):
...         pen.moveTo((0, 0))
...         pen.curveTo((1, 1), (2, 2), (3, 3))
...         pen.closePath()
>>> class CompositeGlyph(object):
...     def draw(self, pen):
...         pen.addComponent('a', (1, 0, 0, 1, -1, 1))
>>> glyphSet = {'a': SimpleGlyph(), 'b': CompositeGlyph()}
>>> for name, glyph in sorted(glyphSet.items()):
...     pen = DecomposingRecordingPen(glyphSet)
...     glyph.draw(pen)
...     print("{}: {}".format(name, pen.value))
a: [('moveTo', ((0, 0),)), ('curveTo', ((1, 1), (2, 2), (3, 3))), ('closePath', ())]
b: [('moveTo', ((-1, 1),)), ('curveTo', ((0, 2), (1, 3), (2, 4))), ('closePath', ())]
skipMissingComponents = False
class fontTools.pens.recordingPen.RecordingPen[source]

Pen recording operations that can be accessed or replayed.

The recording can be accessed as pen.value; or replayed using pen.replay(otherPen).

from fontTools.ttLib import TTFont from fontTools.pens.recordingPen import RecordingPen

glyph_name = ‘dollar’ font_path = ‘MyFont.otf’

font = TTFont(font_path) glyphset = font.getGlyphSet() glyph = glyphset[glyph_name]

pen = RecordingPen() glyph.draw(pen) print(pen.value)

addComponent(glyphName, transformation)[source]

Add a sub glyph. The ‘transformation’ argument must be a 6-tuple containing an affine transformation, or a Transform object from the fontTools.misc.transform module. More precisely: it should be a sequence containing 6 numbers.

closePath()[source]

Close the current sub path. You must call either pen.closePath() or pen.endPath() after each sub path.

curveTo(*points)[source]

Draw a cubic bezier with an arbitrary number of control points.

The last point specified is on-curve, all others are off-curve (control) points. If the number of control points is > 2, the segment is split into multiple bezier segments. This works like this:

Let n be the number of control points (which is the number of arguments to this call minus 1). If n==2, a plain vanilla cubic bezier is drawn. If n==1, we fall back to a quadratic segment and if n==0 we draw a straight line. It gets interesting when n>2: n-1 PostScript-style cubic segments will be drawn as if it were one curve. See decomposeSuperBezierSegment().

The conversion algorithm used for n>2 is inspired by NURB splines, and is conceptually equivalent to the TrueType “implied points” principle. See also decomposeQuadraticSegment().

endPath()[source]

End the current sub path, but don’t close it. You must call either pen.closePath() or pen.endPath() after each sub path.

lineTo(p1)[source]

Draw a straight line from the current point to ‘pt’.

moveTo(p0)[source]

Begin a new sub path, set the current point to ‘pt’. You must end each sub path with a call to pen.closePath() or pen.endPath().

qCurveTo(*points)[source]

Draw a whole string of quadratic curve segments.

The last point specified is on-curve, all others are off-curve points.

This method implements TrueType-style curves, breaking up curves using ‘implied points’: between each two consequtive off-curve points, there is one implied point exactly in the middle between them. See also decomposeQuadraticSegment().

The last argument (normally the on-curve point) may be None. This is to support contours that have NO on-curve points (a rarely seen feature of TrueType outlines).

replay(pen)[source]
fontTools.pens.recordingPen.replayRecording(recording, pen)[source]

Replay a recording, as produced by RecordingPen or DecomposingRecordingPen, to a pen.

Note that recording does not have to be produced by those pens. It can be any iterable of tuples of method name and tuple-of-arguments. Likewise, pen can be any objects receiving those method calls.