camera_pivot.h

Go to the documentation of this file.

/*
 * camera_pivot.h 
 * gunavigation 
 *
 * Created by Callum McColl on 19/06/2020.
 * Copyright © 2020 Callum McColl. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgement:
 *
 *        This product includes software developed by Callum McColl.
 *
 * 4. Neither the name of the author nor the names of contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * -----------------------------------------------------------------------
 * This program is free software; you can redistribute it and/or
 * modify it under the above terms or under the terms of the GNU
 * General Public License as published by the Free Software Foundation;
 * either version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see http://www.gnu.org/licenses/
 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */
 
#ifndef CAMERA_PIVOT_H
#define CAMERA_PIVOT_H
 
#include "camera.h"
#include <stdbool.h>
#include <guunits/guunits.h>
 
#include "percent_coordinate.h"
#include "relative_coordinate.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef GU_CAMERA_PIVOT_NUM_CAMERAS
#define GU_CAMERA_PIVOT_NUM_CAMERAS 2
#endif
 
typedef struct gu_camera_pivot
{
 
    degrees_d pitch;
 
    degrees_d yaw;
 
    centimetres_d height;
 
    gu_camera cameras[GU_CAMERA_PIVOT_NUM_CAMERAS];
 
    int numCameras;
 
} gu_camera_pivot;
 
bool gu_camera_pivot_equals(const gu_camera_pivot, const gu_camera_pivot, const double) __attribute__((const));
 
centimetres_d gu_camera_pivot_calculate_camera_height(const gu_camera_pivot, const int) __attribute__((const));
bool gu_camera_pivot_object_on_ground(const gu_camera_pivot, const int, const gu_percent_coordinate) __attribute__((const));
bool gu_camera_pivot_can_see_object(const gu_camera_pivot, const int, const gu_relative_coordinate) __attribute__((const));
 
#ifdef __cplusplus
}
#endif
 
#endif  /* CAMERA_PIVOT_H */