The python export class for Facet. More...

#include <FacetPy.h>

Public Types

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

Public Member Functions

 FacetPy (Facet *pcObject, PyTypeObject *T=&Type)
 
virtual PyTypeObject * GetType (void)
 
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 FacetPy. More...
 
static PyMethodDef Methods []
 Methods structure of FacetPy. More...
 
static PyTypeObject Type
 Type structure of FacetPy. More...
 
- Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
 
static PyTypeObject Type
 Py_Header struct from python.h. More...
 

Protected Member Functions

 ~FacetPy ()
 
- Protected Member Functions inherited from Base::PyObjectBase
virtual ~PyObjectBase ()
 destructor More...
 

callbacks and implementers for the python object methods

PyObjectunbound (PyObject *args)
 implementer for the unbound() method More...
 
PyObjectintersect (PyObject *args)
 implementer for the intersect() method More...
 
PyObjectisDegenerated (PyObject *args)
 implementer for the isDegenerated() method More...
 
PyObjectisDeformed (PyObject *args)
 implementer for the isDeformed() method More...
 
static PyObjectstaticCallback_unbound (PyObject *self, PyObject *args)
 callback for the unbound() method More...
 
static PyObjectstaticCallback_intersect (PyObject *self, PyObject *args)
 callback for the intersect() method More...
 
static PyObjectstaticCallback_isDegenerated (PyObject *self, PyObject *args)
 callback for the isDegenerated() method More...
 
static PyObjectstaticCallback_isDeformed (PyObject *self, PyObject *args)
 callback for the isDeformed() 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::List getPoints (void) const
 getter for the Points attribute More...
 
Py::Tuple getPointIndices (void) const
 getter for the PointIndices attribute More...
 
Py::Tuple getNeighbourIndices (void) const
 getter for the NeighbourIndices attribute More...
 
Py::Float getArea (void) const
 getter for the Area attribute More...
 
Py::Float getAspectRatio (void) const
 getter for the AspectRatio attribute More...
 
Py::Float getAspectRatio2 (void) const
 getter for the AspectRatio2 attribute More...
 
Py::Float getRoundness (void) const
 getter for the Roundness attribute More...
 
Py::Tuple getCircumCircle (void) const
 getter for the CircumCircle attribute More...
 
Py::Tuple getInCircle (void) const
 getter for the InCircle 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...
 
FacetgetFacetPtr (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_getPoints (PyObject *self, void *closure)
 getter callback for the Points attribute More...
 
static int staticCallback_setPoints (PyObject *self, PyObject *value, void *closure)
 setter callback for the Points attribute More...
 
static PyObjectstaticCallback_getPointIndices (PyObject *self, void *closure)
 getter callback for the PointIndices attribute More...
 
static int staticCallback_setPointIndices (PyObject *self, PyObject *value, void *closure)
 setter callback for the PointIndices attribute More...
 
static PyObjectstaticCallback_getNeighbourIndices (PyObject *self, void *closure)
 getter callback for the NeighbourIndices attribute More...
 
static int staticCallback_setNeighbourIndices (PyObject *self, PyObject *value, void *closure)
 setter callback for the NeighbourIndices attribute More...
 
static PyObjectstaticCallback_getArea (PyObject *self, void *closure)
 getter callback for the Area attribute More...
 
static int staticCallback_setArea (PyObject *self, PyObject *value, void *closure)
 setter callback for the Area attribute More...
 
static PyObjectstaticCallback_getAspectRatio (PyObject *self, void *closure)
 getter callback for the AspectRatio attribute More...
 
static int staticCallback_setAspectRatio (PyObject *self, PyObject *value, void *closure)
 setter callback for the AspectRatio attribute More...
 
static PyObjectstaticCallback_getAspectRatio2 (PyObject *self, void *closure)
 getter callback for the AspectRatio2 attribute More...
 
static int staticCallback_setAspectRatio2 (PyObject *self, PyObject *value, void *closure)
 setter callback for the AspectRatio2 attribute More...
 
static PyObjectstaticCallback_getRoundness (PyObject *self, void *closure)
 getter callback for the Roundness attribute More...
 
static int staticCallback_setRoundness (PyObject *self, PyObject *value, void *closure)
 setter callback for the Roundness attribute More...
 
static PyObjectstaticCallback_getCircumCircle (PyObject *self, void *closure)
 getter callback for the CircumCircle attribute More...
 
static int staticCallback_setCircumCircle (PyObject *self, PyObject *value, void *closure)
 setter callback for the CircumCircle attribute More...
 
static PyObjectstaticCallback_getInCircle (PyObject *self, void *closure)
 getter callback for the InCircle attribute More...
 
static int staticCallback_setInCircle (PyObject *self, PyObject *value, void *closure)
 setter callback for the InCircle attribute More...
 

Additional Inherited Members

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

Detailed Description

The python export class for Facet.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~FacetPy()

FacetPy::~FacetPy ( )
protected

◆ FacetPy()

FacetPy::FacetPy ( Facet pcObject,
PyTypeObject *  T = &Type 
)

Referenced by PyMake().

Member Function Documentation

◆ getArea()

Py::Float FacetPy::getArea ( void  ) const

◆ getAspectRatio()

Py::Float FacetPy::getAspectRatio ( void  ) const

◆ getAspectRatio2()

Py::Float FacetPy::getAspectRatio2 ( void  ) const

◆ getBound()

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

getter for the Bound attribute

References getFacetPtr().

Referenced by staticCallback_getBound().

◆ getCircumCircle()

Py::Tuple FacetPy::getCircumCircle ( void  ) const

◆ getCustomAttributes()

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

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

◆ getFacetPtr()

◆ getInCircle()

Py::Tuple FacetPy::getInCircle ( void  ) const

◆ getIndex()

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

getter for the Index attribute

References getFacetPtr().

Referenced by staticCallback_getIndex().

◆ getNeighbourIndices()

Py::Tuple FacetPy::getNeighbourIndices ( void  ) const

getter for the NeighbourIndices attribute

References getFacetPtr(), and Mesh::Facet::isBound().

Referenced by staticCallback_getNeighbourIndices().

◆ getNormal()

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

getter for the Normal attribute

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

Referenced by staticCallback_getNormal().

◆ getPointIndices()

Py::Tuple FacetPy::getPointIndices ( void  ) const

getter for the PointIndices attribute

References getFacetPtr(), and Mesh::Facet::isBound().

Referenced by staticCallback_getPointIndices().

◆ getPoints()

Py::List FacetPy::getPoints ( void  ) const

getter for the Points attribute

References getFacetPtr().

Referenced by staticCallback_getPoints().

◆ getRoundness()

Py::Float FacetPy::getRoundness ( void  ) const

◆ GetType()

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

Reimplemented from Base::PyObjectBase.

◆ intersect()

◆ isDeformed()

◆ isDegenerated()

◆ PyInit()

int FacetPy::PyInit ( PyObject ,
PyObject  
)
virtual

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

Reimplemented from Base::PyObjectBase.

◆ PyMake()

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

References FacetPy().

◆ representation()

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ staticCallback_getArea()

PyObject * FacetPy::staticCallback_getArea ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getAspectRatio()

PyObject * FacetPy::staticCallback_getAspectRatio ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getAspectRatio2()

PyObject * FacetPy::staticCallback_getAspectRatio2 ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getBound()

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

◆ staticCallback_getCircumCircle()

PyObject * FacetPy::staticCallback_getCircumCircle ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getInCircle()

PyObject * FacetPy::staticCallback_getInCircle ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getIndex()

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

◆ staticCallback_getNeighbourIndices()

PyObject * FacetPy::staticCallback_getNeighbourIndices ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getNormal()

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

◆ staticCallback_getPointIndices()

PyObject * FacetPy::staticCallback_getPointIndices ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getPoints()

PyObject * FacetPy::staticCallback_getPoints ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getRoundness()

PyObject * FacetPy::staticCallback_getRoundness ( PyObject self,
void *  closure 
)
static

◆ staticCallback_intersect()

◆ staticCallback_isDeformed()

◆ staticCallback_isDegenerated()

◆ staticCallback_setArea()

int FacetPy::staticCallback_setArea ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Area attribute

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

◆ staticCallback_setAspectRatio()

int FacetPy::staticCallback_setAspectRatio ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the AspectRatio attribute

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

◆ staticCallback_setAspectRatio2()

int FacetPy::staticCallback_setAspectRatio2 ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the AspectRatio2 attribute

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

◆ staticCallback_setBound()

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

setter callback for the Bound attribute

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

◆ staticCallback_setCircumCircle()

int FacetPy::staticCallback_setCircumCircle ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the CircumCircle attribute

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

◆ staticCallback_setInCircle()

int FacetPy::staticCallback_setInCircle ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the InCircle attribute

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

◆ staticCallback_setIndex()

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

setter callback for the Index attribute

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

◆ staticCallback_setNeighbourIndices()

int FacetPy::staticCallback_setNeighbourIndices ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the NeighbourIndices attribute

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

◆ staticCallback_setNormal()

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

setter callback for the Normal attribute

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

◆ staticCallback_setPointIndices()

int FacetPy::staticCallback_setPointIndices ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the PointIndices attribute

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

◆ staticCallback_setPoints()

int FacetPy::staticCallback_setPoints ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Points attribute

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

◆ staticCallback_setRoundness()

int FacetPy::staticCallback_setRoundness ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Roundness attribute

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

◆ staticCallback_unbound()

◆ unbound()

PyObject * FacetPy::unbound ( PyObject args)

implementer for the unbound() method

References getFacetPtr(), Mesh::Facet::Index, and Mesh::Facet::Mesh.

Referenced by staticCallback_unbound().

Member Data Documentation

◆ GetterSetter

PyGetSetDef FacetPy::GetterSetter
static

Attribute structure of FacetPy.

◆ Methods

PyMethodDef FacetPy::Methods
static
Initial value:
= {
{"unbound",
reinterpret_cast<PyCFunction>( staticCallback_unbound ),
METH_VARARGS,
"method unbound()\nCut the connection to a MeshObject. The facet becomes\nfree and is more or less a simple facet.\nAfter calling unbound() no topological operation will\nwork!\n "
},
{"intersect",
reinterpret_cast<PyCFunction>( staticCallback_intersect ),
METH_VARARGS,
"intersect(Facet) -> list \nGet a list of intersection points with another triangle.\n "
},
{"isDegenerated",
reinterpret_cast<PyCFunction>( staticCallback_isDegenerated ),
METH_VARARGS,
"isDegenerated([float]) -> boolean\nReturns true if the facet is degenerated, otherwise false.\n "
},
{"isDeformed",
reinterpret_cast<PyCFunction>( staticCallback_isDeformed ),
METH_VARARGS,
"isDegenerated(MinAngle, MaxAngle) -> boolean\nReturns true if the facet is deformed, otherwise false.\nA triangle is considered deformed if an angle is less than MinAngle\nor higher than MaxAngle.\nThe two angles are given in radian.\n "
},
{NULL, NULL, 0, NULL}
}

Methods structure of FacetPy.

◆ Type


The documentation for this class was generated from the following files:
  • build/webdoc/src/Mod/Mesh/App/FacetPy.h
  • src/Mod/Mesh/App/FacetPyImp.cpp
  • build/webdoc/src/Mod/Mesh/App/FacetPy.cpp
static PyObject * staticCallback_intersect(PyObject *self, PyObject *args)
callback for the intersect() method
Definition: FacetPy.cpp:274
static PyObject * staticCallback_unbound(PyObject *self, PyObject *args)
callback for the unbound() method
Definition: FacetPy.cpp:191
static PyObject * staticCallback_isDegenerated(PyObject *self, PyObject *args)
callback for the isDegenerated() method
Definition: FacetPy.cpp:357
static PyObject * staticCallback_isDeformed(PyObject *self, PyObject *args)
callback for the isDeformed() method
Definition: FacetPy.cpp:440