blob: 6a43bdcc17b39869e760c30eb036d07fb7936e0c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
################################
1 DesignSpaceDocument Python API
################################
An object to read, write and edit interpolation systems for typefaces.
Define sources, axes, rules, variable fonts and instances.
Get an overview of the available classes in the Class Diagram below:
.. figure:: v5_class_diagram.png
:width: 650px
:alt: UML class diagram of designspaceLib
UML class diagram of designspaceLib. Click to enlarge.
.. contents:: Table of contents
:local:
.. _designspacedocument-object:
===================
DesignSpaceDocument
===================
.. autoclass:: fontTools.designspaceLib::DesignSpaceDocument
:members:
:undoc-members:
:member-order: bysource
.. _axis-descriptor-object:
AxisDescriptor
==============
.. autoclass:: fontTools.designspaceLib::AxisDescriptor
:members:
:undoc-members:
:inherited-members: SimpleDescriptor
:member-order: bysource
DiscreteAxisDescriptor
======================
.. autoclass:: fontTools.designspaceLib::DiscreteAxisDescriptor
:members:
:undoc-members:
:inherited-members: SimpleDescriptor
:member-order: bysource
AxisLabelDescriptor
-------------------
.. autoclass:: fontTools.designspaceLib::AxisLabelDescriptor
:members:
:undoc-members:
:member-order: bysource
LocationLabelDescriptor
=======================
.. autoclass:: fontTools.designspaceLib::LocationLabelDescriptor
:members:
:undoc-members:
:member-order: bysource
RuleDescriptor
==============
.. autoclass:: fontTools.designspaceLib::RuleDescriptor
:members:
:undoc-members:
:member-order: bysource
Evaluating rules
----------------
.. autofunction:: fontTools.designspaceLib::evaluateRule
.. autofunction:: fontTools.designspaceLib::evaluateConditions
.. autofunction:: fontTools.designspaceLib::processRules
.. _source-descriptor-object:
SourceDescriptor
================
.. autoclass:: fontTools.designspaceLib::SourceDescriptor
:members:
:undoc-members:
:member-order: bysource
VariableFontDescriptor
======================
.. autoclass:: fontTools.designspaceLib::VariableFontDescriptor
:members:
:undoc-members:
:member-order: bysource
RangeAxisSubsetDescriptor
-------------------------
.. autoclass:: fontTools.designspaceLib::RangeAxisSubsetDescriptor
:members:
:undoc-members:
:member-order: bysource
ValueAxisSubsetDescriptor
-------------------------
.. autoclass:: fontTools.designspaceLib::ValueAxisSubsetDescriptor
:members:
:undoc-members:
:member-order: bysource
.. _instance-descriptor-object:
InstanceDescriptor
==================
.. autoclass:: fontTools.designspaceLib::InstanceDescriptor
:members:
:undoc-members:
:member-order: bysource
.. _subclassing-descriptors:
=======================
Subclassing descriptors
=======================
The DesignSpaceDocument can take subclassed Reader and Writer objects.
This allows you to work with your own descriptors. You could subclass
the descriptors. But as long as they have the basic attributes the
descriptor does not need to be a subclass.
.. code:: python
class MyDocReader(BaseDocReader):
axisDescriptorClass = MyAxisDescriptor
discreteAxisDescriptorClass = MyDiscreteAxisDescriptor
axisLabelDescriptorClass = MyAxisLabelDescriptor
locationLabelDescriptorClass = MyLocationLabelDescriptor
ruleDescriptorClass = MyRuleDescriptor
sourceDescriptorClass = MySourceDescriptor
variableFontsDescriptorClass = MyVariableFontDescriptor
valueAxisSubsetDescriptorClass = MyValueAxisSubsetDescriptor
rangeAxisSubsetDescriptorClass = MyRangeAxisSubsetDescriptor
instanceDescriptorClass = MyInstanceDescriptor
class MyDocWriter(BaseDocWriter):
axisDescriptorClass = MyAxisDescriptor
discreteAxisDescriptorClass = MyDiscreteAxisDescriptor
axisLabelDescriptorClass = MyAxisLabelDescriptor
locationLabelDescriptorClass = MyLocationLabelDescriptor
ruleDescriptorClass = MyRuleDescriptor
sourceDescriptorClass = MySourceDescriptor
variableFontsDescriptorClass = MyVariableFontDescriptor
valueAxisSubsetDescriptorClass = MyValueAxisSubsetDescriptor
rangeAxisSubsetDescriptorClass = MyRangeAxisSubsetDescriptor
instanceDescriptorClass = MyInstanceDescriptor
myDoc = DesignSpaceDocument(MyDocReader, MyDocWriter)
==============
Helper modules
==============
fontTools.designspaceLib.split
==============================
See :ref:`Scripting > Working with DesignSpace version 5 <working_with_v5>`
for more information.
.. automodule:: fontTools.designspaceLib.split
fontTools.designspaceLib.stat
=============================
.. automodule:: fontTools.designspaceLib.stat
fontTools.designspaceLib.statNames
==================================
.. automodule:: fontTools.designspaceLib.statNames
|
