|
Blender V5.3
|
#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__(*args)\n" "\n" " Accepted call signatures:\n" "\n" " - ``__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" " :param 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" " :param 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" " :param begin: The ViewEdge from which to start the chain.\n" " :type begin: :class:`ViewEdge` | None\n" " :param 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" " :param brother: \n" " :type brother: ChainingIterator\n") | |
| 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.\n") | |
| 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" " :param 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` | None\n") | |
| 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`\n") | |
| static PyObject * | ChainingIterator_object_get (BPy_ChainingIterator *self, void *) |
| PyDoc_STRVAR (ChainingIterator_next_vertex_doc, "The ViewVertex that is the next crossing.\n" "\n" ":type: :class:`ViewVertex`\n") | |
| static PyObject * | ChainingIterator_next_vertex_get (BPy_ChainingIterator *self, void *) |
| PyDoc_STRVAR (ChainingIterator_is_incrementing_doc, "True if the current iteration is an incrementation.\n" "\n" ":type: bool\n") | |
| static PyObject * | ChainingIterator_is_incrementing_get (BPy_ChainingIterator *self, void *) |
Variables | |
| static PyMethodDef | BPy_ChainingIterator_methods [] |
| static PyGetSetDef | BPy_ChainingIterator_getseters [] |
| PyTypeObject | ChainingIterator_Type |
|
static |
Definition at line 69 of file BPy_ChainingIterator.cpp.
References bool_from_PyBool(), BPy_ChainingIterator::c_it, Freestyle::ChainingIterator::ChainingIterator(), ChainingIterator___init__(), ChainingIterator_Type, check_begin(), BPy_Iterator::it, Freestyle::ChainingIterator::py_c_it, BPy_ViewEdgeIterator::py_it, BPy_ChainingIterator::py_ve_it, and BPy_ViewEdgeIterator::ve_it.
Referenced by ChainingIterator___init__().
|
static |
Definition at line 133 of file BPy_ChainingIterator.cpp.
References BPy_ChainingIterator::c_it, ChainingIterator_init(), and Freestyle::ChainingIterator::init().
Referenced by ChainingIterator_init().
|
static |
Definition at line 256 of file BPy_ChainingIterator.cpp.
References BPy_ChainingIterator::c_it, ChainingIterator_is_incrementing_get(), Freestyle::ChainingIterator::isIncrementing(), and PyBool_from_bool().
Referenced by ChainingIterator_is_incrementing_get().
|
static |
Definition at line 240 of file BPy_ChainingIterator.cpp.
References Any_BPy_ViewVertex_from_ViewVertex(), BPy_ChainingIterator::c_it, ChainingIterator_next_vertex_get(), and Freestyle::ChainingIterator::getVertex().
Referenced by ChainingIterator_next_vertex_get().
|
static |
Definition at line 220 of file BPy_ChainingIterator.cpp.
References BPy_ViewEdge_from_ViewEdge(), BPy_ChainingIterator::c_it, ChainingIterator_object_get(), and Freestyle::ViewEdgeInternal::ViewEdgeIterator::isEnd().
Referenced by ChainingIterator_object_get().
|
static |
Definition at line 158 of file BPy_ChainingIterator.cpp.
References AdjacencyIterator_Type, BPy_ChainingIterator::c_it, ChainingIterator_traverse(), and Freestyle::ChainingIterator::traverse().
Referenced by ChainingIterator_traverse().
|
static |
Definition at line 60 of file BPy_ChainingIterator.cpp.
References BPy_ViewEdge_Check, and check_begin().
Referenced by ChainingIterator___init__(), and check_begin().
| 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__*args\n" "\n" " Accepted call signatures:\n" "\n" " - ``__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" " :param 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" " :param 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" " :param begin: The ViewEdge from which to start the chain.\n" " :type begin: :class:`ViewEdge` | None\n" " :param 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" " :param brother:\n" " :type brother:ChainingIterator\n" | ) |
References PyDoc_STRVAR().
| 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.\n" | ) |
References PyDoc_STRVAR().
| PyDoc_STRVAR | ( | ChainingIterator_is_incrementing_doc | , |
| "True if the current iteration is an incrementation.\n" "\n" ":type: bool\n" | ) |
References PyDoc_STRVAR().
| PyDoc_STRVAR | ( | ChainingIterator_next_vertex_doc | , |
| "The ViewVertex that is the next crossing.\n" "\n" ":type: :class:`ViewVertex`\n" | ) |
References PyDoc_STRVAR().
| PyDoc_STRVAR | ( | ChainingIterator_object_doc | , |
| "The ViewEdge object currently pointed by this iterator.\n" "\n" ":type: :class:`ViewEdge`\n" | ) |
References PyDoc_STRVAR().
| 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" " :param 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`|None\n" | ) |
References PyDoc_STRVAR().
|
static |
Definition at line 262 of file BPy_ChainingIterator.cpp.
|
static |
Definition at line 195 of file BPy_ChainingIterator.cpp.
| PyTypeObject ChainingIterator_Type |
Definition at line 283 of file BPy_ChainingIterator.cpp.
Referenced by BPy_ChainingIterator_from_ChainingIterator(), ChainingIterator___init__(), ChainPredicateIterator_dealloc(), Iterator_Init(), Operators_bidirectional_chain(), and Operators_chain().