Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity

resources renamed to media.ev3dev

Browse Source
This commit is contained in:
David Lechner
2020-01-14 17:32:40 -06:00
parent a6e6de28b5
commit dc82ccce40
8 changed files with 350 additions and 348 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/index.rst
-1
View File
@@ -28,7 +28,6 @@ Intro
parameters
tools
robotics
resources
media
.. toctree::
doc/api/media.rst
+83 -1
View File
@@ -10,7 +10,89 @@ folder. You can also use any of the images and sounds built into Pybricks.
ev3dev
------
These images and sounds are only available for Pybricks on ev3dev.
.. automodule:: pybricks.media.ev3dev
:no-members:
Graphical Images
^^^^^^^^^^^^^^^^
.. autoclass:: pybricks.media.ev3dev.Image
:no-members:
.. rubric:: Drawing Text
There are two ways to draw text on images. :meth:`draw_text` lets text be
placed precisely on the image or :meth:`print` can be used to automatically
print text on a new line.
.. automethod:: pybricks.media.ev3dev.Image.draw_text
.. automethod:: pybricks.media.ev3dev.Image.print
.. automethod:: pybricks.media.ev3dev.Image.set_font
.. rubric:: Drawing Images
A copy of another image can be drawn on an image. Also consider using
sub-images to copy part of an image.
.. automethod:: pybricks.media.ev3dev.Image.draw_image
.. rubric:: Drawing Shapes
These are the methods to draw basic shapes, including points, lines,
rectangles and circles.
.. automethod:: pybricks.media.ev3dev.Image.draw_pixel
.. automethod:: pybricks.media.ev3dev.Image.draw_line
.. automethod:: pybricks.media.ev3dev.Image.draw_box
.. automethod:: pybricks.media.ev3dev.Image.draw_circle
.. rubric:: Image properties
.. autoattribute:: pybricks.media.ev3dev.Image.width
.. autoattribute:: pybricks.media.ev3dev.Image.height
.. rubric:: Replacing the Entire Image
.. automethod:: pybricks.media.ev3dev.Image.clear
.. automethod:: pybricks.media.ev3dev.Image.show_image
Fonts
^^^^^
.. autoclass:: pybricks.media.ev3dev.Font
:no-members:
.. autoattribute:: pybricks.media.ev3dev.Font.DEFAULT
:annotation: = Font('Lucida', 12)
.. autoattribute:: pybricks.media.ev3dev.Font.family
.. autoattribute:: pybricks.media.ev3dev.Font.style
.. autoattribute:: pybricks.media.ev3dev.Font.width
.. autoattribute:: pybricks.media.ev3dev.Font.height
.. automethod:: pybricks.media.ev3dev.Font.text_width
.. automethod:: pybricks.media.ev3dev.Font.text_height
Files
^^^^^
.. autoclass:: pybricks.media.ev3dev.ImageFile
:no-members:
doc/api/resources.rst
-81
View File
@@ -1,81 +0,0 @@
:mod:`resources <pybricks.resources>` -- Resources
==================================================
.. automodule:: pybricks.resources
:no-members:
Graphical Images
^^^^^^^^^^^^^^^^
.. autoclass:: pybricks.resources.Image
:no-members:
.. rubric:: Drawing Text
There are two ways to draw text on images. :meth:`draw_text` lets text be
placed precisely on the image or :meth:`print` can be used to automatically
print text on a new line.
.. automethod:: pybricks.resources.Image.draw_text
.. automethod:: pybricks.resources.Image.print
.. automethod:: pybricks.resources.Image.set_font
.. rubric:: Drawing Images
A copy of another image can be drawn on an image. Also consider using
sub-images to copy part of an image.
.. automethod:: pybricks.resources.Image.draw_image
.. rubric:: Drawing Shapes
These are the methods to draw basic shapes, including points, lines,
rectangles and circles.
.. automethod:: pybricks.resources.Image.draw_pixel
.. automethod:: pybricks.resources.Image.draw_line
.. automethod:: pybricks.resources.Image.draw_box
.. automethod:: pybricks.resources.Image.draw_circle
.. rubric:: Image properties
.. autoattribute:: pybricks.resources.Image.width
.. autoattribute:: pybricks.resources.Image.height
.. rubric:: Replacing the Entire Image
.. automethod:: pybricks.resources.Image.clear
.. automethod:: pybricks.resources.Image.show_image
Fonts
^^^^^
.. autoclass:: pybricks.resources.Font
:no-members:
.. autoattribute:: pybricks.resources.Font.DEFAULT
:annotation: = Font('Lucida', 12)
.. autoattribute:: pybricks.resources.Font.family
.. autoattribute:: pybricks.resources.Font.style
.. autoattribute:: pybricks.resources.Font.width
.. autoattribute:: pybricks.resources.Font.height
.. automethod:: pybricks.resources.Font.text_width
.. automethod:: pybricks.resources.Font.text_height
doc/common/conf.py
+3 -3
View File
@@ -24,7 +24,7 @@ sys.path.insert(0, os.path.abspath('../..'))
from pybricks import _version # noqa E402
from pybricks.hubs import EV3Brick # noqa E402
from pybricks.resources import Image # noqa E402
from pybricks.media.ev3dev import Image # noqa E402
from pybricks.builtins import Speaker # noqa E402
# ON_RTD is whether we are on readthedocs.org
@@ -287,9 +287,9 @@ def find_obj(self, env, modname, classname, name, type, searchmode=0):
if modname == 'pybricks.hubs':
if classname == 'screen':
if name.startswith('Font.') or name == 'Font':
modname = 'pybricks.resources'
modname = 'pybricks.media.ev3dev'
elif name.startswith('Image.') or name == 'Image':
modname = 'pybricks.resources'
modname = 'pybricks.media.ev3dev'
else:
classname = 'EV3Brick.screen'
elif classname == 'speaker':
pybricks-projects
+1 -1
Submodule pybricks-projects updated: b7a111a78f...f7f1ce5768
pybricks/hubs.py
+1 -1
View File
@@ -1,7 +1,7 @@
"""LEGO® Programmable Hubs."""
from enum import Enum
from .builtins import Speaker, Battery, ColorLight, KeyPad
from .resources import Image
from .media.ev3dev import Image
class EV3Brick:
pybricks/media/ev3dev.py
+262
View File
@@ -1,3 +1,265 @@
"""Images and Sounds for Pybricks on ev3dev."""
from ..parameters import Color
class Image:
"""Object representing a graphics image. This can either be an in-memory
copy of an image or the image displayed on a screen."""
def __init__(self, source, sub=False):
"""
Arguments:
source (str or Image):
The source of the image.
If ``source`` is a string, then the image will be loaded from
the file path given by the string. Only ``.png`` files are
supported. As a special case, if the string is ``_screen_``,
the image will be configured to draw directly on the screen.
If an :class:`Image` is given, the new object will contain a
copy of the ``source`` image object.
sub (bool):
If ``sub`` is ``True``, then the image object will act as a
sub-image of the ``source`` image (this only works if the type
of ``source`` is :class:`Image` and not when it is a ``str``).
Additional keyword arguments ``x1``, ``y1`, ``x2``, ``y2`` are
needed when ``sub=True``. These specify the top-left and
bottom-right coordinates in the ``source`` image that will be
used as the bounds for the sub-image.
"""
pass
@property
def width(self):
"""Gets the width of the image in pixels."""
return 0
@property
def height(self):
"""Gets the height of the image in pixels."""
return 0
def clear(self):
"""Clears the image. All pixels in the image will be set to
:attr:`Color.WHITE <pybricks.parameters.Color.WHITE>`.
"""
pass
def draw_pixel(self, x, y, color=Color.BLACK):
"""Draws a single pixel on the image.
Arguments:
x (int): The x coordinate of the pixel.
y (int): The y coordinate of the pixel.
color (Color): The color of the pixel.
"""
pass
def draw_line(self, x1, y1, x2, y2, color=Color.BLACK):
"""Draws a line on the image.
Arguments:
x1 (int): The x coordinate of the starting point of the line.
y1 (int): The y coordinate of the starting point of the line.
x2 (int): The x coordinate of the ending point of the line.
y2 (int): The y coordinate of the ending point of the line.
color (Color): The color of the line.
"""
pass
def draw_box(self, x1, y1, x2, y2, r=0, fill=False, color=Color.BLACK):
"""Draws a box on the image.
Arguments:
x1 (int): The x coordinate of the left side of the box.
y1 (int): The y coordinate of the top of the box.
x2 (int): The x coordinate of the right side of the box.
y2 (int): The y coordinate of the bottom of the box.
r (int): The radius of the corners of the box.
fill (bool): If ``True``, the box will be filled with ``color``,
otherwise only the outline of the box will be drawn.
color (Color): The color of the box.
"""
pass
def draw_circle(self, x, y, r=0, fill=False, color=Color.BLACK):
"""Draws a circle on the image.
Arguments:
x (int): The x coordinate of the center of the circle.
y (int): The y coordinate of the center of the circle.
r (int): The radius of the circle.
fill (bool): If ``True``, the circle will be filled with
``color``, otherwise only the circumference will be drawn.
color (Color): The color of the circle.
"""
pass
def draw_image(self, x, y, image, color=None):
"""Draws a copy of another image on this image.
Arguments:
x (int):
The x-axis value where the left side of the image will start.
y (int):
The y-axis value where the top of the image will start.
image (Image):
The image to copy.
color (Color):
The color of ``image`` to treat as transparent or ``None`` for
no transparency.
"""
def show_image(self, source):
"""Clears this image, then draws ``source`` centered in this image.
Arguments:
source (Image or str):
The source :class:`Image`. If the argument is a string, then
the ``source`` image is loaded from file.
"""
def draw_text(self, x, y, text, color=Color.BLACK):
"""Draws text on the image.
The most recent font set using :meth:`set_font` will be used or
:data:`Font.DEFAULT` if no font has been set yet.
Arguments:
x (int):
The x-axis value where the left side of the text will start.
y (int):
The y-axis value where the top of the text will start.
text (str):
The text to display.
color (Color):
The color used for drawing the text.
"""
pass
def print(self, *args, sep=' ', end='\n'):
"""Prints a line of text on the image.
This method works like the built-in ``print()`` function except that
it writes the text on the image instead.
The most recent font set using :meth:`set_font` will be used or
:data:`Font.DEFAULT` if no font has been set yet.
Lines are not wrapped if they are too long to fit on the image
horizontally. On the other hand, If the text would be printed off of
the image vertically, the entire image is scrolled up so that the text
will be visible in the image.
Arguments:
* (object):
Zero or more objects to print.
sep (str):
Separator that will be placed between each object that is
printed.
end (str):
End of line that will be printed after the last object.
"""
pass
def set_font(self, font):
"""Sets the font used for writing on this image.
The font is used for both :meth:`draw_text` and :meth:`print`.
Arguments:
font (:class:`Font`):
The font to use.
"""
pass
class Font:
"""Object that represents a font for writing text."""
DEFAULT = None # assigned later since we can't use Font() here
"""The default font."""
def __init__(self, family=None, size=12, bold=False, monospace=False,
lang=None, scrip=None):
"""The font object will be a font that is the "best" match based on the
parameters given and available fonts installed.
Arguments:
family (str):
The preferred font family or ``None`` to use the default value.
size (int):
The preferred font size. Most fonts have sizes between 6 and 24.
This is the "point" size and not the same as :attr:`height`.
bold (bool):
When ``True``, prefer bold fonts.
monospace (bool):
When ``True`` prefer monospaced fonts. This is useful for
aligning multiple rows of text.
lang (str):
A language code, such as "en-us" or "zh-cn" or ``None`` to use
the default language.
script (str):
A unicode script identifier such as "Runr" or ``None``.
"""
@property
def family(self):
"""Gets the family name of the font."""
return 'Lucida'
@property
def style(self):
"""Gets a string describing the font style.
Can be "Regular" or "Bold".
"""
return 'Regular'
@property
def width(self):
"""Gets the width of the widest character of the font."""
return 0
@property
def height(self):
"""Gets the height of the font."""
return 0
def text_width(self, text):
"""Gets the width of the text when the text is drawn using this font.
Arguments:
text (str):
The text.
Returns:
int:
The width in pixels.
"""
return 0
def text_height(self, text):
"""Gets the height of the text when the text is drawn using this font.
Arguments:
text (str):
The text.
Returns:
int:
The height in pixels.
"""
return 0
Font.DEFAULT = Font('Lucida', 12)
class SoundFile():
"""Paths to standard EV3 sounds.
pybricks/resources.py
-260
View File
@@ -1,260 +0,0 @@
"""Resources module for the Pybricks API."""
from .parameters import Color
class Image:
"""Object representing a graphics image. This can either be an in-memory
copy of an image or the image displayed on a screen."""
def __init__(self, source, sub=False):
"""
Arguments:
source (str or Image):
The source of the image.
If ``source`` is a string, then the image will be loaded from
the file path given by the string. Only ``.png`` files are
supported. As a special case, if the string is ``_screen_``,
the image will be configured to draw directly on the screen.
If an :class:`Image` is given, the new object will contain a
copy of the ``source`` image object.
sub (bool):
If ``sub`` is ``True``, then the image object will act as a
sub-image of the ``source`` image (this only works if the type
of ``source`` is :class:`Image` and not when it is a ``str``).
Additional keyword arguments ``x1``, ``y1`, ``x2``, ``y2`` are
needed when ``sub=True``. These specify the top-left and
bottom-right coordinates in the ``source`` image that will be
used as the bounds for the sub-image.
"""
pass
@property
def width(self):
"""Gets the width of the image in pixels."""
return 0
@property
def height(self):
"""Gets the height of the image in pixels."""
return 0
def clear(self):
"""Clears the image. All pixels in the image will be set to
:attr:`Color.WHITE <pybricks.parameters.Color.WHITE>`.
"""
pass
def draw_pixel(self, x, y, color=Color.BLACK):
"""Draws a single pixel on the image.
Arguments:
x (int): The x coordinate of the pixel.
y (int): The y coordinate of the pixel.
color (Color): The color of the pixel.
"""
pass
def draw_line(self, x1, y1, x2, y2, color=Color.BLACK):
"""Draws a line on the image.
Arguments:
x1 (int): The x coordinate of the starting point of the line.
y1 (int): The y coordinate of the starting point of the line.
x2 (int): The x coordinate of the ending point of the line.
y2 (int): The y coordinate of the ending point of the line.
color (Color): The color of the line.
"""
pass
def draw_box(self, x1, y1, x2, y2, r=0, fill=False, color=Color.BLACK):
"""Draws a box on the image.
Arguments:
x1 (int): The x coordinate of the left side of the box.
y1 (int): The y coordinate of the top of the box.
x2 (int): The x coordinate of the right side of the box.
y2 (int): The y coordinate of the bottom of the box.
r (int): The radius of the corners of the box.
fill (bool): If ``True``, the box will be filled with ``color``,
otherwise only the outline of the box will be drawn.
color (Color): The color of the box.
"""
pass
def draw_circle(self, x, y, r=0, fill=False, color=Color.BLACK):
"""Draws a circle on the image.
Arguments:
x (int): The x coordinate of the center of the circle.
y (int): The y coordinate of the center of the circle.
r (int): The radius of the circle.
fill (bool): If ``True``, the circle will be filled with
``color``, otherwise only the circumference will be drawn.
color (Color): The color of the circle.
"""
pass
def draw_image(self, x, y, image, color=None):
"""Draws a copy of another image on this image.
Arguments:
x (int):
The x-axis value where the left side of the image will start.
y (int):
The y-axis value where the top of the image will start.
image (Image):
The image to copy.
color (Color):
The color of ``image`` to treat as transparent or ``None`` for
no transparency.
"""
def show_image(self, source):
"""Clears this image, then draws ``source`` centered in this image.
Arguments:
source (Image or str):
The source :class:`Image`. If the argument is a string, then
the ``source`` image is loaded from file.
"""
def draw_text(self, x, y, text, color=Color.BLACK):
"""Draws text on the image.
The most recent font set using :meth:`set_font` will be used or
:data:`Font.DEFAULT` if no font has been set yet.
Arguments:
x (int):
The x-axis value where the left side of the text will start.
y (int):
The y-axis value where the top of the text will start.
text (str):
The text to display.
color (Color):
The color used for drawing the text.
"""
pass
def print(self, *args, sep=' ', end='\n'):
"""Prints a line of text on the image.
This method works like the built-in ``print()`` function except that
it writes the text on the image instead.
The most recent font set using :meth:`set_font` will be used or
:data:`Font.DEFAULT` if no font has been set yet.
Lines are not wrapped if they are too long to fit on the image
horizontally. On the other hand, If the text would be printed off of
the image vertically, the entire image is scrolled up so that the text
will be visible in the image.
Arguments:
* (object):
Zero or more objects to print.
sep (str):
Separator that will be placed between each object that is
printed.
end (str):
End of line that will be printed after the last object.
"""
pass
def set_font(self, font):
"""Sets the font used for writing on this image.
The font is used for both :meth:`draw_text` and :meth:`print`.
Arguments:
font (:class:`Font`):
The font to use.
"""
pass
class Font:
"""Object that represents a font for writing text."""
DEFAULT = None # assigned later since we can't use Font() here
"""The default font."""
def __init__(self, family=None, size=12, bold=False, monospace=False,
lang=None, scrip=None):
"""The font object will be a font that is the "best" match based on the
parameters given and available fonts installed.
Arguments:
family (str):
The preferred font family or ``None`` to use the default value.
size (int):
The preferred font size. Most fonts have sizes between 6 and 24.
This is the "point" size and not the same as :attr:`height`.
bold (bool):
When ``True``, prefer bold fonts.
monospace (bool):
When ``True`` prefer monospaced fonts. This is useful for
aligning multiple rows of text.
lang (str):
A language code, such as "en-us" or "zh-cn" or ``None`` to use
the default language.
script (str):
A unicode script identifier such as "Runr" or ``None``.
"""
@property
def family(self):
"""Gets the family name of the font."""
return 'Lucida'
@property
def style(self):
"""Gets a string describing the font style.
Can be "Regular" or "Bold".
"""
return 'Regular'
@property
def width(self):
"""Gets the width of the widest character of the font."""
return 0
@property
def height(self):
"""Gets the height of the font."""
return 0
def text_width(self, text):
"""Gets the width of the text when the text is drawn using this font.
Arguments:
text (str):
The text.
Returns:
int:
The width in pixels.
"""
return 0
def text_height(self, text):
"""Gets the height of the text when the text is drawn using this font.
Arguments:
text (str):
The text.
Returns:
int:
The height in pixels.
"""
return 0
Font.DEFAULT = Font('Lucida', 12)