The python export class for MeshPoint. More...

#include <MeshPointPy.h>

Public Types

typedef MeshPointPointerType
 
- Public Types inherited from Base::PyObjectBase
typedef void * PointerType
 
enum  Status { Valid = 0 , Immutable = 1 , Notify = 2 , NoTrack = 3 }
 

Public Member Functions

virtual PyTypeObject * GetType (void)
 
 MeshPointPy (MeshPoint *pcObject, PyTypeObject *T=&Type)
 
virtual int PyInit (PyObject *args, PyObject *k)
 PyInit method Override this method to initialize a newly created instance of the class (Constructor) More...
 
std::string representation (void) const
 
- Public Member Functions inherited from Base::PyObjectBase
PyObjectBaseDecRef (void)
 decref method wrapper (see python extending manual) More...
 
PyObjectBaseIncRef (void)
 incref method wrapper (see python extending manual) More...
 
bool isConst ()
 
bool isNotTracking () const
 
bool isValid ()
 
 PyObjectBase (void *, PyTypeObject *T)
 Constructor Sets the Type of the object (for inheritance) and decrease the the reference count of the PyObject. More...
 
void setConst ()
 
void setInvalid ()
 
void setNotTracking (bool on=true)
 
void setShouldNotify (bool on)
 
bool shouldNotify () const
 
void startNotify ()
 

Static Public Member Functions

static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
- Static Public Member Functions inherited from Base::PyObjectBase
static void PyDestructor (PyObject *P)
 Wrapper for the Python destructor. More...
 

Static Public Attributes

static PyGetSetDef GetterSetter []
 Attribute structure of MeshPointPy. More...
 
static PyMethodDef Methods []
 Methods structure of MeshPointPy. More...
 
static PyTypeObject Type
 Type structure of MeshPointPy. More...
 
- Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
 
static PyTypeObject Type
 Py_Header struct from python.h. More...
 

Protected Member Functions

 ~MeshPointPy ()
 
- Protected Member Functions inherited from Base::PyObjectBase
void setTwinPointer (void *ptr)
 Overrides the pointer to the twin object. More...
 
virtual ~PyObjectBase ()
 destructor More...
 

callbacks and implementers for the python object methods

PyObjectunbound (PyObject *args)
 implementer for the unbound() method More...
 
PyObjectmove (PyObject *args)
 implementer for the move() method More...
 
static PyObjectstaticCallback_unbound (PyObject *self, PyObject *args)
 callback for the unbound() method More...
 
static PyObjectstaticCallback_move (PyObject *self, PyObject *args)
 callback for the move() method More...
 

callbacks and implementers for the python object attributes

Py::Long getIndex (void) const
 getter for the Index attribute More...
 
Py::Boolean getBound (void) const
 getter for the Bound attribute More...
 
Py::Object getNormal (void) const
 getter for the Normal attribute More...
 
Py::Object getVector (void) const
 getter for the Vector attribute More...
 
Py::Float getx (void) const
 getter for the x attribute More...
 
void setx (Py::Float arg)
 setter for the x attribute More...
 
Py::Float gety (void) const
 getter for the y attribute More...
 
void sety (Py::Float arg)
 setter for the y attribute More...
 
Py::Float getz (void) const
 getter for the z attribute More...
 
void setz (Py::Float arg)
 setter for the z attribute More...
 
PyObjectgetCustomAttributes (const char *attr) const
 getter method for special attributes (e.g. dynamic ones) More...
 
int setCustomAttributes (const char *attr, PyObject *obj)
 setter for special attributes (e.g. More...
 
MeshPointgetMeshPointPtr (void) const
 getter for the object handled by this class More...
 
static PyObjectstaticCallback_getIndex (PyObject *self, void *closure)
 getter callback for the Index attribute More...
 
static int staticCallback_setIndex (PyObject *self, PyObject *value, void *closure)
 setter callback for the Index attribute More...
 
static PyObjectstaticCallback_getBound (PyObject *self, void *closure)
 getter callback for the Bound attribute More...
 
static int staticCallback_setBound (PyObject *self, PyObject *value, void *closure)
 setter callback for the Bound attribute More...
 
static PyObjectstaticCallback_getNormal (PyObject *self, void *closure)
 getter callback for the Normal attribute More...
 
static int staticCallback_setNormal (PyObject *self, PyObject *value, void *closure)
 setter callback for the Normal attribute More...
 
static PyObjectstaticCallback_getVector (PyObject *self, void *closure)
 getter callback for the Vector attribute More...
 
static int staticCallback_setVector (PyObject *self, PyObject *value, void *closure)
 setter callback for the Vector attribute More...
 
static PyObjectstaticCallback_getx (PyObject *self, void *closure)
 getter callback for the x attribute More...
 
static int staticCallback_setx (PyObject *self, PyObject *value, void *closure)
 setter callback for the x attribute More...
 
static PyObjectstaticCallback_gety (PyObject *self, void *closure)
 getter callback for the y attribute More...
 
static int staticCallback_sety (PyObject *self, PyObject *value, void *closure)
 setter callback for the y attribute More...
 
static PyObjectstaticCallback_getz (PyObject *self, void *closure)
 getter callback for the z attribute More...
 
static int staticCallback_setz (PyObject *self, PyObject *value, void *closure)
 setter callback for the z attribute More...
 

Additional Inherited Members

- Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 > StatusBits
 

Detailed Description

The python export class for MeshPoint.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~MeshPointPy()

MeshPointPy::~MeshPointPy ( )
protected

◆ MeshPointPy()

MeshPointPy::MeshPointPy ( MeshPoint pcObject,
PyTypeObject *  T = &Type 
)

Referenced by PyMake().

Member Function Documentation

◆ getBound()

Py::Boolean MeshPointPy::getBound ( void  ) const

getter for the Bound attribute

References getMeshPointPtr().

Referenced by staticCallback_getBound().

◆ getCustomAttributes()

PyObject * MeshPointPy::getCustomAttributes ( const char *  attr) const

getter method for special attributes (e.g. dynamic ones)

◆ getIndex()

Py::Long MeshPointPy::getIndex ( void  ) const

getter for the Index attribute

References getMeshPointPtr().

Referenced by staticCallback_getIndex().

◆ getMeshPointPtr()

MeshPoint * MeshPointPy::getMeshPointPtr ( void  ) const

getter for the object handled by this class

Referenced by getBound(), getIndex(), getNormal(), getx(), gety(), getz(), move(), PyInit(), representation(), setx(), sety(), setz(), and unbound().

◆ getNormal()

Py::Object MeshPointPy::getNormal ( void  ) const

getter for the Normal attribute

References getMeshPointPtr(), and Base::PyObjectBase::setConst().

Referenced by staticCallback_getNormal().

◆ GetType()

virtual PyTypeObject* Mesh::MeshPointPy::GetType ( void  )
virtual

Reimplemented from Base::PyObjectBase.

◆ getVector()

Py::Object MeshPointPy::getVector ( void  ) const

getter for the Vector attribute

References draftgeoutils.general::vec().

Referenced by staticCallback_getVector().

◆ getx()

Py::Float MeshPointPy::getx ( void  ) const

◆ gety()

Py::Float MeshPointPy::gety ( void  ) const

◆ getz()

Py::Float MeshPointPy::getz ( void  ) const

◆ move()

◆ PyInit()

int MeshPointPy::PyInit ( PyObject ,
PyObject  
)
virtual

PyInit method Override this method to initialize a newly created instance of the class (Constructor)

Reimplemented from Base::PyObjectBase.

References getMeshPointPtr().

◆ PyMake()

PyObject * MeshPointPy::PyMake ( struct _typeobject *  ,
PyObject ,
PyObject  
)
static

References MeshPointPy().

◆ representation()

◆ setCustomAttributes()

int MeshPointPy::setCustomAttributes ( const char *  attr,
PyObject obj 
)

setter for special attributes (e.g.

dynamic ones) Output: Success=1, Failure=-1, Ignore=0

◆ setx()

void MeshPointPy::setx ( Py::Float  arg)

◆ sety()

void MeshPointPy::sety ( Py::Float  arg)

◆ setz()

void MeshPointPy::setz ( Py::Float  arg)

◆ staticCallback_getBound()

PyObject * MeshPointPy::staticCallback_getBound ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getIndex()

PyObject * MeshPointPy::staticCallback_getIndex ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getNormal()

PyObject * MeshPointPy::staticCallback_getNormal ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getVector()

PyObject * MeshPointPy::staticCallback_getVector ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getx()

PyObject * MeshPointPy::staticCallback_getx ( PyObject self,
void *  closure 
)
static

◆ staticCallback_gety()

PyObject * MeshPointPy::staticCallback_gety ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getz()

PyObject * MeshPointPy::staticCallback_getz ( PyObject self,
void *  closure 
)
static

◆ staticCallback_move()

◆ staticCallback_setBound()

int MeshPointPy::staticCallback_setBound ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Bound attribute

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

◆ staticCallback_setIndex()

int MeshPointPy::staticCallback_setIndex ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Index attribute

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

◆ staticCallback_setNormal()

int MeshPointPy::staticCallback_setNormal ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Normal attribute

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

◆ staticCallback_setVector()

int MeshPointPy::staticCallback_setVector ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Vector attribute

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

◆ staticCallback_setx()

int MeshPointPy::staticCallback_setx ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_sety()

int MeshPointPy::staticCallback_sety ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setz()

int MeshPointPy::staticCallback_setz ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_unbound()

◆ unbound()

PyObject * MeshPointPy::unbound ( PyObject args)

implementer for the unbound() method

References getMeshPointPtr(), Mesh::MeshPoint::Index, and Mesh::MeshPoint::Mesh.

Referenced by staticCallback_unbound().

Member Data Documentation

◆ GetterSetter

PyGetSetDef MeshPointPy::GetterSetter
static

Attribute structure of MeshPointPy.

◆ Methods

PyMethodDef MeshPointPy::Methods
static
Initial value:
= {
{"unbound",
reinterpret_cast<PyCFunction>( staticCallback_unbound ),
METH_VARARGS,
" method unbound()\nCut the connection to a MeshObject. The point becomes\nfree and is more or less a simple vector/point.\nAfter calling unbound() no topological operation will\nwork!\n "
},
{"move",
reinterpret_cast<PyCFunction>( staticCallback_move ),
METH_VARARGS,
"method move(Vector)\nThis method moves the point in the mesh along the \ngiven vector. This affects the geometry of the mesh.\nBe aware that after moving point(s) the mesh can \nhave self intersections!\n "
},
{NULL, NULL, 0, NULL}
}
static PyObject * staticCallback_unbound(PyObject *self, PyObject *args)
callback for the unbound() method
Definition: MeshPointPy.cpp:163
static PyObject * staticCallback_move(PyObject *self, PyObject *args)
callback for the move() method
Definition: MeshPointPy.cpp:231

Methods structure of MeshPointPy.

◆ Type


The documentation for this class was generated from the following files:
  • Sources/FreeCAD-SourceDocs/src/Mod/Mesh/App/MeshPointPy.h
  • Sources/FreeCAD/src/Mod/Mesh/App/MeshPointPyImp.cpp
  • Sources/FreeCAD-SourceDocs/src/Mod/Mesh/App/MeshPointPy.cpp