Files
test2/source/blender/python/bmesh/bmesh_py_geometry.cc
Campbell Barton 78c9d16919 PyDoc: correct types, consistent formatting for doc-strings in C++
Correct some types, ensure multi-line docs end with a newline,
sentences end with a full stop.
2025-08-22 14:05:28 +10:00

86 lines
2.2 KiB
C++

/* SPDX-FileCopyrightText: 2012 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup pybmesh
*
* This file defines the 'bmesh.geometry' module.
* Utility functions for operating on 'bmesh.types'
*/
#include <Python.h>
#include "../mathutils/mathutils.hh"
#include "bmesh.hh"
#include "bmesh_py_geometry.hh" /* own include */
#include "bmesh_py_types.hh"
PyDoc_STRVAR(
/* Wrap. */
bpy_bm_geometry_intersect_face_point_doc,
".. method:: intersect_face_point(face, point)\n"
"\n"
" Tests if the projection of a point is inside a face (using the face's normal).\n"
"\n"
" :arg face: The face to test.\n"
" :type face: :class:`bmesh.types.BMFace`\n"
" :arg point: The point to test.\n"
" :type point: float triplet\n"
" :return: True when the projection of the point is in the face.\n"
" :rtype: bool\n");
static PyObject *bpy_bm_geometry_intersect_face_point(BPy_BMFace * /*self*/, PyObject *args)
{
BPy_BMFace *py_face;
PyObject *py_point;
float point[3];
bool ret;
if (!PyArg_ParseTuple(args, "O!O:intersect_face_point", &BPy_BMFace_Type, &py_face, &py_point)) {
return nullptr;
}
BPY_BM_CHECK_OBJ(py_face);
if (mathutils_array_parse(point, 3, 3, py_point, "intersect_face_point") == -1) {
return nullptr;
}
ret = BM_face_point_inside_test(py_face->f, point);
return PyBool_FromLong(ret);
}
static PyMethodDef BPy_BM_geometry_methods[] = {
{"intersect_face_point",
(PyCFunction)bpy_bm_geometry_intersect_face_point,
METH_VARARGS,
bpy_bm_geometry_intersect_face_point_doc},
{nullptr, nullptr, 0, nullptr},
};
PyDoc_STRVAR(
/* Wrap. */
BPy_BM_utils_doc,
"This module provides access to bmesh geometry evaluation functions.\n");
static PyModuleDef BPy_BM_geometry_module_def = {
/*m_base*/ PyModuleDef_HEAD_INIT,
/*m_name*/ "bmesh.geometry",
/*m_doc*/ BPy_BM_utils_doc,
/*m_size*/ 0,
/*m_methods*/ BPy_BM_geometry_methods,
/*m_slots*/ nullptr,
/*m_traverse*/ nullptr,
/*m_clear*/ nullptr,
/*m_free*/ nullptr,
};
PyObject *BPyInit_bmesh_geometry()
{
PyObject *submodule;
submodule = PyModule_Create(&BPy_BM_geometry_module_def);
return submodule;
}