Anchor

Description

Anchors are single points in a glyph which are not part of a contour. They can be used as reference positions for doing things like assembling components. In most font editors, anchors have a special appearance and can be edited.

glyph = CurrentGlyph()
for anchor in glyph.anchors:
    print(anchor)

Overview

Copy

BaseAnchor.copy

Copy the current object into a new object of the same type.

Parents

BaseAnchor.glyph

Get or set the anchor's parent glyph object.

BaseAnchor.layer

Get the anchor's parent layer object.

BaseAnchor.font

Get the anchor's parent font object.

Identification

BaseAnchor.name

Get or set the anchor's name.

BaseAnchor.color

Get or set the anchor's color.

BaseAnchor.identifier

Get the object's unique identifier.

BaseAnchor.index

Get the anchor's index.

Coordinate

BaseAnchor.x

Get or set the anchor's x-coordinate.

BaseAnchor.y

Get or set the anchor's y-coordinate.

Transformations

BaseAnchor.transformBy

Transform the object according to the given matrix.

BaseAnchor.moveBy

Move the object according to the given coordinates.

BaseAnchor.scaleBy

Scale the object according to the given values.

BaseAnchor.rotateBy

Rotate the object by the specified value.

BaseAnchor.skewBy

Skew the object by the given value.

Normalization

BaseAnchor.round

Round the anchor's coordinate.

Environment

BaseAnchor.naked

Return the environment's native object wrapped by the current object.

BaseAnchor.changed

Tell the environment that something has changed in the object.

Reference

class fontParts.base.BaseAnchor(*args: Any, **kwargs: Any)[source]

Represent the basis for an anchor object.

This object is almost always created with BaseGlyph.appendAnchor. An orphan anchor can be created like this:

>>> anchor = RAnchor()

Copy

BaseAnchor.copy() BaseObjectType

Copy the current object into a new object of the same type.

The returned object will not have a parent object.

Returns:

A new BaseObject subclass instance with the same attributes.

Parents

BaseAnchor.glyph: dynamicProperty

Get or set the anchor’s parent glyph object.

The value must be a BaseGlyph instance or None.

Returns:

The BaseGlyph instance containing the anchor or None.

Raises:

AssertionError – If attempting to set the glyph when it has already been set.

Example:

>>> glyph = anchor.glyph
BaseAnchor.layer: dynamicProperty

Get the anchor’s parent layer object.

This property is read-only.

Returns:

The BaseLayer instance containing the anchor or None.

Example:

>>> layer = anchor.layer
BaseAnchor.font: dynamicProperty

Get the anchor’s parent font object.

This property is read-only.

Returns:

The BaseFont instance containing the anchor or None.

Example:

>>> font = anchor.font

Identification

BaseAnchor.name: dynamicProperty

Get or set the anchor’s name.

The value must be a str or None.

Returns:

A str representing the name of the anchor, or None.

>>> anchor.name
'my anchor'
>>> anchor.name = None

BaseAnchor.color: dynamicProperty

Get or set the anchor’s color.

The value must be a Color or None.

Returns:

A Color representing the color of the anchor, or None.

Example:

>>> anchor.color
None
>>> anchor.color = (1, 0, 0, 0.5)
BaseAnchor.identifier

Get the object’s unique identifier.

This attribute is read-only. Use IdentifierMixin.getIdentifier to request an identifier if it does not exist.

Returns:

The unique identifier assigned to the object as a str, or None indicating the object has no identifier.

Example

>>> object.identifier
'ILHGJlygfds'
BaseAnchor.index: dynamicProperty

Get the anchor’s index.

This property is read-only.

Returns:

An int representing the index of the anchor within the ordered list of the parent glyph’s anchors.

Example:

>>> guideline.index
0

Coordinate

BaseAnchor.x

Get or set the anchor’s x-coordinate.

The value must be an int or a float.

Returns:

An int or a float representing the x-coordinate of the anchor.

Example:

>>> anchor.x
100
>>> anchor.x = 101
BaseAnchor.y: dynamicProperty

Get or set the anchor’s y-coordinate.

The value must be an int or a float.

Returns:

An int or a float representing the y-coordinate of the anchor.

Example:

>>> anchor.y
100
>>> anchor.y = 101

Transformations

BaseAnchor.transformBy(matrix: list[int | float] | tuple[float, float, float, float, float, float], origin: list[int | float] | tuple[int | float, int | float] | None = None) None

Transform the object according to the given matrix.

Parameters:
  • matrix – The Transformation Matrix to apply.

  • origin – The optional point at which the transformation should originate as a:ref:type-coordinate. Defaults to None, representing an origin of (0, 0).

Example:

>>> obj.transformBy((0.5, 0, 0, 2.0, 10, 0))
>>> obj.transformBy((0.5, 0, 0, 2.0, 10, 0), origin=(500, 500))
BaseAnchor.moveBy(value: list[int | float] | tuple[int | float, int | float]) None

Move the object according to the given coordinates.

Parameters:

value – The x and y values to move the object by as a Coordinate.

Example:

>>> obj.moveBy((10, 0))
BaseAnchor.scaleBy(value: int | float | list[int | float] | tuple[float, float], origin: list[int | float] | tuple[int | float, int | float] | None = None) None

Scale the object according to the given values.

Parameters:
  • value – The value to scale the glyph by as a single int or float, or a tuple or list of two int or float values representing the values (x, y).

  • origin – The optional point at which the scale should originate as a Coordinate. Defaults to None, representing an origin of (0, 0).

Example:

>>> obj.scaleBy(2.0)
>>> obj.scaleBy((0.5, 2.0), origin=(500, 500))
BaseAnchor.rotateBy(value: int | float, origin: list[int | float] | tuple[int | float, int | float] | None = None) None

Rotate the object by the specified value.

Parameters:
  • value – The angle at which to rotate the object as an int or a float.

  • origin – The optional point at which the rotation should originate as a Coordinate. Defaults to None, representing an origin of (0, 0).

Example:

>>> obj.rotateBy(45)
>>> obj.rotateBy(45, origin=(500, 500))
BaseAnchor.skewBy(value: int | float | list[int | float] | tuple[float, float], origin: list[int | float] | tuple[int | float, int | float] | None = None) None

Skew the object by the given value.

Parameters:
  • value – The value by which to skew the object as either a single int or float corresponding to the x direction, or a tuple of two int or float values corresponding to the x and y directions.

  • origin – The optional point at which the rotation should originate as a Coordinate. Defaults to None, representing an origin of (0, 0).

Example:

>>> obj.skewBy(11)
>>> obj.skewBy((25, 10), origin=(500, 500))

Normalization

BaseAnchor.round() None[source]

Round the anchor’s coordinate.

This applies to:

  • x

  • :attr:`y

Example::`

>>> guideline.round()

Environment

BaseAnchor.naked() Any

Return the environment’s native object wrapped by the current object.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Example:

>>> loweLevelObj = obj.naked()
BaseAnchor.changed(*args: Any, **kwargs: Any) None

Tell the environment that something has changed in the object.

The behavior of this method will vary from environment to environment.

Parameters:
  • *args – Any positional arguments.

  • **kwargs – Any keyword arguments.

Example:

>>> obj.changed()