Blender V5.3
BPy_ViewEdge.cpp
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2004-2022 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BPy_ViewEdge.h"
10
11#include "../BPy_Convert.h"
12#include "../BPy_Id.h"
13#include "../BPy_Nature.h"
14#include "../BPy_ViewShape.h"
18
19using namespace Freestyle;
20
22
23/*----------------------ViewEdge methods ----------------------------*/
24
26 /* Wrap. */
27 ViewEdge_doc,
28 "Class hierarchy: :class:`Interface1D` > :class:`ViewEdge`\n"
29 "\n"
30 "Class defining a ViewEdge. A ViewEdge in an edge of the image graph.\n"
31 "it connects two :class:`ViewVertex` objects. It is made by connecting\n"
32 "a set of FEdges.\n"
33 "\n"
34 ".. method:: __init__(*args)\n"
35 "\n"
36 " Accepted call signatures:\n"
37 "\n"
38 " - ``__init__()``\n"
39 " - ``__init__(brother)``\n"
40 "\n"
41 " Builds a :class:`ViewEdge` using the default constructor or the copy constructor.\n"
42 "\n"
43 " :param brother: A ViewEdge object.\n"
44 " :type brother: :class:`ViewEdge`\n");
45static int ViewEdge_init(BPy_ViewEdge *self, PyObject *args, PyObject *kwds)
46{
47 static const char *kwlist[] = {"brother", nullptr};
48 PyObject *brother = nullptr;
49
50 if (!PyArg_ParseTupleAndKeywords(args,
51 kwds,
52 "|" /* Optional arguments. */
53 "O!" /* `brother` */
54 ":__init__",
55 (char **)kwlist,
57 &brother))
58 {
59 return -1;
60 }
61 if (!brother) {
62 self->ve = new ViewEdge();
63 }
64 else {
65 self->ve = new ViewEdge(*(((BPy_ViewEdge *)brother)->ve));
66 }
67 self->py_if1D.if1D = self->ve;
68 self->py_if1D.borrowed = false;
69 return 0;
70}
71
73 /* Wrap. */
74 ViewEdge_update_fedges_doc,
75 ".. method:: update_fedges()\n"
76 "\n"
77 " Sets Viewedge to this for all embedded fedges.\n");
78static PyObject *ViewEdge_update_fedges(BPy_ViewEdge *self)
79{
80 self->ve->UpdateFEdges();
81 Py_RETURN_NONE;
82}
83
84#ifdef __GNUC__
85# ifdef __clang__
86# pragma clang diagnostic push
87# pragma clang diagnostic ignored "-Wcast-function-type"
88# else
89# pragma GCC diagnostic push
90# pragma GCC diagnostic ignored "-Wcast-function-type"
91# endif
92#endif
93
94static PyMethodDef BPy_ViewEdge_methods[] = {
95 {"update_fedges",
96 (PyCFunction)ViewEdge_update_fedges,
97 METH_NOARGS,
98 ViewEdge_update_fedges_doc},
99 {nullptr, nullptr, 0, nullptr},
100};
101
102#ifdef __GNUC__
103# ifdef __clang__
104# pragma clang diagnostic pop
105# else
106# pragma GCC diagnostic pop
107# endif
108#endif
109
110/*----------------------ViewEdge get/setters ----------------------------*/
111
113 /* Wrap. */
114 ViewEdge_first_viewvertex_doc,
115 "The first ViewVertex.\n"
116 "\n"
117 ":type: :class:`ViewVertex`\n");
118static PyObject *ViewEdge_first_viewvertex_get(BPy_ViewEdge *self, void * /*closure*/)
119{
120 ViewVertex *v = self->ve->A();
121 if (v) {
123 }
124 Py_RETURN_NONE;
125}
126
127static int ViewEdge_first_viewvertex_set(BPy_ViewEdge *self, PyObject *value, void * /*closure*/)
128{
129 if (!BPy_ViewVertex_Check(value)) {
130 return -1;
131 }
132 self->ve->setA(((BPy_ViewVertex *)value)->vv);
133 return 0;
134}
135
137 /* Wrap. */
138 ViewEdge_last_viewvertex_doc,
139 "The second ViewVertex.\n"
140 "\n"
141 ":type: :class:`ViewVertex`\n");
142static PyObject *ViewEdge_last_viewvertex_get(BPy_ViewEdge *self, void * /*closure*/)
143{
144 ViewVertex *v = self->ve->B();
145 if (v) {
147 }
148 Py_RETURN_NONE;
149}
150
151static int ViewEdge_last_viewvertex_set(BPy_ViewEdge *self, PyObject *value, void * /*closure*/)
152{
153 if (!BPy_ViewVertex_Check(value)) {
154 return -1;
155 }
156 self->ve->setB(((BPy_ViewVertex *)value)->vv);
157 return 0;
158}
159
161 /* Wrap. */
162 ViewEdge_first_fedge_doc,
163 "The first FEdge that constitutes this ViewEdge.\n"
164 "\n"
165 ":type: :class:`FEdge`\n");
166static PyObject *ViewEdge_first_fedge_get(BPy_ViewEdge *self, void * /*closure*/)
167{
168 FEdge *fe = self->ve->fedgeA();
169 if (fe) {
170 return Any_BPy_FEdge_from_FEdge(*fe);
171 }
172 Py_RETURN_NONE;
173}
174
175static int ViewEdge_first_fedge_set(BPy_ViewEdge *self, PyObject *value, void * /*closure*/)
176{
177 if (!BPy_FEdge_Check(value)) {
178 return -1;
179 }
180 self->ve->setFEdgeA(((BPy_FEdge *)value)->fe);
181 return 0;
182}
183
185 /* Wrap. */
186 ViewEdge_last_fedge_doc,
187 "The last FEdge that constitutes this ViewEdge.\n"
188 "\n"
189 ":type: :class:`FEdge`\n");
190static PyObject *ViewEdge_last_fedge_get(BPy_ViewEdge *self, void * /*closure*/)
191{
192 FEdge *fe = self->ve->fedgeB();
193 if (fe) {
194 return Any_BPy_FEdge_from_FEdge(*fe);
195 }
196 Py_RETURN_NONE;
197}
198
199static int ViewEdge_last_fedge_set(BPy_ViewEdge *self, PyObject *value, void * /*closure*/)
200{
201 if (!BPy_FEdge_Check(value)) {
202 return -1;
203 }
204 self->ve->setFEdgeB(((BPy_FEdge *)value)->fe);
205 return 0;
206}
207
209 /* Wrap. */
210 ViewEdge_viewshape_doc,
211 "The ViewShape to which this ViewEdge belongs to.\n"
212 "\n"
213 ":type: :class:`ViewShape`\n");
214static PyObject *ViewEdge_viewshape_get(BPy_ViewEdge *self, void * /*closure*/)
215{
216 ViewShape *vs = self->ve->viewShape();
217 if (vs) {
219 }
220 Py_RETURN_NONE;
221}
222
223static int ViewEdge_viewshape_set(BPy_ViewEdge *self, PyObject *value, void * /*closure*/)
224{
225 if (!BPy_ViewShape_Check(value)) {
226 return -1;
227 }
228 self->ve->setShape(((BPy_ViewShape *)value)->vs);
229 return 0;
230}
231
233 /* Wrap. */
234 ViewEdge_occludee_doc,
235 "The shape that is occluded by the ViewShape to which this ViewEdge\n"
236 "belongs to. If no object is occluded, this property is set to None.\n"
237 "\n"
238 ":type: :class:`ViewShape`\n");
239static PyObject *ViewEdge_occludee_get(BPy_ViewEdge *self, void * /*closure*/)
240{
241 ViewShape *vs = self->ve->aShape();
242 if (vs) {
244 }
245 Py_RETURN_NONE;
246}
247
248static int ViewEdge_occludee_set(BPy_ViewEdge *self, PyObject *value, void * /*closure*/)
249{
250 if (!BPy_ViewShape_Check(value)) {
251 return -1;
252 }
253 self->ve->setaShape(((BPy_ViewShape *)value)->vs);
254 return 0;
255}
256
258 /* Wrap. */
259 ViewEdge_is_closed_doc,
260 "True if this ViewEdge forms a closed loop.\n"
261 "\n"
262 ":type: bool\n");
263static PyObject *ViewEdge_is_closed_get(BPy_ViewEdge *self, void * /*closure*/)
264{
265 return PyBool_from_bool(self->ve->isClosed());
266}
267
269 /* Wrap. */
270 ViewEdge_id_doc,
271 "The Id of this ViewEdge.\n"
272 "\n"
273 ":type: :class:`Id`\n");
274static PyObject *ViewEdge_id_get(BPy_ViewEdge *self, void * /*closure*/)
275{
276 Id id(self->ve->getId());
277 return BPy_Id_from_Id(id); // return a copy
278}
279
280static int ViewEdge_id_set(BPy_ViewEdge *self, PyObject *value, void * /*closure*/)
281{
282 if (!BPy_Id_Check(value)) {
283 PyErr_SetString(PyExc_TypeError, "value must be an Id");
284 return -1;
285 }
286 self->ve->setId(*(((BPy_Id *)value)->id));
287 return 0;
288}
289
291 /* Wrap. */
292 ViewEdge_nature_doc,
293 "The nature of this ViewEdge.\n"
294 "\n"
295 ":type: :class:`Nature`\n");
296static PyObject *ViewEdge_nature_get(BPy_ViewEdge *self, void * /*closure*/)
297{
298 return BPy_Nature_from_Nature(self->ve->getNature());
299}
300
301static int ViewEdge_nature_set(BPy_ViewEdge *self, PyObject *value, void * /*closure*/)
302{
303 if (!BPy_Nature_Check(value)) {
304 PyErr_SetString(PyExc_TypeError, "value must be a Nature");
305 return -1;
306 }
307 self->ve->setNature(PyLong_AsLong((PyObject *)&((BPy_Nature *)value)->i));
308 return 0;
309}
310
312 /* Wrap. */
313 ViewEdge_qi_doc,
314 "The quantitative invisibility.\n"
315 "\n"
316 ":type: int\n");
317static PyObject *ViewEdge_qi_get(BPy_ViewEdge *self, void * /*closure*/)
318{
319 return PyLong_FromLong(self->ve->qi());
320}
321
322static int ViewEdge_qi_set(BPy_ViewEdge *self, PyObject *value, void * /*closure*/)
323{
324 int qi;
325
326 if ((qi = PyLong_AsLong(value)) == -1 && PyErr_Occurred()) {
327 return -1;
328 }
329 self->ve->setQI(qi);
330 return 0;
331}
332
334 /* Wrap. */
335 ViewEdge_chaining_time_stamp_doc,
336 "The time stamp of this ViewEdge.\n"
337 "\n"
338 ":type: int\n");
339static PyObject *ViewEdge_chaining_time_stamp_get(BPy_ViewEdge *self, void * /*closure*/)
340{
341 return PyLong_FromLong(self->ve->getChainingTimeStamp());
342}
343
345 PyObject *value,
346 void * /*closure*/)
347{
348 int timestamp;
349
350 if ((timestamp = PyLong_AsLong(value)) == -1 && PyErr_Occurred()) {
351 return -1;
352 }
353 self->ve->setChainingTimeStamp(timestamp);
354 return 0;
355}
356
357static PyGetSetDef BPy_ViewEdge_getseters[] = {
358 {"first_viewvertex",
361 ViewEdge_first_viewvertex_doc,
362 nullptr},
363 {"last_viewvertex",
366 ViewEdge_last_viewvertex_doc,
367 nullptr},
368 {"first_fedge",
371 ViewEdge_first_fedge_doc,
372 nullptr},
373 {"last_fedge",
376 ViewEdge_last_fedge_doc,
377 nullptr},
378 {"viewshape",
381 ViewEdge_viewshape_doc,
382 nullptr},
383 {"occludee",
384 (getter)ViewEdge_occludee_get,
385 (setter)ViewEdge_occludee_set,
386 ViewEdge_occludee_doc,
387 nullptr},
388 {"is_closed",
390 (setter) nullptr,
391 ViewEdge_is_closed_doc,
392 nullptr},
393 {"id", (getter)ViewEdge_id_get, (setter)ViewEdge_id_set, ViewEdge_id_doc, nullptr},
394 {"nature",
395 (getter)ViewEdge_nature_get,
396 (setter)ViewEdge_nature_set,
397 ViewEdge_nature_doc,
398 nullptr},
399 {"qi", (getter)ViewEdge_qi_get, (setter)ViewEdge_qi_set, ViewEdge_qi_doc, nullptr},
400 {"chaining_time_stamp",
403 ViewEdge_chaining_time_stamp_doc,
404 nullptr},
405 {nullptr, nullptr, nullptr, nullptr, nullptr} /* Sentinel */
406};
407
408/*-----------------------BPy_ViewEdge type definition ------------------------------*/
409
410PyTypeObject ViewEdge_Type = {
411 /*ob_base*/ PyVarObject_HEAD_INIT(nullptr, 0)
412 /*tp_name*/ "ViewEdge",
413 /*tp_basicsize*/ sizeof(BPy_ViewEdge),
414 /*tp_itemsize*/ 0,
415 /*tp_dealloc*/ nullptr,
416 /*tp_vectorcall_offset*/ 0,
417 /*tp_getattr*/ nullptr,
418 /*tp_setattr*/ nullptr,
419 /*tp_as_async*/ nullptr,
420 /*tp_repr*/ nullptr,
421 /*tp_as_number*/ nullptr,
422 /*tp_as_sequence*/ nullptr,
423 /*tp_as_mapping*/ nullptr,
424 /*tp_hash*/ nullptr,
425 /*tp_call*/ nullptr,
426 /*tp_str*/ nullptr,
427 /*tp_getattro*/ nullptr,
428 /*tp_setattro*/ nullptr,
429 /*tp_as_buffer*/ nullptr,
430 /*tp_flags*/ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
431 /*tp_doc*/ ViewEdge_doc,
432 /*tp_traverse*/ nullptr,
433 /*tp_clear*/ nullptr,
434 /*tp_richcompare*/ nullptr,
435 /*tp_weaklistoffset*/ 0,
436 /*tp_iter*/ nullptr,
437 /*tp_iternext*/ nullptr,
438 /*tp_methods*/ BPy_ViewEdge_methods,
439 /*tp_members*/ nullptr,
440 /*tp_getset*/ BPy_ViewEdge_getseters,
441 /*tp_base*/ &Interface1D_Type,
442 /*tp_dict*/ nullptr,
443 /*tp_descr_get*/ nullptr,
444 /*tp_descr_set*/ nullptr,
445 /*tp_dictoffset*/ 0,
446 /*tp_init*/ (initproc)ViewEdge_init,
447 /*tp_alloc*/ nullptr,
448 /*tp_new*/ nullptr,
449};
450
PyObject * BPy_Id_from_Id(Id &id)
PyObject * Any_BPy_FEdge_from_FEdge(FEdge &fe)
PyObject * BPy_Nature_from_Nature(ushort n)
PyObject * Any_BPy_ViewVertex_from_ViewVertex(ViewVertex &vv)
PyObject * PyBool_from_bool(bool b)
PyObject * BPy_ViewShape_from_ViewShape(ViewShape &vs)
#define BPy_FEdge_Check(v)
Definition BPy_FEdge.h:19
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")
#define BPy_Id_Check(v)
Definition BPy_Id.h:23
PyTypeObject Interface1D_Type
#define BPy_Nature_Check(v)
Definition BPy_Nature.h:21
static PyObject * ViewEdge_update_fedges(BPy_ViewEdge *self)
static PyObject * ViewEdge_is_closed_get(BPy_ViewEdge *self, void *)
static int ViewEdge_occludee_set(BPy_ViewEdge *self, PyObject *value, void *)
static PyGetSetDef BPy_ViewEdge_getseters[]
static int ViewEdge_id_set(BPy_ViewEdge *self, PyObject *value, void *)
static int ViewEdge_last_fedge_set(BPy_ViewEdge *self, PyObject *value, void *)
static PyObject * ViewEdge_qi_get(BPy_ViewEdge *self, void *)
static PyObject * ViewEdge_nature_get(BPy_ViewEdge *self, void *)
static PyObject * ViewEdge_id_get(BPy_ViewEdge *self, void *)
static PyObject * ViewEdge_first_viewvertex_get(BPy_ViewEdge *self, void *)
static PyObject * ViewEdge_chaining_time_stamp_get(BPy_ViewEdge *self, void *)
static PyObject * ViewEdge_occludee_get(BPy_ViewEdge *self, void *)
static int ViewEdge_init(BPy_ViewEdge *self, PyObject *args, PyObject *kwds)
static int ViewEdge_first_fedge_set(BPy_ViewEdge *self, PyObject *value, void *)
static PyMethodDef BPy_ViewEdge_methods[]
static PyObject * ViewEdge_last_viewvertex_get(BPy_ViewEdge *self, void *)
static int ViewEdge_chaining_time_stamp_set(BPy_ViewEdge *self, PyObject *value, void *)
static int ViewEdge_nature_set(BPy_ViewEdge *self, PyObject *value, void *)
static int ViewEdge_qi_set(BPy_ViewEdge *self, PyObject *value, void *)
static int ViewEdge_viewshape_set(BPy_ViewEdge *self, PyObject *value, void *)
static int ViewEdge_last_viewvertex_set(BPy_ViewEdge *self, PyObject *value, void *)
static PyObject * ViewEdge_first_fedge_get(BPy_ViewEdge *self, void *)
static int ViewEdge_first_viewvertex_set(BPy_ViewEdge *self, PyObject *value, void *)
static PyObject * ViewEdge_last_fedge_get(BPy_ViewEdge *self, void *)
PyTypeObject ViewEdge_Type
static PyObject * ViewEdge_viewshape_get(BPy_ViewEdge *self, void *)
#define BPy_ViewShape_Check(v)
#define BPy_ViewVertex_Check(v)
int qi() const
Definition ViewMap.h:1272
ViewShape * aShape()
Definition ViewMap.h:1087
void setId(const Id &id)
Definition ViewMap.h:1170
uint getChainingTimeStamp()
Definition ViewMap.h:1102
void setaShape(ViewShape *iShape)
Definition ViewMap.h:1179
virtual Nature::EdgeNature getNature() const
Definition ViewMap.h:902
void setFEdgeB(FEdge *iFEdge)
Definition ViewMap.h:1158
void setA(ViewVertex *iA)
Definition ViewMap.h:1134
virtual Id getId() const
Definition ViewMap.h:896
ViewShape * viewShape()
Definition ViewMap.h:1079
void setFEdgeA(FEdge *iFEdge)
Definition ViewMap.h:1152
void setShape(ViewShape *iVShape)
Definition ViewMap.h:1164
ViewVertex * B()
Definition ViewMap.h:1061
void setChainingTimeStamp(uint ts)
Definition ViewMap.h:1191
void setNature(Nature::EdgeNature iNature)
Definition ViewMap.h:1146
ViewVertex * A()
Definition ViewMap.h:1055
void setQI(int qi)
Definition ViewMap.h:1185
void setB(ViewVertex *iB)
Definition ViewMap.h:1140
inherits from class Rep
Definition AppCanvas.cpp:20
PyObject_HEAD Freestyle::Interface1D * if1D
Freestyle::ViewEdge * ve
BPy_Interface1D py_if1D