From d5039668625ea92cc30031b916238fda561fca0d Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Mon, 12 Apr 2021 10:21:08 +0200 Subject: [PATCH] v3: Drop geometry module. --- doc/api/geometry.rst | 49 -------------------------------------------- doc/api/index.rst | 1 - doc/ide/geometry.rst | 1 - doc/ide/index.rst | 1 - 4 files changed, 52 deletions(-) delete mode 100644 doc/api/geometry.rst delete mode 100644 doc/ide/geometry.rst diff --git a/doc/api/geometry.rst b/doc/api/geometry.rst deleted file mode 100644 index 7deeda4..0000000 --- a/doc/api/geometry.rst +++ /dev/null @@ -1,49 +0,0 @@ -:mod:`geometry ` -- Geometry and algebra -============================================================ - -.. module:: pybricks.geometry - -.. autoclass:: pybricks.geometry.Matrix - :no-members: - - .. autoattribute:: pybricks.geometry::Matrix.T - - .. autoattribute:: pybricks.geometry::Matrix.shape - -.. autofunction:: pybricks.geometry.vector - -.. autoclass:: pybricks.geometry.Axis - :no-members: - -.. _robotframe: - -Reference frames ------------------------ - -The Pybricks module and this documentation use the following conventions: - -- X: Positive means forward. Negative means backward. -- Y: Positive means to the left. Negative means to the right. -- Z: Positive means upward. Negative means downward. - -To make sure that all hub measurements (such as acceleration) have the correct -value and sign, you can specify how the hub is mounted in your creation. This -adjust the measurements so that it is easy to see how your *robot* is moving, -rather than how the *hub* is moving. - -For example, the hub may be mounted upside down in your design. If you -configure the settings as shown in :numref:`fig_imuexamples`, the hub -measurements will be adjusted accordingly. This way, a positive acceleration -value in the X direction means that your *robot* accelerates forward, even -though the *hub* accelerates backward. - -.. _fig_imuexamples: - -.. figure:: ../api/images/imuexamples_label.png - :width: 100 % - - How to configure the ``top_side`` and ``front_side`` settings for three - different robot designs. The same technique can be applied to other hubs - and other creations, by noting which way the top and - front :class:`Side ` of the hub are pointing. The example - on the left is the default configuration. diff --git a/doc/api/index.rst b/doc/api/index.rst index 856d079..008a09c 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -70,7 +70,6 @@ findings on our `support page`_ so we can make Pybricks even better. robotics media messaging - geometry .. toctree:: :maxdepth: 1 diff --git a/doc/ide/geometry.rst b/doc/ide/geometry.rst deleted file mode 100644 index 2deff88..0000000 --- a/doc/ide/geometry.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../api/geometry.rst diff --git a/doc/ide/index.rst b/doc/ide/index.rst index 8c45944..17ca9f8 100644 --- a/doc/ide/index.rst +++ b/doc/ide/index.rst @@ -12,7 +12,6 @@ Pybricks Documentation parameters/index tools/index robotics - geometry .. toctree:: :maxdepth: 1