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