RNA: sync API changes from 2.8
[blender.git] / source / blender / python / mathutils / mathutils_Matrix.h
1 /* 
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Joseph Gilbert
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/python/mathutils/mathutils_Matrix.h
24  *  \ingroup pymathutils
25  */
26
27
28 #ifndef __MATHUTILS_MATRIX_H__
29 #define __MATHUTILS_MATRIX_H__
30
31 extern PyTypeObject matrix_Type;
32 extern PyTypeObject matrix_access_Type;
33 #define MatrixObject_Check(_v) PyObject_TypeCheck((_v), &matrix_Type)
34 #define MATRIX_MAX_DIM 4
35
36 /* matrix[row][col] == MATRIX_ITEM_INDEX(matrix, row, col) */
37
38 #ifdef DEBUG
39 #  define MATRIX_ITEM_ASSERT(_mat, _row, _col) (BLI_assert(_row < (_mat)->num_row && _col < (_mat)->num_col))
40 #else
41 #  define MATRIX_ITEM_ASSERT(_mat, _row, _col) (void)0
42 #endif
43
44 #define MATRIX_ITEM_INDEX_NUMROW(_totrow, _row, _col) (((_totrow) * (_col)) + (_row))
45 #define MATRIX_ITEM_INDEX(_mat, _row, _col) (MATRIX_ITEM_ASSERT(_mat, _row, _col),(((_mat)->num_row * (_col)) + (_row)))
46 #define MATRIX_ITEM_PTR(  _mat, _row, _col) ((_mat)->matrix + MATRIX_ITEM_INDEX(_mat, _row, _col))
47 #define MATRIX_ITEM(      _mat, _row, _col) ((_mat)->matrix  [MATRIX_ITEM_INDEX(_mat, _row, _col)])
48
49 #define MATRIX_COL_INDEX(_mat, _col) (MATRIX_ITEM_INDEX(_mat, 0, _col))
50 #define MATRIX_COL_PTR(  _mat, _col) ((_mat)->matrix + MATRIX_COL_INDEX(_mat, _col))
51
52 typedef struct {
53         BASE_MATH_MEMBERS(matrix);
54         unsigned short num_col;
55         unsigned short num_row;
56 } MatrixObject;
57
58 /* struct data contains a pointer to the actual data that the
59  * object uses. It can use either PyMem allocated data (which will
60  * be stored in py_data) or be a wrapper for data allocated through
61  * blender (stored in blend_data). This is an either/or struct not both */
62
63 /* prototypes */
64 PyObject *Matrix_CreatePyObject(
65         const float *mat,
66         const unsigned short num_col, const unsigned short num_row,
67         PyTypeObject *base_type
68         ) ATTR_WARN_UNUSED_RESULT;
69 PyObject *Matrix_CreatePyObject_wrap(
70         float *mat,
71         const unsigned short num_col, const unsigned short num_row,
72         PyTypeObject *base_type
73         ) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
74 PyObject *Matrix_CreatePyObject_cb(
75         PyObject *user,
76         const unsigned short num_col, const unsigned short num_row,
77         unsigned char cb_type, unsigned char cb_subtype
78         ) ATTR_WARN_UNUSED_RESULT;
79
80 /* PyArg_ParseTuple's "O&" formatting helpers. */
81 int Matrix_ParseAny(PyObject *o, void *p);
82 int Matrix_Parse3x3(PyObject *o, void *p);
83 int Matrix_Parse4x4(PyObject *o, void *p);
84
85 extern unsigned char mathutils_matrix_row_cb_index; /* default */
86 extern unsigned char mathutils_matrix_col_cb_index;
87 extern unsigned char mathutils_matrix_translation_cb_index;
88
89 extern struct Mathutils_Callback mathutils_matrix_row_cb; /* default */
90 extern struct Mathutils_Callback mathutils_matrix_col_cb;
91 extern struct Mathutils_Callback mathutils_matrix_translation_cb;
92
93 void matrix_as_3x3(float mat[3][3], MatrixObject *self);
94
95 #endif /* __MATHUTILS_MATRIX_H__ */