Blender  V3.3
Functions | Variables
BPy_ViewVertex.cpp File Reference
#include "BPy_ViewVertex.h"
#include "../BPy_Convert.h"
#include "../BPy_Nature.h"
#include "../Interface1D/BPy_ViewEdge.h"

Go to the source code of this file.

Functions

 PyDoc_STRVAR (ViewVertex_doc, "Class hierarchy: :class:`Interface0D` > :class:`ViewVertex`\n" "\n" "Class to define a view vertex. A view vertex is a feature vertex\n" "corresponding to a point of the image graph, where the characteristics\n" "of an edge (e.g., nature and visibility) might change. A\n" ":class:`ViewVertex` can be of two kinds: A :class:`TVertex` when it\n" "corresponds to the intersection between two ViewEdges or a\n" ":class:`NonTVertex` when it corresponds to a vertex of the initial\n" "input mesh (it is the case for vertices such as corners for example).\n" "Thus, this class can be specialized into two classes, the\n" ":class:`TVertex` class and the :class:`NonTVertex` class.")
 
static int ViewVertex_init (BPy_ViewVertex *, PyObject *, PyObject *)
 
 PyDoc_STRVAR (ViewVertex_edges_begin_doc, ".. method:: edges_begin()\n" "\n" " Returns an iterator over the ViewEdges that goes to or comes from\n" " this ViewVertex pointing to the first ViewEdge of the list. The\n" " orientedViewEdgeIterator allows to iterate in CCW order over these\n" " ViewEdges and to get the orientation for each ViewEdge\n" " (incoming/outgoing).\n" "\n" " :return: An orientedViewEdgeIterator pointing to the first ViewEdge.\n" " :rtype: :class:`orientedViewEdgeIterator`")
 
static PyObject * ViewVertex_edges_begin (BPy_ViewVertex *self)
 
 PyDoc_STRVAR (ViewVertex_edges_end_doc, ".. method:: edges_end()\n" "\n" " Returns an orientedViewEdgeIterator over the ViewEdges around this\n" " ViewVertex, pointing after the last ViewEdge.\n" "\n" " :return: An orientedViewEdgeIterator pointing after the last ViewEdge.\n" " :rtype: :class:`orientedViewEdgeIterator`")
 
static PyObject * ViewVertex_edges_end (BPy_ViewVertex *)
 
 PyDoc_STRVAR (ViewVertex_edges_iterator_doc, ".. method:: edges_iterator(edge)\n" "\n" " Returns an orientedViewEdgeIterator pointing to the ViewEdge given\n" " as argument.\n" "\n" " :arg edge: A ViewEdge object.\n" " :type edge: :class:`ViewEdge`\n" " :return: An orientedViewEdgeIterator pointing to the given ViewEdge.\n" " :rtype: :class:`orientedViewEdgeIterator`")
 
static PyObject * ViewVertex_edges_iterator (BPy_ViewVertex *self, PyObject *args, PyObject *kwds)
 
 PyDoc_STRVAR (ViewVertex_nature_doc, "The nature of this ViewVertex.\n" "\n" ":type: :class:`Nature`")
 
static PyObject * ViewVertex_nature_get (BPy_ViewVertex *self, void *UNUSED(closure))
 
static int ViewVertex_nature_set (BPy_ViewVertex *self, PyObject *value, void *UNUSED(closure))
 

Variables

static PyMethodDef BPy_ViewVertex_methods []
 
static PyGetSetDef BPy_ViewVertex_getseters []
 
PyTypeObject ViewVertex_Type
 

Function Documentation

◆ PyDoc_STRVAR() [1/5]

PyDoc_STRVAR ( ViewVertex_doc  ,
"Class hierarchy: :class:`Interface0D ,
:class:`ViewVertex`\n" "\n" "Class to define a view vertex. A view vertex is a feature vertex\n" "corresponding to a point of the image  graph,
where the characteristics\n" "of an edge(e.g., nature and visibility) might change. A\n" ":class:`ViewVertex` can be of two kinds:A :class:`TVertex` when it\n" "corresponds to the intersection between two ViewEdges or a\n" ":class:`NonTVertex` when it corresponds to a vertex of the initial\n" "input mesh(it is the case for vertices such as corners for example).\n" "  Thus,
this class can be specialized into two  classes,
the\n" ":class:`TVertex` class and the :class:`NonTVertex` class."   
)

◆ PyDoc_STRVAR() [2/5]

PyDoc_STRVAR ( ViewVertex_edges_begin_doc  ,
".. method:: edges_begin()\n" "\n" " Returns an iterator over the ViewEdges that goes to or comes from\n" " this ViewVertex pointing to the first ViewEdge of the list. The\n" " orientedViewEdgeIterator allows to iterate in CCW order over these\n" " ViewEdges and to get the orientation for each ViewEdge\n" " (incoming/outgoing).\n" "\n" " :return: An orientedViewEdgeIterator pointing to the first ViewEdge.\n" " :rtype: :class:`orientedViewEdgeIterator`"   
)

◆ PyDoc_STRVAR() [3/5]

PyDoc_STRVAR ( ViewVertex_edges_end_doc  ,
".. method:: edges_end()\n" "\n" " Returns an orientedViewEdgeIterator over the ViewEdges around this\n" "  ViewVertex,
pointing after the last ViewEdge.\n" "\n" " :return:An orientedViewEdgeIterator pointing after the last ViewEdge.\n" " :rtype::class:`orientedViewEdgeIterator`"   
)

◆ PyDoc_STRVAR() [4/5]

PyDoc_STRVAR ( ViewVertex_edges_iterator_doc  ,
".. method:: edges_iterator(edge)\n" "\n" " Returns an orientedViewEdgeIterator pointing to the ViewEdge given\n" " as argument.\n" "\n" " :arg edge: A ViewEdge object.\n" " :type edge: :class:`ViewEdge`\n" " :return: An orientedViewEdgeIterator pointing to the given ViewEdge.\n" " :rtype: :class:`orientedViewEdgeIterator`"   
)

◆ PyDoc_STRVAR() [5/5]

PyDoc_STRVAR ( ViewVertex_nature_doc  ,
"The nature of this ViewVertex.\n" "\n" ":type: :class:`Nature`"   
)

◆ ViewVertex_edges_begin()

static PyObject* ViewVertex_edges_begin ( BPy_ViewVertex self)
static

◆ ViewVertex_edges_end()

static PyObject* ViewVertex_edges_end ( BPy_ViewVertex )
static

◆ ViewVertex_edges_iterator()

static PyObject* ViewVertex_edges_iterator ( BPy_ViewVertex self,
PyObject *  args,
PyObject *  kwds 
)
static

◆ ViewVertex_init()

static int ViewVertex_init ( BPy_ViewVertex ,
PyObject *  ,
PyObject *   
)
static

Definition at line 36 of file BPy_ViewVertex.cpp.

◆ ViewVertex_nature_get()

static PyObject* ViewVertex_nature_get ( BPy_ViewVertex self,
void UNUSEDclosure 
)
static

Definition at line 121 of file BPy_ViewVertex.cpp.

References BPy_Nature_from_Nature().

◆ ViewVertex_nature_set()

static int ViewVertex_nature_set ( BPy_ViewVertex self,
PyObject *  value,
void UNUSEDclosure 
)
static

Definition at line 130 of file BPy_ViewVertex.cpp.

References BPy_Nature_Check.

Variable Documentation

◆ BPy_ViewVertex_getseters

PyGetSetDef BPy_ViewVertex_getseters[]
static
Initial value:
= {
{"nature",
ViewVertex_nature_doc,
nullptr},
{nullptr, nullptr, nullptr, nullptr, nullptr}
}
static PyObject * ViewVertex_nature_get(BPy_ViewVertex *self, void *UNUSED(closure))
static int ViewVertex_nature_set(BPy_ViewVertex *self, PyObject *value, void *UNUSED(closure))

Definition at line 140 of file BPy_ViewVertex.cpp.

◆ BPy_ViewVertex_methods

PyMethodDef BPy_ViewVertex_methods[]
static
Initial value:
= {
{"edges_begin", (PyCFunction)ViewVertex_edges_begin, METH_NOARGS, ViewVertex_edges_begin_doc},
{"edges_end", (PyCFunction)ViewVertex_edges_end, METH_NOARGS, ViewVertex_edges_end_doc},
{"edges_iterator",
METH_VARARGS | METH_KEYWORDS,
ViewVertex_edges_iterator_doc},
{nullptr, nullptr, 0, nullptr},
}
static PyObject * ViewVertex_edges_begin(BPy_ViewVertex *self)
static PyObject * ViewVertex_edges_end(BPy_ViewVertex *)
static PyObject * ViewVertex_edges_iterator(BPy_ViewVertex *self, PyObject *args, PyObject *kwds)

Definition at line 104 of file BPy_ViewVertex.cpp.

◆ ViewVertex_Type

PyTypeObject ViewVertex_Type