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

Go to the source code of this file.

Functions

 PyDoc_STRVAR (ChainingIterator_doc, "Class hierarchy: :class:`Iterator` > :class:`ViewEdgeIterator` > :class:`ChainingIterator`\n" "\n" "Base class for chaining iterators. This class is designed to be\n" "overloaded in order to describe chaining rules. It makes the\n" "description of chaining rules easier. The two main methods that need\n" "to overloaded are traverse() and init(). traverse() tells which\n" ":class:`ViewEdge` to follow, among the adjacent ones. If you specify\n" "restriction rules (such as \"Chain only ViewEdges of the selection\"),\n" "they will be included in the adjacency iterator (i.e, the adjacent\n" "iterator will only stop on \"valid\" edges).\n" "\n" ".. method:: __init__(restrict_to_selection=True, restrict_to_unvisited=True," " begin=None, orientation=True)\n" " __init__(brother)\n" "\n" " Builds a Chaining Iterator from the first ViewEdge used for\n" " iteration and its orientation or by using the copy constructor.\n" "\n" " :arg restrict_to_selection: Indicates whether to force the chaining\n" " to stay within the set of selected ViewEdges or not.\n" " :type restrict_to_selection: bool\n" " :arg restrict_to_unvisited: Indicates whether a ViewEdge that has\n" " already been chained must be ignored ot not.\n" " :type restrict_to_unvisited: bool\n" " :arg begin: The ViewEdge from which to start the chain.\n" " :type begin: :class:`ViewEdge` or None\n" " :arg orientation: The direction to follow to explore the graph. If\n" " true, the direction indicated by the first ViewEdge is used.\n" " :type orientation: bool\n" " :arg brother: \n" " :type brother: ChainingIterator")
 
static int check_begin (PyObject *obj, void *v)
 
static int ChainingIterator___init__ (BPy_ChainingIterator *self, PyObject *args, PyObject *kwds)
 
 PyDoc_STRVAR (ChainingIterator_init_doc, ".. method:: init()\n" "\n" " Initializes the iterator context. This method is called each\n" " time a new chain is started. It can be used to reset some\n" " history information that you might want to keep.")
 
static PyObject * ChainingIterator_init (BPy_ChainingIterator *self)
 
 PyDoc_STRVAR (ChainingIterator_traverse_doc, ".. method:: traverse(it)\n" "\n" " This method iterates over the potential next ViewEdges and returns\n" " the one that will be followed next. Returns the next ViewEdge to\n" " follow or None when the end of the chain is reached.\n" "\n" " :arg it: The iterator over the ViewEdges adjacent to the end vertex\n" " of the current ViewEdge. The adjacency iterator reflects the\n" " restriction rules by only iterating over the valid ViewEdges.\n" " :type it: :class:`AdjacencyIterator`\n" " :return: Returns the next ViewEdge to follow, or None if chaining ends.\n" " :rtype: :class:`ViewEdge` or None")
 
static PyObject * ChainingIterator_traverse (BPy_ChainingIterator *self, PyObject *args, PyObject *kwds)
 
 PyDoc_STRVAR (ChainingIterator_object_doc, "The ViewEdge object currently pointed by this iterator.\n" "\n" ":type: :class:`ViewEdge`")
 
static PyObject * ChainingIterator_object_get (BPy_ChainingIterator *self, void *UNUSED(closure))
 
 PyDoc_STRVAR (ChainingIterator_next_vertex_doc, "The ViewVertex that is the next crossing.\n" "\n" ":type: :class:`ViewVertex`")
 
static PyObject * ChainingIterator_next_vertex_get (BPy_ChainingIterator *self, void *UNUSED(closure))
 
 PyDoc_STRVAR (ChainingIterator_is_incrementing_doc, "True if the current iteration is an incrementation.\n" "\n" ":type: bool")
 
static PyObject * ChainingIterator_is_incrementing_get (BPy_ChainingIterator *self, void *UNUSED(closure))
 

Variables

static PyMethodDef BPy_ChainingIterator_methods []
 
static PyGetSetDef BPy_ChainingIterator_getseters []
 
PyTypeObject ChainingIterator_Type
 

Function Documentation

◆ ChainingIterator___init__()

static int ChainingIterator___init__ ( BPy_ChainingIterator self,
PyObject *  args,
PyObject *  kwds 
)
static

Definition at line 67 of file BPy_ChainingIterator.cpp.

References bool_from_PyBool(), ChainingIterator_Type, and check_begin().

◆ ChainingIterator_init()

static PyObject* ChainingIterator_init ( BPy_ChainingIterator self)
static

Definition at line 118 of file BPy_ChainingIterator.cpp.

References self.

◆ ChainingIterator_is_incrementing_get()

static PyObject* ChainingIterator_is_incrementing_get ( BPy_ChainingIterator self,
void UNUSEDclosure 
)
static

Definition at line 214 of file BPy_ChainingIterator.cpp.

References PyBool_from_bool(), and self.

◆ ChainingIterator_next_vertex_get()

static PyObject* ChainingIterator_next_vertex_get ( BPy_ChainingIterator self,
void UNUSEDclosure 
)
static

Definition at line 198 of file BPy_ChainingIterator.cpp.

References Any_BPy_ViewVertex_from_ViewVertex(), and v.

◆ ChainingIterator_object_get()

static PyObject* ChainingIterator_object_get ( BPy_ChainingIterator self,
void UNUSEDclosure 
)
static

Definition at line 179 of file BPy_ChainingIterator.cpp.

References BPy_ViewEdge_from_ViewEdge(), and self.

◆ ChainingIterator_traverse()

static PyObject* ChainingIterator_traverse ( BPy_ChainingIterator self,
PyObject *  args,
PyObject *  kwds 
)
static

Definition at line 142 of file BPy_ChainingIterator.cpp.

References AdjacencyIterator_Type, and self.

◆ check_begin()

static int check_begin ( PyObject *  obj,
void v 
)
static

Definition at line 58 of file BPy_ChainingIterator.cpp.

References BPy_ViewEdge_Check, and v.

Referenced by ChainingIterator___init__().

◆ PyDoc_STRVAR() [1/6]

PyDoc_STRVAR ( ChainingIterator_doc  ,
"Class hierarchy: :class:`Iterator ,
:class:`ViewEdgeIterator`  ,
:class:`ChainingIterator`\n" "\n" "Base class for chaining iterators. This class is designed to be\n" "overloaded in order to describe chaining rules. It makes the\n" "description of chaining rules easier. The two main methods that need\n" "to overloaded are traverse() and init(). traverse() tells which\n" ":class:`ViewEdge` to  follow,
among the adjacent ones. If you specify\n" "restriction   rulessuch as \"Chain only ViewEdges of the selection\",
\n" "they will be included in the adjacency iterator(i.e, the adjacent\n" "iterator will only stop on \"valid\" edges).\n" "\n" ".. method:: __init__(restrict_to_selection=True, restrict_to_unvisited=True," " begin=None, orientation=True)\n" " __init__(brother)\n" "\n" " Builds a Chaining Iterator from the first ViewEdge used for\n" " iteration and its orientation or by using the copy constructor.\n" "\n" " :arg restrict_to_selection: Indicates whether to force the chaining\n" " to stay within the set of selected ViewEdges or not.\n" " :type restrict_to_selection: bool\n" " :arg restrict_to_unvisited: Indicates whether a ViewEdge that has\n" " already been chained must be ignored ot not.\n" " :type restrict_to_unvisited: bool\n" " :arg begin: The ViewEdge from which to start the chain.\n" " :type begin: :class:`ViewEdge` or None\n" " :arg orientation: The direction to follow to explore the graph. If\n" "  true,
the direction indicated by the first ViewEdge is used.\n" " :type orientation:bool\n" " :arg brother:\n" " :type brother:ChainingIterator"   
)

◆ PyDoc_STRVAR() [2/6]

PyDoc_STRVAR ( ChainingIterator_init_doc  ,
".. method:: init()\n" "\n" " Initializes the iterator context. This method is called each\n" " time a new chain is started. It can be used to reset some\n" " history information that you might want to keep."   
)

◆ PyDoc_STRVAR() [3/6]

PyDoc_STRVAR ( ChainingIterator_is_incrementing_doc  ,
"True if the current iteration is an incrementation.\n" "\n" ":type: bool  
)

◆ PyDoc_STRVAR() [4/6]

PyDoc_STRVAR ( ChainingIterator_next_vertex_doc  ,
"The ViewVertex that is the next crossing.\n" "\n" ":type: :class:`ViewVertex`"   
)

◆ PyDoc_STRVAR() [5/6]

PyDoc_STRVAR ( ChainingIterator_object_doc  ,
"The ViewEdge object currently pointed by this iterator.\n" "\n" ":type: :class:`ViewEdge`"   
)

◆ PyDoc_STRVAR() [6/6]

PyDoc_STRVAR ( ChainingIterator_traverse_doc  ,
".. method:: traverse(it)\n" "\n" " This method iterates over the potential next ViewEdges and returns\n" " the one that will be followed next. Returns the next ViewEdge to\n" " follow or None when the end of the chain is reached.\n" "\n" " :arg it: The iterator over the ViewEdges adjacent to the end vertex\n" " of the current ViewEdge. The adjacency iterator reflects the\n" " restriction rules by only iterating over the valid ViewEdges.\n" " :type it: :class:`AdjacencyIterator`\n" " :return: Returns the next ViewEdge to  follow,
or None if chaining ends.\n" " :rtype::class:`ViewEdge` or None"   
)

Variable Documentation

◆ BPy_ChainingIterator_getseters

PyGetSetDef BPy_ChainingIterator_getseters[]
static
Initial value:
= {
{"object",
(setter) nullptr,
ChainingIterator_object_doc,
nullptr},
{"next_vertex",
(setter) nullptr,
ChainingIterator_next_vertex_doc,
nullptr},
{"is_incrementing",
(setter) nullptr,
ChainingIterator_is_incrementing_doc,
nullptr},
{nullptr, nullptr, nullptr, nullptr, nullptr}
}
static PyObject * ChainingIterator_next_vertex_get(BPy_ChainingIterator *self, void *UNUSED(closure))
static PyObject * ChainingIterator_object_get(BPy_ChainingIterator *self, void *UNUSED(closure))
static PyObject * ChainingIterator_is_incrementing_get(BPy_ChainingIterator *self, void *UNUSED(closure))

Definition at line 220 of file BPy_ChainingIterator.cpp.

◆ BPy_ChainingIterator_methods

PyMethodDef BPy_ChainingIterator_methods[]
static
Initial value:
= {
{"init", (PyCFunction)ChainingIterator_init, METH_NOARGS, ChainingIterator_init_doc},
{"traverse",
METH_VARARGS | METH_KEYWORDS,
ChainingIterator_traverse_doc},
{nullptr, nullptr, 0, nullptr},
}
static PyObject * ChainingIterator_init(BPy_ChainingIterator *self)
static PyObject * ChainingIterator_traverse(BPy_ChainingIterator *self, PyObject *args, PyObject *kwds)

Definition at line 163 of file BPy_ChainingIterator.cpp.

◆ ChainingIterator_Type

PyTypeObject ChainingIterator_Type