The python export class for CenterLine. More...

#include <CenterLinePy.h>

Public Types

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

Public Member Functions

 CenterLinePy (CenterLine *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 CenterLinePy. More...
 
static PyMethodDef Methods []
 Methods structure of CenterLinePy. More...
 
static PyTypeObject Type
 Type structure of CenterLinePy. More...
 
- Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
 
static PyTypeObject Type
 Py_Header struct from python.h. More...
 

Protected Member Functions

 ~CenterLinePy ()
 
- 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

PyObjectclone (PyObject *args)
 implementer for the clone() method More...
 
PyObjectcopy (PyObject *args)
 implementer for the copy() method More...
 
static PyObjectstaticCallback_clone (PyObject *self, PyObject *args)
 callback for the clone() method More...
 
static PyObjectstaticCallback_copy (PyObject *self, PyObject *args)
 callback for the copy() method More...
 

callbacks and implementers for the python object attributes

Py::String getTag (void) const
 getter for the Tag attribute More...
 
Py::Long getType (void) const
 getter for the Type attribute More...
 
Py::Long getMode (void) const
 getter for the Mode attribute More...
 
void setMode (Py::Long arg)
 setter for the Mode attribute More...
 
Py::Object getFormat (void) const
 getter for the Format attribute More...
 
void setFormat (Py::Object arg)
 setter for the Format attribute More...
 
Py::Float getHorizShift (void) const
 getter for the HorizShift attribute More...
 
void setHorizShift (Py::Float arg)
 setter for the HorizShift attribute More...
 
Py::Float getVertShift (void) const
 getter for the VertShift attribute More...
 
void setVertShift (Py::Float arg)
 setter for the VertShift attribute More...
 
Py::Float getRotation (void) const
 getter for the Rotation attribute More...
 
void setRotation (Py::Float arg)
 setter for the Rotation attribute More...
 
Py::Float getExtension (void) const
 getter for the Extension attribute More...
 
void setExtension (Py::Float arg)
 setter for the Extension attribute More...
 
Py::Boolean getFlip (void) const
 getter for the Flip attribute More...
 
void setFlip (Py::Boolean arg)
 setter for the Flip attribute More...
 
Py::Object getEdges (void) const
 getter for the Edges attribute More...
 
void setEdges (Py::Object arg)
 setter for the Edges attribute More...
 
Py::Object getFaces (void) const
 getter for the Faces attribute More...
 
void setFaces (Py::Object arg)
 setter for the Faces attribute More...
 
Py::Object getPoints (void) const
 getter for the Points attribute More...
 
void setPoints (Py::Object arg)
 setter for the Points 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...
 
CenterLinegetCenterLinePtr (void) const
 getter for the object handled by this class More...
 
static PyObjectstaticCallback_getTag (PyObject *self, void *closure)
 getter callback for the Tag attribute More...
 
static int staticCallback_setTag (PyObject *self, PyObject *value, void *closure)
 setter callback for the Tag attribute More...
 
static PyObjectstaticCallback_getType (PyObject *self, void *closure)
 getter callback for the Type attribute More...
 
static int staticCallback_setType (PyObject *self, PyObject *value, void *closure)
 setter callback for the Type attribute More...
 
static PyObjectstaticCallback_getMode (PyObject *self, void *closure)
 getter callback for the Mode attribute More...
 
static int staticCallback_setMode (PyObject *self, PyObject *value, void *closure)
 setter callback for the Mode attribute More...
 
static PyObjectstaticCallback_getFormat (PyObject *self, void *closure)
 getter callback for the Format attribute More...
 
static int staticCallback_setFormat (PyObject *self, PyObject *value, void *closure)
 setter callback for the Format attribute More...
 
static PyObjectstaticCallback_getHorizShift (PyObject *self, void *closure)
 getter callback for the HorizShift attribute More...
 
static int staticCallback_setHorizShift (PyObject *self, PyObject *value, void *closure)
 setter callback for the HorizShift attribute More...
 
static PyObjectstaticCallback_getVertShift (PyObject *self, void *closure)
 getter callback for the VertShift attribute More...
 
static int staticCallback_setVertShift (PyObject *self, PyObject *value, void *closure)
 setter callback for the VertShift attribute More...
 
static PyObjectstaticCallback_getRotation (PyObject *self, void *closure)
 getter callback for the Rotation attribute More...
 
static int staticCallback_setRotation (PyObject *self, PyObject *value, void *closure)
 setter callback for the Rotation attribute More...
 
static PyObjectstaticCallback_getExtension (PyObject *self, void *closure)
 getter callback for the Extension attribute More...
 
static int staticCallback_setExtension (PyObject *self, PyObject *value, void *closure)
 setter callback for the Extension attribute More...
 
static PyObjectstaticCallback_getFlip (PyObject *self, void *closure)
 getter callback for the Flip attribute More...
 
static int staticCallback_setFlip (PyObject *self, PyObject *value, void *closure)
 setter callback for the Flip attribute More...
 
static PyObjectstaticCallback_getEdges (PyObject *self, void *closure)
 getter callback for the Edges attribute More...
 
static int staticCallback_setEdges (PyObject *self, PyObject *value, void *closure)
 setter callback for the Edges attribute More...
 
static PyObjectstaticCallback_getFaces (PyObject *self, void *closure)
 getter callback for the Faces attribute More...
 
static int staticCallback_setFaces (PyObject *self, PyObject *value, void *closure)
 setter callback for the Faces 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...
 

Additional Inherited Members

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

Detailed Description

The python export class for CenterLine.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~CenterLinePy()

CenterLinePy::~CenterLinePy ( )
protected

◆ CenterLinePy()

CenterLinePy::CenterLinePy ( CenterLine pcObject,
PyTypeObject *  T = &Type 
)

Member Function Documentation

◆ clone()

◆ copy()

PyObject * CenterLinePy::copy ( PyObject args)

implementer for the copy() method

References TechDraw::CenterLine::copy(), getCenterLinePtr(), and GetType().

Referenced by staticCallback_copy().

◆ getCenterLinePtr()

◆ getCustomAttributes()

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

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

◆ getEdges()

Py::Object CenterLinePy::getEdges ( void  ) const

◆ getExtension()

Py::Float CenterLinePy::getExtension ( void  ) const

getter for the Extension attribute

References getCenterLinePtr(), and TechDraw::CenterLine::getExtend().

Referenced by staticCallback_getExtension().

◆ getFaces()

Py::Object CenterLinePy::getFaces ( void  ) const

getter for the Faces attribute

References getCenterLinePtr(), and TechDraw::CenterLine::m_faces.

Referenced by staticCallback_getFaces().

◆ getFlip()

Py::Boolean CenterLinePy::getFlip ( void  ) const

getter for the Flip attribute

References getCenterLinePtr(), and TechDraw::CenterLine::getFlip().

Referenced by staticCallback_getFlip().

◆ getFormat()

◆ getHorizShift()

Py::Float CenterLinePy::getHorizShift ( void  ) const

getter for the HorizShift attribute

References getCenterLinePtr(), and TechDraw::CenterLine::getHShift().

Referenced by staticCallback_getHorizShift().

◆ getMode()

Py::Long CenterLinePy::getMode ( void  ) const

getter for the Mode attribute

References getCenterLinePtr(), and TechDraw::CenterLine::m_mode.

Referenced by staticCallback_getMode().

◆ getPoints()

Py::Object CenterLinePy::getPoints ( void  ) const

getter for the Points attribute

References getCenterLinePtr(), and TechDraw::CenterLine::m_verts.

Referenced by staticCallback_getPoints().

◆ getRotation()

Py::Float CenterLinePy::getRotation ( void  ) const

getter for the Rotation attribute

References getCenterLinePtr(), and TechDraw::CenterLine::getRotate().

Referenced by staticCallback_getRotation().

◆ getTag()

Py::String CenterLinePy::getTag ( void  ) const

getter for the Tag attribute

References getCenterLinePtr().

Referenced by staticCallback_getTag().

◆ GetType()

virtual PyTypeObject* TechDraw::CenterLinePy::GetType ( void  )
virtual

Reimplemented from Base::PyObjectBase.

Referenced by clone(), and copy().

◆ getType()

Py::Long CenterLinePy::getType ( void  ) const

◆ getVertShift()

Py::Float CenterLinePy::getVertShift ( void  ) const

getter for the VertShift attribute

References getCenterLinePtr(), and TechDraw::CenterLine::getVShift().

Referenced by staticCallback_getVertShift().

◆ PyInit()

int CenterLinePy::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 * CenterLinePy::PyMake ( struct _typeobject *  ,
PyObject ,
PyObject  
)
static

◆ representation()

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ setEdges()

void CenterLinePy::setEdges ( Py::Object  arg)

◆ setExtension()

void CenterLinePy::setExtension ( Py::Float  arg)

setter for the Extension attribute

References getCenterLinePtr(), and TechDraw::CenterLine::setExtend().

Referenced by staticCallback_setExtension().

◆ setFaces()

void CenterLinePy::setFaces ( Py::Object  arg)

◆ setFlip()

void CenterLinePy::setFlip ( Py::Boolean  arg)

setter for the Flip attribute

References getCenterLinePtr(), and TechDraw::CenterLine::setFlip().

Referenced by staticCallback_setFlip().

◆ setFormat()

◆ setHorizShift()

void CenterLinePy::setHorizShift ( Py::Float  arg)

◆ setMode()

void CenterLinePy::setMode ( Py::Long  arg)

setter for the Mode attribute

References getCenterLinePtr(), and TechDraw::CenterLine::m_mode.

Referenced by staticCallback_setMode().

◆ setPoints()

void CenterLinePy::setPoints ( Py::Object  arg)

◆ setRotation()

void CenterLinePy::setRotation ( Py::Float  arg)

setter for the Rotation attribute

References getCenterLinePtr(), and TechDraw::CenterLine::setRotate().

Referenced by staticCallback_setRotation().

◆ setVertShift()

void CenterLinePy::setVertShift ( Py::Float  arg)

◆ staticCallback_clone()

PyObject * CenterLinePy::staticCallback_clone ( PyObject self,
PyObject args 
)
static

◆ staticCallback_copy()

PyObject * CenterLinePy::staticCallback_copy ( PyObject self,
PyObject args 
)
static

◆ staticCallback_getEdges()

PyObject * CenterLinePy::staticCallback_getEdges ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getExtension()

PyObject * CenterLinePy::staticCallback_getExtension ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getFaces()

PyObject * CenterLinePy::staticCallback_getFaces ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getFlip()

PyObject * CenterLinePy::staticCallback_getFlip ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getFormat()

PyObject * CenterLinePy::staticCallback_getFormat ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getHorizShift()

PyObject * CenterLinePy::staticCallback_getHorizShift ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getMode()

PyObject * CenterLinePy::staticCallback_getMode ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getPoints()

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

◆ staticCallback_getRotation()

PyObject * CenterLinePy::staticCallback_getRotation ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getTag()

PyObject * CenterLinePy::staticCallback_getTag ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getType()

PyObject * CenterLinePy::staticCallback_getType ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getVertShift()

PyObject * CenterLinePy::staticCallback_getVertShift ( PyObject self,
void *  closure 
)
static

◆ staticCallback_setEdges()

int CenterLinePy::staticCallback_setEdges ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setExtension()

int CenterLinePy::staticCallback_setExtension ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setFaces()

int CenterLinePy::staticCallback_setFaces ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setFlip()

int CenterLinePy::staticCallback_setFlip ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setFormat()

int CenterLinePy::staticCallback_setFormat ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setHorizShift()

int CenterLinePy::staticCallback_setHorizShift ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setMode()

int CenterLinePy::staticCallback_setMode ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setPoints()

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

◆ staticCallback_setRotation()

int CenterLinePy::staticCallback_setRotation ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setTag()

int CenterLinePy::staticCallback_setTag ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Tag attribute

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

◆ staticCallback_setType()

int CenterLinePy::staticCallback_setType ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Type attribute

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

◆ staticCallback_setVertShift()

int CenterLinePy::staticCallback_setVertShift ( PyObject self,
PyObject value,
void *  closure 
)
static

Member Data Documentation

◆ GetterSetter

PyGetSetDef CenterLinePy::GetterSetter
static

Attribute structure of CenterLinePy.

◆ Methods

PyMethodDef CenterLinePy::Methods
static
Initial value:
= {
{"clone",
reinterpret_cast<PyCFunction>( staticCallback_clone ),
METH_VARARGS,
"Create a clone of this centerline"
},
{"copy",
reinterpret_cast<PyCFunction>( staticCallback_copy ),
METH_VARARGS,
"Create a copy of this centerline"
},
{NULL, NULL, 0, NULL}
}
static PyObject * staticCallback_clone(PyObject *self, PyObject *args)
callback for the clone() method
Definition: CenterLinePy.cpp:187
static PyObject * staticCallback_copy(PyObject *self, PyObject *args)
callback for the copy() method
Definition: CenterLinePy.cpp:248

Methods structure of CenterLinePy.

◆ Type


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