diff options
author | Alexander Gavrilov <angavrilov@gmail.com> | 2020-07-04 13:20:59 +0300 |
---|---|---|
committer | Alexander Gavrilov <angavrilov@gmail.com> | 2020-07-21 19:01:50 +0300 |
commit | f8cc01595d1181b9a8adcb6aa930d4cbfebdc8bf (patch) | |
tree | 881dd5079bb2e7d674980a5e80d3ea7d16dd8375 /source/blender/python/generic | |
parent | 8369adabc0ec7a1fce248b688bf20860ae0434bb (diff) |
Drivers: add lerp and clamp functions to namespace.
Implementation of lerp without a function requires repeating one of
the arguments, which is not ideal. To avoid that, add a new function
to the driver namespace. In addition, provide a function for clamping
between 0 and 1 to support easy clamped lerp, and a smoothstep function
from GLSL that is somewhat related.
The function implementations are added to a new bl_math module.
As an aside, add the round function and two-argument log to the
pylike expression subset.
Differential Revision: https://developer.blender.org/D8205
Diffstat (limited to 'source/blender/python/generic')
-rw-r--r-- | source/blender/python/generic/CMakeLists.txt | 2 | ||||
-rw-r--r-- | source/blender/python/generic/bl_math_py_api.c | 163 | ||||
-rw-r--r-- | source/blender/python/generic/bl_math_py_api.h | 27 |
3 files changed, 192 insertions, 0 deletions
diff --git a/source/blender/python/generic/CMakeLists.txt b/source/blender/python/generic/CMakeLists.txt index 822f05bad90..785c1d66407 100644 --- a/source/blender/python/generic/CMakeLists.txt +++ b/source/blender/python/generic/CMakeLists.txt @@ -36,12 +36,14 @@ set(SRC bpy_threads.c idprop_py_api.c imbuf_py_api.c + bl_math_py_api.c py_capi_utils.c bgl.h blf_py_api.h idprop_py_api.h imbuf_py_api.h + bl_math_py_api.h py_capi_utils.h # header-only diff --git a/source/blender/python/generic/bl_math_py_api.c b/source/blender/python/generic/bl_math_py_api.c new file mode 100644 index 00000000000..4d5a63ffba3 --- /dev/null +++ b/source/blender/python/generic/bl_math_py_api.c @@ -0,0 +1,163 @@ +/* + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ + +/** + * \file + * \ingroup pygen + * + * This file defines the 'bl_math' module, a module for math utilities. + */ + +#include <Python.h> + +#include "BLI_math.h" +#include "BLI_utildefines.h" + +#include "py_capi_utils.h" + +#include "bl_math_py_api.h" + +/*------------------------------------------------------------*/ +/** + * \name Module doc string + * \{ */ + +PyDoc_STRVAR(M_Math_doc, "Miscellaneous math utilities module"); + +/** \} */ +/*------------------------------------------------------------*/ +/** + * \name Python functions + * \{ */ + +PyDoc_STRVAR(M_Math_clamp_doc, + ".. function:: clamp(value, min=0, max=1)\n" + "\n" + " Clamps the float value between minimum and maximum. To avoid\n" + " confusion, any call must use either one or all three arguments.\n" + "\n" + " :arg value: The value to clamp.\n" + " :type value: float\n" + " :arg min: The minimum value, defaults to 0.\n" + " :type min: float\n" + " :arg max: The maximum value, defaults to 1.\n" + " :type max: float\n" + " :return: The clamped value.\n" + " :rtype: float\n"); +static PyObject *M_Math_clamp(PyObject *UNUSED(self), PyObject *args) +{ + double x, minv = 0.0, maxv = 1.0; + + if (PyTuple_Size(args) <= 1) { + if (!PyArg_ParseTuple(args, "d:clamp", &x)) { + return NULL; + } + } + else { + if (!PyArg_ParseTuple(args, "ddd:clamp", &x, &minv, &maxv)) { + return NULL; + } + } + + CLAMP(x, minv, maxv); + + return PyFloat_FromDouble(x); +} + +PyDoc_STRVAR(M_Math_lerp_doc, + ".. function:: lerp(from, to, factor)\n" + "\n" + " Linearly interpolate between two float values based on factor.\n" + "\n" + " :arg from: The value to return when factor is 0.\n" + " :type from: float\n" + " :arg to: The value to return when factor is 1.\n" + " :type to: float\n" + " :arg factor: The interpolation value, normally in [0.0, 1.0].\n" + " :type factor: float\n" + " :return: The interpolated value.\n" + " :rtype: float\n"); +static PyObject *M_Math_lerp(PyObject *UNUSED(self), PyObject *args) +{ + double a, b, x; + if (!PyArg_ParseTuple(args, "ddd:lerp", &a, &b, &x)) { + return NULL; + } + + return PyFloat_FromDouble(a * (1.0 - x) + b * x); +} + +PyDoc_STRVAR( + M_Math_smoothstep_doc, + ".. function:: smoothstep(from, to, value)\n" + "\n" + " Performs smooth interpolation between 0 and 1 as value changes between from and to.\n" + " Outside the range the function returns the same value as the nearest edge.\n" + "\n" + " :arg from: The edge value where the result is 0.\n" + " :type from: float\n" + " :arg to: The edge value where the result is 1.\n" + " :type to: float\n" + " :arg factor: The interpolation value.\n" + " :type factor: float\n" + " :return: The interpolated value in [0.0, 1.0].\n" + " :rtype: float\n"); +static PyObject *M_Math_smoothstep(PyObject *UNUSED(self), PyObject *args) +{ + double a, b, x; + if (!PyArg_ParseTuple(args, "ddd:smoothstep", &a, &b, &x)) { + return NULL; + } + + double t = (x - a) / (b - a); + + CLAMP(t, 0.0, 1.0); + + return PyFloat_FromDouble(t * t * (3.0 - 2.0 * t)); +} + +/** \} */ +/*------------------------------------------------------------*/ +/** + * \name Module definition + * \{ */ + +static PyMethodDef M_Math_methods[] = { + {"clamp", (PyCFunction)M_Math_clamp, METH_VARARGS, M_Math_clamp_doc}, + {"lerp", (PyCFunction)M_Math_lerp, METH_VARARGS, M_Math_lerp_doc}, + {"smoothstep", (PyCFunction)M_Math_smoothstep, METH_VARARGS, M_Math_smoothstep_doc}, + {NULL, NULL, 0, NULL}, +}; + +static struct PyModuleDef M_Math_module_def = { + PyModuleDef_HEAD_INIT, + "bl_math", /* m_name */ + M_Math_doc, /* m_doc */ + 0, /* m_size */ + M_Math_methods, /* m_methods */ + NULL, /* m_reload */ + NULL, /* m_traverse */ + NULL, /* m_clear */ + NULL, /* m_free */ +}; + +PyMODINIT_FUNC BPyInit_bl_math(void) +{ + PyObject *submodule = PyModule_Create(&M_Math_module_def); + return submodule; +} + +/** \} */ diff --git a/source/blender/python/generic/bl_math_py_api.h b/source/blender/python/generic/bl_math_py_api.h new file mode 100644 index 00000000000..9183573abfc --- /dev/null +++ b/source/blender/python/generic/bl_math_py_api.h @@ -0,0 +1,27 @@ +/* + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ + +/** + * \file + * \ingroup pygen + */ + +#ifndef __BL_MATH_PY_API_H__ +#define __BL_MATH_PY_API_H__ + +PyMODINIT_FUNC BPyInit_bl_math(void); + +#endif /* __BL_MATH_PY_API_H__ */ |