Blender  V3.3
mathutils_Matrix.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 
7 #pragma once
8 
9 extern PyTypeObject matrix_Type;
10 extern PyTypeObject matrix_access_Type;
11 
12 typedef unsigned short ushort;
13 
14 #define MatrixObject_Check(v) PyObject_TypeCheck((v), &matrix_Type)
15 #define MatrixObject_CheckExact(v) (Py_TYPE(v) == &matrix_Type)
16 
17 #define MATRIX_MAX_DIM 4
18 
19 /* matrix[row][col] == MATRIX_ITEM_INDEX(matrix, row, col) */
20 
21 #ifdef DEBUG
22 # define MATRIX_ITEM_ASSERT(_mat, _row, _col) \
23  (BLI_assert(_row < (_mat)->row_num && _col < (_mat)->col_num))
24 #else
25 # define MATRIX_ITEM_ASSERT(_mat, _row, _col) (void)0
26 #endif
27 
28 #define MATRIX_ITEM_INDEX_NUMROW(_totrow, _row, _col) (((_totrow) * (_col)) + (_row))
29 #define MATRIX_ITEM_INDEX(_mat, _row, _col) \
30  (MATRIX_ITEM_ASSERT(_mat, _row, _col), (((_mat)->row_num * (_col)) + (_row)))
31 #define MATRIX_ITEM_PTR(_mat, _row, _col) ((_mat)->matrix + MATRIX_ITEM_INDEX(_mat, _row, _col))
32 #define MATRIX_ITEM(_mat, _row, _col) ((_mat)->matrix[MATRIX_ITEM_INDEX(_mat, _row, _col)])
33 
34 #define MATRIX_COL_INDEX(_mat, _col) (MATRIX_ITEM_INDEX(_mat, 0, _col))
35 #define MATRIX_COL_PTR(_mat, _col) ((_mat)->matrix + MATRIX_COL_INDEX(_mat, _col))
36 
37 typedef struct {
41 } MatrixObject;
42 
43 /* struct data contains a pointer to the actual data that the
44  * object uses. It can use either PyMem allocated data (which will
45  * be stored in py_data) or be a wrapper for data allocated through
46  * blender (stored in blend_data). This is an either/or struct not both */
47 
48 /* Prototypes. */
49 
50 PyObject *Matrix_CreatePyObject(const float *mat,
51  ushort col_num,
52  ushort row_num,
53  PyTypeObject *base_type) ATTR_WARN_UNUSED_RESULT;
54 PyObject *Matrix_CreatePyObject_wrap(float *mat,
55  ushort col_num,
56  ushort row_num,
57  PyTypeObject *base_type) ATTR_WARN_UNUSED_RESULT
58  ATTR_NONNULL(1);
59 PyObject *Matrix_CreatePyObject_cb(PyObject *user,
60  unsigned short col_num,
61  unsigned short row_num,
62  unsigned char cb_type,
63  unsigned char cb_subtype) ATTR_WARN_UNUSED_RESULT;
64 
68 PyObject *Matrix_CreatePyObject_alloc(float *mat,
69  ushort col_num,
70  ushort row_num,
71  PyTypeObject *base_type) ATTR_WARN_UNUSED_RESULT;
72 
73 /* PyArg_ParseTuple's "O&" formatting helpers. */
74 
75 int Matrix_ParseAny(PyObject *o, void *p);
76 int Matrix_Parse2x2(PyObject *o, void *p);
77 int Matrix_Parse3x3(PyObject *o, void *p);
78 int Matrix_Parse4x4(PyObject *o, void *p);
79 
80 extern unsigned char mathutils_matrix_row_cb_index; /* default */
81 extern unsigned char mathutils_matrix_col_cb_index;
82 extern unsigned char mathutils_matrix_translation_cb_index;
83 
84 extern struct Mathutils_Callback mathutils_matrix_row_cb; /* default */
87 
88 void matrix_as_3x3(float mat[3][3], MatrixObject *self);
#define ATTR_WARN_UNUSED_RESULT
#define ATTR_NONNULL(...)
unsigned short ushort
Definition: BLI_sys_types.h:68
int Matrix_Parse3x3(PyObject *o, void *p)
int Matrix_ParseAny(PyObject *o, void *p)
unsigned char mathutils_matrix_translation_cb_index
unsigned char mathutils_matrix_row_cb_index
PyObject * Matrix_CreatePyObject_cb(PyObject *user, unsigned short col_num, unsigned short row_num, unsigned char cb_type, unsigned char cb_subtype) ATTR_WARN_UNUSED_RESULT
PyTypeObject matrix_access_Type
struct Mathutils_Callback mathutils_matrix_row_cb
void matrix_as_3x3(float mat[3][3], MatrixObject *self)
int Matrix_Parse2x2(PyObject *o, void *p)
struct Mathutils_Callback mathutils_matrix_col_cb
PyObject * Matrix_CreatePyObject(const float *mat, ushort col_num, ushort row_num, PyTypeObject *base_type) ATTR_WARN_UNUSED_RESULT
int Matrix_Parse4x4(PyObject *o, void *p)
PyObject * Matrix_CreatePyObject_alloc(float *mat, ushort col_num, ushort row_num, PyTypeObject *base_type) ATTR_WARN_UNUSED_RESULT
unsigned short ushort
PyObject * Matrix_CreatePyObject_wrap(float *mat, ushort col_num, ushort row_num, PyTypeObject *base_type) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
unsigned char mathutils_matrix_col_cb_index
PyTypeObject matrix_Type
struct Mathutils_Callback mathutils_matrix_translation_cb
BASE_MATH_MEMBERS(matrix)