PyAPI: add function to check any mathutils type
[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
34 #define MatrixObject_Check(v) PyObject_TypeCheck((v), &matrix_Type)
35 #define MatrixObject_CheckExact(v) (Py_TYPE(v) == &matrix_Type)
36
37 #define MATRIX_MAX_DIM 4
38
39 /* matrix[row][col] == MATRIX_ITEM_INDEX(matrix, row, col) */
40
41 #ifdef DEBUG
42 #  define MATRIX_ITEM_ASSERT(_mat, _row, _col) (BLI_assert(_row < (_mat)->num_row && _col < (_mat)->num_col))
43 #else
44 #  define MATRIX_ITEM_ASSERT(_mat, _row, _col) (void)0
45 #endif
46
47 #define MATRIX_ITEM_INDEX_NUMROW(_totrow, _row, _col) (((_totrow) * (_col)) + (_row))
48 #define MATRIX_ITEM_INDEX(_mat, _row, _col) (MATRIX_ITEM_ASSERT(_mat, _row, _col),(((_mat)->num_row * (_col)) + (_row)))
49 #define MATRIX_ITEM_PTR(  _mat, _row, _col) ((_mat)->matrix + MATRIX_ITEM_INDEX(_mat, _row, _col))
50 #define MATRIX_ITEM(      _mat, _row, _col) ((_mat)->matrix  [MATRIX_ITEM_INDEX(_mat, _row, _col)])
51
52 #define MATRIX_COL_INDEX(_mat, _col) (MATRIX_ITEM_INDEX(_mat, 0, _col))
53 #define MATRIX_COL_PTR(  _mat, _col) ((_mat)->matrix + MATRIX_COL_INDEX(_mat, _col))
54
55 typedef struct {
56         BASE_MATH_MEMBERS(matrix);
57         unsigned short num_col;
58         unsigned short num_row;
59 } MatrixObject;
60
61 /* struct data contains a pointer to the actual data that the
62  * object uses. It can use either PyMem allocated data (which will
63  * be stored in py_data) or be a wrapper for data allocated through
64  * blender (stored in blend_data). This is an either/or struct not both */
65
66 /* prototypes */
67 PyObject *Matrix_CreatePyObject(
68         const float *mat,
69         const unsigned short num_col, const unsigned short num_row,
70         PyTypeObject *base_type
71         ) ATTR_WARN_UNUSED_RESULT;
72 PyObject *Matrix_CreatePyObject_wrap(
73         float *mat,
74         const unsigned short num_col, const unsigned short num_row,
75         PyTypeObject *base_type
76         ) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
77 PyObject *Matrix_CreatePyObject_cb(
78         PyObject *user,
79         const unsigned short num_col, const unsigned short num_row,
80         unsigned char cb_type, unsigned char cb_subtype
81         ) ATTR_WARN_UNUSED_RESULT;
82
83 /* PyArg_ParseTuple's "O&" formatting helpers. */
84 int Matrix_ParseAny(PyObject *o, void *p);
85 int Matrix_Parse3x3(PyObject *o, void *p);
86 int Matrix_Parse4x4(PyObject *o, void *p);
87
88 extern unsigned char mathutils_matrix_row_cb_index; /* default */
89 extern unsigned char mathutils_matrix_col_cb_index;
90 extern unsigned char mathutils_matrix_translation_cb_index;
91
92 extern struct Mathutils_Callback mathutils_matrix_row_cb; /* default */
93 extern struct Mathutils_Callback mathutils_matrix_col_cb;
94 extern struct Mathutils_Callback mathutils_matrix_translation_cb;
95
96 void matrix_as_3x3(float mat[3][3], MatrixObject *self);
97
98 #endif /* __MATHUTILS_MATRIX_H__ */