Part::GeometryPy Class Reference

The python export class for Geometry. More...

#include <GeometryPy.h>

Inheritance diagram for Part::GeometryPy:

Public Types
typedef Geometry *	PointerType
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.
	GeometryPy (Geometry pcObject, PyTypeObject T=&Type)
PyObject *	getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones)
Geometry *	getGeometryPtr (void) const
	getter for the object handled by this class
virtual PyParentObject *	GetParents (void)
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)
	~GeometryPy ()
Static Public Member Functions
static PyObject *	PyMake (struct _typeobject , PyObject , PyObject *)
Static Public Attributes
static PyGetSetDef	GetterSetter []
	Attribute structure of GeometryPy.
static PyMethodDef	Methods []
	Methods structure of GeometryPy.
static PyParentObject	Parents [] = { PARENTSPartGeometryPy }
static PyTypeObject	Type
	Type structure of GeometryPy.
callbacks and implementers for the python object attributes

Py::Boolean	getConstruction (void) const
	getter for the Construction attribute
void	setConstruction (Py::Boolean arg)
	setter for the Construction attribute
static PyObject *	staticCallback_getConstruction (PyObject self, void closure)
	getter callback for the Construction attribute
static int	staticCallback_setConstruction (PyObject self, PyObject value, void *closure)
	setter callback for the Construction attribute
callbacks and implementers for the python object methods

PyObject *	mirror (PyObject *args)
	implementer for the mirror() method
PyObject *	rotate (PyObject *args)
	implementer for the rotate() method
PyObject *	scale (PyObject *args)
	implementer for the scale() method
PyObject *	transform (PyObject *args)
	implementer for the transform() method
PyObject *	translate (PyObject *args)
	implementer for the translate() method
static PyObject *	staticCallback_mirror (PyObject self, PyObject args)
	callback for the mirror() method
static PyObject *	staticCallback_rotate (PyObject self, PyObject args)
	callback for the rotate() method
static PyObject *	staticCallback_scale (PyObject self, PyObject args)
	callback for the scale() method
static PyObject *	staticCallback_transform (PyObject self, PyObject args)
	callback for the transform() method
static PyObject *	staticCallback_translate (PyObject self, PyObject args)
	callback for the translate() method

Detailed Description

The python export class for Geometry.

Definition at line 20 of file GeometryPy.h.

Member Typedef Documentation

typedef Geometry* Part::GeometryPy::PointerType

Reimplemented from Base::PyObjectBase.

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 36 of file GeometryPy.h.

Constructor & Destructor Documentation

GeometryPy::GeometryPy	(	Geometry *	pcObject,
		PyTypeObject *	T = `&Type`
	)

Definition at line 553 of file GeometryPy.cpp.

GeometryPy::~GeometryPy ( )

Definition at line 562 of file GeometryPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Member Function Documentation

PyObject * GeometryPy::_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 Base::PyObjectBase.

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 580 of file GeometryPy.cpp.

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

PyObject * GeometryPy::_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 Base::PyObjectBase.

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 572 of file GeometryPy.cpp.

References representation().

int GeometryPy::_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 Base::PyObjectBase.

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 648 of file GeometryPy.cpp.

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

Py::Boolean GeometryPy::getConstruction ( void ) const

getter for the Construction attribute

Definition at line 182 of file GeometryPyImp.cpp.

References getGeometryPtr().

Referenced by staticCallback_getConstruction().

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

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

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 192 of file GeometryPyImp.cpp.

Referenced by _getattr().

Geometry * GeometryPy::getGeometryPtr ( void ) const

getter for the object handled by this class

Definition at line 707 of file GeometryPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

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

Reimplemented from Base::PyObjectBase.

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 28 of file GeometryPy.h.

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

Reimplemented from Base::PyObjectBase.

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 27 of file GeometryPy.h.

PyObject * GeometryPy::mirror ( PyObject * args )

implementer for the mirror() method

Definition at line 76 of file GeometryPyImp.cpp.

References getGeometryPtr(), Part::Geometry::handle(), Py_Return, Base::VectorPy::Type, Py::value(), draftlibs::fcgeo::vec(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

int GeometryPy::PyInit	(	PyObject *	,
		PyObject *
	)			`[virtual]`

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

Reimplemented from Base::PyObjectBase.

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 71 of file GeometryPyImp.cpp.

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

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

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 57 of file GeometryPyImp.cpp.

Referenced by _repr().

PyObject * GeometryPy::rotate ( PyObject * args )

implementer for the rotate() method

Definition at line 101 of file GeometryPyImp.cpp.

References draftlibs::fcvec::angle(), getGeometryPtr(), Base::Placement::getPosition(), Base::Placement::getRotation(), Part::Geometry::handle(), Py_Return, and Base::PlacementPy::Type.

PyObject * GeometryPy::scale ( PyObject * args )

implementer for the scale() method

Definition at line 120 of file GeometryPyImp.cpp.

References getGeometryPtr(), Part::Geometry::handle(), Py_Return, Base::VectorPy::Type, Py::value(), draftlibs::fcgeo::vec(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

void GeometryPy::setConstruction ( Py::Boolean arg )

setter for the Construction attribute

Definition at line 187 of file GeometryPyImp.cpp.

References Part::Geometry::Construction, and getGeometryPtr().

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

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

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 197 of file GeometryPyImp.cpp.

Referenced by _setattr().

PyObject * GeometryPy::staticCallback_getConstruction	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the Construction attribute

Definition at line 502 of file GeometryPy.cpp.

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

PyObject * GeometryPy::staticCallback_mirror	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the mirror() method

Definition at line 122 of file GeometryPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * GeometryPy::staticCallback_rotate	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the rotate() method

Definition at line 198 of file GeometryPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * GeometryPy::staticCallback_scale	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the scale() method

Definition at line 274 of file GeometryPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

int GeometryPy::staticCallback_setConstruction	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the Construction attribute

Definition at line 520 of file GeometryPy.cpp.

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

PyObject * GeometryPy::staticCallback_transform	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the transform() method

Definition at line 350 of file GeometryPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * GeometryPy::staticCallback_translate	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the translate() method

Definition at line 426 of file GeometryPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * GeometryPy::transform ( PyObject * args )

implementer for the transform() method

Definition at line 144 of file GeometryPyImp.cpp.

References getGeometryPtr(), Part::Geometry::handle(), Py_Return, Base::MatrixPy::Type, and Py::value().

PyObject * GeometryPy::translate ( PyObject * args )

implementer for the translate() method

Definition at line 159 of file GeometryPyImp.cpp.

References getGeometryPtr(), Part::Geometry::handle(), Py_Return, Base::VectorPy::Type, Py::value(), draftlibs::fcgeo::vec(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

Member Data Documentation

PyGetSetDef GeometryPy::GetterSetter [static]

Initial value:

 {
    {"Construction",
        (getter) staticCallback_getConstruction,
        (setter) staticCallback_setConstruction, 
        "Defines this geometry as a construction one which\nmeans that it is not part of a later built shape.",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of GeometryPy.

Reimplemented in Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::GeometryCurvePy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, and Part::ToroidPy.

Definition at line 25 of file GeometryPy.h.

PyMethodDef GeometryPy::Methods [static]

Initial value:

 {
    {"mirror",
        (PyCFunction) staticCallback_mirror,
        METH_VARARGS,
        "Performs the symmetrical transformation of this geometric object"
    },
    {"rotate",
        (PyCFunction) staticCallback_rotate,
        METH_VARARGS,
        "Rotates this geometric object at angle Ang (in radians) about axis"
    },
    {"scale",
        (PyCFunction) staticCallback_scale,
        METH_VARARGS,
        "Applies a scaling transformation on this geometric object with a center and scaling factor"
    },
    {"transform",
        (PyCFunction) staticCallback_transform,
        METH_VARARGS,
        "Applies a transformation to this geometric object"
    },
    {"translate",
        (PyCFunction) staticCallback_translate,
        METH_VARARGS,
        "Translates this geometric object"
    },
    {NULL, NULL, 0, NULL}               
}