BPy_ViewEdgeIterator.cpp File Reference

#include "BPy_ViewEdgeIterator.h"
#include "../BPy_Convert.h"
#include "../Interface1D/BPy_ViewEdge.h"

Go to the source code of this file.

Functions
	PyDoc_STRVAR (ViewEdgeIterator_doc, "Class hierarchy: :class:`Iterator` > :class:`ViewEdgeIterator`\n" "\n" "Base class for iterators over ViewEdges of the :class:`ViewMap` Graph.\n" "Basically the increment() operator of this class should be able to\n" "take the decision of \"where\" (on which ViewEdge) to go when pointing\n" "on a given ViewEdge.\n" "\n" ".. method:: __init__(begin=None, orientation=True)\n" " __init__(brother)\n" "\n" " Builds a ViewEdgeIterator from a starting ViewEdge and its\n" " orientation or the copy constructor.\n" "\n" " :arg begin: The ViewEdge from where to start the iteration.\n" " :type begin: :class:`ViewEdge` | None\n" " :arg orientation: If true, we'll look for the next ViewEdge among\n" " the ViewEdges that surround the ending ViewVertex of begin. If\n" " false, we'll search over the ViewEdges surrounding the ending\n" " ViewVertex of begin.\n" " :type orientation: bool\n" " :arg brother: A ViewEdgeIterator object.\n" " :type brother: :class:`ViewEdgeIterator`\n")
static int	check_begin (PyObject *obj, void *v)
static int	ViewEdgeIterator_init (BPy_ViewEdgeIterator *self, PyObject *args, PyObject *kwds)
	PyDoc_STRVAR (ViewEdgeIterator_change_orientation_doc, ".. method:: change_orientation()\n" "\n" " Changes the current orientation.\n")
static PyObject *	ViewEdgeIterator_change_orientation (BPy_ViewEdgeIterator *self)
	PyDoc_STRVAR (ViewEdgeIterator_object_doc, "The ViewEdge object currently pointed by this iterator.\n" "\n" ":type: :class:`ViewEdge`\n")
static PyObject *	ViewEdgeIterator_object_get (BPy_ViewEdgeIterator *self, void *)
	PyDoc_STRVAR (ViewEdgeIterator_current_edge_doc, "The ViewEdge object currently pointed by this iterator.\n" "\n" ":type: :class:`ViewEdge`\n")
static PyObject *	ViewEdgeIterator_current_edge_get (BPy_ViewEdgeIterator *self, void *)
static int	ViewEdgeIterator_current_edge_set (BPy_ViewEdgeIterator *self, PyObject *value, void *)
	PyDoc_STRVAR (ViewEdgeIterator_orientation_doc, "The orientation of the pointed ViewEdge in the iteration.\n" "If true, the iterator looks for the next ViewEdge among those ViewEdges\n" "that surround the ending ViewVertex of the \"begin\" ViewEdge. If false,\n" "the iterator searches over the ViewEdges surrounding the ending ViewVertex\n" "of the \"begin\" ViewEdge.\n" "\n" ":type: bool\n")
static PyObject *	ViewEdgeIterator_orientation_get (BPy_ViewEdgeIterator *self, void *)
static int	ViewEdgeIterator_orientation_set (BPy_ViewEdgeIterator *self, PyObject *value, void *)
	PyDoc_STRVAR (ViewEdgeIterator_begin_doc, "The first ViewEdge used for the iteration.\n" "\n" ":type: :class:`ViewEdge`\n")
static PyObject *	ViewEdgeIterator_begin_get (BPy_ViewEdgeIterator *self, void *)
static int	ViewEdgeIterator_begin_set (BPy_ViewEdgeIterator *self, PyObject *value, void *)

Variables
static PyMethodDef	BPy_ViewEdgeIterator_methods []
static PyGetSetDef	BPy_ViewEdgeIterator_getseters []
PyTypeObject	ViewEdgeIterator_Type

Function Documentation

check_begin()

int check_begin ( PyObject * obj, void * v )

static

Definition at line 45 of file BPy_ViewEdgeIterator.cpp.

References BPy_ViewEdge_Check, and v.

PyDoc_STRVAR() [1/6]

PyDoc_STRVAR	(	ViewEdgeIterator_begin_doc	,
		"The first ViewEdge used for the iteration.\n" "\n" ":type: :class:`ViewEdge`\n"	)

PyDoc_STRVAR() [2/6]

PyDoc_STRVAR	(	ViewEdgeIterator_change_orientation_doc	,
		".. method:: change_orientation()\n" "\n" " Changes the current orientation.\n"	)

PyDoc_STRVAR() [3/6]

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

PyDoc_STRVAR() [4/6]

PyDoc_STRVAR	(	ViewEdgeIterator_doc	,
		"Class hierarchy: :class:`Iterator`	,
		:class:`ViewEdgeIterator`\n" "\n" "Base class for iterators over ViewEdges of the :class:`ViewMap` Graph.\n" "Basically the increment() operator of this class should be able to\n" "take the decision of \"where\" (on which ViewEdge) to go when pointing\n" "on a given ViewEdge.\n" "\n" ".. method:: __init__(begin=None, orientation=True)\n" " __init__(brother)\n" "\n" " Builds a ViewEdgeIterator from a starting ViewEdge and its\n" " orientation or the copy constructor.\n" "\n" " :arg begin: The ViewEdge from where to start the iteration.\n" " :type begin: :class:`ViewEdge` | None\n" " :arg orientation: If	true,
		we 'll look for the next ViewEdge among\n" " the ViewEdges that surround the ending ViewVertex of begin. If\n" "	false,
		we 'll search over the ViewEdges surrounding the ending\n" " ViewVertex of begin.\n" " :type orientation:bool\n" " :arg brother:A ViewEdgeIterator object.\n" " :type brother::class:`ViewEdgeIterator`\n"	)

PyDoc_STRVAR() [5/6]

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

PyDoc_STRVAR() [6/6]

PyDoc_STRVAR	(	ViewEdgeIterator_orientation_doc	,
		"The orientation of the pointed ViewEdge in the iteration.\n" "If	true,
		the iterator looks for the next ViewEdge among those ViewEdges\n" "that surround the ending ViewVertex of the \"begin\" ViewEdge. If	false,
		\n" "the iterator searches over the ViewEdges surrounding the ending ViewVertex\n" "of the \"begin\" ViewEdge.\n" "\n" ":type: bool\n"	)

ViewEdgeIterator_begin_get()

PyObject * ViewEdgeIterator_begin_get ( BPy_ViewEdgeIterator * self, void *  )

static

Definition at line 201 of file BPy_ViewEdgeIterator.cpp.

References BPy_ViewEdge_from_ViewEdge(), and self.

ViewEdgeIterator_begin_set()

int ViewEdgeIterator_begin_set ( BPy_ViewEdgeIterator * self, PyObject * value, void *  )

static

Definition at line 210 of file BPy_ViewEdgeIterator.cpp.

References BPy_ViewEdge_Check, and self.

ViewEdgeIterator_change_orientation()

PyObject * ViewEdgeIterator_change_orientation ( BPy_ViewEdgeIterator * self )

static

Definition at line 88 of file BPy_ViewEdgeIterator.cpp.

References self.

ViewEdgeIterator_current_edge_get()

PyObject * ViewEdgeIterator_current_edge_get ( BPy_ViewEdgeIterator * self, void *  )

static

Definition at line 147 of file BPy_ViewEdgeIterator.cpp.

References BPy_ViewEdge_from_ViewEdge(), and self.

ViewEdgeIterator_current_edge_set()

int ViewEdgeIterator_current_edge_set ( BPy_ViewEdgeIterator * self, PyObject * value, void *  )

static

Definition at line 156 of file BPy_ViewEdgeIterator.cpp.

References BPy_ViewEdge_Check, and self.

ViewEdgeIterator_init()

int ViewEdgeIterator_init ( BPy_ViewEdgeIterator * self, PyObject * args, PyObject * kwds )

static

Definition at line 54 of file BPy_ViewEdgeIterator.cpp.

References begin(), bool_from_PyBool(), check_begin(), self, and ViewEdgeIterator_Type.

ViewEdgeIterator_object_get()

PyObject * ViewEdgeIterator_object_get ( BPy_ViewEdgeIterator * self, void *  )

static

Definition at line 128 of file BPy_ViewEdgeIterator.cpp.

References BPy_ViewEdge_from_ViewEdge(), and self.

ViewEdgeIterator_orientation_get()

PyObject * ViewEdgeIterator_orientation_get ( BPy_ViewEdgeIterator * self, void *  )

static

Definition at line 178 of file BPy_ViewEdgeIterator.cpp.

References PyBool_from_bool(), and self.

ViewEdgeIterator_orientation_set()

int ViewEdgeIterator_orientation_set ( BPy_ViewEdgeIterator * self, PyObject * value, void *  )

static

Definition at line 183 of file BPy_ViewEdgeIterator.cpp.

References bool_from_PyBool(), and self.

Variable Documentation

BPy_ViewEdgeIterator_getseters

PyGetSetDef BPy_ViewEdgeIterator_getseters[]

static

Initial value:

                                                  = {
    {"object",
     (getter)ViewEdgeIterator_object_get,
     (setter) nullptr,
     ViewEdgeIterator_object_doc,
     nullptr},
    {"current_edge",
     (getter)ViewEdgeIterator_current_edge_get,
     (setter)ViewEdgeIterator_current_edge_set,
     ViewEdgeIterator_current_edge_doc,
     nullptr},
    {"orientation",
     (getter)ViewEdgeIterator_orientation_get,
     (setter)ViewEdgeIterator_orientation_set,
     ViewEdgeIterator_orientation_doc,
     nullptr},
    {"begin",
     (getter)ViewEdgeIterator_begin_get,
     (setter)ViewEdgeIterator_begin_set,
     ViewEdgeIterator_begin_doc,
     nullptr},
    {nullptr, nullptr, nullptr, nullptr, nullptr} 
}

Definition at line 222 of file BPy_ViewEdgeIterator.cpp.

BPy_ViewEdgeIterator_methods

PyMethodDef BPy_ViewEdgeIterator_methods[]

static

Initial value:

                                                = {
    {"change_orientation",
     (PyCFunction)ViewEdgeIterator_change_orientation,
     METH_NOARGS,
     ViewEdgeIterator_change_orientation_doc},
    {nullptr, nullptr, 0, nullptr},
}

Definition at line 104 of file BPy_ViewEdgeIterator.cpp.

ViewEdgeIterator_Type

PyTypeObject ViewEdgeIterator_Type

Definition at line 248 of file BPy_ViewEdgeIterator.cpp.

Referenced by BPy_ViewEdgeIterator_from_ViewEdgeIterator(), Iterator_Init(), and ViewEdgeIterator_init().