fontlab.flModel
flModel
Think of flModel as FontLab's type registry — its internal catalogue of every kind of object that can exist in a font. Every node, contour, shape, glyph, layer, guideline, and anchor has a numeric type ID registered here. flModel lets you look those IDs up, create objects dynamically by type, and most importantly, send "something changed" signals to the rest of the application after you've made scripted edits.
As a type designer writing scripts, you'll reach for flModel in two situations:
- After editing glyph data — call
notifyGlyphChanged()so FontLab refreshes its displays (metrics, previews, the glyph window). - Type checking — use
ModelTypeIDs andtypeToStr()to confirm what kind of object you're holding.
The class is a singleton; you don't need an instance. All methods are called directly on the class, like flModel.notifyGlyphChanged(fg_id).
Enum: flModel.ModelType
A dictionary of integer constants, one for every object type in the font model. You use these with createObject(), typeToStr(), and type-checking code.
The table below is organized from most to least relevant for scripting work. The bolded entries are ones you're likely to encounter in day-to-day type design scripting.
| Key | Native value | Description |
|---|---|---|
Undefined |
flModel::ModelType::Undefined |
Null/unset type. Used as a sentinel. |
Transform |
flModel::ModelType::Transform |
A transform matrix object. |
Pair |
flModel::ModelType::Pair |
Native enum value. |
Notifier |
flModel::ModelType::Notifier |
Native enum value. |
Private |
flModel::ModelType::Private |
Internal private type — not for scripting. |
Object |
flModel::ModelType::Object |
The base flObject type. |
State |
flModel::ModelType::State |
Native enum value. |
Container |
flModel::ModelType::Container |
Generic container/collection types. |
Surface |
flModel::ModelType::Surface |
Native enum value. |
Property |
flModel::ModelType::Property |
Native enum value. |
Producer |
flModel::ModelType::Producer |
Native enum value. |
Snap |
flModel::ModelType::Snap |
Various snap-system objects (SnapNode, SnapContour, SnapPoint, etc.). |
Tool |
flModel::ModelType::Tool |
Native enum value. |
Controls |
flModel::ModelType::Controls |
Native enum value. |
ObjectList |
flModel::ModelType::ObjectList |
Generic container/collection types. |
Objects |
flModel::ModelType::Objects |
Generic container/collection types. |
Point |
flModel::ModelType::Point |
Native enum value. |
Intersection |
flModel::ModelType::Intersection |
Native enum value. |
Marker |
flModel::ModelType::Marker |
A marker on a snap guideline. |
JoinPoint |
flModel::ModelType::JoinPoint |
A join point between open contours. |
Node |
flModel::ModelType::Node |
flNode — a single on-curve or off-curve point on a contour. The most atomic editable element of a glyph outline. |
VectorNode |
flModel::ModelType::VectorNode |
A guideline-anchored node. |
GuidelineIntersectionNode |
flModel::ModelType::GuidelineIntersectionNode |
Native enum value. |
NodeOnNode |
flModel::ModelType::NodeOnNode |
Native enum value. |
IntersectionNode |
flModel::ModelType::IntersectionNode |
Native enum value. |
SumNode |
flModel::ModelType::SumNode |
Native enum value. |
PinPoint |
flModel::ModelType::PinPoint |
See above. |
Contour |
flModel::ModelType::Contour |
flContour — a closed or open path made of nodes. Contours live inside shapes. |
Bezier |
flModel::ModelType::Bezier |
A single Bézier curve segment. |
Sticker |
flModel::ModelType::Sticker |
flSticker — a canvas annotation (sticky note). |
Interval |
flModel::ModelType::Interval |
Native enum value. |
GuideLine |
flModel::ModelType::GuideLine |
flGuideLine — a guideline, either glyph-level or font-level. |
GuideMarker |
flModel::ModelType::GuideMarker |
A marker on a snap guideline. |
SnapNode |
flModel::ModelType::SnapNode |
Native enum value. |
AutoShape |
flModel::ModelType::AutoShape |
An auto-shape (ShapeBuilder parametric shape). |
Stapler |
flModel::ModelType::Stapler |
Native enum value. |
StaplersGraph |
flModel::ModelType::StaplersGraph |
Native enum value. |
TTH |
flModel::ModelType::TTH |
A TrueType hinting command on a node. |
Shape |
flModel::ModelType::Shape |
flShape — a container for one or more contours, and the unit that carries position/transform within a layer. |
ShapeData |
flModel::ModelType::ShapeData |
flShapeData — shared outline data that can be referenced by multiple shapes (components/composites). |
Layer |
flModel::ModelType::Layer |
flLayer — one master layer of a glyph (e.g. "Regular", "Bold"). Layers contain shapes. |
Glyph |
flModel::ModelType::Glyph |
flGlyph — the full glyph object: all its layers, metrics, components, and anchors. |
Font |
flModel::ModelType::Font |
flPackage — a font file open in FontLab (confusingly, both Package and Font keys refer to this). |
TextBlock |
flModel::ModelType::TextBlock |
flTextBlock — a block of text in the Metrics or Text window. |
Gallery |
flModel::ModelType::Gallery |
Native enum value. |
Package |
flModel::ModelType::Package |
flPackage — a font file open in FontLab (confusingly, both Package and Font keys refer to this). |
Text |
flModel::ModelType::Text |
Native enum value. |
TextBlockParams |
flModel::ModelType::TextBlockParams |
Native enum value. |
Project |
flModel::ModelType::Project |
A project file (a collection of related font files). |
Paper |
flModel::ModelType::Paper |
flPaper — the background (canvas) of the metrics view. |
Graphic |
flModel::ModelType::Graphic |
An embedded image element. |
ShapeBuilderMerger |
flModel::ModelType::ShapeBuilderMerger |
ShapeBuilder merge operation. |
ShapeBuilderAutoShape |
flModel::ModelType::ShapeBuilderAutoShape |
ShapeBuilder parametric auto-shape. |
ShapeBuilderStapledShape |
flModel::ModelType::ShapeBuilderStapledShape |
ShapeBuilder stapled shape. |
ShapeBuilderBoolOperation |
flModel::ModelType::ShapeBuilderBoolOperation |
ShapeBuilder boolean (union/subtract/intersect) operation. |
ShapeBuilderStem |
flModel::ModelType::ShapeBuilderStem |
ShapeBuilder stem shape. |
ShapeBuilderNice |
flModel::ModelType::ShapeBuilderNice |
Native enum value. |
ShapeBuilderSmartAngle |
flModel::ModelType::ShapeBuilderSmartAngle |
Native enum value. |
ShapeBuilderGroup |
flModel::ModelType::ShapeBuilderGroup |
Native enum value. |
ShapeBuilderBucket |
flModel::ModelType::ShapeBuilderBucket |
Native enum value. |
ShapeBuilderStroke |
flModel::ModelType::ShapeBuilderStroke |
ShapeBuilder stroke-expand shape. |
ShapeBuilderEngraving |
flModel::ModelType::ShapeBuilderEngraving |
ShapeBuilder engraving shape. |
Expression |
flModel::ModelType::Expression |
flExpression — a formula expression, used in variable font masters. |
Graph |
flModel::ModelType::Graph |
Graph data structures used internally by ShapeBuilder. |
Edge |
flModel::ModelType::Edge |
Graph data structures used internally by ShapeBuilder. |
Vertex |
flModel::ModelType::Vertex |
Graph data structures used internally by ShapeBuilder. |
NodeInfo |
flModel::ModelType::NodeInfo |
flNodeInfo — a canvas-level proxy for a node (holds screen position info). Not the same as the node itself. |
ContourInfo |
flModel::ModelType::ContourInfo |
flContourInfo — a canvas proxy for a contour. |
ShapeInfo |
flModel::ModelType::ShapeInfo |
flShapeInfo — a canvas proxy for a shape. |
LayerInfo |
flModel::ModelType::LayerInfo |
flLayerInfo — a canvas proxy for a layer. |
GlyphInfo |
flModel::ModelType::GlyphInfo |
flGlyphInfo — a canvas proxy for a glyph. |
Anchor |
flModel::ModelType::Anchor |
flAnchor — an anchor attachment object (related to PinPoint). |
AnchorNode |
flModel::ModelType::AnchorNode |
Native enum value. |
AnchorNodeToGuidelineCoords |
flModel::ModelType::AnchorNodeToGuidelineCoords |
Native enum value. |
SnapContour |
flModel::ModelType::SnapContour |
Native enum value. |
SnapPoint |
flModel::ModelType::SnapPoint |
Native enum value. |
SnapPinPoint |
flModel::ModelType::SnapPinPoint |
Native enum value. |
PaperModelProducer |
flModel::ModelType::PaperModelProducer |
Native enum value. |
TextBlockModelProducer |
flModel::ModelType::TextBlockModelProducer |
Native enum value. |
ParameterDouble |
flModel::ModelType::PropertyDouble |
flPropertyDouble — a scalar (single-number) axis parameter. |
ParameterPoint |
flModel::ModelType::PropertyPoint |
flPropertyPoint — a point (x, y) axis parameter. |
PropProcessorLayer |
flModel::ModelType::PropProcessorLayer |
Native enum value. |
PropProcessorGlyph |
flModel::ModelType::PropProcessorGlyph |
Native enum value. |
PropProcessorPackage |
flModel::ModelType::PropProcessorPackage |
Native enum value. |
Item |
flModel::ModelType::Item |
Native enum value. |
Enum: flModel.ObjectParameter
Parameters that can be applied to model objects. Used in ShapeBuilder and advanced transformation contexts.
| Key | Native value | Description |
|---|---|---|
prmStructure |
flModel::ObjectParameter::prmStructure |
The structural parameter — describes shape/contour topology. |
prmTransform |
flModel::ObjectParameter::prmTransform |
The transform parameter — describes position and scale. |
prmBrush |
flModel::ObjectParameter::prmBrush |
The brush parameter — ShapeBuilder stroke brush settings. |
prmPen |
flModel::ObjectParameter::prmPen |
The pen parameter — ShapeBuilder pen settings. |
Common Scripting Patterns
# The most common pattern: after any scripted edit, fire a notification
glyph = fl.CurrentFont()['A']
# ... (make changes to glyph.layers[0].shapes[0] here) ...
flModel.notifyGlyphChanged(glyph.id)
# Batch notification for efficiency
changed_glyphs = set()
for name in ['A', 'B', 'C']:
g = fl.CurrentFont()[name]
# ... edit g ...
changed_glyphs.add(g.id)
flModel.notifyGlyphsChanged(changed_glyphs)
# Type checking: confirm what kind of object you have
obj = something_from_the_api()
print(flModel.typeToStr(obj.type)) # e.g. "Node", "Shape", "GuideLine"
# Check if an object is of a specific type
if obj.type == flModel.ModelType["Node"]:
print("It's a node!")
Tutorial
import fontlab as fl
from fontlab import flModel
# ============================================================
# 1. Identifying object types
# ============================================================
# Every font object has a .type property — an integer code.
# typeToStr() turns that code into a human-readable name.
font = fl.CurrentFont()
glyph = font['A']
layer = glyph.layers[0]
shape = layer.shapes[0]
node = shape.contours[0].nodes()[0]
for obj, label in [(glyph, 'glyph'), (layer, 'layer'),
(shape, 'shape'), (node, 'node')]:
type_id = obj.type
type_name = flModel.typeToStr(type_id)
print(f" {label}: type={type_id} name='{type_name}'")
# Using ModelType to get type IDs by name:
print("Node type ID:", flModel.ModelType["Node"])
print("Shape type ID:", flModel.ModelType["Shape"])
print("GuideLine ID:", flModel.ModelType["GuideLine"])
# ============================================================
# 2. Creating objects dynamically
# ============================================================
# You can create a new, blank object by its type ID.
# This is useful for building objects programmatically.
node_type_id = flModel.ModelType["Node"]
new_node = flModel.createObject(node_type_id)
if new_node is not None:
print("Created a new:", flModel.typeToStr(new_node.type))
# ============================================================
# 3. Class mask checks (advanced)
# ============================================================
# isClassMask tells you if a type constant is a bitmask
# (abstract base class) rather than a concrete type:
print("Is 'Node' a class mask?",
flModel.isClassMask(flModel.ModelType["Node"])) # False — it's concrete
print("Is 'Object' a class mask?",
flModel.isClassMask(flModel.ModelType["Object"])) # True — it's abstract
# getClassMask: what abstract base categories does a type belong to?
mask = flModel.getClassMask(flModel.ModelType["Shape"])
print("Shape class mask:", bin(mask))
# ============================================================
# 4. Notifying FontLab after scripted edits
# ============================================================
# This is the most important real-world use of flModel.
# After you change glyph data from a script, FontLab's UI
# doesn't know about it until you send a notification.
# Get the fontgate glyph ID (not Unicode, not array index):
fg_id = glyph.id
# Lightweight: just refresh the visual display
flModel.notifyGlyphUpdate(fg_id)
# Full update: recalculate metrics, refresh previews, etc.
# Use this after actually changing node positions or outlines.
flModel.notifyGlyphChanged(fg_id)
# Batch update — efficient for multi-glyph scripts:
changed_ids = {font['A'].id, font['B'].id, font['C'].id}
flModel.notifyGlyphsChanged(changed_ids)
# ============================================================
# 5. Browsing ObjectParameter constants
# ============================================================
print("ObjectParameter constants:")
for k, v in flModel.ObjectParameter.items():
print(f" {k} = {v}")
All registered methods are static and take positional arguments.
Constructors: None, static only methods
Native bases: object
Captured native MRO: flModel, object
Native new allocation evidence (not an init overload): (args, *kwargs) Create and return a new object. See help(type) for accurate signature.
Supplemental documentation:
A static-only model class with no constructor. The captured declaration exposes the methods createObject, getClassMask, instance, isClassMask, notifyGlyphChanged, notifyGlyphUpdate, notifyGlyphsChanged and typeToStr, and the dict attributes ModelType and ObjectParameter. Call instance to obtain the flModel object.
Source: FontLab Proteus API documentation
Source: generated/fontlab.py: flModel captured declaration
Complete member index
Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.
| Member | Kind | Signature | Summary |
|---|---|---|---|
ModelType |
attribute | dict |
|
ObjectParameter |
attribute | dict |
|
__init__ |
function | (self, /, *args: Any, **kwargs: Any) -> None |
Initialize self. (shared captured text) |
createObject |
function | (type: int) -> Any |
FlObject/Nothing createObject(int type) |
getClassMask |
function | (type: int) -> int |
Returns a bitmask describing which base-class categories this type belongs to. |
instance |
function | () -> flModel |
Returns the application-wide flModel singleton. |
isClassMask |
function | (type: int) -> bool |
Returns True if the given constant is a class-mask bitmask rather than a concrete object type ID. |
notifyGlyphChanged |
function | (fg_glyphId: Any) -> Any |
|
notifyGlyphUpdate |
function | (fg_glyphId: Any) -> Any |
|
notifyGlyphsChanged |
function | (glyphs: set[Any]) -> Any |
|
typeToStr |
function | (flObject: Any) -> str |
Returns the human-readable name for a type code or object. |