Skip to content

Latest commit

 

History

History
272 lines (157 loc) · 5.21 KB

SamsaGlyph-reference.md

File metadata and controls

272 lines (157 loc) · 5.21 KB
Raw

SamsaGlyph

Class representing a glyph in the variable font object SamsaFont. They are usually stored in arrays as the glyphs property of either a SamsaFont object or an instance object.

Constructor

SamsaGlyph( init )

Parameters

  1. init : Object
init: {
    id: Number, 
    name: String, 
    font: SamsaFont Object
}

Returns

SamsaGlyph

Example

new SamsaGlyph({
    id: this.id, 
    name: this.name, 
    font: this.font
});

Properties

.curveOrder

Type: Number

This is 2 for glyphs with quadratic curves, that is, curves from TrueType glyphs. No other glyphs are handled currently, but this field would be 3 for glyphs with cubic outlines.

.endPts

Type: Array of Number

In a simple glyph, this array contains point ids for the last point of each contour. There are numContours entries. The last entry is equal to numPoints - 1. The array is imported directly from the TrueType source font. In a complex glyph, endPts is not used.

.font

Refer to its parent SamsaFont

Type: Object (SamsaFont)

.id

Glyph id in the SamsaFont

Type: Number

.instructionLength

Type: Number

.name

Postscript name for this glyph, such as "A", ".notdef", "dollar", "acircumflex".

Type: String

.numContours

For simple glyphs this is the number of contours. It is -1 for composite glyphs.

Type: Number

.numPoints

Total number of Points, not including phantom points. For simple glyphs, .numPoints is 4 less than .points.length because of the 4 phantom points representing metrics. Composite glyphs do not use .numPoints.

Type: Number

.points

Array of Points, including phantom points. For simple glyphs, .points.length is 4 more than .numPoints. For composite glyphs, the points represent the offsets of each of the components, therefore .points.length = + 4.

Type: Array of Array

Example

In this example, points 0 to 3 define a rectangle, and points 4 to 7 are the phantom points which Samsa has automatically added. The advance width is always the first element in the point 3rd from last, in this case 500. Note that .numPoints in this example is 4, while .points.length is 8.

[
	[50, 0, 1],
	[450, 0, 1],
	[450, 700, 1],
	[50, 700, 1],
	[0, 0],
	[500, 0],
	[0, 0],
	[0, 0]
]

.xMax

Type: Number

.xMin

Type: Number

.yMax

Type: Number

.yMin

Type: Number

.tvts

Array of tuple variable table (TVT) data structures. Each tvt defines:

  • a table of delta x,y movements for a subset of points (or components) in this glyph
  • the region of application in designspace using start, peak and end locations for each axis

Because TVT data is not always required, is not parsed as part of creating new glyphs using font.parseGlyph(<glyphId>). If it is required, TVT data is typically parsed immediately after parsing glyph data:

    let myGlyph;
    let g = 22;
    myGlyph = font.parseGlyph(g);
    myGlyph.tvts = font.parseTvts(g);.

Methods

.decompose ( tuple , params )

Decompose a composite glyph into a new simple glyph

Parameters

  1. tuple : Array
  2. params : Object – (optional)

Returns

Object (SamsaGlyph)

Source

samsa/src/samsa-core.js:201

.instantiate ( userTuple , instance , extra )

Take a default glyph and return the instantiation produced using the userTuple or instance settings

Parameters

  1. userTuple : Array or null
  2. instance : Object
  3. extra : Object – (optional)

Returns

Object (SamsaGlyph)

Example

glyph.instantiate(null, instance)

Source

samsa/src/samsa-core.js:311

.svgPath ()

Convert glyph’s points to a string that can be used as an SVG "d" attribute.

Coordinates are identical to those used in the font, so the SVG typically needs scaling and flipping vertically. The transformation is typically perfomed in an enclosing <g> tag to transform multiple SVG elements together.

Returns

String

Example

glyph.svgPath();

Result

"M50 0L450 0L450 700L50 700Z"

<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="1000" height="1000">
	<g transform="translate(0,500) scale(0.5,-0.5)">
		<path d="M50 0L450 0L450 700L50 700Z"></path>
	</g>
</svg>

Source

samsa/src/samsa-core.js:525

.svg ()

Export glyph as a string, suitable for saving as a complete SVG file.

.ttx ()

Export glyph as a string to be used as a complete XML <TTGlyph> structure within a TTX file.

.ufo ()

Export glyph as a string to be used as a complete XML structure as a standalone .glif file.

.json ()

Export glyph as a JSON representation of Samsa’s own data structure, but without the circular references of the internal object.

Source

samsa/src/samsa-core.js