RGlyph

../../../../../_images/RGlyph.gif

Usage

# robofab manual
# Glyph object
# Usage examples

# start using the current font
from robofab.world import CurrentGlyph
g = CurrentGlyph()

# suppose you've done the right imports
# different ways of creating glyphs
# a new empty glyph object
g = robofab.world.RGlyph()

# a new empty fontlab glyph object
g = robofab.objects.objectsFL.RGlyph()

# a new empty robofab glyph object
g = robofab.objects.objectsRF.RGlyph()

# the easiest way to get a new glyph
# is to ask a font to make you one:
g = aFontObject[glyphName]

Description

The RGlyph object represents a glyph, its parts and associated data. In FontLab RGlyph talks directly to a glyph in an open font. In NoneLab the RGlyph refers to data read from (and written to) a specific glif file in a UFO. RGlyph can be used as a list of RContour. When RGlyph is obtained from a RoboFab font object (see examples), the font is the parent object of the glyph.

Attributes

components

A list of the Components in this glyph.

anchors

A list of the Anchors in this glyph.

len(aGlyph)

The number of contours.

aGlyph[index]

Get the Contour object at index.

width

The horizontal advance width of the glyph.

leftMargin

The left margin of the glyph.

rightMargin

The right margin of the glyph.

name

The glyph name.

unicode

The unicode value for this glyph, integer.

note

A place for a short string, a note about this glyph.

unicodes

A list of unicodes value for this glyph. Not all applications and editors support multiple unicode values for a glyph. Assume that glyph.unicode == glyph.unicodes[0].

box

The bounding box. The values are (xMin, yMin, xMax, yMax). Note: these values represent the actual measurements of the shape of the glyph. They’re usually different from the rectangle described by glyph.width / font.info.unitsPerEm.

+ - *

Math operators work on glyphs.

See also

how to glyphmath.

lib

The glyph’s lib, an RLib.

See also

how to use the lib.

psHints

A PostScriptGlyphHintValues object with all glyph level PostScript hints, vertical and horizontal.

Attribute examples

# robofab manual
# Glyph object
# attribute examples

from robofab.world import CurrentFont, CurrentGlyph
f = CurrentFont()

# create a glyph object by asking the font
g = f["Adieresis"]

# alternatively, create a glyph object for the current glyph
g = CurrentGlyph()

# get the width
print g.width

# get the name
print g.name

# a  list of unicode values for this glyph. Can be more than 1!
print g.unicodes

# set the width
g.width = 1000
print g.width

# get the number of contours in a glyph by getting its length
print len(g)
230
Adieresis
[123, 345]
1000
4

Methods

getParent()

Return the parent of this glyph, the font object it belongs to. The method returns None if there is none.

appendComponent(glyphName, (offsetX=0, offsetY=0), (scaleX=1, scaleY=1))

Add a component to the glyph. Optional values for offset and scale.

appendContour(aContour)

Add a contour to the glyph.

removeComponent(componentObject)

Remove a component from the glyph.

appendGlyph(aGlyph, (offsetX=0, offsetY=0))

Add a whole glyph. This adds all the contours, anchors and components to the glyph.

appendAnchor(name, position)

Create a new anchor in this glyph with name at position.

removeAnchor(anchor)

Remove this anchor from the glyph. This only works if the glyph does not have anchors with duplicate names in exactly the same location with the same mark.

autoUnicodes()

Try to find unicode values for this glyph. This method tries to match the glyph name to a known value.

copy()

Returns a deep copy of this glyph. That means that all parts of the glyph: contours, components, anchors etc. are duplicated.

correctDirection()

Correct the direction of all contours in this glyphs.

autoContourOrder()

Automatically order the contours based on (in this order):

  1. the point count of the contours
  2. the segment count of the contours
  3. the x value of the center of the contours
  4. the y value of the center of the contours
  5. the surface of the bounding box of the contours
pointInside((x, y))

Returns True if the point is inside the “black” area of the glyph or False if the point is inside the “white” area of the glyph.

draw(aPen)

Get this glyph to draw itself with the pen on offer.

drawPoints(aPointsPen)

Get this glyph to draw itself with the points pen on offer. For differences between Pen and PointsPen see here Pens.

getPen()

Returns an appropriate Pen object to draw in this glyph.

getPointPen()

Returns an appropriate PointPen object to draw in this glyph.

interpolate(factor, minGlyph, maxGlyph, suppressError=True, analyzeOnly=False)

Make this glyph the interpolation between minGlyph and maxGlyph by factor. When suppressError is True (the default value) this method will not complain if the interpolation is not possible. When analyzeOnly is True (default is False), this method will only analyze if the interpolation is possible and provide a report if something is wrong.

See also

how to interpolate.

isCompatible(anotherGlyph, report=True)

Returns True if the glyph has a compatible point structure as anotherGlyph. When report is True, isCompatible also returns a report on what the problems could be.

See also

how to interpolate.

isEmpty()

Returns True when the glyph does not contain any contours, components or anchors.

move(x, y), contours=True, components=True, anchors=True)

Move a glyph’s items that are flagged as True.

scale((x, y), center=(0, 0))

Scale the glyph by x and y. Optionally set the center of the scale.

rotate(angle, offset=None)

Rotate the glyph by angle (in degrees). Optionally set an offset value.

skew(angle, offset=None)

Skew the glyph by angle (in degrees). Optionally set an offset value.

rasterize(cellSize=50, xMin=None, yMin=None, xMax=None, yMax=None)

Slice the glyph into a grid based on the cell size. It returns a list of lists containing bool values that indicate the black (True) or white (False) value of that particular cell. These lists are arranged from top to bottom of the glyph and proceed from left to right. This is an expensive operation!

Method examples

# robofab manual
# Glyph object
# method examples

# get a glyph object from a font
f = CurrentFont()
g = f["A"]
print g

# move the glyph 10 units to the right, and 200 units up:
g = f["a"]
g.move((10, 200))

FontLab

Methods

Glyph methods only available in FontLab.

removeOverlap()

Remove overlap in this glyph.

naked()

Return the wrapped FontLab glyph object itself. This can be useful if you want to set very specific values in the FontLab font that aren’t wrapped or handled by RoboFab objects.

update()

Tell FontLab to update all references to this glyph. Call this after you’ve changed something in the glyph object and you want these changes to be seen in the application. If you’re calling glyph.update() a lot, for instance in a loop, consider calling it only once after the loop is done. You can also call font.update() if you’ve changed several glyphs at once. Calling update() makes a script slower.

getVGuides()

Return a list of wrapped vertical guides in this RGlyph.

getHGuides()

Return a list of wrapped horizontal guides in this RGlyph.

appendVGuide(x)

Add a vertical guide at x in this RGlyph.

appendHGuide(y)

Add a horizontal guide at y in this RGlyph.

clearVGuides()

Remove vertical guides from this RGlyph.

clearHGuides()

Remove horizontal guides from this RGlyph.

Useful

# robofab manual
# Glyph object
# method examples

# In FontLab the baseglyph of a component can't be changed easily.
# This assumes that there will only be
# one component that needs to be remapped.

def remapComponent(glyph, oldBaseGlyph, newBaseGlyph):
    foundComponent = None
    for component in glyph.components:
        if component.baseGlyph = oldBaseGlyph:
            foundComponent = component
            break
    if foundComponent is None:
        return
    offset = foundComponent.offset
    scale = foundComponent.scale
    glyph.removeComponent(component)
    glyph.appendComponent(newBaseGlyph, offset=offset, scale=scale)