test/source/blender/python/mathutils/mathutils_Matrix.hh

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

/** \file
 * \ingroup pymathutils
 */

#pragma once

#include <Python.h>

#include "mathutils.hh"

extern PyTypeObject matrix_Type;
extern PyTypeObject matrix_access_Type;

using ushort = unsigned short;

#define MatrixObject_Check(v) PyObject_TypeCheck((v), &matrix_Type)
#define MatrixObject_CheckExact(v) (Py_TYPE(v) == &matrix_Type)

#define MATRIX_MAX_DIM 4

/* matrix[row][col] == MATRIX_ITEM_INDEX(matrix, row, col) */

#ifndef NDEBUG
#  define MATRIX_ITEM_ASSERT(_mat, _row, _col) \
    (BLI_assert(_row < (_mat)->row_num && _col < (_mat)->col_num))
#else
#  define MATRIX_ITEM_ASSERT(_mat, _row, _col) (void)0
#endif

#define MATRIX_ITEM_INDEX_NUMROW(_totrow, _row, _col) (((_totrow) * (_col)) + (_row))
#define MATRIX_ITEM_INDEX(_mat, _row, _col) \
  (MATRIX_ITEM_ASSERT(_mat, _row, _col), (((_mat)->row_num * (_col)) + (_row)))
#define MATRIX_ITEM_PTR(_mat, _row, _col) ((_mat)->matrix + MATRIX_ITEM_INDEX(_mat, _row, _col))
#define MATRIX_ITEM(_mat, _row, _col) ((_mat)->matrix[MATRIX_ITEM_INDEX(_mat, _row, _col)])

#define MATRIX_COL_INDEX(_mat, _col) (MATRIX_ITEM_INDEX(_mat, 0, _col))
#define MATRIX_COL_PTR(_mat, _col) ((_mat)->matrix + MATRIX_COL_INDEX(_mat, _col))

struct MatrixObject {
  BASE_MATH_MEMBERS(matrix);
  ushort col_num;
  ushort row_num;
};

/* struct data contains a pointer to the actual data that the
 * object uses. It can use either PyMem allocated data (which will
 * be stored in py_data) or be a wrapper for data allocated through
 * blender (stored in blend_data). This is an either/or struct not both */

/* Prototypes. */

[[nodiscard]] PyObject *Matrix_CreatePyObject(const float *mat,
                                              ushort col_num,
                                              ushort row_num,
                                              PyTypeObject *base_type);
[[nodiscard]] PyObject *Matrix_CreatePyObject_wrap(float *mat,
                                                   ushort col_num,
                                                   ushort row_num,
                                                   PyTypeObject *base_type) ATTR_NONNULL(1);
[[nodiscard]] PyObject *Matrix_CreatePyObject_cb(PyObject *cb_user,
                                                 unsigned short col_num,
                                                 unsigned short row_num,
                                                 unsigned char cb_type,
                                                 unsigned char cb_subtype);

/**
 * \param mat: Initialized matrix value to use in-place, allocated with #PyMem_Malloc
 */
[[nodiscard]] PyObject *Matrix_CreatePyObject_alloc(float *mat,
                                                    ushort col_num,
                                                    ushort row_num,
                                                    PyTypeObject *base_type);

/* PyArg_ParseTuple's "O&" formatting helpers. */

[[nodiscard]] int Matrix_ParseAny(PyObject *o, void *p);
[[nodiscard]] int Matrix_Parse2x2(PyObject *o, void *p);
[[nodiscard]] int Matrix_Parse3x3(PyObject *o, void *p);
[[nodiscard]] int Matrix_Parse4x4(PyObject *o, void *p);

extern unsigned char mathutils_matrix_row_cb_index; /* default */
extern unsigned char mathutils_matrix_col_cb_index;
extern unsigned char mathutils_matrix_translation_cb_index;

extern struct Mathutils_Callback mathutils_matrix_row_cb; /* default */
extern struct Mathutils_Callback mathutils_matrix_col_cb;
extern struct Mathutils_Callback mathutils_matrix_translation_cb;

void matrix_as_3x3(float mat[3][3], MatrixObject *self);