efl/src/lib/eina/eina_quad.h

127 lines
3.5 KiB
C

/* EINA - EFL data type library
* Copyright (C) 2007-2014 Jorge Luis Zapata
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library.
* If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef EINA_QUAD_H_
#define EINA_QUAD_H_
#include <eina_rectangle.h>
/**
* @file
*/
/**
* @addtogroup Eina_Data_Types_Group Data Types
*
* @{
*/
/**
* @defgroup Eina_Quad_Group Quadrangles
*
* @brief Quadrangles operations.
*
* @{
*/
/**
* Quadrangle definition
*/
typedef struct _Eina_Quad
{
double x0; /**< Top left x coordinate */
double y0; /**< Top left y coordinate */
double x1; /**< Top right x coordinate */
double y1; /**< Top right y coordinate */
double x2; /**< Bottom right x coordinate */
double y2; /**< Bottom right y coordinate */
double x3; /**< Bottom left x coordinate */
double y3; /**< Bottom left y coordinate */
} Eina_Quad;
/**
* @brief Transform the given quadrangle to the given rectangle.
*
* @param[in] q The quadrangle to get coordinates.
* @param[out] r The rectangle.
*
* @since 1.14
* */
EAPI void eina_quad_rectangle_to(const Eina_Quad *q,
Eina_Rectangle *r);
/**
* @brief Transform the given rectangle to the given quadrangle.
*
* @param[in] q The quadrangle.
* @param[out] r The rectangle to get coordinates.
*
* @since 1.14
* */
EAPI void eina_quad_rectangle_from(Eina_Quad *q,
const Eina_Rectangle *r);
/**
* @brief Sets the values of the coordinates of the given quadrangle.
*
* @param[out] q The quadrangle to set coordinates.
* @param[in] x0 Top left x coordinate.
* @param[in] y0 Top left y coordinate.
* @param[in] x1 Top right x coordinate.
* @param[in] y1 Top right y coordinate.
* @param[in] x2 Bottom right x coordinate.
* @param[in] y2 Bottom right y coordinate.
* @param[in] x3 Bottom left x coordinate.
* @param[in] y3 Bottom left y coordinate.
*
* @since 1.14
* */
EAPI void eina_quad_coords_set(Eina_Quad *q,
double x0, double y0,
double x1, double y1,
double x2, double y2,
double x3, double y3);
/**
* @brief Gets the values of the coordinates of the given quadrangle.
*
* @param[in] q The quadrangle to get coordinates.
* @param[out] x0 Top left x coordinate.
* @param[out] y0 Top left y coordinate.
* @param[out] x1 Top right x coordinate.
* @param[out] y1 Top right y coordinate.
* @param[out] x2 Bottom right x coordinate.
* @param[out] y2 Bottom right y coordinate.
* @param[out] x3 Bottom left x coordinate.
* @param[out] y3 Bottom left y coordinate.
*
* @since 1.14
* */
EAPI void eina_quad_coords_get(const Eina_Quad *q,
double *x0, double *y0,
double *x1, double *y1,
double *x2, double *y2,
double *x3, double *y3);
/**
* @}
*/
/**
* @}
*/
#endif