Part::PlanePy Class Reference

The python export class for GeomPlane. More...

#include <PlanePy.h>

Public Types
typedef GeomPlane *	PointerType
Public Types inherited from Part::GeometrySurfacePy
typedef GeomSurface *	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)
	PlanePy (GeomPlane *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::GeometrySurfacePy
	GeometrySurfacePy (GeomSurface *pcObject, PyTypeObject *T=&Type)
std::string	representation (void) const
PyObject *	toShape (PyObject *args)
	implementer for the toShape() method More...
PyObject *	value (PyObject *args)
	implementer for the value() method More...
PyObject *	tangent (PyObject *args)
	implementer for the tangent() method More...
PyObject *	normal (PyObject *args)
	implementer for the normal() method More...
PyObject *	isUmbillic (PyObject *args)
	implementer for the isUmbillic() method More...
PyObject *	curvature (PyObject *args)
	implementer for the curvature() method More...
PyObject *	curvatureDirections (PyObject *args)
	implementer for the curvatureDirections() method More...
PyObject *	bounds (PyObject *args)
	implementer for the bounds() method More...
PyObject *	isPlanar (PyObject *args)
	implementer for the isPlanar() method More...
PyObject *	uIso (PyObject *args)
	implementer for the uIso() method More...
PyObject *	vIso (PyObject *args)
	implementer for the vIso() method More...
PyObject *	isUPeriodic (PyObject *args)
	implementer for the isUPeriodic() method More...
PyObject *	isVPeriodic (PyObject *args)
	implementer for the isVPeriodic() method More...
PyObject *	isUClosed (PyObject *args)
	implementer for the isUClosed() method More...
PyObject *	isVClosed (PyObject *args)
	implementer for the isVClosed() method More...
PyObject *	UPeriod (PyObject *args)
	implementer for the UPeriod() method More...
PyObject *	VPeriod (PyObject *args)
	implementer for the VPeriod() method More...
PyObject *	parameter (PyObject *args)
	implementer for the parameter() method More...
PyObject *	toBSpline (PyObject *args)
	implementer for the toBSpline() method More...
PyObject *	intersect (PyObject *args)
	implementer for the intersect() method More...
PyObject *	intersectSS (PyObject *args)
	implementer for the intersectSS() method More...
Py::String	getContinuity (void) const
	getter for the Continuity 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...
GeomSurface *	getGeomSurfacePtr (void) const
	getter for the object handled by this class More...
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::GeometrySurfacePy
static PyObject *	PyMake (struct _typeobject *, PyObject *, PyObject *)
static PyObject *	staticCallback_toShape (PyObject *self, PyObject *args)
	callback for the toShape() method More...
static PyObject *	staticCallback_value (PyObject *self, PyObject *args)
	callback for the value() method More...
static PyObject *	staticCallback_tangent (PyObject *self, PyObject *args)
	callback for the tangent() method More...
static PyObject *	staticCallback_normal (PyObject *self, PyObject *args)
	callback for the normal() method More...
static PyObject *	staticCallback_isUmbillic (PyObject *self, PyObject *args)
	callback for the isUmbillic() method More...
static PyObject *	staticCallback_curvature (PyObject *self, PyObject *args)
	callback for the curvature() method More...
static PyObject *	staticCallback_curvatureDirections (PyObject *self, PyObject *args)
	callback for the curvatureDirections() method More...
static PyObject *	staticCallback_bounds (PyObject *self, PyObject *args)
	callback for the bounds() method More...
static PyObject *	staticCallback_isPlanar (PyObject *self, PyObject *args)
	callback for the isPlanar() method More...
static PyObject *	staticCallback_uIso (PyObject *self, PyObject *args)
	callback for the uIso() method More...
static PyObject *	staticCallback_vIso (PyObject *self, PyObject *args)
	callback for the vIso() method More...
static PyObject *	staticCallback_isUPeriodic (PyObject *self, PyObject *args)
	callback for the isUPeriodic() method More...
static PyObject *	staticCallback_isVPeriodic (PyObject *self, PyObject *args)
	callback for the isVPeriodic() method More...
static PyObject *	staticCallback_isUClosed (PyObject *self, PyObject *args)
	callback for the isUClosed() method More...
static PyObject *	staticCallback_isVClosed (PyObject *self, PyObject *args)
	callback for the isVClosed() method More...
static PyObject *	staticCallback_UPeriod (PyObject *self, PyObject *args)
	callback for the UPeriod() method More...
static PyObject *	staticCallback_VPeriod (PyObject *self, PyObject *args)
	callback for the VPeriod() method More...
static PyObject *	staticCallback_parameter (PyObject *self, PyObject *args)
	callback for the parameter() method More...
static PyObject *	staticCallback_toBSpline (PyObject *self, PyObject *args)
	callback for the toBSpline() method More...
static PyObject *	staticCallback_intersect (PyObject *self, PyObject *args)
	callback for the intersect() method More...
static PyObject *	staticCallback_intersectSS (PyObject *self, PyObject *args)
	callback for the intersectSS() method More...
static PyObject *	staticCallback_getContinuity (PyObject *self, void *closure)
	getter callback for the Continuity attribute More...
static int	staticCallback_setContinuity (PyObject *self, PyObject *value, void *closure)
	setter callback for the Continuity attribute More...
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 PlanePy. More...
static PyMethodDef	Methods []
	Methods structure of PlanePy. More...
static PyTypeObject	Type
	Type structure of PlanePy. More...
Static Public Attributes inherited from Part::GeometrySurfacePy
static PyGetSetDef	GetterSetter []
	Attribute structure of GeometrySurfacePy. More...
static PyMethodDef	Methods []
	Methods structure of GeometrySurfacePy. More...
static PyTypeObject	Type
	Type structure of GeometrySurfacePy. 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
	~PlanePy ()
Protected Member Functions inherited from Part::GeometrySurfacePy
	~GeometrySurfacePy ()
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 *	uIso (PyObject *args)
	implementer for the uIso() method More...
PyObject *	vIso (PyObject *args)
	implementer for the vIso() method More...
static PyObject *	staticCallback_uIso (PyObject *self, PyObject *args)
	callback for the uIso() method More...
static PyObject *	staticCallback_vIso (PyObject *self, PyObject *args)
	callback for the vIso() method More...

callbacks and implementers for the python object attributes
Py::Object	getPosition (void) const
	getter for the Position attribute More...
void	setPosition (Py::Object arg)
	setter for the Position attribute More...
Py::Object	getAxis (void) const
	getter for the Axis attribute More...
void	setAxis (Py::Object arg)
	setter for the Axis 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...
GeomPlane *	getGeomPlanePtr (void) const
	getter for the object handled by this class More...
static PyObject *	staticCallback_getPosition (PyObject *self, void *closure)
	getter callback for the Position attribute More...
static int	staticCallback_setPosition (PyObject *self, PyObject *value, void *closure)
	setter callback for the Position attribute More...
static PyObject *	staticCallback_getAxis (PyObject *self, void *closure)
	getter callback for the Axis attribute More...
static int	staticCallback_setAxis (PyObject *self, PyObject *value, void *closure)
	setter callback for the Axis attribute More...

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

Detailed Description

The python export class for GeomPlane.

Member Typedef Documentation

PointerType

typedef GeomPlane* Part::PlanePy::PointerType

Constructor & Destructor Documentation

~PlanePy()

PlanePy::~PlanePy ( )

protected

PlanePy()

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

Referenced by PyMake().

Member Function Documentation

getAxis()

Py::Object PlanePy::getAxis

(

void

)

const

getter for the Axis attribute

References Part::GeometryPy::getGeometryPtr().

Referenced by staticCallback_getAxis().

getCustomAttributes()

PyObject * PlanePy::getCustomAttributes

(

const char *

attr

)

const

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

getGeomPlanePtr()

GeomPlane * PlanePy::getGeomPlanePtr

(

void

)

const

getter for the object handled by this class

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

getPosition()

Py::Object PlanePy::getPosition

(

void

)

const

getter for the Position attribute

References getGeomPlanePtr().

Referenced by staticCallback_getPosition().

GetType()

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

virtual

Reimplemented from Part::GeometrySurfacePy.

PyInit()

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

virtual

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

Reimplemented from Part::GeometrySurfacePy.

References DraftVecUtils::dist(), Part::GeometryPy::getGeometryPtr(), Part::PartExceptionOCCError, Type, Base::VectorPy::Type, and Part::GeometrySurfacePy::value().

PyMake()

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

static

References PlanePy().

representation()

std::string PlanePy::representation

(

void

)

const

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().

setAxis()

void PlanePy::setAxis

(

Py::Object

arg

)

setter for the Axis attribute

References Part::GeometryPy::getGeometryPtr(), Base::VectorPy::Type, and Part::GeometrySurfacePy::value().

Referenced by staticCallback_setAxis().

setCustomAttributes()

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

setter for special attributes (e.g.

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

setPosition()

void PlanePy::setPosition

(

Py::Object

arg

)

setter for the Position attribute

References getGeomPlanePtr(), Base::VectorPy::Type, and Part::GeometrySurfacePy::value().

Referenced by staticCallback_setPosition().

staticCallback_getAxis()

PyObject * PlanePy::staticCallback_getAxis ( PyObject *  self, void *  closure  )

static

getter callback for the Axis attribute

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

staticCallback_getPosition()

PyObject * PlanePy::staticCallback_getPosition ( PyObject *  self, void *  closure  )

static

getter callback for the Position attribute

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

staticCallback_setAxis()

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

static

setter callback for the Axis attribute

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

staticCallback_setPosition()

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

static

setter callback for the Position attribute

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

staticCallback_uIso()

PyObject * PlanePy::staticCallback_uIso ( PyObject *  self, PyObject *  args  )

static

callback for the uIso() method

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

staticCallback_vIso()

PyObject * PlanePy::staticCallback_vIso ( PyObject *  self, PyObject *  args  )

static

callback for the vIso() method

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

uIso()

PyObject * PlanePy::uIso

(

PyObject *

args

)

implementer for the uIso() method

References getGeomPlanePtr(), and Part::PartExceptionOCCError.

Referenced by staticCallback_uIso().

vIso()

PyObject * PlanePy::vIso

(

PyObject *

args

)

implementer for the vIso() method

References getGeomPlanePtr(), and Part::PartExceptionOCCError.

Referenced by staticCallback_vIso().

Member Data Documentation

GetterSetter

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.

Methods

PyMethodDef PlanePy::Methods

static

Initial value:

= {
    {"uIso",
        reinterpret_cast<PyCFunction>( staticCallback_uIso ),
        METH_VARARGS,
        "Builds the U isoparametric line of this plane"
    },
    {"vIso",
        reinterpret_cast<PyCFunction>( staticCallback_vIso ),
        METH_VARARGS,
        "Builds the V isoparametric line of this plane"
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of PlanePy.

Type

PyTypeObject PlanePy::Type

static

Type structure of PlanePy.

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

---

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

• build/webdoc/src/Mod/Part/App/PlanePy.h
• src/Mod/Part/App/PlanePyImp.cpp
• build/webdoc/src/Mod/Part/App/PlanePy.cpp