forked from enlightenment/efl
1165 lines
34 KiB
C
1165 lines
34 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_MATRIX_H_
|
|
#define EINA_MATRIX_H_
|
|
|
|
#include "eina_quad.h"
|
|
|
|
/**
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup Eina_Data_Types_Group Data Types
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @defgroup Eina_Matrix_Group Matrix
|
|
*
|
|
* Eina includes a family of matrix types of different dimension sizes
|
|
* and underlying data types. Dimensions supported include 2x2, 3x3,
|
|
* and 4x4. A fixed point variation of the 3x3 matrix is also
|
|
* supported, which uses the Eina_F16p16 (Q16.16) data type.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @typedef Eina_Matrix_Type
|
|
* Matrix types
|
|
*/
|
|
typedef enum _Eina_Matrix_Type
|
|
{
|
|
EINA_MATRIX_TYPE_IDENTITY, /**< Identity matrix type */
|
|
EINA_MATRIX_TYPE_AFFINE, /**< Affine matrix type */
|
|
EINA_MATRIX_TYPE_PROJECTIVE, /**< Projective matrix type */
|
|
EINA_MATRIX_TYPE_LAST /**< The total number of matrix types */
|
|
} Eina_Matrix_Type;
|
|
|
|
/**
|
|
* @typedef Eina_Matrix_Axis
|
|
* Matrix Axes
|
|
*/
|
|
typedef enum _Eina_Matrix_Axis
|
|
{
|
|
EINA_MATRIX_AXIS_X, /**< X-Axis */
|
|
EINA_MATRIX_AXIS_Y, /**< Y-Axis */
|
|
EINA_MATRIX_AXIS_Z, /**< Z-Axis */
|
|
} Eina_Matrix_Axis;
|
|
|
|
/**
|
|
* @defgroup Eina_Matrix3_Group 3x3 floating point matrices
|
|
*
|
|
* @brief Definition and operations for 3x3 matrices.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @typedef Eina_Matrix3
|
|
* A 3x3 floating point matrix.
|
|
*/
|
|
typedef struct _Eina_Matrix3 Eina_Matrix3;
|
|
|
|
/**
|
|
* @struct _Eina_Matrix3
|
|
* A 3x3 floating point matrix.
|
|
*/
|
|
struct _Eina_Matrix3
|
|
{
|
|
double xx; /**< xx in x' = (x * xx) + (y * xy) + xz */
|
|
double xy; /**< xy in x' = (x * xx) + (y * xy) + xz */
|
|
double xz; /**< xz in x' = (x * xx) + (y * xy) + xz */
|
|
|
|
double yx; /**< yx in y' = (x * yx) + (y * yy) + yz */
|
|
double yy; /**< yy in y' = (x * yx) + (y * yy) + yz */
|
|
double yz; /**< yz in y' = (x * yx) + (y * yy) + yz */
|
|
|
|
double zx; /**< zx in z' = (x * zx) + (y * zy) + zz */
|
|
double zy; /**< zy in z' = (x * zx) + (y * zy) + zz */
|
|
double zz; /**< zz in z' = (x * zx) + (y * zy) + zz */
|
|
};
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @defgroup Eina_Matrix4_Group 4x4 Matrices in floating point
|
|
*
|
|
* @brief Definition and operations for 4x4 matrices.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @typedef Eina_Matrix4
|
|
* A 4x4 floating point matrix.
|
|
*/
|
|
typedef struct _Eina_Matrix4 Eina_Matrix4;
|
|
|
|
/**
|
|
* @struct Eina_Matrix4
|
|
* A 4x4 floating point matrix.
|
|
*/
|
|
struct _Eina_Matrix4
|
|
{
|
|
double xx; /**< xx in x' = (x * xx) + (y * xy) + (z * xz) + xw */
|
|
double xy; /**< xy in x' = (x * xx) + (y * xy) + (z * xz) + xw */
|
|
double xz; /**< xz in x' = (x * xx) + (y * xy) + (z * xz) + xw */
|
|
double xw; /**< xw in x' = (x * xx) + (y * xy) + (z * xz) + xw */
|
|
|
|
double yx; /**< yx in y' = (x * yx) + (y * yy) + (z * yz) + yw */
|
|
double yy; /**< yy in y' = (x * yx) + (y * yy) + (z * yz) + yw */
|
|
double yz; /**< yz in y' = (x * yx) + (y * yy) + (z * yz) + yw */
|
|
double yw; /**< yw in y' = (x * yx) + (y * yy) + (z * yz) + yw */
|
|
|
|
double zx; /**< zx in z' = (x * zx) + (y * zy) + (z * zz) + zw */
|
|
double zy; /**< zy in z' = (x * zx) + (y * zy) + (z * zz) + zw */
|
|
double zz; /**< zz in z' = (x * zx) + (y * zy) + (z * zz) + zw */
|
|
double zw; /**< zw in z' = (x * zx) + (y * zy) + (z * zz) + zw */
|
|
|
|
double wx; /**< wx in w' = (x * wx) + (y * wy) + (z * wz) + ww */
|
|
double wy; /**< wy in w' = (x * wx) + (y * wy) + (z * wz) + ww */
|
|
double wz; /**< wz in w' = (x * wx) + (y * wy) + (z * wz) + ww */
|
|
double ww; /**< ww in w' = (x * wx) + (y * wy) + (z * wz) + ww */
|
|
};
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @defgroup Eina_Matrix3_F16p16_Group 3x3 Matrices in fixed point
|
|
*
|
|
* @brief Definition and operations for 3x3 fixed point matrices.
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @typedef Eina_Matrix3_F16p16
|
|
* A 3x3 fixed point (Q16.16) matrix.
|
|
*/
|
|
typedef struct _Eina_Matrix3_F16p16 Eina_Matrix3_F16p16;
|
|
|
|
/**
|
|
* @struct Eina_Matrix3_F16p16
|
|
* A 3x3 fixed point (Q16.16) matrix.
|
|
*/
|
|
struct _Eina_Matrix3_F16p16
|
|
{
|
|
Eina_F16p16 xx; /**< xx in x' = (x * xx) + (y * xy) + xz */
|
|
Eina_F16p16 xy; /**< xy in x' = (x * xx) + (y * xy) + xz */
|
|
Eina_F16p16 xz; /**< xz in x' = (x * xx) + (y * xy) + xz */
|
|
|
|
Eina_F16p16 yx; /**< yx in y' = (x * yx) + (y * yy) + yz */
|
|
Eina_F16p16 yy; /**< yy in y' = (x * yx) + (y * yy) + yz */
|
|
Eina_F16p16 yz; /**< yz in y' = (x * yx) + (y * yy) + yz */
|
|
|
|
Eina_F16p16 zx; /**< zx in z' = (x * zx) + (y * zy) + zz */
|
|
Eina_F16p16 zy; /**< zy in z' = (x * zx) + (y * zy) + zz */
|
|
Eina_F16p16 zz; /**< zz in z' = (x * zx) + (y * zy) + zz */
|
|
};
|
|
|
|
/**
|
|
* @brief Sets the given fixed point matrix to the identity matrix.
|
|
*
|
|
* @param[in] m The fixed point matrix to set.
|
|
*
|
|
* This function sets @p m to the identity matrix. No check is done on
|
|
* @p m.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_f16p16_identity(Eina_Matrix3_F16p16 *m);
|
|
|
|
/**
|
|
* @brief Sets dst as the matrix multiplication (composition) of two
|
|
* Eina_F16p16 matrices.
|
|
*
|
|
* @param[in] m1 The first matrix. Must be non-NULL.
|
|
* @param[in] m2 The second matrix. Must be non-NULL.
|
|
* @param[out] dst The results matrix.
|
|
*
|
|
* In matrix multiplication, AB, the resultant matrix is created from
|
|
* the rows of A multiplied against the columns of B and summed. This
|
|
* is not a commutative; i.e. AB != BA, so the ordering of arguments
|
|
* @p m1 and @p m2 matters.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_f16p16_compose(const Eina_Matrix3_F16p16 *m1,
|
|
const Eina_Matrix3_F16p16 *m2,
|
|
Eina_Matrix3_F16p16 *dst);
|
|
|
|
/**
|
|
* @brief Returns the type of the given fixed point matrix.
|
|
*
|
|
* @param[in] m The fixed point matrix.
|
|
* @return The type of the matrix.
|
|
*
|
|
* This function returns the type of the matrix @p m. No check is done
|
|
* on @p m.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI Eina_Matrix_Type eina_matrix3_f16p16_type_get(const Eina_Matrix3_F16p16 *m);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup Eina_Matrix3_Group
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/** Helper macro for printf formatting */
|
|
#define EINA_MATRIX3_FORMAT "g %g %g | %g %g %g | %g %g %g"
|
|
/** Helper macro for printf formatting arg */
|
|
#define EINA_MATRIX3_ARGS(m) (m)->xx, (m)->xy, (m)->xz, \
|
|
(m)->yx, (m)->yy, (m)->yz, \
|
|
(m)->zx, (m)->zy, (m)->zz
|
|
|
|
|
|
|
|
/**
|
|
* @brief Returns the type of the given floating point matrix.
|
|
*
|
|
* @param[in] m The floating point matrix.
|
|
* @return The type of the matrix.
|
|
*
|
|
* This function returns the type of the matrix @p m. No check is done
|
|
* on @p m.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI Eina_Matrix_Type eina_matrix3_type_get(const Eina_Matrix3 *m);
|
|
|
|
/**
|
|
* @brief Sets the values of the coefficients of the given floating
|
|
* point matrix.
|
|
*
|
|
* @param[out] m The floating point matrix.
|
|
* @param[in] xx The first coefficient value.
|
|
* @param[in] xy The second coefficient value.
|
|
* @param[in] xz The third coefficient value.
|
|
* @param[in] yx The fourth coefficient value.
|
|
* @param[in] yy The fifth coefficient value.
|
|
* @param[in] yz The sixth coefficient value.
|
|
* @param[in] zx The seventh coefficient value.
|
|
* @param[in] zy The eighth coefficient value.
|
|
* @param[in] zz The ninth coefficient value.
|
|
*
|
|
* This function sets the values of the coefficients of the matrix
|
|
* @p m. No check is done on @p m.
|
|
*
|
|
* @see eina_matrix3_values_get()
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_values_set(Eina_Matrix3 *m,
|
|
double xx, double xy, double xz,
|
|
double yx, double yy, double yz,
|
|
double zx, double zy, double zz);
|
|
|
|
/**
|
|
* @brief Gets the values of the coefficients of the given floating
|
|
* point matrix.
|
|
*
|
|
* @param[in] m The floating point matrix.
|
|
* @param[out] xx The first coefficient value.
|
|
* @param[out] xy The second coefficient value.
|
|
* @param[out] xz The third coefficient value.
|
|
* @param[out] yx The fourth coefficient value.
|
|
* @param[out] yy The fifth coefficient value.
|
|
* @param[out] yz The sixth coefficient value.
|
|
* @param[out] zx The seventh coefficient value.
|
|
* @param[out] zy The eighth coefficient value.
|
|
* @param[out] zz The ninth coefficient value.
|
|
*
|
|
* This function gets the values of the coefficients of the matrix
|
|
* @p m. No check is done on @p m.
|
|
*
|
|
* @see eina_matrix3_values_set()
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_values_get(const Eina_Matrix3 *m,
|
|
double *xx, double *xy, double *xz,
|
|
double *yx, double *yy, double *yz,
|
|
double *zx, double *zy, double *zz);
|
|
|
|
/**
|
|
* @brief Gets the values of the coefficients of the given fixed
|
|
* point matrix.
|
|
*
|
|
* @param[in] m The fixed point matrix.
|
|
* @param[out] xx The first coefficient value.
|
|
* @param[out] xy The second coefficient value.
|
|
* @param[out] xz The third coefficient value.
|
|
* @param[out] yx The fourth coefficient value.
|
|
* @param[out] yy The fifth coefficient value.
|
|
* @param[out] yz The sixth coefficient value.
|
|
* @param[out] zx The seventh coefficient value.
|
|
* @param[out] zy The eighth coefficient value.
|
|
* @param[out] zz The nine-th coefficient value.
|
|
*
|
|
* This function gets the values of the coefficients of the matrix
|
|
* @p m. No check is done on @p m.
|
|
*
|
|
* @see eina_matrix3_values_set()
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_fixed_values_get(const Eina_Matrix3 *m,
|
|
Eina_F16p16 *xx, Eina_F16p16 *xy, Eina_F16p16 *xz,
|
|
Eina_F16p16 *yx, Eina_F16p16 *yy, Eina_F16p16 *yz,
|
|
Eina_F16p16 *zx, Eina_F16p16 *zy, Eina_F16p16 *zz);
|
|
|
|
/**
|
|
* @brief Transforms the given floating point matrix to the given fixed
|
|
* point matrix.
|
|
*
|
|
* @param[in] m The floating point matrix.
|
|
* @param[out] fm The fixed point matrix.
|
|
*
|
|
* This function transforms the floating point matrix @p m to a fixed
|
|
* point matrix and stores the coefficients into the fixed point matrix
|
|
* @p fm.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_matrix3_f16p16_to(const Eina_Matrix3 *m,
|
|
Eina_Matrix3_F16p16 *fm);
|
|
|
|
/**
|
|
* @brief Checks whether the two matrices are equivalent.
|
|
*
|
|
* @param[in] m1 The first matrix.
|
|
* @param[in] m2 The second matrix.
|
|
* @return @c EINA_TRUE if the two matrices are equal, @c EINA_FALSE otherwise.
|
|
*
|
|
* This function returns @c EINA_TRUE if the matrices @p m1 and @p m2
|
|
* are equal, @c EINA_FALSE otherwise. No check is done on the matrices.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI Eina_Bool eina_matrix3_equal(const Eina_Matrix3 *m1, const Eina_Matrix3 *m2);
|
|
|
|
/**
|
|
* @brief Sets dst as the matrix multiplication (composition) of two matrices.
|
|
*
|
|
* @param[in] m1 The first matrix. Must be non-NULL.
|
|
* @param[in] m2 The second matrix. Must be non-NULL.
|
|
* @param[out] dst The results matrix.
|
|
*
|
|
* In matrix multiplication, AB, the resultant matrix is created from
|
|
* the rows of A multiplied against the columns of B and summed. This
|
|
* is not commutative; i.e. AB != BA, so the ordering of arguments
|
|
* @p m1 and @p m2 matters.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_compose(const Eina_Matrix3 *m1,
|
|
const Eina_Matrix3 *m2,
|
|
Eina_Matrix3 *dst);
|
|
|
|
/**
|
|
* @brief Sets the matrix values for a translation operation.
|
|
*
|
|
* @param[out] m The matrix.
|
|
* @param[in] tx The X coordinate translation.
|
|
* @param[in] ty The Y coordinate translation.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_translate(Eina_Matrix3 *m, double tx, double ty);
|
|
|
|
/**
|
|
* @brief Sets the matrix values for a scaling operation.
|
|
*
|
|
* @param[out] m The matrix.
|
|
* @param[in] sx The X coordinate scaling factor.
|
|
* @param[in] sy The Y coordinate scaling factor.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_scale(Eina_Matrix3 *m, double sx, double sy);
|
|
|
|
/**
|
|
* @brief Sets the matrix values for a rotation operation.
|
|
* @param[out] m The matrix.
|
|
* @param[in] rad The number of radians to rotate.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_rotate(Eina_Matrix3 *m, double rad);
|
|
|
|
/**
|
|
* @brief Sets the given floating point matrix to the identity matrix.
|
|
*
|
|
* @param[out] m The matrix to set to identity.
|
|
*
|
|
* This function sets @p m to the identity matrix. No check is done on
|
|
* @p m.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_identity(Eina_Matrix3 *m);
|
|
|
|
/**
|
|
* @brief Calculates the determinant of the given matrix.
|
|
*
|
|
* @param[in] m The matrix.
|
|
* @return The determinant.
|
|
*
|
|
* This function returns the determinant of the matrix @p m. No check
|
|
* is done on @p m.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI double eina_matrix3_determinant(const Eina_Matrix3 *m);
|
|
|
|
/**
|
|
* @brief Divides the given matrix by a scalar number.
|
|
*
|
|
* @param[in,out] m The matrix.
|
|
* @param[in] scalar The scalar number.
|
|
*
|
|
* This function divides the matrix @p m by @p scalar. No check
|
|
* is done on @p m.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_divide(Eina_Matrix3 *m, double scalar);
|
|
|
|
/**
|
|
* @brief Computes the inverse of the given matrix.
|
|
*
|
|
* @param[in] m The source matrix.
|
|
* @param[out] m2 The inverse matrix.
|
|
*
|
|
* This function inverts the matrix @p m and stores the result in
|
|
* @p m2. No check is done on @p m or @p m2. If @p m cannot be
|
|
* inverted, then @p m2 is set to the identity matrix.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_inverse(const Eina_Matrix3 *m, Eina_Matrix3 *m2);
|
|
|
|
/**
|
|
* @brief Computes the transpose of the given matrix.
|
|
*
|
|
* @param[in] m The source matrix.
|
|
* @param[out] a The transposed matrix.
|
|
*
|
|
* This function transposes the matrix @p m and stores the result in
|
|
* @p a. No check is done on @p m or @p a. The transpose of a matrix
|
|
* essentially flips a matrix over its diagonal.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_transpose(const Eina_Matrix3 *m, Eina_Matrix3 *a);
|
|
|
|
/**
|
|
* @brief Computes the cofactor of the given matrix.
|
|
*
|
|
* @param[in] m The source matrix.
|
|
* @param[out] a The cofactored matrix.
|
|
*
|
|
* This function cofactors the matrix @p m and stores the result in
|
|
* @p a. No check is done on @p m or @p a. The cofactor of a matrix3 at
|
|
* row i, column j is computed by taking the determinant of the
|
|
* submatrix formed by deleting the i-th row and j-th column, and then
|
|
* multiplying by (-1)^(i+j).
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_cofactor(const Eina_Matrix3 *m, Eina_Matrix3 *a);
|
|
|
|
/**
|
|
* @brief Computes the adjoint of the given matrix.
|
|
*
|
|
* @param[in] m The matrix to be adjointed.
|
|
* @param[out] a The adjoint matrix.
|
|
*
|
|
* This function finds the adjoint of the matrix @p m and stores the
|
|
* result in @p a. No check is done on @p m or @p a. The adjoint of a
|
|
* matrix3 is effectively the transpose of its cofactor.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_adjoint(const Eina_Matrix3 *m, Eina_Matrix3 *a);
|
|
|
|
/**
|
|
* @brief Computes the transform of a 2D point using the given matrix.
|
|
*
|
|
* @param[in] m The transformation matrix to apply.
|
|
* @param[in] x The x point to be transformed.
|
|
* @param[in] y The y point to be transformed.
|
|
* @param[out] xr The transformed x point.
|
|
* @param[out] yr The transformed y point.
|
|
*
|
|
* Applies the transformation matrix @p m to the point (x,y), and stores
|
|
* the result in (*xr,*yr). No check is done on @p m; @p xr and @p yr
|
|
* must point to valid memory. A fast-path is included for if the zx
|
|
* and zy components of the matrix are zero.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_point_transform(const Eina_Matrix3 *m,
|
|
double x, double y,
|
|
double *xr, double *yr);
|
|
/**
|
|
* @brief Computes the transformation of a rectangle using the given matrix.
|
|
*
|
|
* @param[in] m The transformation matrix to apply.
|
|
* @param[in] r The rectangle to be transformed.
|
|
* @param[out] q The resultant transformed points.
|
|
*
|
|
* Performs a point transformation of each corner of the rectangle @p r,
|
|
* and stores the result in the quadrangle @p q. No checks are done on the
|
|
* inputs, and @p q must point to valid memory.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void eina_matrix3_rectangle_transform(const Eina_Matrix3 *m,
|
|
const Eina_Rectangle *r,
|
|
const Eina_Quad *q);
|
|
|
|
/**
|
|
* @brief Creates a projective matrix that maps a quadrangle to a quadrangle.
|
|
*
|
|
* @param[out] m The transformation matrix to create.
|
|
* @param[in] src The source quadrangle.
|
|
* @param[in] dst The destination quadrangle.
|
|
* @return @c EINA_TRUE if matrix could be successfully created, @c EINA_FALSE otherwise.
|
|
*
|
|
* Calculates a matrix @p m that can be used to transform from an arbitrary
|
|
* source quadrangle @p src to another arbitrary quadrangle @p dst.
|
|
*/
|
|
EAPI Eina_Bool eina_matrix3_quad_quad_map(Eina_Matrix3 *m,
|
|
const Eina_Quad *src,
|
|
const Eina_Quad *dst);
|
|
|
|
/**
|
|
* @brief Creates a matrix for unit-square to quad mapping.
|
|
*
|
|
* @param[out] m The transformation matrix to create.
|
|
* @param[in] q The source quadrangle.
|
|
* @return @c EINA_TRUE if matrix could be successfully created, @c EINA_FALSE otherwise.
|
|
*
|
|
* Calculates a matrix @p m that can be used to transform an arbitrary
|
|
* quadrangle @p q into a square. If @p q is a parallelogram, then a
|
|
* fast path affine transformation is used, otherwise it computes the
|
|
* matrix using a full projective transformation operation. No other
|
|
* checks are done on @p m or @p q.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI Eina_Bool eina_matrix3_square_quad_map(Eina_Matrix3 *m,
|
|
const Eina_Quad *q);
|
|
|
|
/**
|
|
* @brief Creates a matrix for mapping squares to match quad.
|
|
*
|
|
* @param[out] m The transformation matrix to create.
|
|
* @param[in] q The source quadrangle.
|
|
* @return @c EINA_FALSE on successful transform creation, @c EINA_FALSE otherwise.
|
|
*
|
|
* Calculates a matrix @p m that can be used to transform a square to
|
|
* fit a given quadrangle. The created matrix will always have its zz
|
|
* element equal to 1.0. The @p m matrix and @p q quad must be valid
|
|
* memory.
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI Eina_Bool eina_matrix3_quad_square_map(Eina_Matrix3 *m,
|
|
const Eina_Quad *q);
|
|
|
|
/**
|
|
* @brief Sets matrix values using an array.
|
|
*
|
|
* @param[out] m The result matrix.
|
|
* @param[in] v The array[9] of values.
|
|
*
|
|
* Uses the first 9 elements in the given C array @p v to set the
|
|
* values in the matrix @p m. The values will be set in the order
|
|
* of the elements in the Eina_Matrix3 structure.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix3_array_set(Eina_Matrix3 *m, const double *v);
|
|
|
|
/**
|
|
* @brief Copies a matrix.
|
|
*
|
|
* @param[out] dst Copy of the matrix.
|
|
* @param[in] src The matrix to copy.
|
|
*
|
|
* @since 1.16
|
|
*/
|
|
EAPI void eina_matrix3_copy(Eina_Matrix3 *dst, const Eina_Matrix3 *src);
|
|
|
|
/**
|
|
* @brief Multiplies two matrices.
|
|
*
|
|
* @param[out] out The resulting matrix.
|
|
* @param[in] mat_a The first member of the multiplication.
|
|
* @param[in] mat_b The second member of the multiplication.
|
|
*
|
|
* @p out must not point to the same structure as @p mat_a or @p mat_b,
|
|
* else the calculation results will be incorrect. Use
|
|
* eina_matrix3_multiply_copy() instead in this case.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix3_multiply(Eina_Matrix3 *out, const Eina_Matrix3 *mat_a,
|
|
const Eina_Matrix3 *mat_b);
|
|
|
|
/**
|
|
* @brief Multiplies two matrices without overwriting them.
|
|
*
|
|
* @param[out] out The resulting matrix.
|
|
* @param[in] mat_a The first member of the multiplication.
|
|
* @param[in] mat_b The second member of the multiplication.
|
|
*
|
|
* Safely multiplies @p mat_a and @p mat_b by checking if the @p out
|
|
* parameter points to either of them, and if so uses a temporary matrix
|
|
* for the intermediary calculations.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix3_multiply_copy(Eina_Matrix3 *out, const Eina_Matrix3 *mat_a,
|
|
const Eina_Matrix3 *mat_b);
|
|
|
|
/**
|
|
* @brief Sets the scale parameters (XX, YY) of a matrix.
|
|
*
|
|
* @param[out] out The resulting matrix.
|
|
* @param[in] s_x The scale value for x.
|
|
* @param[in] s_y The scale value for y.
|
|
*
|
|
* Sets only the XX and YY components of the matrix, leaving the rest of
|
|
* the matrix as it was.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix3_scale_transform_set(Eina_Matrix3 *out, double s_x, double s_y);
|
|
|
|
/**
|
|
* @brief Sets the positional parameters (XZ, YZ) of a matrix.
|
|
*
|
|
* @param[out] out The resulting matrix.
|
|
* @param[in] p_x The position value for x.
|
|
* @param[in] p_y The position value for y.
|
|
*
|
|
* Sets only the XZ and YZ components of the matrix, leaving the rest of
|
|
* the matrix as it was.
|
|
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix3_position_transform_set(Eina_Matrix3 *out, const double p_x,
|
|
const double p_y);
|
|
|
|
/**
|
|
* @brief Sets normal of the given matrix.
|
|
*
|
|
* @param[out] out The resulting matrix.
|
|
* @param[in] m The matrix.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_normal3_matrix_get(Eina_Matrix3 *out, const Eina_Matrix4 *m);
|
|
|
|
/**
|
|
* @brief Converts an Eina_Matrix3 into an Eina_Matrix4.
|
|
*
|
|
* @param[out] m3 The destination Eina_Matrix3.
|
|
* @param[in] m4 The source Eina_Matrix4.
|
|
*
|
|
* @since 1.15
|
|
*/
|
|
EAPI void eina_matrix3_matrix4_to(Eina_Matrix4 *m4, const Eina_Matrix3 *m3);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup Eina_Matrix4_Group
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Returns the type of the given floating point matrix.
|
|
*
|
|
* @param[in] m The floating point matrix.
|
|
* @return The type of the matrix.
|
|
*
|
|
* This function returns the type of the matrix @p m. No check is done
|
|
* on @p m.
|
|
*
|
|
* @since 1.15
|
|
*/
|
|
EAPI Eina_Matrix_Type eina_matrix4_type_get(const Eina_Matrix4 *m);
|
|
|
|
/**
|
|
* @brief Sets the values of the coefficients of the given floating
|
|
* point matrix.
|
|
*
|
|
* @param[out] m The floating point matrix.
|
|
* @param[in] xx The first coefficient value.
|
|
* @param[in] xy The second coefficient value.
|
|
* @param[in] xz The third coefficient value.
|
|
* @param[in] xw The fourth coefficient value.
|
|
* @param[in] yx The fifth coefficient value.
|
|
* @param[in] yy The sixth coefficient value.
|
|
* @param[in] yz The seventh coefficient value.
|
|
* @param[in] yw The eighth coefficient value.
|
|
* @param[in] zx The ninth coefficient value.
|
|
* @param[in] zy The tenth coefficient value.
|
|
* @param[in] zz The eleventh coefficient value.
|
|
* @param[in] zw The twelfth coefficient value.
|
|
* @param[in] wx The thirteenth coefficient value.
|
|
* @param[in] wy The fourteenth coefficient value.
|
|
* @param[in] wz The fifteenth coefficient value.
|
|
* @param[in] ww The sixteenth coefficient value.
|
|
*
|
|
* This function sets the values of the coefficients of the matrix
|
|
* @p m. No check is done on @p m.
|
|
*
|
|
* @see eina_matrix4_values_get()
|
|
*
|
|
* @since 1.15
|
|
*/
|
|
EAPI void eina_matrix4_values_set(Eina_Matrix4 *m,
|
|
double xx, double xy, double xz, double xw,
|
|
double yx, double yy, double yz, double yw,
|
|
double zx, double zy, double zz, double zw,
|
|
double wx, double wy, double wz, double ww);
|
|
|
|
/**
|
|
* @brief Gets the values of the coefficients of the given floating
|
|
* point matrix.
|
|
*
|
|
* @param[in] m The floating point matrix.
|
|
* @param[out] xx The first coefficient value.
|
|
* @param[out] xy The second coefficient value.
|
|
* @param[out] xz The third coefficient value.
|
|
* @param[out] xw The fourth coefficient value.
|
|
* @param[out] yx The fifth coefficient value.
|
|
* @param[out] yy The sixth coefficient value.
|
|
* @param[out] yz The seventh coefficient value.
|
|
* @param[out] yw The eighth coefficient value.
|
|
* @param[out] zx The ninth coefficient value.
|
|
* @param[out] zy The tenth coefficient value.
|
|
* @param[out] zz The eleventh coefficient value.
|
|
* @param[out] zw The twelfth coefficient value.
|
|
* @param[out] wx The thirteenth coefficient value.
|
|
* @param[out] wy The fourteenth coefficient value.
|
|
* @param[out] wz The fifteenth coefficient value.
|
|
* @param[out] ww The sixteenth coefficient value.
|
|
*
|
|
* This function gets the values of the coefficients of the matrix
|
|
* @p m. No check is done on @p m.
|
|
*
|
|
* @see eina_matrix4_values_set()
|
|
*
|
|
* @since 1.15
|
|
*/
|
|
EAPI void eina_matrix4_values_get(const Eina_Matrix4 *m,
|
|
double *xx, double *xy, double *xz, double *xw,
|
|
double *yx, double *yy, double *yz, double *yw,
|
|
double *zx, double *zy, double *zz, double *zw,
|
|
double *wx, double *wy, double *wz, double *ww);
|
|
|
|
/**
|
|
* @brief Calculates the determinant of the given matrix.
|
|
*
|
|
* @param[in] m The matrix.
|
|
* @return The determinant.
|
|
*
|
|
* This function returns the determinant of the matrix @p m. No check
|
|
* is done on @p m.
|
|
*
|
|
* @since 1.16
|
|
*/
|
|
EAPI double eina_matrix4_determinant(const Eina_Matrix4 *m);
|
|
|
|
/**
|
|
* @brief Normalizes the given matrix.
|
|
*
|
|
* @param[out] out The normalized matrix.
|
|
* @param[in] in The matrix.
|
|
* @return @c EINA_FALSE if matrix could not be normalized, @c EINA_TRUE
|
|
* otherwise.
|
|
*
|
|
* This function returns the determinant of the matrix @p in. No check
|
|
* is done on @p in.
|
|
*
|
|
* @since 1.16
|
|
*/
|
|
EAPI Eina_Bool eina_matrix4_normalized(Eina_Matrix4 *out,
|
|
const Eina_Matrix4 *in);
|
|
|
|
/**
|
|
* @brief Computes the inverse of the given matrix.
|
|
*
|
|
* @param[out] out The inverse matrix.
|
|
* @param[in] in The matrix.
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
|
|
*
|
|
* This function inverts the matrix @p in and stores the result in
|
|
* @p out. No check is done on @p in or @p out. If @p in cannot be
|
|
* inverted, then @c EINA_FALSE is returned.
|
|
*
|
|
* @since 1.16
|
|
*/
|
|
EAPI Eina_Bool eina_matrix4_inverse(Eina_Matrix4 *out, const Eina_Matrix4 *in);
|
|
|
|
/**
|
|
* @brief Computes the transpose of the given matrix.
|
|
*
|
|
* @param[out] out The transposed matrix.
|
|
* @param[in] in The source matrix.
|
|
*
|
|
* This function transposes the matrix @p in and stores the result in
|
|
* @p out. No check is done on @p in or @p out. The transpose of a matrix
|
|
* essentially flips a matrix over its diagonal.
|
|
*
|
|
* @since 1.16
|
|
*/
|
|
EAPI void eina_matrix4_transpose(Eina_Matrix4 *out, const Eina_Matrix4 *in);
|
|
|
|
/**
|
|
* @brief Converts an Eina_Matrix4 into an Eina_Matrix3.
|
|
*
|
|
* @param[out] m3 The destination Eina_Matrix3.
|
|
* @param[in] m4 The source Eina_Matrix4.
|
|
*
|
|
* @since 1.15
|
|
*/
|
|
EAPI void eina_matrix4_matrix3_to(Eina_Matrix3 *m3, const Eina_Matrix4 *m4);
|
|
|
|
/**
|
|
* @brief Sets the given matrix to identity.
|
|
*
|
|
* @param[out] out The matrix to set.
|
|
*
|
|
* @since 1.16
|
|
*/
|
|
EAPI void eina_matrix4_identity(Eina_Matrix4 *out);
|
|
|
|
/**
|
|
* @brief Multiplies two matrix.
|
|
*
|
|
* @param[out] out The resulting matrix.
|
|
* @param[in] mat_a The first member of the multiplication.
|
|
* @param[in] mat_b The second member of the multiplication.
|
|
*
|
|
* Safely multiplies @p mat_a and @p mat_b by checking if the @p out
|
|
* parameter points to either of them, and if so uses a temporary matrix
|
|
* for the intermediary calculations.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix4_multiply_copy(Eina_Matrix4 *out,
|
|
const Eina_Matrix4 *mat_a, const Eina_Matrix4 *mat_b);
|
|
|
|
/**
|
|
* @brief Sets matrix values using an array.
|
|
*
|
|
* @param[out] m The result matrix.
|
|
* @param[in] v The the array[16] of values.
|
|
*
|
|
* Uses the first 16 elements in the given C array @p v to set the
|
|
* values in the matrix @p m. The values will be set in the order
|
|
* of the elements in the Eina_Matrix4 structure.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix4_array_set(Eina_Matrix4 *m, const double *v);
|
|
|
|
/**
|
|
* @brief Copies matrix.
|
|
*
|
|
* @param[out] dst The matrix copy.
|
|
* @param[in] src The matrix to copy.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix4_copy(Eina_Matrix4 *dst, const Eina_Matrix4 *src);
|
|
|
|
/**
|
|
* @brief Multiplies two matrices with check.
|
|
*
|
|
* @param[out] out The resulting matrix.
|
|
* @param[in] mat_a The first member of the multiplication.
|
|
* @param[in] mat_b The second member of the multiplication.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix4_multiply(Eina_Matrix4 *out, const Eina_Matrix4 *mat_a,
|
|
const Eina_Matrix4 *mat_b);
|
|
|
|
/**
|
|
* @brief Sets orthogonality matrix.
|
|
*
|
|
* @param[out] m The resulting matrix.
|
|
* @param[in] right The right value.
|
|
* @param[in] left The left value.
|
|
* @param[in] bottom The bottom value.
|
|
* @param[in] top The top value.
|
|
* @param[in] dnear The dnear value.
|
|
* @param[in] dfar The dfar value.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix4_ortho_set(Eina_Matrix4 *m,
|
|
double left, double right, double bottom, double top,
|
|
double dnear, double dfar);
|
|
|
|
|
|
/**
|
|
* @brief Sets out as the matrix multiplication (composition) of two matrices.
|
|
*
|
|
* @param[in] mat_a The first matrix. Must be non-NULL.
|
|
* @param[in] mat_b The second matrix. Must be non-NULL.
|
|
* @param[out] out The results matrix.
|
|
*
|
|
* In matrix multiplication, AB, the resultant matrix is created from
|
|
* the rows of A multiplied against the columns of B and summed. This
|
|
* is not commutative; i.e. AB != BA, so the ordering of arguments
|
|
* @p m1 and @p m2 matters.
|
|
*
|
|
* @since 1.24
|
|
*/
|
|
EAPI void eina_matrix4_compose(const Eina_Matrix4 *mat_a,
|
|
const Eina_Matrix4 *mat_b,
|
|
Eina_Matrix4 *out);
|
|
|
|
/**
|
|
* @brief Sets the matrix values for a translation operation.
|
|
*
|
|
* @param[out] t Where to store the resulting matrix.
|
|
* @param[in] tx The X coordinate translation.
|
|
* @param[in] ty The Y coordinate translation.
|
|
* @param[in] tz The Z coordinate translation.
|
|
*
|
|
* @since 1.24
|
|
*/
|
|
EAPI void eina_matrix4_translate(Eina_Matrix4 *t, double tx, double ty, double tz);
|
|
|
|
/**
|
|
* @brief Sets the matrix values for a scaling operation.
|
|
*
|
|
* @param[out] t Where to store the resulting matrix.
|
|
* @param[in] sx The X coordinate scaling factor.
|
|
* @param[in] sy The Y coordinate scaling factor.
|
|
* @param[in] sz The Z coordinate scaling factor.
|
|
*
|
|
* @since 1.24
|
|
*/
|
|
EAPI void eina_matrix4_scale(Eina_Matrix4 *t, double sx, double sy, double sz);
|
|
|
|
/**
|
|
* @brief Sets the matrix values for a rotation operation.
|
|
* @param[out] t Where to store the resulting matrix.
|
|
* @param[in] rad The number of radians to rotate.
|
|
* @param[in] axis The Axis of rotation.
|
|
*
|
|
* @since 1.24
|
|
*/
|
|
EAPI void eina_matrix4_rotate(Eina_Matrix4 *t, double rad, Eina_Matrix_Axis axis);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
/**
|
|
* @defgroup Eina_Matrix2_Group 2x2 Matrices in floating point
|
|
*
|
|
* @brief Definition and operations for 2x3 matrices.
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @typedef Eina_Matrix2
|
|
* A 2x2 floating point matrix.
|
|
*/
|
|
typedef struct _Eina_Matrix2 Eina_Matrix2;
|
|
|
|
/**
|
|
* @struct Eina_Matrix2
|
|
* A 2x2 floating point matrix.
|
|
*/
|
|
struct _Eina_Matrix2
|
|
{
|
|
double xx;
|
|
double xy;
|
|
|
|
double yx;
|
|
double yy;
|
|
};
|
|
|
|
/**
|
|
* @brief Sets the values of the coefficients of the given floating
|
|
* point matrix.
|
|
*
|
|
* @param[out] m The floating point matrix.
|
|
* @param[in] xx The first coefficient value.
|
|
* @param[in] xy The second coefficient value.
|
|
* @param[in] yx The fourth coefficient value.
|
|
* @param[in] yy The fifth coefficient value.
|
|
*
|
|
* This function sets the values of the coefficients of the matrix
|
|
* @p m. No check is done on @p m.
|
|
*
|
|
* @see eina_matrix2_values_get()
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix2_values_set(Eina_Matrix2 *m, double xx, double xy,
|
|
double yx, double yy);
|
|
|
|
/**
|
|
* @brief Gets the values of the coefficients of the given floating
|
|
* point matrix.
|
|
*
|
|
* @param[out] m The floating point matrix.
|
|
* @param[in] xx The first coefficient value.
|
|
* @param[in] xy The second coefficient value.
|
|
* @param[in] yx The fourth coefficient value.
|
|
* @param[in] yy The fifth coefficient value.
|
|
*
|
|
* This function gets the values of the coefficients of the matrix
|
|
* @p m. No check is done on @p m.
|
|
*
|
|
* @see eina_matrix2_values_set()
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix2_values_get(const Eina_Matrix2 *m, double *xx, double *xy,
|
|
double *yx, double *yy);
|
|
|
|
/**
|
|
* @brief Computes the inverse with check of the given matrix.
|
|
*
|
|
* @param[out] out The matrix to inverse.
|
|
* @param[in] mat The inverse matrix.
|
|
*
|
|
* This function inverse the matrix @p out and stores the result in
|
|
* @p mat. No check is done on @p out or @p mat. If @p out can not be
|
|
* invertible, then @p mat is set to the identity matrix.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix2_inverse(Eina_Matrix2 *out, const Eina_Matrix2 *mat);
|
|
|
|
/**
|
|
* @brief Sets the given floating point matrix to the identity matrix.
|
|
*
|
|
* @param[out] m The floating point matrix to set.
|
|
*
|
|
* This function sets @p m to the identity matrix. No check is done on
|
|
* @p m.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix2_identity(Eina_Matrix2 *m);
|
|
|
|
/**
|
|
* @brief Sets array to matrix.
|
|
*
|
|
* @param[out] m The result matrix.
|
|
* @param[in] v The the array[4] for set.
|
|
*
|
|
* Set to matrix first 4 elements from array
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix2_array_set(Eina_Matrix2 *m, const double *v);
|
|
|
|
/**
|
|
* @brief Copies matrix.
|
|
*
|
|
* @param[out] dst The matrix copy.
|
|
* @param[in] src The matrix to copy.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix2_copy(Eina_Matrix2 *dst, const Eina_Matrix2 *src);
|
|
|
|
/**
|
|
* @brief Multiplies two matrices.
|
|
*
|
|
* @param[out] out The resulting matrix.
|
|
* @param[in] mat_a The first member of the multiplication.
|
|
* @param[in] mat_b The second member of the multiplication.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix2_multiply(Eina_Matrix2 *out, const Eina_Matrix2 *mat_a,
|
|
const Eina_Matrix2 *mat_b);
|
|
|
|
/**
|
|
* @brief Multiplies two matrices with check.
|
|
*
|
|
* @param[out] out The resulting matrix.
|
|
* @param[in] mat_a The first member of the multiplication.
|
|
* @param[in] mat_b The second member of the multiplication.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI void eina_matrix2_multiply_copy(Eina_Matrix2 *out, const Eina_Matrix2 *mat_a,
|
|
const Eina_Matrix2 *mat_b);
|
|
|
|
/**
|
|
* @brief Returns the type of the given floating point matrix.
|
|
*
|
|
* @param[in] m The floating point matrix.
|
|
* @return The type of the matrix.
|
|
*
|
|
* This function returns the type of the matrix @p m. No check is done
|
|
* on @p m.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
EAPI Eina_Matrix_Type eina_matrix2_type_get(const Eina_Matrix2 *m);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /*EINA_MATRIX_H_*/
|