Skip to content

Commit f6d5fa9

Browse files
committed
release 0.3a4
1 parent 4d4615a commit f6d5fa9

File tree

18 files changed

+9812
-6309
lines changed

18 files changed

+9812
-6309
lines changed

py5/__init__.py

Lines changed: 1656 additions & 1459 deletions
Large diffs are not rendered by default.

py5/font.py

Lines changed: 78 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class Py5Font:
6262
6363
To create a new font dynamically, use the ``create_font()`` function. Do not use
6464
the syntax ``new Py5Font()``.
65-
"""
65+
"""
6666

6767
_cls = jpype.JClass('processing.core.PFont')
6868
CHARSET = _cls.CHARSET
@@ -71,80 +71,92 @@ def __init__(self, pfont):
7171
self._instance = pfont
7272

7373
def ascent(self) -> float:
74-
"""new template no description.
74+
"""The documentation for this field or method has not yet been written.
7575
7676
Underlying Java method: PFont.ascent
7777
7878
Notes
7979
-----
8080
81-
new template no description.
82-
"""
81+
The documentation for this field or method has not yet been written. If you know
82+
what it does, please help out with a pull request to the relevant file in
83+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
84+
"""
8385
return self._instance.ascent()
8486

8587
def descent(self) -> float:
86-
"""new template no description.
88+
"""The documentation for this field or method has not yet been written.
8789
8890
Underlying Java method: PFont.descent
8991
9092
Notes
9193
-----
9294
93-
new template no description.
94-
"""
95+
The documentation for this field or method has not yet been written. If you know
96+
what it does, please help out with a pull request to the relevant file in
97+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
98+
"""
9599
return self._instance.descent()
96100

97101
def get_default_size(self) -> int:
98-
"""new template no description.
102+
"""The documentation for this field or method has not yet been written.
99103
100104
Underlying Java method: PFont.getDefaultSize
101105
102106
Notes
103107
-----
104108
105-
new template no description.
106-
"""
109+
The documentation for this field or method has not yet been written. If you know
110+
what it does, please help out with a pull request to the relevant file in
111+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
112+
"""
107113
return self._instance.getDefaultSize()
108114

109115
def get_glyph_count(self) -> int:
110-
"""new template no description.
116+
"""The documentation for this field or method has not yet been written.
111117
112118
Underlying Java method: PFont.getGlyphCount
113119
114120
Notes
115121
-----
116122
117-
new template no description.
118-
"""
123+
The documentation for this field or method has not yet been written. If you know
124+
what it does, please help out with a pull request to the relevant file in
125+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
126+
"""
119127
return self._instance.getGlyphCount()
120128

121129
def get_name(self) -> str:
122-
"""new template no description.
130+
"""The documentation for this field or method has not yet been written.
123131
124132
Underlying Java method: PFont.getName
125133
126134
Notes
127135
-----
128136
129-
new template no description.
130-
"""
137+
The documentation for this field or method has not yet been written. If you know
138+
what it does, please help out with a pull request to the relevant file in
139+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
140+
"""
131141
return self._instance.getName()
132142

133143
def get_post_script_name(self) -> str:
134-
"""new template no description.
144+
"""The documentation for this field or method has not yet been written.
135145
136146
Underlying Java method: PFont.getPostScriptName
137147
138148
Notes
139149
-----
140150
141-
new template no description.
142-
"""
151+
The documentation for this field or method has not yet been written. If you know
152+
what it does, please help out with a pull request to the relevant file in
153+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
154+
"""
143155
return self._instance.getPostScriptName()
144156

145157
@overload
146158
def get_shape(self, ch: chr, /) -> Py5Shape:
147-
"""new template no description.
159+
"""The documentation for this field or method has not yet been written.
148160
149161
Underlying Java method: PFont.getShape
150162
@@ -153,8 +165,8 @@ def get_shape(self, ch: chr, /) -> Py5Shape:
153165
154166
You can use any of the following signatures:
155167
156-
* get_shape(ch: chr) -> Py5Shape
157-
* get_shape(ch: chr, detail: float) -> Py5Shape
168+
* get_shape(ch: chr, /) -> Py5Shape
169+
* get_shape(ch: chr, detail: float, /) -> Py5Shape
158170
159171
Parameters
160172
----------
@@ -168,13 +180,15 @@ def get_shape(self, ch: chr, /) -> Py5Shape:
168180
Notes
169181
-----
170182
171-
new template no description.
172-
"""
183+
The documentation for this field or method has not yet been written. If you know
184+
what it does, please help out with a pull request to the relevant file in
185+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
186+
"""
173187
pass
174188

175189
@overload
176190
def get_shape(self, ch: chr, detail: float, /) -> Py5Shape:
177-
"""new template no description.
191+
"""The documentation for this field or method has not yet been written.
178192
179193
Underlying Java method: PFont.getShape
180194
@@ -183,8 +197,8 @@ def get_shape(self, ch: chr, detail: float, /) -> Py5Shape:
183197
184198
You can use any of the following signatures:
185199
186-
* get_shape(ch: chr) -> Py5Shape
187-
* get_shape(ch: chr, detail: float) -> Py5Shape
200+
* get_shape(ch: chr, /) -> Py5Shape
201+
* get_shape(ch: chr, detail: float, /) -> Py5Shape
188202
189203
Parameters
190204
----------
@@ -198,13 +212,15 @@ def get_shape(self, ch: chr, detail: float, /) -> Py5Shape:
198212
Notes
199213
-----
200214
201-
new template no description.
202-
"""
215+
The documentation for this field or method has not yet been written. If you know
216+
what it does, please help out with a pull request to the relevant file in
217+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
218+
"""
203219
pass
204220

205221
@_return_py5shape
206222
def get_shape(self, *args):
207-
"""new template no description.
223+
"""The documentation for this field or method has not yet been written.
208224
209225
Underlying Java method: PFont.getShape
210226
@@ -213,8 +229,8 @@ def get_shape(self, *args):
213229
214230
You can use any of the following signatures:
215231
216-
* get_shape(ch: chr) -> Py5Shape
217-
* get_shape(ch: chr, detail: float) -> Py5Shape
232+
* get_shape(ch: chr, /) -> Py5Shape
233+
* get_shape(ch: chr, detail: float, /) -> Py5Shape
218234
219235
Parameters
220236
----------
@@ -228,44 +244,52 @@ def get_shape(self, *args):
228244
Notes
229245
-----
230246
231-
new template no description.
232-
"""
247+
The documentation for this field or method has not yet been written. If you know
248+
what it does, please help out with a pull request to the relevant file in
249+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
250+
"""
233251
return self._instance.getShape(*args)
234252

235253
def get_size(self) -> int:
236-
"""new template no description.
254+
"""The documentation for this field or method has not yet been written.
237255
238256
Underlying Java method: PFont.getSize
239257
240258
Notes
241259
-----
242260
243-
new template no description.
244-
"""
261+
The documentation for this field or method has not yet been written. If you know
262+
what it does, please help out with a pull request to the relevant file in
263+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
264+
"""
245265
return self._instance.getSize()
246266

247267
def is_smooth(self) -> bool:
248-
"""new template no description.
268+
"""The documentation for this field or method has not yet been written.
249269
250270
Underlying Java method: PFont.isSmooth
251271
252272
Notes
253273
-----
254274
255-
new template no description.
256-
"""
275+
The documentation for this field or method has not yet been written. If you know
276+
what it does, please help out with a pull request to the relevant file in
277+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
278+
"""
257279
return self._instance.isSmooth()
258280

259281
def is_stream(self) -> bool:
260-
"""new template no description.
282+
"""The documentation for this field or method has not yet been written.
261283
262284
Underlying Java method: PFont.isStream
263285
264286
Notes
265287
-----
266288
267-
new template no description.
268-
"""
289+
The documentation for this field or method has not yet been written. If you know
290+
what it does, please help out with a pull request to the relevant file in
291+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
292+
"""
269293
return self._instance.isStream()
270294

271295
@classmethod
@@ -281,23 +305,25 @@ def list(cls) -> List[str]:
281305
Gets a list of the fonts installed on the system. The data is returned as a
282306
String array. This list provides the names of each font for input into
283307
``create_font()``, which allows Processing to dynamically format fonts.
284-
"""
308+
"""
285309
return cls._cls.list()
286310

287311
def set_subsetting(self) -> None:
288-
"""new template no description.
312+
"""The documentation for this field or method has not yet been written.
289313
290314
Underlying Java method: PFont.setSubsetting
291315
292316
Notes
293317
-----
294318
295-
new template no description.
296-
"""
319+
The documentation for this field or method has not yet been written. If you know
320+
what it does, please help out with a pull request to the relevant file in
321+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
322+
"""
297323
return self._instance.setSubsetting()
298324

299325
def width(self, c: chr, /) -> float:
300-
"""new template no description.
326+
"""The documentation for this field or method has not yet been written.
301327
302328
Underlying Java method: PFont.width
303329
@@ -310,6 +336,8 @@ def width(self, c: chr, /) -> float:
310336
Notes
311337
-----
312338
313-
new template no description.
314-
"""
339+
The documentation for this field or method has not yet been written. If you know
340+
what it does, please help out with a pull request to the relevant file in
341+
https://github.com/hx2A/py5generator/tree/master/py5_docs/Reference/api_en/.
342+
"""
315343
return self._instance.width(c)

0 commit comments

Comments
 (0)