Blender  V3.3
Functions | Variables
BPy_FrsCurve.cpp File Reference
#include "BPy_FrsCurve.h"
#include "../BPy_Convert.h"
#include "../BPy_Id.h"
#include "../Interface0D/BPy_CurvePoint.h"
#include "../Interface0D/BPy_SVertex.h"

Go to the source code of this file.

Functions

 PyDoc_STRVAR (FrsCurve_doc, "Class hierarchy: :class:`Interface1D` > :class:`Curve`\n" "\n" "Base class for curves made of CurvePoints. :class:`SVertex` is the\n" "type of the initial curve vertices. A :class:`Chain` is a\n" "specialization of a Curve.\n" "\n" ".. method:: __init__()\n" " __init__(brother)\n" " __init__(id)\n" "\n" " Builds a :class:`FrsCurve` using a default constructor,\n" " copy constructor or from an :class:`Id`.\n" "\n" " :arg brother: A Curve object.\n" " :type brother: :class:`Curve`\n" " :arg id: An Id object.\n" " :type id: :class:`Id`")
 
static int FrsCurve_init (BPy_FrsCurve *self, PyObject *args, PyObject *kwds)
 
 PyDoc_STRVAR (FrsCurve_push_vertex_back_doc, ".. method:: push_vertex_back(vertex)\n" "\n" " Adds a single vertex at the end of the Curve.\n" "\n" " :arg vertex: A vertex object.\n" " :type vertex: :class:`SVertex` or :class:`CurvePoint`")
 
static PyObject * FrsCurve_push_vertex_back (BPy_FrsCurve *self, PyObject *args, PyObject *kwds)
 
 PyDoc_STRVAR (FrsCurve_push_vertex_front_doc, ".. method:: push_vertex_front(vertex)\n" "\n" " Adds a single vertex at the front of the Curve.\n" "\n" " :arg vertex: A vertex object.\n" " :type vertex: :class:`SVertex` or :class:`CurvePoint`")
 
static PyObject * FrsCurve_push_vertex_front (BPy_FrsCurve *self, PyObject *args, PyObject *kwds)
 
 PyDoc_STRVAR (FrsCurve_is_empty_doc, "True if the Curve doesn't have any Vertex yet.\n" "\n" ":type: bool")
 
static PyObject * FrsCurve_is_empty_get (BPy_FrsCurve *self, void *UNUSED(closure))
 
 PyDoc_STRVAR (FrsCurve_segments_size_doc, "The number of segments in the polyline constituting the Curve.\n" "\n" ":type: int")
 
static PyObject * FrsCurve_segments_size_get (BPy_FrsCurve *self, void *UNUSED(closure))
 

Variables

static PyMethodDef BPy_FrsCurve_methods []
 
static PyGetSetDef BPy_FrsCurve_getseters []
 
PyTypeObject FrsCurve_Type
 

Function Documentation

◆ FrsCurve_init()

static int FrsCurve_init ( BPy_FrsCurve self,
PyObject *  args,
PyObject *  kwds 
)
static

Definition at line 43 of file BPy_FrsCurve.cpp.

References Freestyle::c, FrsCurve_Type, and Id_Type.

◆ FrsCurve_is_empty_get()

static PyObject* FrsCurve_is_empty_get ( BPy_FrsCurve self,
void UNUSEDclosure 
)
static

Definition at line 149 of file BPy_FrsCurve.cpp.

References PyBool_from_bool(), and self.

◆ FrsCurve_push_vertex_back()

static PyObject* FrsCurve_push_vertex_back ( BPy_FrsCurve self,
PyObject *  args,
PyObject *  kwds 
)
static

Definition at line 78 of file BPy_FrsCurve.cpp.

References BPy_CurvePoint_Check, and BPy_SVertex_Check.

◆ FrsCurve_push_vertex_front()

static PyObject* FrsCurve_push_vertex_front ( BPy_FrsCurve self,
PyObject *  args,
PyObject *  kwds 
)
static

Definition at line 108 of file BPy_FrsCurve.cpp.

References BPy_CurvePoint_Check, and BPy_SVertex_Check.

◆ FrsCurve_segments_size_get()

static PyObject* FrsCurve_segments_size_get ( BPy_FrsCurve self,
void UNUSEDclosure 
)
static

Definition at line 159 of file BPy_FrsCurve.cpp.

References self.

◆ PyDoc_STRVAR() [1/5]

PyDoc_STRVAR ( FrsCurve_doc  ,
"Class hierarchy: :class:`Interface1D ,
:class:`Curve`\n" "\n" "Base class for curves made of CurvePoints. :class:`SVertex` is the\n" "type of the initial curve vertices. A :class:`Chain` is a\n" "specialization of a Curve.\n" "\n" ".. method::__init__()\n" " __init__(brother)\n" " __init__(id)\n" "\n" " Builds a :class:`FrsCurve` using a default  constructor,
\n" " copy constructor or from an :class:`Id`.\n" "\n" " :arg brother:A Curve object.\n" " :type brother::class:`Curve`\n" " :arg id:An Id object.\n" " :type id::class:`Id`"   
)

◆ PyDoc_STRVAR() [2/5]

PyDoc_STRVAR ( FrsCurve_is_empty_doc  ,
"True if the Curve doesn't have any Vertex yet.\n" "\n" ":type: bool  
)

◆ PyDoc_STRVAR() [3/5]

PyDoc_STRVAR ( FrsCurve_push_vertex_back_doc  ,
".. method:: push_vertex_back(vertex)\n" "\n" " Adds a single vertex at the end of the Curve.\n" "\n" " :arg vertex: A vertex object.\n" " :type vertex: :class:`SVertex` or :class:`CurvePoint`"   
)

◆ PyDoc_STRVAR() [4/5]

PyDoc_STRVAR ( FrsCurve_push_vertex_front_doc  ,
".. method:: push_vertex_front(vertex)\n" "\n" " Adds a single vertex at the front of the Curve.\n" "\n" " :arg vertex: A vertex object.\n" " :type vertex: :class:`SVertex` or :class:`CurvePoint`"   
)

◆ PyDoc_STRVAR() [5/5]

PyDoc_STRVAR ( FrsCurve_segments_size_doc  ,
"The number of segments in the polyline constituting the Curve.\n" "\n" ":type: int"   
)

Variable Documentation

◆ BPy_FrsCurve_getseters

PyGetSetDef BPy_FrsCurve_getseters[]
static
Initial value:
= {
{"is_empty", (getter)FrsCurve_is_empty_get, (setter) nullptr, FrsCurve_is_empty_doc, nullptr},
{"segments_size",
(setter) nullptr,
FrsCurve_segments_size_doc,
nullptr},
{nullptr, nullptr, nullptr, nullptr, nullptr}
}
static PyObject * FrsCurve_segments_size_get(BPy_FrsCurve *self, void *UNUSED(closure))
static PyObject * FrsCurve_is_empty_get(BPy_FrsCurve *self, void *UNUSED(closure))

Definition at line 164 of file BPy_FrsCurve.cpp.

◆ BPy_FrsCurve_methods

PyMethodDef BPy_FrsCurve_methods[]
static
Initial value:
= {
{"push_vertex_back",
METH_VARARGS | METH_KEYWORDS,
FrsCurve_push_vertex_back_doc},
{"push_vertex_front",
METH_VARARGS | METH_KEYWORDS,
FrsCurve_push_vertex_front_doc},
{nullptr, nullptr, 0, nullptr},
}
static PyObject * FrsCurve_push_vertex_front(BPy_FrsCurve *self, PyObject *args, PyObject *kwds)
static PyObject * FrsCurve_push_vertex_back(BPy_FrsCurve *self, PyObject *args, PyObject *kwds)

Definition at line 130 of file BPy_FrsCurve.cpp.

◆ FrsCurve_Type

PyTypeObject FrsCurve_Type

Definition at line 176 of file BPy_FrsCurve.cpp.

Referenced by FrsCurve_init(), and Interface1D_Init().