BPy_StrokeVertexIterator.cpp File Reference

#include "BPy_StrokeVertexIterator.h"
#include "../BPy_Convert.h"
#include "../Interface1D/BPy_Stroke.h"
#include "BPy_Interface0DIterator.h"

Go to the source code of this file.

Functions
	PyDoc_STRVAR (StrokeVertexIterator_doc, "Class hierarchy: :class:`Iterator` > :class:`StrokeVertexIterator`\n" "\n" "Class defining an iterator designed to iterate over the\n" ":class:`StrokeVertex` of a :class:`Stroke`. An instance of a\n" "StrokeVertexIterator can be obtained from a Stroke by calling\n" "iter(), stroke_vertices_begin() or stroke_vertices_begin(). It is iterating\n" "over the same vertices as an :class:`Interface0DIterator`. The difference\n" "resides in the object access: an Interface0DIterator only allows\n" "access to an Interface0D while one might need to access the\n" "specialized StrokeVertex type. In this case, one should use a\n" "StrokeVertexIterator. To call functions of the UnaryFuntion0D type,\n" "a StrokeVertexIterator can be converted to an Interface0DIterator by\n" "by calling Interface0DIterator(it).\n" "\n" ".. method:: __init__()\n" " __init__(brother)\n" "\n" " Creates a :class:`StrokeVertexIterator` using either the\n" " default constructor or the copy constructor.\n" "\n" " :arg brother: A StrokeVertexIterator object.\n" " :type brother: :class:`StrokeVertexIterator`")
static int	StrokeVertexIterator_init (BPy_StrokeVertexIterator *self, PyObject *args, PyObject *kwds)
static PyObject *	StrokeVertexIterator_iter (BPy_StrokeVertexIterator *self)
static PyObject *	StrokeVertexIterator_iternext (BPy_StrokeVertexIterator *self)
	PyDoc_STRVAR (StrokeVertexIterator_incremented_doc, ".. method:: incremented()\n" "\n" " Returns a copy of an incremented StrokeVertexIterator.\n" "\n" " :return: A StrokeVertexIterator pointing the next StrokeVertex.\n" " :rtype: :class:`StrokeVertexIterator`")
static PyObject *	StrokeVertexIterator_incremented (BPy_StrokeVertexIterator *self)
	PyDoc_STRVAR (StrokeVertexIterator_decremented_doc, ".. method:: decremented()\n" "\n" " Returns a copy of a decremented StrokeVertexIterator.\n" "\n" " :return: A StrokeVertexIterator pointing the previous StrokeVertex.\n" " :rtype: :class:`StrokeVertexIterator`")
static PyObject *	StrokeVertexIterator_decremented (BPy_StrokeVertexIterator *self)
	PyDoc_STRVAR (StrokeVertexIterator_reversed_doc, ".. method:: reversed()\n" "\n" " Returns a StrokeVertexIterator that traverses stroke vertices in the\n" " reversed order.\n" "\n" " :return: A StrokeVertexIterator traversing stroke vertices backward.\n" " :rtype: :class:`StrokeVertexIterator`")
static PyObject *	StrokeVertexIterator_reversed (BPy_StrokeVertexIterator *self)
	PyDoc_STRVAR (StrokeVertexIterator_object_doc, "The StrokeVertex object currently pointed to by this iterator.\n" "\n" ":type: :class:`StrokeVertex`")
static PyObject *	StrokeVertexIterator_object_get (BPy_StrokeVertexIterator *self, void *)
	PyDoc_STRVAR (StrokeVertexIterator_t_doc, "The curvilinear abscissa of the current point.\n" "\n" ":type: float")
static PyObject *	StrokeVertexIterator_t_get (BPy_StrokeVertexIterator *self, void *)
	PyDoc_STRVAR (StrokeVertexIterator_u_doc, "The point parameter at the current point in the stroke (0 <= u <= 1).\n" "\n" ":type: float")
static PyObject *	StrokeVertexIterator_u_get (BPy_StrokeVertexIterator *self, void *)
	PyDoc_STRVAR (StrokeVertexIterator_at_last_doc, "True if the iterator points to the last valid element.\n" "For its counterpart (pointing to the first valid element), use it.is_begin.\n" "\n" ":type: bool")
static PyObject *	StrokeVertexIterator_at_last_get (BPy_StrokeVertexIterator *self)

Variables
static PyMethodDef	BPy_StrokeVertexIterator_methods []
static PyGetSetDef	BPy_StrokeVertexIterator_getseters []
PyTypeObject	StrokeVertexIterator_Type

Function Documentation

PyDoc_STRVAR() [1/8]

PyDoc_STRVAR	(	StrokeVertexIterator_at_last_doc	,
		"True if the iterator points to the last valid element.\n" "For its counterpart	pointing to the first valid element,
		use it.is_begin.\n" "\n" ":type:bool"	)

PyDoc_STRVAR() [2/8]

PyDoc_STRVAR	(	StrokeVertexIterator_decremented_doc	,
		".. method:: decremented()\n" "\n" " Returns a copy of a decremented StrokeVertexIterator.\n" "\n" " :return: A StrokeVertexIterator pointing the previous StrokeVertex.\n" " :rtype: :class:`StrokeVertexIterator`"	)

PyDoc_STRVAR() [3/8]

PyDoc_STRVAR	(	StrokeVertexIterator_doc	,
		"Class hierarchy: :class:`Iterator`	,
		:class:`StrokeVertexIterator`\n" "\n" "Class defining an iterator designed to iterate over the\n" ":class:`StrokeVertex` of a :class:`Stroke`. An instance of a\n" "StrokeVertexIterator can be obtained from a Stroke by calling\n" "	iter(),
		stroke_vertices_begin() or stroke_vertices_begin(). It is iterating\n" "over the same vertices as an :class:`Interface0DIterator`. The difference\n" "resides in the object access:an Interface0DIterator only allows\n" "access to an Interface0D while one might need to access the\n" "specialized StrokeVertex type. In this	case,
		one should use a\n" "StrokeVertexIterator. To call functions of the UnaryFuntion0D	type,
		\n" "a StrokeVertexIterator can be converted to an Interface0DIterator by\n" "by calling Interface0DIterator(it).\n" "\n" ".. method::__init__()\n" " __init__(brother)\n" "\n" " Creates a :class:`StrokeVertexIterator` using either the\n" " default constructor or the copy constructor.\n" "\n" " :arg brother:A StrokeVertexIterator object.\n" " :type brother::class:`StrokeVertexIterator`"	)

PyDoc_STRVAR() [4/8]

PyDoc_STRVAR	(	StrokeVertexIterator_incremented_doc	,
		".. method:: incremented()\n" "\n" " Returns a copy of an incremented StrokeVertexIterator.\n" "\n" " :return: A StrokeVertexIterator pointing the next StrokeVertex.\n" " :rtype: :class:`StrokeVertexIterator`"	)

PyDoc_STRVAR() [5/8]

PyDoc_STRVAR	(	StrokeVertexIterator_object_doc	,
		"The StrokeVertex object currently pointed to by this iterator.\n" "\n" ":type: :class:`StrokeVertex`"	)

PyDoc_STRVAR() [6/8]

PyDoc_STRVAR	(	StrokeVertexIterator_reversed_doc	,
		".. method:: reversed()\n" "\n" " Returns a StrokeVertexIterator that traverses stroke vertices in the\n" " reversed order.\n" "\n" " :return: A StrokeVertexIterator traversing stroke vertices backward.\n" " :rtype: :class:`StrokeVertexIterator`"	)

PyDoc_STRVAR() [7/8]

PyDoc_STRVAR	(	StrokeVertexIterator_t_doc	,
		"The curvilinear abscissa of the current point.\n" "\n" ":type: float"	)

PyDoc_STRVAR() [8/8]

PyDoc_STRVAR	(	StrokeVertexIterator_u_doc	,
		"The point parameter at the current point in the stroke (0 <= u <= 1).\n" "\n" ":type: float"	)

StrokeVertexIterator_at_last_get()

static PyObject * StrokeVertexIterator_at_last_get ( BPy_StrokeVertexIterator * self )

static

Definition at line 268 of file BPy_StrokeVertexIterator.cpp.

References PyBool_from_bool(), and self.

StrokeVertexIterator_decremented()

static PyObject * StrokeVertexIterator_decremented ( BPy_StrokeVertexIterator * self )

static

Definition at line 170 of file BPy_StrokeVertexIterator.cpp.

References BPy_StrokeVertexIterator_from_StrokeVertexIterator(), copy(), and self.

StrokeVertexIterator_incremented()

static PyObject * StrokeVertexIterator_incremented ( BPy_StrokeVertexIterator * self )

static

Definition at line 149 of file BPy_StrokeVertexIterator.cpp.

References BPy_StrokeVertexIterator_from_StrokeVertexIterator(), copy(), and self.

StrokeVertexIterator_init()

static int StrokeVertexIterator_init ( BPy_StrokeVertexIterator * self, PyObject * args, PyObject * kwds )

static

Definition at line 51 of file BPy_StrokeVertexIterator.cpp.

References self, Stroke_Type, and StrokeVertexIterator_Type.

StrokeVertexIterator_iter()

static PyObject * StrokeVertexIterator_iter ( BPy_StrokeVertexIterator * self )

static

Definition at line 90 of file BPy_StrokeVertexIterator.cpp.

References self.

StrokeVertexIterator_iternext()

static PyObject * StrokeVertexIterator_iternext ( BPy_StrokeVertexIterator * self )

static

Definition at line 97 of file BPy_StrokeVertexIterator.cpp.

References BPy_StrokeVertex_from_StrokeVertex(), and self.

StrokeVertexIterator_object_get()

static PyObject * StrokeVertexIterator_object_get ( BPy_StrokeVertexIterator * self, void *  )

static

Definition at line 222 of file BPy_StrokeVertexIterator.cpp.

References BPy_StrokeVertex_from_StrokeVertex(), and self.

StrokeVertexIterator_reversed()

static PyObject * StrokeVertexIterator_reversed ( BPy_StrokeVertexIterator * self )

static

Definition at line 192 of file BPy_StrokeVertexIterator.cpp.

References BPy_StrokeVertexIterator_from_StrokeVertexIterator(), and self.

StrokeVertexIterator_t_get()

static PyObject * StrokeVertexIterator_t_get ( BPy_StrokeVertexIterator * self, void *  )

static

Definition at line 243 of file BPy_StrokeVertexIterator.cpp.

References self.

StrokeVertexIterator_u_get()

static PyObject * StrokeVertexIterator_u_get ( BPy_StrokeVertexIterator * self, void *  )

static

Definition at line 255 of file BPy_StrokeVertexIterator.cpp.

References self.

Variable Documentation

BPy_StrokeVertexIterator_getseters

PyGetSetDef BPy_StrokeVertexIterator_getseters[]

static

Initial value:

= {
    {"object",
     (getter)StrokeVertexIterator_object_get,
     (setter) nullptr,
     StrokeVertexIterator_object_doc,
     nullptr},
    {"t",
     (getter)StrokeVertexIterator_t_get,
     (setter) nullptr,
     StrokeVertexIterator_t_doc,
     nullptr},
    {"u",
     (getter)StrokeVertexIterator_u_get,
     (setter) nullptr,
     StrokeVertexIterator_u_doc,
     nullptr},
    {"at_last",
     (getter)StrokeVertexIterator_at_last_get,
     (setter) nullptr,
     StrokeVertexIterator_at_last_doc,
     nullptr},
    {nullptr, nullptr, nullptr, nullptr, nullptr} 
}

Definition at line 273 of file BPy_StrokeVertexIterator.cpp.

BPy_StrokeVertexIterator_methods

PyMethodDef BPy_StrokeVertexIterator_methods[]

static

Initial value:

= {
    {"incremented",
     (PyCFunction)StrokeVertexIterator_incremented,
     METH_NOARGS,
     StrokeVertexIterator_incremented_doc},
    {"decremented",
     (PyCFunction)StrokeVertexIterator_decremented,
     METH_NOARGS,
     StrokeVertexIterator_decremented_doc},
    {"reversed",
     (PyCFunction)StrokeVertexIterator_reversed,
     METH_NOARGS,
     StrokeVertexIterator_reversed_doc},
    {nullptr, nullptr, 0, nullptr},
}

Definition at line 197 of file BPy_StrokeVertexIterator.cpp.

StrokeVertexIterator_Type

PyTypeObject StrokeVertexIterator_Type

Definition at line 299 of file BPy_StrokeVertexIterator.cpp.

Referenced by BPy_StrokeVertexIterator_from_StrokeVertexIterator(), Iterator_Init(), Stroke_insert_vertex(), and StrokeVertexIterator_init().