MicroBitCoordinateSystem.h

00001 /*
00002 The MIT License (MIT)
00003 
00004 Copyright (c) 2016 British Broadcasting Corporation.
00005 This software is provided by Lancaster University by arrangement with the BBC.
00006 
00007 Permission is hereby granted, free of charge, to any person obtaining a
00008 copy of this software and associated documentation files (the "Software"),
00009 to deal in the Software without restriction, including without limitation
00010 the rights to use, copy, modify, merge, publish, distribute, sublicense,
00011 and/or sell copies of the Software, and to permit persons to whom the
00012 Software is furnished to do so, subject to the following conditions:
00013 
00014 The above copyright notice and this permission notice shall be included in
00015 all copies or substantial portions of the Software.
00016 
00017 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00018 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00019 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
00020 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00021 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
00022 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
00023 DEALINGS IN THE SOFTWARE.
00024 */
00025 
00026 #ifndef MICROBIT_COORDINATE_SYSTEM_H
00027 #define MICROBIT_COORDINATE_SYSTEM_H
00028 #include "MicroBitConfig.h"
00029 
00030 /**
00031   * Co-ordinate systems that can be used.
00032   * RAW: Unaltered data. Data will be returned directly from the accelerometer.
00033   *
00034   * SIMPLE_CARTESIAN: Data will be returned based on an easy to understand alignment, consistent with the cartesian system taught in schools.
00035   * When held upright, facing the user:
00036   *
00037   *                            /
00038   *    +--------------------+ z
00039   *    |                    |
00040   *    |       .....        |
00041   *    | *     .....      * |
00042   * ^  |       .....        |
00043   * |  |                    |
00044   * y  +--------------------+  x-->
00045   *
00046   *
00047   * NORTH_EAST_DOWN: Data will be returned based on the industry convention of the North East Down (NED) system.
00048   * When held upright, facing the user:
00049   *
00050   *                            z
00051   *    +--------------------+ /
00052   *    |                    |
00053   *    |       .....        |
00054   *    | *     .....      * |
00055   * ^  |       .....        |
00056   * |  |                    |
00057   * x  +--------------------+  y-->
00058   *
00059   */
00060 enum MicroBitCoordinateSystem
00061 {
00062     RAW,
00063     SIMPLE_CARTESIAN,
00064     NORTH_EAST_DOWN
00065 };
00066 
00067 #endif