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

Go to the source code of this file.

Functions

 PyDoc_STRVAR (CurvePoint_doc, "Class hierarchy: :class:`Interface0D` > :class:`CurvePoint`\n" "\n" "Class to represent a point of a curve. A CurvePoint can be any point\n" "of a 1D curve (it doesn't have to be a vertex of the curve). Any\n" ":class:`Interface1D` is built upon ViewEdges, themselves built upon\n" "FEdges. Therefore, a curve is basically a polyline made of a list of\n" ":class:`SVertex` objects. Thus, a CurvePoint is built by linearly\n" "interpolating two :class:`SVertex` instances. CurvePoint can be used\n" "as virtual points while querying 0D information along a curve at a\n" "given resolution.\n" "\n" ".. method:: __init__()\n" " __init__(brother)\n" " __init__(first_vertex, second_vertex, t2d)\n" " __init__(first_point, second_point, t2d)\n" "\n" " Builds a CurvePoint using the default constructor, copy constructor,\n" " or one of the overloaded constructors. The over loaded constructors\n" " can either take two :class:`SVertex` or two :class:`CurvePoint`\n" " objects and an interpolation parameter\n" "\n" " :arg brother: A CurvePoint object.\n" " :type brother: :class:`CurvePoint`\n" " :arg first_vertex: The first SVertex.\n" " :type first_vertex: :class:`SVertex`\n" " :arg second_vertex: The second SVertex.\n" " :type second_vertex: :class:`SVertex`\n" " :arg first_point: The first CurvePoint.\n" " :type first_point: :class:`CurvePoint`\n" " :arg second_point: The second CurvePoint.\n" " :type second_point: :class:`CurvePoint`\n" " :arg t2d: A 2D interpolation parameter used to linearly interpolate\n" " first_vertex and second_vertex or first_point and second_point.\n" " :type t2d: float\n")
 
static int CurvePoint_init (BPy_CurvePoint *self, PyObject *args, PyObject *kwds)
 
 PyDoc_STRVAR (CurvePoint_first_svertex_doc, "The first SVertex upon which the CurvePoint is built.\n" "\n" ":type: :class:`SVertex`")
 bool operator== (const CurvePoint &b) More...
 
static PyObject * CurvePoint_first_svertex_get (BPy_CurvePoint *self, void *UNUSED(closure))
 
static int CurvePoint_first_svertex_set (BPy_CurvePoint *self, PyObject *value, void *UNUSED(closure))
 
 PyDoc_STRVAR (CurvePoint_second_svertex_doc, "The second SVertex upon which the CurvePoint is built.\n" "\n" ":type: :class:`SVertex`")
 
static PyObject * CurvePoint_second_svertex_get (BPy_CurvePoint *self, void *UNUSED(closure))
 
static int CurvePoint_second_svertex_set (BPy_CurvePoint *self, PyObject *value, void *UNUSED(closure))
 
 PyDoc_STRVAR (CurvePoint_fedge_doc, "Gets the FEdge for the two SVertices that given CurvePoints consists out of.\n" "A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex).\n" "\n" ":type: :class:`FEdge`")
 
static PyObject * CurvePoint_fedge_get (BPy_CurvePoint *self, void *UNUSED(closure))
 
 PyDoc_STRVAR (CurvePoint_t2d_doc, "The 2D interpolation parameter.\n" "\n" ":type: float")
 
static PyObject * CurvePoint_t2d_get (BPy_CurvePoint *self, void *UNUSED(closure))
 
static int CurvePoint_t2d_set (BPy_CurvePoint *self, PyObject *value, void *UNUSED(closure))
 

Variables

static PyGetSetDef BPy_CurvePoint_getseters []
 
PyTypeObject CurvePoint_Type
 

Function Documentation

◆ CurvePoint_fedge_get()

static PyObject* CurvePoint_fedge_get ( BPy_CurvePoint self,
void UNUSEDclosure 
)
static

Definition at line 179 of file BPy_CurvePoint.cpp.

References A, Any_BPy_Interface1D_from_Interface1D(), B, and self.

◆ CurvePoint_first_svertex_get()

static PyObject* CurvePoint_first_svertex_get ( BPy_CurvePoint self,
void UNUSEDclosure 
)
static

Definition at line 126 of file BPy_CurvePoint.cpp.

References A, and BPy_SVertex_from_SVertex().

◆ CurvePoint_first_svertex_set()

static int CurvePoint_first_svertex_set ( BPy_CurvePoint self,
PyObject *  value,
void UNUSEDclosure 
)
static

Definition at line 135 of file BPy_CurvePoint.cpp.

References BPy_SVertex_Check.

◆ CurvePoint_init()

static int CurvePoint_init ( BPy_CurvePoint self,
PyObject *  args,
PyObject *  kwds 
)
static

◆ CurvePoint_second_svertex_get()

static PyObject* CurvePoint_second_svertex_get ( BPy_CurvePoint self,
void UNUSEDclosure 
)
static

Definition at line 152 of file BPy_CurvePoint.cpp.

References B, and BPy_SVertex_from_SVertex().

◆ CurvePoint_second_svertex_set()

static int CurvePoint_second_svertex_set ( BPy_CurvePoint self,
PyObject *  value,
void UNUSEDclosure 
)
static

Definition at line 161 of file BPy_CurvePoint.cpp.

References BPy_SVertex_Check.

◆ CurvePoint_t2d_get()

static PyObject* CurvePoint_t2d_get ( BPy_CurvePoint self,
void UNUSEDclosure 
)
static

Definition at line 195 of file BPy_CurvePoint.cpp.

References self.

◆ CurvePoint_t2d_set()

static int CurvePoint_t2d_set ( BPy_CurvePoint self,
PyObject *  value,
void UNUSEDclosure 
)
static

Definition at line 200 of file BPy_CurvePoint.cpp.

◆ PyDoc_STRVAR() [1/5]

PyDoc_STRVAR ( CurvePoint_doc  ,
"Class hierarchy: :class:`Interface0D ,
:class:`CurvePoint`\n" "\n" "Class to represent a point of a curve. A CurvePoint can be any point\n" "of a 1D curve(it doesn 't have to be a vertex of the curve). Any\n" ":class:`Interface1D` is built upon  ViewEdges,
themselves built upon\n" "FEdges.  Therefore,
a curve is basically a polyline made of a list of\n" ":class:`SVertex` objects.  Thus,
a CurvePoint is built by linearly\n" "interpolating two :class:`SVertex` instances. CurvePoint can be used\n" "as virtual points while querying 0D information along a curve at a\n" "given resolution.\n" "\n" ".. method::__init__()\n" " __init__(brother)\n" " __init__(first_vertex, second_vertex, t2d)\n" " __init__(first_point, second_point, t2d)\n" "\n" " Builds a CurvePoint using the default  constructor,
copy  constructor,
\n" " or one of the overloaded constructors. The over loaded constructors\n" " can either take two :class:`SVertex` or two :class:`CurvePoint`\n" " objects and an interpolation parameter\n" "\n" " :arg brother:A CurvePoint object.\n" " :type brother::class:`CurvePoint`\n" " :arg first_vertex:The first SVertex.\n" " :type first_vertex::class:`SVertex`\n" " :arg second_vertex:The second SVertex.\n" " :type second_vertex::class:`SVertex`\n" " :arg first_point:The first CurvePoint.\n" " :type first_point::class:`CurvePoint`\n" " :arg second_point:The second CurvePoint.\n" " :type second_point::class:`CurvePoint`\n" " :arg t2d:A 2D interpolation parameter used to linearly interpolate\n" " first_vertex and second_vertex or first_point and second_point.\n" " :type t2d:float\n"   
)

◆ PyDoc_STRVAR() [2/5]

PyDoc_STRVAR ( CurvePoint_fedge_doc  ,
"Gets the FEdge for the two SVertices that given CurvePoints consists out of.\n" "A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex).\n" "\n" ":type: :class:`FEdge`"   
)

◆ PyDoc_STRVAR() [3/5]

PyDoc_STRVAR ( CurvePoint_first_svertex_doc  ,
"The first SVertex upon which the CurvePoint is built.\n" "\n" ":type: :class:`SVertex`"   
)

bool operator== (const CurvePoint &b)

◆ PyDoc_STRVAR() [4/5]

PyDoc_STRVAR ( CurvePoint_second_svertex_doc  ,
"The second SVertex upon which the CurvePoint is built.\n" "\n" ":type: :class:`SVertex`"   
)

◆ PyDoc_STRVAR() [5/5]

PyDoc_STRVAR ( CurvePoint_t2d_doc  ,
"The 2D interpolation parameter.\n" "\n" ":type: float  
)

Variable Documentation

◆ BPy_CurvePoint_getseters

PyGetSetDef BPy_CurvePoint_getseters[]
static
Initial value:
= {
{"first_svertex",
CurvePoint_first_svertex_doc,
nullptr},
{"second_svertex",
CurvePoint_second_svertex_doc,
nullptr},
{"fedge", (getter)CurvePoint_fedge_get, nullptr, CurvePoint_fedge_doc, nullptr},
{"t2d", (getter)CurvePoint_t2d_get, (setter)CurvePoint_t2d_set, CurvePoint_t2d_doc, nullptr},
{nullptr, nullptr, nullptr, nullptr, nullptr}
}
static PyObject * CurvePoint_second_svertex_get(BPy_CurvePoint *self, void *UNUSED(closure))
static int CurvePoint_first_svertex_set(BPy_CurvePoint *self, PyObject *value, void *UNUSED(closure))
static int CurvePoint_t2d_set(BPy_CurvePoint *self, PyObject *value, void *UNUSED(closure))
static PyObject * CurvePoint_first_svertex_get(BPy_CurvePoint *self, void *UNUSED(closure))
static int CurvePoint_second_svertex_set(BPy_CurvePoint *self, PyObject *value, void *UNUSED(closure))
static PyObject * CurvePoint_fedge_get(BPy_CurvePoint *self, void *UNUSED(closure))
static PyObject * CurvePoint_t2d_get(BPy_CurvePoint *self, void *UNUSED(closure))

Definition at line 211 of file BPy_CurvePoint.cpp.

◆ CurvePoint_Type

PyTypeObject CurvePoint_Type