Part::PlanePy Class Reference

The python export class for GeomPlane. More...

#include <PlanePy.h>

Inheritance diagram for Part::PlanePy:
Part::GeometrySurfacePy Part::GeometryPy Base::PyObjectBase

List of all members.

Public Types

typedef GeomPlanePointerType

Public Member Functions

PyObject_getattr (char *attr)
 GetAttribute implementation This method implements the retriavel of object attributes.
virtual PyObject_repr (void)
 _repr method Overide this method to return a string object with some invormation about the object.
int _setattr (char *attr, PyObject *value)
 SetAttribute implementation This method implements the seting of object attributes.
PyObjectgetCustomAttributes (const char *attr) const
 getter method for special attributes (e.g. dynamic ones)
GeomPlanegetGeomPlanePtr (void) const
 getter for the object handled by this class
virtual PyParentObjectGetParents (void)
virtual PyTypeObject * GetType (void)
 PlanePy (GeomPlane *pcObject, PyTypeObject *T=&Type)
virtual int PyInit (PyObject *args, PyObject *k)
 PyInit method Overide this method to initialize a newly created instance of the class (Constuctor).
std::string representation (void) const
int setCustomAttributes (const char *attr, PyObject *obj)
 setter for special attributes (e.g. dynamic ones)
 ~PlanePy ()

Static Public Member Functions

static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)

Static Public Attributes

static PyGetSetDef GetterSetter []
 Attribute structure of PlanePy.
static PyMethodDef Methods []
 Methods structure of PlanePy.
static PyParentObject Parents [] = { PARENTSPartPlanePy }
static PyTypeObject Type
 Type structure of PlanePy.

callbacks and implementers for the python object attributes



Py::Object getAxis (void) const
 getter for the Axis attribute
Py::Object getPosition (void) const
 getter for the Position attribute
void setAxis (Py::Object arg)
 setter for the Axis attribute
void setPosition (Py::Object arg)
 setter for the Position attribute
static PyObjectstaticCallback_getAxis (PyObject *self, void *closure)
 getter callback for the Axis attribute
static PyObjectstaticCallback_getPosition (PyObject *self, void *closure)
 getter callback for the Position attribute
static int staticCallback_setAxis (PyObject *self, PyObject *value, void *closure)
 setter callback for the Axis attribute
static int staticCallback_setPosition (PyObject *self, PyObject *value, void *closure)
 setter callback for the Position attribute

callbacks and implementers for the python object methods



PyObjectuIso (PyObject *args)
 implementer for the uIso() method
PyObjectvIso (PyObject *args)
 implementer for the vIso() method
static PyObjectstaticCallback_uIso (PyObject *self, PyObject *args)
 callback for the uIso() method
static PyObjectstaticCallback_vIso (PyObject *self, PyObject *args)
 callback for the vIso() method

Detailed Description

The python export class for GeomPlane.

Definition at line 20 of file PlanePy.h.


Member Typedef Documentation

Reimplemented from Part::GeometrySurfacePy.

Definition at line 36 of file PlanePy.h.


Constructor & Destructor Documentation

PlanePy::PlanePy ( GeomPlane pcObject,
PyTypeObject *  T = &Type 
)

Definition at line 377 of file PlanePy.cpp.

Referenced by PyMake().

PlanePy::~PlanePy (  ) 

Definition at line 386 of file PlanePy.cpp.


Member Function Documentation

PyObject * PlanePy::_getattr ( char *  attr  )  [virtual]

GetAttribute implementation This method implements the retriavel of object attributes.

If you want to implement attributes in your class, reimplement this method. You have to call the method of the base class. Note: if you reimplement _gettattr() in a inheriting class you need to call the method of the base class! Otherwise even the methods of the object will disapiear!

Reimplemented from Part::GeometrySurfacePy.

Definition at line 401 of file PlanePy.cpp.

References Base::Console(), getCustomAttributes(), Methods, Base::Exception::ReportException(), and Base::Exception::what().

PyObject * PlanePy::_repr ( void   )  [virtual]

_repr method Overide this method to return a string object with some invormation about the object.

 PyObject *MeshFeaturePy::_repr(void)
 {
   std::stringstream a;
   a << "MeshFeature: [ ";
   a << "some realy important info about the object!";
   a << "]" << std::endl;
   return Py_BuildValue("s", a.str().c_str());
 }

Reimplemented from Part::GeometrySurfacePy.

Definition at line 393 of file PlanePy.cpp.

References representation().

int PlanePy::_setattr ( char *  attr,
PyObject value 
) [virtual]

SetAttribute implementation This method implements the seting of object attributes.

If you want to implement attributes in your class, reimplement this method. You have to call the method of the base class.

Reimplemented from Part::GeometrySurfacePy.

Definition at line 469 of file PlanePy.cpp.

References Base::Console(), Base::Exception::ReportException(), setCustomAttributes(), and Base::Exception::what().

Py::Object PlanePy::getAxis ( void   )  const

getter for the Axis attribute

Definition at line 215 of file PlanePyImp.cpp.

References Part::GeometryPy::getGeometryPtr(), and StartPage::StartPage::handle().

Referenced by staticCallback_getAxis().

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

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 308 of file PlanePyImp.cpp.

Referenced by _getattr().

GeomPlane * PlanePy::getGeomPlanePtr ( void   )  const

getter for the object handled by this class

Definition at line 528 of file PlanePy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Referenced by getPosition(), setPosition(), uIso(), and vIso().

virtual PyParentObject* Part::PlanePy::GetParents ( void   )  [inline, virtual]

Reimplemented from Part::GeometrySurfacePy.

Definition at line 28 of file PlanePy.h.

Py::Object PlanePy::getPosition ( void   )  const

getter for the Position attribute

Definition at line 174 of file PlanePyImp.cpp.

References getGeomPlanePtr(), and StartPage::StartPage::handle().

Referenced by staticCallback_getPosition().

virtual PyTypeObject* Part::PlanePy::GetType ( void   )  [inline, virtual]

Reimplemented from Part::GeometrySurfacePy.

Definition at line 27 of file PlanePy.h.

int PlanePy::PyInit ( PyObject ,
PyObject  
) [virtual]
PyObject * PlanePy::PyMake ( struct _typeobject *  ,
PyObject ,
PyObject  
) [static]

Reimplemented from Part::GeometrySurfacePy.

Definition at line 56 of file PlanePyImp.cpp.

References PlanePy().

std::string PlanePy::representation ( void   )  const

Reimplemented from Part::GeometrySurfacePy.

Definition at line 51 of file PlanePyImp.cpp.

Referenced by _repr().

void PlanePy::setAxis ( Py::Object  arg  ) 
int PlanePy::setCustomAttributes ( const char *  attr,
PyObject obj 
)

setter for special attributes (e.g. dynamic ones)

Reimplemented from Part::GeometrySurfacePy.

Definition at line 313 of file PlanePyImp.cpp.

Referenced by _setattr().

void PlanePy::setPosition ( Py::Object  arg  ) 
PyObject * PlanePy::staticCallback_getAxis ( PyObject self,
void *  closure 
) [static]

getter callback for the Axis attribute

Definition at line 326 of file PlanePy.cpp.

References getAxis(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * PlanePy::staticCallback_getPosition ( PyObject self,
void *  closure 
) [static]

getter callback for the Position attribute

Definition at line 282 of file PlanePy.cpp.

References getPosition(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

int PlanePy::staticCallback_setAxis ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Axis attribute

Definition at line 344 of file PlanePy.cpp.

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

int PlanePy::staticCallback_setPosition ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Position attribute

Definition at line 300 of file PlanePy.cpp.

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

PyObject * PlanePy::staticCallback_uIso ( PyObject self,
PyObject args 
) [static]
PyObject * PlanePy::staticCallback_vIso ( PyObject self,
PyObject args 
) [static]
PyObject * PlanePy::uIso ( PyObject args  ) 

implementer for the uIso() method

Definition at line 258 of file PlanePyImp.cpp.

References getGeomPlanePtr(), StartPage::StartPage::handle(), and draftTools::plane.

PyObject * PlanePy::vIso ( PyObject args  ) 

implementer for the vIso() method

Definition at line 283 of file PlanePyImp.cpp.

References getGeomPlanePtr(), StartPage::StartPage::handle(), and draftTools::plane.


Member Data Documentation

PyGetSetDef PlanePy::GetterSetter [static]
Initial value:
 {
    {"Position",
        (getter) staticCallback_getPosition,
        (setter) staticCallback_setPosition, 
        "Returns the position point of this plane.",
        NULL
    },
    {"Axis",
        (getter) staticCallback_getAxis,
        (setter) staticCallback_setAxis, 
        "Returns the axis of this plane.",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of PlanePy.

Reimplemented from Part::GeometrySurfacePy.

Definition at line 25 of file PlanePy.h.

PyMethodDef PlanePy::Methods [static]
Initial value:
 {
    {"uIso",
        (PyCFunction) staticCallback_uIso,
        METH_VARARGS,
        "Builds the U isoparametric line of this plane"
    },
    {"vIso",
        (PyCFunction) staticCallback_vIso,
        METH_VARARGS,
        "Builds the V isoparametric line of this plane"
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of PlanePy.

Reimplemented from Part::GeometrySurfacePy.

Definition at line 24 of file PlanePy.h.

Referenced by _getattr().

PyParentObject PlanePy::Parents = { PARENTSPartPlanePy } [static]

Reimplemented from Part::GeometrySurfacePy.

Definition at line 26 of file PlanePy.h.

PyTypeObject PlanePy::Type [static]

Type structure of PlanePy.

Reimplemented from Part::GeometrySurfacePy.

Definition at line 23 of file PlanePy.h.

Referenced by initPart(), and PyInit().


The documentation for this class was generated from the following files:

Generated on Wed Nov 23 19:02:36 2011 for FreeCAD by  doxygen 1.6.1