gucoordinates
camera.h
Go to the documentation of this file.
1/*
2 * camera.h
3 * gunavigation
4 *
5 * Created by Callum McColl on 18/06/2020.
6 * Copyright © 2020 Callum McColl. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following
17 * disclaimer in the documentation and/or other materials
18 * provided with the distribution.
19 *
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgement:
22 *
23 * This product includes software developed by Callum McColl.
24 *
25 * 4. Neither the name of the author nor the names of contributors
26 * may be used to endorse or promote products derived from this
27 * software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
33 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
34 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
35 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
36 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
37 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
38 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
39 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * -----------------------------------------------------------------------
42 * This program is free software; you can redistribute it and/or
43 * modify it under the above terms or under the terms of the GNU
44 * General Public License as published by the Free Software Foundation;
45 * either version 2 of the License, or (at your option) any later version.
46 *
47 * This program is distributed in the hope that it will be useful,
48 * but WITHOUT ANY WARRANTY; without even the implied warranty of
49 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
50 * GNU General Public License for more details.
51 *
52 * You should have received a copy of the GNU General Public License
53 * along with this program; if not, see http://www.gnu.org/licenses/
54 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
55 * Fifth Floor, Boston, MA 02110-1301, USA.
56 *
57 */
58
59#ifndef CAMERA_H
60#define CAMERA_H
61
62#include <guunits/guunits.h>
63#include <stdbool.h>
64
65#ifdef __cplusplus
66extern "C" {
67#endif
68
69
70typedef struct gu_camera
71{
80 centimetres_d height;
81
92 centimetres_d centerOffset;
93
100 degrees_d vDirection;
101
105 degrees_d vFov;
106
110 degrees_d hFov;
111
113
114bool gu_camera_equals(const gu_camera, const gu_camera, const double) __attribute__((const));
115
116gu_camera gu_camera_make(const centimetres_d, const centimetres_d, const degrees_d, const degrees_d, const degrees_d) __attribute__((const));
117
118
119#ifdef __cplusplus
120}
121#endif
122
123#endif /* CAMERA_H */
gu_camera gu_camera_make(const centimetres_d, const centimetres_d, const degrees_d, const degrees_d, const degrees_d) __attribute__((const))
bool gu_camera_equals(const gu_camera, const gu_camera, const double) __attribute__((const))
struct gu_camera gu_camera
centimetres_d centerOffset
The distance the camera is from the center point.
Definition: camera.h:92
centimetres_d height
The height from the pivot of the camera to the middle of the camera.
Definition: camera.h:80
degrees_d hFov
The horizontal field of view.
Definition: camera.h:110
degrees_d vFov
The vertical field of view.
Definition: camera.h:105
degrees_d vDirection
The degree in which the camera is facing in the vertical direction.
Definition: camera.h:100