Part::TopoShapeFacePy Class Reference

The python export class for TopoShape. More...

#include <TopoShapeFacePy.h>

Inheritance diagram for Part::TopoShapeFacePy:
Part::TopoShapePy Data::ComplexGeoDataPy Base::PersistencePy Base::BaseClassPy Base::PyObjectBase

List of all members.

Public Types

typedef TopoShapePointerType

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)
virtual PyParentObjectGetParents (void)
TopoShapegetTopoShapePtr (void) const
 getter for the object handled by this class
virtual PyTypeObject * GetType (void)
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)
 TopoShapeFacePy (TopoShape *pcObject, PyTypeObject *T=&Type)
 ~TopoShapeFacePy ()

Static Public Member Functions

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

Static Public Attributes

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

callbacks and implementers for the python object methods



PyObjectcurvatureAt (PyObject *args)
 implementer for the curvatureAt() method
PyObjectderivative1At (PyObject *args)
 implementer for the derivative1At() method
PyObjectderivative2At (PyObject *args)
 implementer for the derivative2At() method
PyObjectisPartOfDomain (PyObject *args)
 implementer for the isPartOfDomain() method
PyObjectmakeHalfSpace (PyObject *args)
 implementer for the makeHalfSpace() method
PyObjectmakeOffset (PyObject *args)
 implementer for the makeOffset() method
PyObjectnormalAt (PyObject *args)
 implementer for the normalAt() method
PyObjectsetTolerance (PyObject *args)
 implementer for the setTolerance() method
PyObjecttangentAt (PyObject *args)
 implementer for the tangentAt() method
PyObjectvalueAt (PyObject *args)
 implementer for the valueAt() method
static PyObjectstaticCallback_curvatureAt (PyObject *self, PyObject *args)
 callback for the curvatureAt() method
static PyObjectstaticCallback_derivative1At (PyObject *self, PyObject *args)
 callback for the derivative1At() method
static PyObjectstaticCallback_derivative2At (PyObject *self, PyObject *args)
 callback for the derivative2At() method
static PyObjectstaticCallback_isPartOfDomain (PyObject *self, PyObject *args)
 callback for the isPartOfDomain() method
static PyObjectstaticCallback_makeHalfSpace (PyObject *self, PyObject *args)
 callback for the makeHalfSpace() method
static PyObjectstaticCallback_makeOffset (PyObject *self, PyObject *args)
 callback for the makeOffset() method
static PyObjectstaticCallback_normalAt (PyObject *self, PyObject *args)
 callback for the normalAt() method
static PyObjectstaticCallback_setTolerance (PyObject *self, PyObject *args)
 callback for the setTolerance() method
static PyObjectstaticCallback_tangentAt (PyObject *self, PyObject *args)
 callback for the tangentAt() method
static PyObjectstaticCallback_valueAt (PyObject *self, PyObject *args)
 callback for the valueAt() method

callbacks and implementers for the python object attributes



Py::Object getCenterOfMass (void) const
 getter for the CenterOfMass attribute
Py::Tuple getParameterRange (void) const
 getter for the ParameterRange attribute
Py::Object getSurface (void) const
 getter for the Surface attribute
Py::Object getWire (void) const
 getter for the Wire attribute
static PyObjectstaticCallback_getCenterOfMass (PyObject *self, void *closure)
 getter callback for the CenterOfMass attribute
static PyObjectstaticCallback_getParameterRange (PyObject *self, void *closure)
 getter callback for the ParameterRange attribute
static PyObjectstaticCallback_getSurface (PyObject *self, void *closure)
 getter callback for the Surface attribute
static PyObjectstaticCallback_getWire (PyObject *self, void *closure)
 getter callback for the Wire attribute
static int staticCallback_setCenterOfMass (PyObject *self, PyObject *value, void *closure)
 setter callback for the CenterOfMass attribute
static int staticCallback_setParameterRange (PyObject *self, PyObject *value, void *closure)
 setter callback for the ParameterRange attribute
static int staticCallback_setSurface (PyObject *self, PyObject *value, void *closure)
 setter callback for the Surface attribute
static int staticCallback_setWire (PyObject *self, PyObject *value, void *closure)
 setter callback for the Wire attribute

Detailed Description

The python export class for TopoShape.

Definition at line 20 of file TopoShapeFacePy.h.


Member Typedef Documentation

Reimplemented from Part::TopoShapePy.

Definition at line 36 of file TopoShapeFacePy.h.


Constructor & Destructor Documentation

TopoShapeFacePy::TopoShapeFacePy ( TopoShape pcObject,
PyTypeObject *  T = &Type 
)

Definition at line 1057 of file TopoShapeFacePy.cpp.

Referenced by PyMake().

TopoShapeFacePy::~TopoShapeFacePy (  ) 

Definition at line 1066 of file TopoShapeFacePy.cpp.


Member Function Documentation

PyObject * TopoShapeFacePy::_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::TopoShapePy.

Definition at line 1081 of file TopoShapeFacePy.cpp.

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

PyObject * TopoShapeFacePy::_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::TopoShapePy.

Definition at line 1073 of file TopoShapeFacePy.cpp.

References representation().

int TopoShapeFacePy::_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::TopoShapePy.

Definition at line 1149 of file TopoShapeFacePy.cpp.

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

PyObject * TopoShapeFacePy::curvatureAt ( PyObject args  ) 

implementer for the curvatureAt() method

Definition at line 290 of file TopoShapeFacePyImp.cpp.

References SketcherExample::f, getTopoShapePtr(), Py::new_reference_to(), and Py::Tuple::setItem().

PyObject * TopoShapeFacePy::derivative1At ( PyObject args  ) 

implementer for the derivative1At() method

Definition at line 313 of file TopoShapeFacePyImp.cpp.

References SketcherExample::f, getTopoShapePtr(), Py::new_reference_to(), and Py::Tuple::setItem().

PyObject * TopoShapeFacePy::derivative2At ( PyObject args  ) 

implementer for the derivative2At() method

Definition at line 338 of file TopoShapeFacePyImp.cpp.

References SketcherExample::f, getTopoShapePtr(), Py::new_reference_to(), and Py::Tuple::setItem().

Py::Object TopoShapeFacePy::getCenterOfMass ( void   )  const

getter for the CenterOfMass attribute

Definition at line 547 of file TopoShapeFacePyImp.cpp.

References getTopoShapePtr().

Referenced by staticCallback_getCenterOfMass().

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

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

Reimplemented from Part::TopoShapePy.

Definition at line 555 of file TopoShapeFacePyImp.cpp.

Referenced by _getattr().

Py::Tuple TopoShapeFacePy::getParameterRange ( void   )  const

getter for the ParameterRange attribute

Definition at line 516 of file TopoShapeFacePyImp.cpp.

References SketcherExample::f, getTopoShapePtr(), Py::Tuple::setItem(), RobotExample::t, and draftlibs::fcgeo::v1().

Referenced by staticCallback_getParameterRange().

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

Reimplemented from Part::TopoShapePy.

Definition at line 28 of file TopoShapeFacePy.h.

Py::Object TopoShapeFacePy::getSurface ( void   )  const
TopoShape * TopoShapeFacePy::getTopoShapePtr ( void   )  const
virtual PyTypeObject* Part::TopoShapeFacePy::GetType ( void   )  [inline, virtual]

Reimplemented from Part::TopoShapePy.

Definition at line 27 of file TopoShapeFacePy.h.

Py::Object TopoShapeFacePy::getWire ( void   )  const

getter for the Wire attribute

Definition at line 533 of file TopoShapeFacePyImp.cpp.

References Part::TopoShape::_Shape, and getTopoShapePtr().

Referenced by staticCallback_getWire().

PyObject * TopoShapeFacePy::isPartOfDomain ( PyObject args  ) 

implementer for the isPartOfDomain() method

Definition at line 363 of file TopoShapeFacePyImp.cpp.

References getTopoShapePtr().

PyObject * TopoShapeFacePy::makeHalfSpace ( PyObject args  ) 
PyObject * TopoShapeFacePy::makeOffset ( PyObject args  ) 
PyObject * TopoShapeFacePy::normalAt ( PyObject args  ) 

implementer for the normalAt() method

Definition at line 236 of file TopoShapeFacePyImp.cpp.

References SketcherExample::f, getTopoShapePtr(), and draftlibs::fcgeo::vec().

int TopoShapeFacePy::PyInit ( PyObject ,
PyObject  
) [virtual]

PyInit method Overide this method to initialize a newly created instance of the class (Constuctor).

Reimplemented from Part::TopoShapePy.

Definition at line 99 of file TopoShapeFacePyImp.cpp.

References Part::TopoShape::_Shape, Py::SeqBase< T >::begin(), Py::SeqBase< T >::end(), getTopoShapePtr(), StartPage::StartPage::handle(), Part::GeometryPy::Type, Part::TopoShapePy::Type, and Mesh2Shape::wires.

PyObject * TopoShapeFacePy::PyMake ( struct _typeobject *  ,
PyObject ,
PyObject  
) [static]

Reimplemented from Part::TopoShapePy.

Definition at line 92 of file TopoShapeFacePyImp.cpp.

References TopoShapeFacePy().

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

Reimplemented from Part::TopoShapePy.

Definition at line 84 of file TopoShapeFacePyImp.cpp.

References getTopoShapePtr().

Referenced by _repr().

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

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

Reimplemented from Part::TopoShapePy.

Definition at line 560 of file TopoShapeFacePyImp.cpp.

Referenced by _setattr().

PyObject * TopoShapeFacePy::setTolerance ( PyObject args  ) 

implementer for the setTolerance() method

Definition at line 415 of file TopoShapeFacePyImp.cpp.

References SketcherExample::f, getTopoShapePtr(), and Py_Return.

PyObject * TopoShapeFacePy::staticCallback_curvatureAt ( PyObject self,
PyObject args 
) [static]
PyObject * TopoShapeFacePy::staticCallback_derivative1At ( PyObject self,
PyObject args 
) [static]
PyObject * TopoShapeFacePy::staticCallback_derivative2At ( PyObject self,
PyObject args 
) [static]
PyObject * TopoShapeFacePy::staticCallback_getCenterOfMass ( PyObject self,
void *  closure 
) [static]

getter callback for the CenterOfMass attribute

Definition at line 1018 of file TopoShapeFacePy.cpp.

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

PyObject * TopoShapeFacePy::staticCallback_getParameterRange ( PyObject self,
void *  closure 
) [static]

getter callback for the ParameterRange attribute

Definition at line 922 of file TopoShapeFacePy.cpp.

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

PyObject * TopoShapeFacePy::staticCallback_getSurface ( PyObject self,
void *  closure 
) [static]

getter callback for the Surface attribute

Definition at line 954 of file TopoShapeFacePy.cpp.

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

PyObject * TopoShapeFacePy::staticCallback_getWire ( PyObject self,
void *  closure 
) [static]

getter callback for the Wire attribute

Definition at line 986 of file TopoShapeFacePy.cpp.

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

PyObject * TopoShapeFacePy::staticCallback_isPartOfDomain ( PyObject self,
PyObject args 
) [static]
PyObject * TopoShapeFacePy::staticCallback_makeHalfSpace ( PyObject self,
PyObject args 
) [static]
PyObject * TopoShapeFacePy::staticCallback_makeOffset ( PyObject self,
PyObject args 
) [static]
PyObject * TopoShapeFacePy::staticCallback_normalAt ( PyObject self,
PyObject args 
) [static]
int TopoShapeFacePy::staticCallback_setCenterOfMass ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the CenterOfMass attribute

Definition at line 1036 of file TopoShapeFacePy.cpp.

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

int TopoShapeFacePy::staticCallback_setParameterRange ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the ParameterRange attribute

Definition at line 940 of file TopoShapeFacePy.cpp.

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

int TopoShapeFacePy::staticCallback_setSurface ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Surface attribute

Definition at line 972 of file TopoShapeFacePy.cpp.

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

PyObject * TopoShapeFacePy::staticCallback_setTolerance ( PyObject self,
PyObject args 
) [static]
int TopoShapeFacePy::staticCallback_setWire ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Wire attribute

Definition at line 1004 of file TopoShapeFacePy.cpp.

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

PyObject * TopoShapeFacePy::staticCallback_tangentAt ( PyObject self,
PyObject args 
) [static]
PyObject * TopoShapeFacePy::staticCallback_valueAt ( PyObject self,
PyObject args 
) [static]
PyObject * TopoShapeFacePy::tangentAt ( PyObject args  ) 

implementer for the tangentAt() method

Definition at line 258 of file TopoShapeFacePyImp.cpp.

References SketcherExample::f, getTopoShapePtr(), Py::new_reference_to(), and Py::Tuple::setItem().

PyObject * TopoShapeFacePy::valueAt ( PyObject args  ) 

implementer for the valueAt() method

Definition at line 222 of file TopoShapeFacePyImp.cpp.

References SketcherExample::f, and getTopoShapePtr().


Member Data Documentation

PyGetSetDef TopoShapeFacePy::GetterSetter [static]
Initial value:
 {
    {"ParameterRange",
        (getter) staticCallback_getParameterRange,
        (setter) staticCallback_setParameterRange, 
        "Returns a 4 tuple with the parameter range",
        NULL
    },
    {"Surface",
        (getter) staticCallback_getSurface,
        (setter) staticCallback_setSurface, 
        "Returns the geometric surface of the face",
        NULL
    },
    {"Wire",
        (getter) staticCallback_getWire,
        (setter) staticCallback_setWire, 
        "The Wire of this face",
        NULL
    },
    {"CenterOfMass",
        (getter) staticCallback_getCenterOfMass,
        (setter) staticCallback_setCenterOfMass, 
        "\n                                     Returns the center of mass of the current system.\n                                     If the gravitational field is uniform, it is the center of gravity.\n                                   The coordinates returned for the center of mass are expressed in the\n                                  absolute Cartesian coordinate system.\n                         ",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of TopoShapeFacePy.

Reimplemented from Part::TopoShapePy.

Definition at line 25 of file TopoShapeFacePy.h.

PyMethodDef TopoShapeFacePy::Methods [static]

Methods structure of TopoShapeFacePy.

Reimplemented from Part::TopoShapePy.

Definition at line 24 of file TopoShapeFacePy.h.

Referenced by _getattr().

PyParentObject TopoShapeFacePy::Parents = { PARENTSPartTopoShapeFacePy } [static]

Reimplemented from Part::TopoShapePy.

Definition at line 26 of file TopoShapeFacePy.h.

PyTypeObject TopoShapeFacePy::Type [static]

Type structure of TopoShapeFacePy.

Reimplemented from Part::TopoShapePy.

Definition at line 23 of file TopoShapeFacePy.h.

Referenced by Part::TopoShapeShellPy::add(), initPart(), makeShell(), and Part::TopoShapeShellPy::PyInit().


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

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