Blender V5.3
BPy_FrsMaterial.cpp
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2004-2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BPy_FrsMaterial.h"
10
11#include "BPy_Convert.h"
12
13#include "BLI_hash_mm2a.hh"
14#include "BLI_math_vector_c.hh"
15
16using namespace Freestyle;
17
19
20//-------------------MODULE INITIALIZATION--------------------------------
21int FrsMaterial_Init(PyObject *module)
22{
23 if (module == nullptr) {
24 return -1;
25 }
26
27 if (PyType_Ready(&FrsMaterial_Type) < 0) {
28 return -1;
29 }
30 PyModule_AddObjectRef(module, "Material", (PyObject *)&FrsMaterial_Type);
31
33
34 return 0;
35}
36
37//------------------------INSTANCE METHODS ----------------------------------
38
40 /* Wrap. */
41 FrsMaterial_doc,
42 "Class defining a material.\n"
43 "\n"
44 ".. method:: __init__(*args)\n"
45 "\n"
46 " Accepted call signatures:\n"
47 "\n"
48 " - ``__init__()``\n"
49 " - ``__init__(brother)``\n"
50 " - ``__init__(line, diffuse, ambient, specular, emission, shininess, priority)``\n"
51 "\n"
52 " Creates a :class:`FrsMaterial` using either default constructor,\n"
53 " copy constructor, or an overloaded constructor\n"
54 "\n"
55 " :param brother: A Material object to be used as a copy constructor.\n"
56 " :type brother: :class:`Material`\n"
57 " :param line: The line color.\n"
58 " :type line: :class:`mathutils.Vector` | tuple[float, float, float, float] | list[float]\n"
59 " :param diffuse: The diffuse color.\n"
60 " :type diffuse: \n"
61 " :param ambient: The ambient color.\n"
62 " :type ambient: :class:`mathutils.Vector` | tuple[float, float, float, float] | "
63 "list[float]\n"
64 " :param specular: The specular color.\n"
65 " :type specular: :class:`mathutils.Vector` | tuple[float, float, float, float] | "
66 "list[float]\n"
67 " :param emission: The emissive color.\n"
68 " :type emission: :class:`mathutils.Vector` | tuple[float, float, float, float] | "
69 "list[float]\n"
70 " :param shininess: The shininess coefficient.\n"
71 " :type shininess: float\n"
72 " :param priority: The line color priority.\n"
73 " :type priority: int\n");
74static int FrsMaterial_init(BPy_FrsMaterial *self, PyObject *args, PyObject *kwds)
75{
76 static const char *kwlist_1[] = {"brother", nullptr};
77 static const char *kwlist_2[] = {
78 "line", "diffuse", "ambient", "specular", "emission", "shininess", "priority", nullptr};
79 PyObject *brother = nullptr;
80 float line[4], diffuse[4], ambient[4], specular[4], emission[4], shininess;
81 int priority;
82
83 if (PyArg_ParseTupleAndKeywords(args,
84 kwds,
85 "|" /* Optional arguments. */
86 "O!" /* `brother` */
87 ":__init__",
88 (char **)kwlist_1,
90 &brother))
91 {
92 if (!brother) {
93 self->m = new FrsMaterial();
94 }
95 else {
96 FrsMaterial *m = ((BPy_FrsMaterial *)brother)->m;
97 if (!m) {
98 PyErr_SetString(PyExc_RuntimeError, "invalid Material object");
99 return -1;
100 }
101 self->m = new FrsMaterial(*m);
102 }
103 }
104 else if ((void)PyErr_Clear(),
105 PyArg_ParseTupleAndKeywords(args,
106 kwds,
107 "O&" /* `line` */
108 "O&" /* `diffuse` */
109 "O&" /* `ambient` */
110 "O&" /* `specular` */
111 "O&" /* `emission` */
112 "f" /* `shininess` */
113 "i" /* `priority` */
114 ":__init__",
115 (char **)kwlist_2,
117 line,
119 diffuse,
121 ambient,
123 specular,
125 emission,
126 &shininess,
127 &priority))
128 {
129 self->m = new FrsMaterial(line, diffuse, ambient, specular, emission, shininess, priority);
130 }
131 else {
132 PyErr_SetString(PyExc_TypeError, "invalid argument(s)");
133 return -1;
134 }
135 return 0;
136}
137
139{
140 delete self->m;
141 Py_TYPE(self)->tp_free((PyObject *)self);
142}
143
144static PyObject *FrsMaterial_repr(BPy_FrsMaterial *self)
145{
146 return PyUnicode_FromFormat("Material - address: %p", self->m);
147}
148
149/*----------------------mathutils callbacks ----------------------------*/
150
151/* subtype */
152#define MATHUTILS_SUBTYPE_DIFFUSE 1
153#define MATHUTILS_SUBTYPE_SPECULAR 2
154#define MATHUTILS_SUBTYPE_AMBIENT 3
155#define MATHUTILS_SUBTYPE_EMISSION 4
156#define MATHUTILS_SUBTYPE_LINE 5
157
159{
160 if (!BPy_FrsMaterial_Check(bmo->cb_user)) {
161 return -1;
162 }
163 return 0;
164}
165
167{
168 BPy_FrsMaterial *self = (BPy_FrsMaterial *)bmo->cb_user;
169 switch (subtype) {
171 bmo->data[0] = self->m->lineR();
172 bmo->data[1] = self->m->lineG();
173 bmo->data[2] = self->m->lineB();
174 bmo->data[3] = self->m->lineA();
175 break;
177 bmo->data[0] = self->m->diffuseR();
178 bmo->data[1] = self->m->diffuseG();
179 bmo->data[2] = self->m->diffuseB();
180 bmo->data[3] = self->m->diffuseA();
181 break;
183 bmo->data[0] = self->m->specularR();
184 bmo->data[1] = self->m->specularG();
185 bmo->data[2] = self->m->specularB();
186 bmo->data[3] = self->m->specularA();
187 break;
189 bmo->data[0] = self->m->ambientR();
190 bmo->data[1] = self->m->ambientG();
191 bmo->data[2] = self->m->ambientB();
192 bmo->data[3] = self->m->ambientA();
193 break;
195 bmo->data[0] = self->m->emissionR();
196 bmo->data[1] = self->m->emissionG();
197 bmo->data[2] = self->m->emissionB();
198 bmo->data[3] = self->m->emissionA();
199 break;
200 default:
201 return -1;
202 }
203 return 0;
204}
205
207{
208 BPy_FrsMaterial *self = (BPy_FrsMaterial *)bmo->cb_user;
209 switch (subtype) {
211 self->m->setLine(bmo->data[0], bmo->data[1], bmo->data[2], bmo->data[3]);
212 break;
214 self->m->setDiffuse(bmo->data[0], bmo->data[1], bmo->data[2], bmo->data[3]);
215 break;
217 self->m->setSpecular(bmo->data[0], bmo->data[1], bmo->data[2], bmo->data[3]);
218 break;
220 self->m->setAmbient(bmo->data[0], bmo->data[1], bmo->data[2], bmo->data[3]);
221 break;
223 self->m->setEmission(bmo->data[0], bmo->data[1], bmo->data[2], bmo->data[3]);
224 break;
225 default:
226 return -1;
227 }
228 return 0;
229}
230
232{
233 BPy_FrsMaterial *self = (BPy_FrsMaterial *)bmo->cb_user;
234 switch (subtype) {
236 const float *color = self->m->line();
237 bmo->data[index] = color[index];
238 break;
239 }
241 const float *color = self->m->diffuse();
242 bmo->data[index] = color[index];
243 break;
244 }
246 const float *color = self->m->specular();
247 bmo->data[index] = color[index];
248 break;
249 }
251 const float *color = self->m->ambient();
252 bmo->data[index] = color[index];
253 break;
254 }
256 const float *color = self->m->emission();
257 bmo->data[index] = color[index];
258 break;
259 }
260 default:
261 return -1;
262 }
263 return 0;
264}
265
267{
268 BPy_FrsMaterial *self = (BPy_FrsMaterial *)bmo->cb_user;
269 float color[4];
270 switch (subtype) {
272 blender::copy_v4_v4(color, self->m->line());
273 color[index] = bmo->data[index];
274 self->m->setLine(color[0], color[1], color[2], color[3]);
275 break;
277 blender::copy_v4_v4(color, self->m->diffuse());
278 color[index] = bmo->data[index];
279 self->m->setDiffuse(color[0], color[1], color[2], color[3]);
280 break;
282 blender::copy_v4_v4(color, self->m->specular());
283 color[index] = bmo->data[index];
284 self->m->setSpecular(color[0], color[1], color[2], color[3]);
285 break;
287 blender::copy_v4_v4(color, self->m->ambient());
288 color[index] = bmo->data[index];
289 self->m->setAmbient(color[0], color[1], color[2], color[3]);
290 break;
292 blender::copy_v4_v4(color, self->m->emission());
293 color[index] = bmo->data[index];
294 self->m->setEmission(color[0], color[1], color[2], color[3]);
295 break;
296 default:
297 return -1;
298 }
299 return 0;
300}
301
309
311
316
317/*----------------------FrsMaterial get/setters ----------------------------*/
318
320 /* Wrap. */
321 FrsMaterial_line_doc,
322 "RGBA components of the line color of the material.\n"
323 "\n"
324 ":type: :class:`mathutils.Vector`\n");
325static PyObject *FrsMaterial_line_get(BPy_FrsMaterial *self, void * /*closure*/)
326{
329}
330
331static int FrsMaterial_line_set(BPy_FrsMaterial *self, PyObject *value, void * /*closure*/)
332{
333 float color[4];
334 if (blender::mathutils_array_parse(color, 4, 4, value, "value must be a 4-dimensional vector") ==
335 -1)
336 {
337 return -1;
338 }
339 self->m->setLine(color[0], color[1], color[2], color[3]);
340 return 0;
341}
342
344 /* Wrap. */
345 FrsMaterial_diffuse_doc,
346 "RGBA components of the diffuse color of the material.\n"
347 "\n"
348 ":type: :class:`mathutils.Vector`\n");
349static PyObject *FrsMaterial_diffuse_get(BPy_FrsMaterial *self, void * /*closure*/)
350{
353}
354
355static int FrsMaterial_diffuse_set(BPy_FrsMaterial *self, PyObject *value, void * /*closure*/)
356{
357 float color[4];
358 if (blender::mathutils_array_parse(color, 4, 4, value, "value must be a 4-dimensional vector") ==
359 -1)
360 {
361 return -1;
362 }
363 self->m->setDiffuse(color[0], color[1], color[2], color[3]);
364 return 0;
365}
366
368 /* Wrap. */
369 FrsMaterial_specular_doc,
370 "RGBA components of the specular color of the material.\n"
371 "\n"
372 ":type: :class:`mathutils.Vector`\n");
373static PyObject *FrsMaterial_specular_get(BPy_FrsMaterial *self, void * /*closure*/)
374{
377}
378
379static int FrsMaterial_specular_set(BPy_FrsMaterial *self, PyObject *value, void * /*closure*/)
380{
381 float color[4];
382 if (blender::mathutils_array_parse(color, 4, 4, value, "value must be a 4-dimensional vector") ==
383 -1)
384 {
385 return -1;
386 }
387 self->m->setSpecular(color[0], color[1], color[2], color[3]);
388 return 0;
389}
390
392 /* Wrap. */
393 FrsMaterial_ambient_doc,
394 "RGBA components of the ambient color of the material.\n"
395 "\n"
396 ":type: :class:`mathutils.Color`\n");
397static PyObject *FrsMaterial_ambient_get(BPy_FrsMaterial *self, void * /*closure*/)
398{
401}
402
403static int FrsMaterial_ambient_set(BPy_FrsMaterial *self, PyObject *value, void * /*closure*/)
404{
405 float color[4];
406 if (blender::mathutils_array_parse(color, 4, 4, value, "value must be a 4-dimensional vector") ==
407 -1)
408 {
409 return -1;
410 }
411 self->m->setAmbient(color[0], color[1], color[2], color[3]);
412 return 0;
413}
414
416 /* Wrap. */
417 FrsMaterial_emission_doc,
418 "RGBA components of the emissive color of the material.\n"
419 "\n"
420 ":type: :class:`mathutils.Color`\n");
421static PyObject *FrsMaterial_emission_get(BPy_FrsMaterial *self, void * /*closure*/)
422{
425}
426
427static int FrsMaterial_emission_set(BPy_FrsMaterial *self, PyObject *value, void * /*closure*/)
428{
429 float color[4];
430 if (blender::mathutils_array_parse(color, 4, 4, value, "value must be a 4-dimensional vector") ==
431 -1)
432 {
433 return -1;
434 }
435 self->m->setEmission(color[0], color[1], color[2], color[3]);
436 return 0;
437}
438
440 /* Wrap. */
441 FrsMaterial_shininess_doc,
442 "Shininess coefficient of the material.\n"
443 "\n"
444 ":type: float\n");
445static PyObject *FrsMaterial_shininess_get(BPy_FrsMaterial *self, void * /*closure*/)
446{
447 return PyFloat_FromDouble(self->m->shininess());
448}
449
450static int FrsMaterial_shininess_set(BPy_FrsMaterial *self, PyObject *value, void * /*closure*/)
451{
452 float scalar;
453 if ((scalar = PyFloat_AsDouble(value)) == -1.0f && PyErr_Occurred()) {
454 /* parsed item not a number */
455 PyErr_SetString(PyExc_TypeError, "value must be a number");
456 return -1;
457 }
458 self->m->setShininess(scalar);
459 return 0;
460}
461
463 /* Wrap. */
464 FrsMaterial_priority_doc,
465 "Line color priority of the material.\n"
466 "\n"
467 ":type: int\n");
468static PyObject *FrsMaterial_priority_get(BPy_FrsMaterial *self, void * /*closure*/)
469{
470 return PyLong_FromLong(self->m->priority());
471}
472
473static int FrsMaterial_priority_set(BPy_FrsMaterial *self, PyObject *value, void * /*closure*/)
474{
475 int scalar;
476 if ((scalar = PyLong_AsLong(value)) == -1 && PyErr_Occurred()) {
477 PyErr_SetString(PyExc_TypeError, "value must be an integer");
478 return -1;
479 }
480 self->m->setPriority(scalar);
481 return 0;
482}
483
484static PyGetSetDef BPy_FrsMaterial_getseters[] = {
485 {"line",
486 (getter)FrsMaterial_line_get,
487 (setter)FrsMaterial_line_set,
488 FrsMaterial_line_doc,
489 nullptr},
490 {"diffuse",
493 FrsMaterial_diffuse_doc,
494 nullptr},
495 {"specular",
498 FrsMaterial_specular_doc,
499 nullptr},
500 {"ambient",
503 FrsMaterial_ambient_doc,
504 nullptr},
505 {"emission",
508 FrsMaterial_emission_doc,
509 nullptr},
510 {"shininess",
513 FrsMaterial_shininess_doc,
514 nullptr},
515 {"priority",
518 FrsMaterial_priority_doc,
519 nullptr},
520 {nullptr, nullptr, nullptr, nullptr, nullptr} /* Sentinel */
521};
522
523static PyObject *BPy_FrsMaterial_richcmpr(PyObject *objectA,
524 PyObject *objectB,
525 int comparison_type)
526{
527 const BPy_FrsMaterial *matA = nullptr, *matB = nullptr;
528 bool result = false;
529
530 if (!BPy_FrsMaterial_Check(objectA) || !BPy_FrsMaterial_Check(objectB)) {
531 if (comparison_type == Py_NE) {
532 Py_RETURN_TRUE;
533 }
534
535 Py_RETURN_FALSE;
536 }
537
538 matA = (BPy_FrsMaterial *)objectA;
539 matB = (BPy_FrsMaterial *)objectB;
540
541 switch (comparison_type) {
542 case Py_NE:
543 result = (*matA->m) != (*matB->m);
544 break;
545 case Py_EQ:
546 result = (*matA->m) == (*matB->m);
547 break;
548 default:
549 PyErr_SetString(PyExc_TypeError, "Material does not support this comparison type");
550 return nullptr;
551 }
552
553 if (result == true) {
554 Py_RETURN_TRUE;
555 }
556
557 Py_RETURN_FALSE;
558}
559
560static Py_hash_t FrsMaterial_hash(PyObject *self)
561{
562 return (Py_uhash_t)blender::BLI_hash_mm2((const uchar *)self, sizeof(*self), 0);
563}
564/*-----------------------BPy_FrsMaterial type definition ------------------------------*/
565
566PyTypeObject FrsMaterial_Type = {
567 /*ob_base*/ PyVarObject_HEAD_INIT(nullptr, 0)
568 /*tp_name*/ "Material",
569 /*tp_basicsize*/ sizeof(BPy_FrsMaterial),
570 /*tp_itemsize*/ 0,
571 /*tp_dealloc*/ (destructor)FrsMaterial_dealloc,
572 /*tp_vectorcall_offset*/ 0,
573 /*tp_getattr*/ nullptr,
574 /*tp_setattr*/ nullptr,
575 /*tp_as_async*/ nullptr,
576 /*tp_repr*/ (reprfunc)FrsMaterial_repr,
577 /*tp_as_number*/ nullptr,
578 /*tp_as_sequence*/ nullptr,
579 /*tp_as_mapping*/ nullptr,
580 /*tp_hash*/ (hashfunc)FrsMaterial_hash,
581 /*tp_call*/ nullptr,
582 /*tp_str*/ nullptr,
583 /*tp_getattro*/ nullptr,
584 /*tp_setattro*/ nullptr,
585 /*tp_as_buffer*/ nullptr,
586 /*tp_flags*/ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
587 /*tp_doc*/ FrsMaterial_doc,
588 /*tp_traverse*/ nullptr,
589 /*tp_clear*/ nullptr,
590 /*tp_richcompare*/ (richcmpfunc)BPy_FrsMaterial_richcmpr,
591 /*tp_weaklistoffset*/ 0,
592 /*tp_iter*/ nullptr,
593 /*tp_iternext*/ nullptr,
594 /*tp_methods*/ nullptr,
595 /*tp_members*/ nullptr,
596 /*tp_getset*/ BPy_FrsMaterial_getseters,
597 /*tp_base*/ nullptr,
598 /*tp_dict*/ nullptr,
599 /*tp_descr_get*/ nullptr,
600 /*tp_descr_set*/ nullptr,
601 /*tp_dictoffset*/ 0,
602 /*tp_init*/ (initproc)FrsMaterial_init,
603 /*tp_alloc*/ nullptr,
604 /*tp_new*/ PyType_GenericNew,
605};
606
int convert_v4(PyObject *obj, void *v)
PyDoc_STRVAR(FalseBP1D___doc__, "Class hierarchy: :class:`freestyle.types.BinaryPredicate1D` > :class:`FalseBP1D`\n" "\n" ".. method:: __call__(inter1, inter2)\n" "\n" " Always returns false.\n" "\n" " :param inter1: The first Interface1D object.\n" " :type inter1: :class:`freestyle.types.Interface1D`\n" " :param inter2: The second Interface1D object.\n" " :type inter2: :class:`freestyle.types.Interface1D`\n" " :return: False.\n" " :rtype: bool\n")
void FrsMaterial_mathutils_register_callback()
int FrsMaterial_Init(PyObject *module)
static int FrsMaterial_specular_set(BPy_FrsMaterial *self, PyObject *value, void *)
#define MATHUTILS_SUBTYPE_DIFFUSE
static PyGetSetDef BPy_FrsMaterial_getseters[]
static int FrsMaterial_ambient_set(BPy_FrsMaterial *self, PyObject *value, void *)
static int FrsMaterial_mathutils_set_index(blender::BaseMathObject *bmo, int subtype, int index)
static PyObject * FrsMaterial_specular_get(BPy_FrsMaterial *self, void *)
static void FrsMaterial_dealloc(BPy_FrsMaterial *self)
static int FrsMaterial_line_set(BPy_FrsMaterial *self, PyObject *value, void *)
static int FrsMaterial_mathutils_get_index(blender::BaseMathObject *bmo, int subtype, int index)
static PyObject * BPy_FrsMaterial_richcmpr(PyObject *objectA, PyObject *objectB, int comparison_type)
static PyObject * FrsMaterial_line_get(BPy_FrsMaterial *self, void *)
static PyObject * FrsMaterial_emission_get(BPy_FrsMaterial *self, void *)
static PyObject * FrsMaterial_ambient_get(BPy_FrsMaterial *self, void *)
static int FrsMaterial_priority_set(BPy_FrsMaterial *self, PyObject *value, void *)
static int FrsMaterial_init(BPy_FrsMaterial *self, PyObject *args, PyObject *kwds)
#define MATHUTILS_SUBTYPE_EMISSION
#define MATHUTILS_SUBTYPE_LINE
PyTypeObject FrsMaterial_Type
static int FrsMaterial_emission_set(BPy_FrsMaterial *self, PyObject *value, void *)
static int FrsMaterial_diffuse_set(BPy_FrsMaterial *self, PyObject *value, void *)
#define MATHUTILS_SUBTYPE_SPECULAR
static PyObject * FrsMaterial_shininess_get(BPy_FrsMaterial *self, void *)
static PyObject * FrsMaterial_repr(BPy_FrsMaterial *self)
#define MATHUTILS_SUBTYPE_AMBIENT
static blender::Mathutils_Callback FrsMaterial_mathutils_cb
static int FrsMaterial_mathutils_set(blender::BaseMathObject *bmo, int subtype)
static int FrsMaterial_mathutils_get(blender::BaseMathObject *bmo, int subtype)
static uchar FrsMaterial_mathutils_cb_index
static PyObject * FrsMaterial_priority_get(BPy_FrsMaterial *self, void *)
static PyObject * FrsMaterial_diffuse_get(BPy_FrsMaterial *self, void *)
static int FrsMaterial_shininess_set(BPy_FrsMaterial *self, PyObject *value, void *)
static int FrsMaterial_mathutils_check(blender::BaseMathObject *bmo)
static Py_hash_t FrsMaterial_hash(PyObject *self)
#define BPy_FrsMaterial_Check(v)
const float * ambient() const
float lineR() const
Definition FrsMaterial.h:62
void setShininess(float s)
float emissionB() const
const float * specular() const
void setPriority(int priority)
float ambientG() const
float shininess() const
float specularB() const
void setDiffuse(float r, float g, float b, float a)
float ambientR() const
void setLine(float r, float g, float b, float a)
float emissionG() const
float lineA() const
Definition FrsMaterial.h:80
float emissionR() const
void setAmbient(float r, float g, float b, float a)
const float * diffuse() const
Definition FrsMaterial.h:86
float ambientA() const
float ambientB() const
float diffuseG() const
Definition FrsMaterial.h:98
float specularR() const
const float * line() const
Definition FrsMaterial.h:56
float specularG() const
const float * emission() const
void setSpecular(float r, float g, float b, float a)
float emissionA() const
float diffuseB() const
float specularA() const
float lineG() const
Definition FrsMaterial.h:68
void setEmission(float r, float g, float b, float a)
float diffuseR() const
Definition FrsMaterial.h:92
float diffuseA() const
float lineB() const
Definition FrsMaterial.h:74
#define index(i)
unsigned int uchar
inherits from class Rep
Definition AppCanvas.cpp:20
PyObject * Vector_CreatePyObject_cb(PyObject *cb_user, int vec_num, uchar cb_type, uchar cb_subtype)
int mathutils_array_parse(float *array, int array_num_min, int array_num_max, PyObject *value, const char *error_prefix)
Definition mathutils.cc:97
uint32_t BLI_hash_mm2(const unsigned char *data, size_t len, uint32_t seed)
Definition hash_mm2a.cc:102
MINLINE void copy_v4_v4(float r[4], const float a[4])
PyObject_HEAD Freestyle::FrsMaterial * m