Part::PointPy Class Reference

The python export class for GeomPoint. More...

#include <PointPy.h>

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

Public Member Functions
virtual PyTypeObject * GetType (void)
PointPy (GeomPoint *pcObject, PyTypeObject *T=&Type)
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 Part::GeometryPy
GeometryPy (Geometry *pcObject, PyTypeObject *T=&Type)
std::string representation (void) const
PyObject * mirror (PyObject *args)
	implementer for the mirror() method More...
PyObject * rotate (PyObject *args)
	implementer for the rotate() method More...
PyObject * scale (PyObject *args)
	implementer for the scale() method More...
PyObject * transform (PyObject *args)
	implementer for the transform() method More...
PyObject * translate (PyObject *args)
	implementer for the translate() method More...
PyObject * copy (PyObject *args)
	implementer for the copy() method More...
PyObject * clone (PyObject *args)
	implementer for the clone() method More...
PyObject * hasExtensionOfType (PyObject *args)
	implementer for the hasExtensionOfType() method More...
PyObject * hasExtensionOfName (PyObject *args)
	implementer for the hasExtensionOfName() method More...
PyObject * getExtensionOfType (PyObject *args)
	implementer for the getExtensionOfType() method More...
PyObject * getExtensionOfName (PyObject *args)
	implementer for the getExtensionOfName() method More...
PyObject * setExtension (PyObject *args)
	implementer for the setExtension() method More...
PyObject * deleteExtensionOfType (PyObject *args)
	implementer for the deleteExtensionOfType() method More...
PyObject * deleteExtensionOfName (PyObject *args)
	implementer for the deleteExtensionOfName() method More...
PyObject * getExtensions (PyObject *args)
	implementer for the getExtensions() method More...
Py::Boolean getConstruction (void) const
	getter for the Construction attribute More...
void setConstruction (Py::Boolean arg)
	setter for the Construction attribute More...
Py::String getTag (void) const
	getter for the Tag attribute More...
PyObject * getCustomAttributes (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...
Geometry * getGeometryPtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from Base::PyObjectBase
PyObjectBase * DecRef (void)
	decref method wrapper (see python extending manual) More...
PyObjectBase * IncRef (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 PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
Static Public Member Functions inherited from Part::GeometryPy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
static PyObject * staticCallback_mirror (PyObject *self, PyObject *args)
	callback for the mirror() method More...
static PyObject * staticCallback_rotate (PyObject *self, PyObject *args)
	callback for the rotate() method More...
static PyObject * staticCallback_scale (PyObject *self, PyObject *args)
	callback for the scale() method More...
static PyObject * staticCallback_transform (PyObject *self, PyObject *args)
	callback for the transform() method More...
static PyObject * staticCallback_translate (PyObject *self, PyObject *args)
	callback for the translate() method More...
static PyObject * staticCallback_copy (PyObject *self, PyObject *args)
	callback for the copy() method More...
static PyObject * staticCallback_clone (PyObject *self, PyObject *args)
	callback for the clone() method More...
static PyObject * staticCallback_hasExtensionOfType (PyObject *self, PyObject *args)
	callback for the hasExtensionOfType() method More...
static PyObject * staticCallback_hasExtensionOfName (PyObject *self, PyObject *args)
	callback for the hasExtensionOfName() method More...
static PyObject * staticCallback_getExtensionOfType (PyObject *self, PyObject *args)
	callback for the getExtensionOfType() method More...
static PyObject * staticCallback_getExtensionOfName (PyObject *self, PyObject *args)
	callback for the getExtensionOfName() method More...
static PyObject * staticCallback_setExtension (PyObject *self, PyObject *args)
	callback for the setExtension() method More...
static PyObject * staticCallback_deleteExtensionOfType (PyObject *self, PyObject *args)
	callback for the deleteExtensionOfType() method More...
static PyObject * staticCallback_deleteExtensionOfName (PyObject *self, PyObject *args)
	callback for the deleteExtensionOfName() method More...
static PyObject * staticCallback_getExtensions (PyObject *self, PyObject *args)
	callback for the getExtensions() method More...
static PyObject * staticCallback_getConstruction (PyObject *self, void *closure)
	getter callback for the Construction attribute More...
static int staticCallback_setConstruction (PyObject *self, PyObject *value, void *closure)
	setter callback for the Construction attribute More...
static PyObject * staticCallback_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 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 PointPy. More...
static PyMethodDef Methods []
	Methods structure of PointPy. More...
static PyTypeObject Type
	Type structure of PointPy. More...
Static Public Attributes inherited from Part::GeometryPy
static PyGetSetDef GetterSetter []
	Attribute structure of GeometryPy. More...
static PyMethodDef Methods []
	Methods structure of GeometryPy. More...
static PyTypeObject Type
	Type structure of GeometryPy. More...
Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
static PyTypeObject Type
	Py_Header struct from python.h. More...

Protected Member Functions
~PointPy ()
Protected Member Functions inherited from Part::GeometryPy
~GeometryPy ()
Protected Member Functions inherited from Base::PyObjectBase
virtual ~PyObjectBase ()
	destructor More...

callbacks and implementers for the python object methods
PyObject * toShape (PyObject *args)
	implementer for the toShape() method More...
static PyObject * staticCallback_toShape (PyObject *self, PyObject *args)
	callback for the toShape() method More...

callbacks and implementers for the python object attributes
Py::Float getX (void) const
	getter for the X attribute More...
void setX (Py::Float arg)
	setter for the X attribute More...
Py::Float getY (void) const
	getter for the Y attribute More...
void setY (Py::Float arg)
	setter for the Y attribute More...
Py::Float getZ (void) const
	getter for the Z attribute More...
void setZ (Py::Float arg)
	setter for the Z attribute More...
PyObject * getCustomAttributes (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...
GeomPoint * getGeomPointPtr (void) const
	getter for the object handled by this class More...
static PyObject * staticCallback_getX (PyObject *self, void *closure)
	getter callback for the X attribute More...
static int staticCallback_setX (PyObject *self, PyObject *value, void *closure)
	setter callback for the X attribute More...
static PyObject * staticCallback_getY (PyObject *self, void *closure)
	getter callback for the Y attribute More...
static int staticCallback_setY (PyObject *self, PyObject *value, void *closure)
	setter callback for the Y attribute More...
static PyObject * staticCallback_getZ (PyObject *self, void *closure)
	getter callback for the Z attribute More...
static int staticCallback_setZ (PyObject *self, PyObject *value, void *closure)
	setter callback for the Z attribute More...

Additional Inherited Members
Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 > StatusBits

Detailed Description

The python export class for GeomPoint.

Member Typedef Documentation

PointerType

typedef GeomPoint* Part::PointPy::PointerType

Constructor & Destructor Documentation

~PointPy()

PointPy::~PointPy ( )

protected

PointPy()

PointPy::PointPy	(	GeomPoint *	pcObject,
		PyTypeObject *	T = &Type
	)

Referenced by PyMake().

Member Function Documentation

getCustomAttributes()

PyObject * PointPy::getCustomAttributes

(

const char *

attr

)

const

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

getGeomPointPtr()

GeomPoint * PointPy::getGeomPointPtr

(

void

)

const

getter for the object handled by this class

Referenced by getX(), getY(), getZ(), PyInit(), representation(), setX(), setY(), setZ(), and toShape().

GetType()

virtual PyTypeObject* Part::PointPy::GetType ( void  )

virtual

Reimplemented from Part::GeometryPy.

getX()

Py::Float PointPy::getX

(

void

)

const

getter for the X attribute

References getGeomPointPtr().

Referenced by staticCallback_getX().

getY()

Py::Float PointPy::getY

(

void

)

const

getter for the Y attribute

References getGeomPointPtr().

Referenced by staticCallback_getY().

getZ()

Py::Float PointPy::getZ

(

void

)

const

getter for the Z attribute

References getGeomPointPtr().

Referenced by staticCallback_getZ().

PyInit()

int PointPy::PyInit ( PyObject *  , PyObject *    )

virtual

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

Reimplemented from Part::GeometryPy.

References getGeomPointPtr(), Base::VectorPy::Type, and Type.

PyMake()

PyObject * PointPy::PyMake ( struct _typeobject *  , PyObject *  , PyObject *    )

static

References PointPy().

representation()

std::string PointPy::representation

(

void

)

const

References getGeomPointPtr(), and Part::GeomPoint::getPoint().

Referenced by config_control_design.pcurve::wr1(), config_control_design.degenerate_pcurve::wr1(), automotive_design.motion_link_relationship::wr1(), automotive_design.pcurve::wr1(), automotive_design.degenerate_pcurve::wr1(), config_control_design.pcurve::wr2(), config_control_design.degenerate_pcurve::wr2(), automotive_design.pcurve::wr2(), and automotive_design.degenerate_pcurve::wr2().

setCustomAttributes()

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

setter for special attributes (e.g.

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

setX()

void PointPy::setX

(

Py::Float

arg

)

setter for the X attribute

References getGeomPointPtr().

Referenced by staticCallback_setX().

setY()

void PointPy::setY

(

Py::Float

arg

)

setter for the Y attribute

References getGeomPointPtr().

Referenced by staticCallback_setY().

setZ()

void PointPy::setZ

(

Py::Float

arg

)

setter for the Z attribute

References getGeomPointPtr().

Referenced by staticCallback_setZ().

staticCallback_getX()

PyObject * PointPy::staticCallback_getX ( PyObject *  self, void *  closure  )

static

getter callback for the X attribute

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

staticCallback_getY()

PyObject * PointPy::staticCallback_getY ( PyObject *  self, void *  closure  )

static

getter callback for the Y attribute

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

staticCallback_getZ()

PyObject * PointPy::staticCallback_getZ ( PyObject *  self, void *  closure  )

static

getter callback for the Z attribute

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

staticCallback_setX()

int PointPy::staticCallback_setX ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the X attribute

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

staticCallback_setY()

int PointPy::staticCallback_setY ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Y attribute

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

staticCallback_setZ()

int PointPy::staticCallback_setZ ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Z attribute

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

staticCallback_toShape()

PyObject * PointPy::staticCallback_toShape ( PyObject *  self, PyObject *  args  )

static

callback for the toShape() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and toShape().

toShape()

PyObject * PointPy::toShape

(

PyObject *

args

)

implementer for the toShape() method

References getGeomPointPtr(), and Part::PartExceptionOCCError.

Referenced by staticCallback_toShape().

Member Data Documentation

GetterSetter

PyGetSetDef PointPy::GetterSetter

static

Initial value:

= {
    {"X",
        (getter) staticCallback_getX,
        (setter) staticCallback_setX, 
        "X component of this point.",
        NULL
    },
    {"Y",
        (getter) staticCallback_getY,
        (setter) staticCallback_setY, 
        "Y component of this point.",
        NULL
    },
    {"Z",
        (getter) staticCallback_getZ,
        (setter) staticCallback_setZ, 
        "Z component of this point.",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of PointPy.

Methods

PyMethodDef PointPy::Methods

static

Initial value:

= {
    {"toShape",
        reinterpret_cast<PyCFunction>( staticCallback_toShape ),
        METH_VARARGS,
        "Create a vertex from this point."
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of PointPy.

Type

PyTypeObject PointPy::Type

static

Type structure of PointPy.

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), Part::TopoShapeVertexPy::PyInit(), and PyInit().

---

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

• build/webdoc/src/Mod/Part/App/PointPy.h
• src/Mod/Part/App/PointPyImp.cpp
• build/webdoc/src/Mod/Part/App/PointPy.cpp