Part::LinePy Class Reference

The python export class for GeomLine. More...

#include <LinePy.h>

Public Types
typedef GeomLine *	PointerType
Public Types inherited from Part::GeometryCurvePy
typedef GeomCurve *	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)
	LinePy (GeomLine *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::GeometryCurvePy
	GeometryCurvePy (GeomCurve *pcObject, PyTypeObject *T=&Type)
std::string	representation (void) const
PyObject *	toShape (PyObject *args)
	implementer for the toShape() method More...
PyObject *	discretize (PyObject *args, PyObject *kwd)
	implementer for the discretize() method More...
PyObject *	length (PyObject *args)
	implementer for the length() method More...
PyObject *	parameterAtDistance (PyObject *args)
	implementer for the parameterAtDistance() method More...
PyObject *	value (PyObject *args)
	implementer for the value() method More...
PyObject *	tangent (PyObject *args)
	implementer for the tangent() method More...
PyObject *	makeRuledSurface (PyObject *args)
	implementer for the makeRuledSurface() method More...
PyObject *	intersect2d (PyObject *args)
	implementer for the intersect2d() method More...
PyObject *	parameter (PyObject *args)
	implementer for the parameter() method More...
PyObject *	normal (PyObject *args)
	implementer for the normal() method More...
PyObject *	curvature (PyObject *args)
	implementer for the curvature() method More...
PyObject *	centerOfCurvature (PyObject *args)
	implementer for the centerOfCurvature() method More...
PyObject *	intersect (PyObject *args)
	implementer for the intersect() method More...
PyObject *	intersectCS (PyObject *args)
	implementer for the intersectCS() method More...
PyObject *	intersectCC (PyObject *args)
	implementer for the intersectCC() method More...
PyObject *	toBSpline (PyObject *args)
	implementer for the toBSpline() method More...
PyObject *	toNurbs (PyObject *args)
	implementer for the toNurbs() method More...
PyObject *	trim (PyObject *args)
	implementer for the trim() method More...
PyObject *	approximateBSpline (PyObject *args)
	implementer for the approximateBSpline() method More...
PyObject *	reverse (PyObject *args)
	implementer for the reverse() method More...
PyObject *	reversedParameter (PyObject *args)
	implementer for the reversedParameter() method More...
PyObject *	isPeriodic (PyObject *args)
	implementer for the isPeriodic() method More...
PyObject *	period (PyObject *args)
	implementer for the period() method More...
PyObject *	isClosed (PyObject *args)
	implementer for the isClosed() method More...
Py::String	getContinuity (void) const
	getter for the Continuity attribute More...
Py::Float	getFirstParameter (void) const
	getter for the FirstParameter attribute More...
Py::Float	getLastParameter (void) const
	getter for the LastParameter 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...
GeomCurve *	getGeomCurvePtr (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::GeometryCurvePy
static PyObject *	PyMake (struct _typeobject *, PyObject *, PyObject *)
static PyObject *	staticCallback_toShape (PyObject *self, PyObject *args)
	callback for the toShape() method More...
static PyObject *	staticCallback_discretize (PyObject *self, PyObject *args, PyObject *kwd)
	callback for the discretize() method More...
static PyObject *	staticCallback_length (PyObject *self, PyObject *args)
	callback for the length() method More...
static PyObject *	staticCallback_parameterAtDistance (PyObject *self, PyObject *args)
	callback for the parameterAtDistance() 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_makeRuledSurface (PyObject *self, PyObject *args)
	callback for the makeRuledSurface() method More...
static PyObject *	staticCallback_intersect2d (PyObject *self, PyObject *args)
	callback for the intersect2d() method More...
static PyObject *	staticCallback_parameter (PyObject *self, PyObject *args)
	callback for the parameter() method More...
static PyObject *	staticCallback_normal (PyObject *self, PyObject *args)
	callback for the normal() method More...
static PyObject *	staticCallback_curvature (PyObject *self, PyObject *args)
	callback for the curvature() method More...
static PyObject *	staticCallback_centerOfCurvature (PyObject *self, PyObject *args)
	callback for the centerOfCurvature() method More...
static PyObject *	staticCallback_intersect (PyObject *self, PyObject *args)
	callback for the intersect() method More...
static PyObject *	staticCallback_intersectCS (PyObject *self, PyObject *args)
	callback for the intersectCS() method More...
static PyObject *	staticCallback_intersectCC (PyObject *self, PyObject *args)
	callback for the intersectCC() method More...
static PyObject *	staticCallback_toBSpline (PyObject *self, PyObject *args)
	callback for the toBSpline() method More...
static PyObject *	staticCallback_toNurbs (PyObject *self, PyObject *args)
	callback for the toNurbs() method More...
static PyObject *	staticCallback_trim (PyObject *self, PyObject *args)
	callback for the trim() method More...
static PyObject *	staticCallback_approximateBSpline (PyObject *self, PyObject *args)
	callback for the approximateBSpline() method More...
static PyObject *	staticCallback_reverse (PyObject *self, PyObject *args)
	callback for the reverse() method More...
static PyObject *	staticCallback_reversedParameter (PyObject *self, PyObject *args)
	callback for the reversedParameter() method More...
static PyObject *	staticCallback_isPeriodic (PyObject *self, PyObject *args)
	callback for the isPeriodic() method More...
static PyObject *	staticCallback_period (PyObject *self, PyObject *args)
	callback for the period() method More...
static PyObject *	staticCallback_isClosed (PyObject *self, PyObject *args)
	callback for the isClosed() 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 PyObject *	staticCallback_getFirstParameter (PyObject *self, void *closure)
	getter callback for the FirstParameter attribute More...
static int	staticCallback_setFirstParameter (PyObject *self, PyObject *value, void *closure)
	setter callback for the FirstParameter attribute More...
static PyObject *	staticCallback_getLastParameter (PyObject *self, void *closure)
	getter callback for the LastParameter attribute More...
static int	staticCallback_setLastParameter (PyObject *self, PyObject *value, void *closure)
	setter callback for the LastParameter 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 LinePy. More...
static PyMethodDef	Methods []
	Methods structure of LinePy. More...
static PyTypeObject	Type
	Type structure of LinePy. More...
Static Public Attributes inherited from Part::GeometryCurvePy
static PyGetSetDef	GetterSetter []
	Attribute structure of GeometryCurvePy. More...
static PyMethodDef	Methods []
	Methods structure of GeometryCurvePy. More...
static PyTypeObject	Type
	Type structure of GeometryCurvePy. 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
	~LinePy ()
Protected Member Functions inherited from Part::GeometryCurvePy
	~GeometryCurvePy ()
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 attributes
Py::Object	getLocation (void) const
	getter for the Location attribute More...
void	setLocation (Py::Object arg)
	setter for the Location attribute More...
Py::Object	getDirection (void) const
	getter for the Direction attribute More...
void	setDirection (Py::Object arg)
	setter for the Direction 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...
GeomLine *	getGeomLinePtr (void) const
	getter for the object handled by this class More...
static PyObject *	staticCallback_getLocation (PyObject *self, void *closure)
	getter callback for the Location attribute More...
static int	staticCallback_setLocation (PyObject *self, PyObject *value, void *closure)
	setter callback for the Location attribute More...
static PyObject *	staticCallback_getDirection (PyObject *self, void *closure)
	getter callback for the Direction attribute More...
static int	staticCallback_setDirection (PyObject *self, PyObject *value, void *closure)
	setter callback for the Direction attribute More...

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

Detailed Description

The python export class for GeomLine.

Member Typedef Documentation

PointerType

typedef GeomLine* Part::LinePy::PointerType

Constructor & Destructor Documentation

~LinePy()

LinePy::~LinePy ( )

protected

LinePy()

LinePy::LinePy	(	GeomLine *	pcObject,
		PyTypeObject *	T = &Type
	)

Referenced by PyMake().

Member Function Documentation

getCustomAttributes()

PyObject * LinePy::getCustomAttributes

(

const char *

attr

)

const

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

getDirection()

Py::Object LinePy::getDirection

(

void

)

const

getter for the Direction attribute

References getGeomLinePtr().

Referenced by staticCallback_getDirection().

getGeomLinePtr()

GeomLine * LinePy::getGeomLinePtr

(

void

)

const

getter for the object handled by this class

Referenced by getDirection(), getLocation(), PyInit(), Part::LineSegmentPy::PyInit(), setDirection(), and setLocation().

getLocation()

Py::Object LinePy::getLocation

(

void

)

const

getter for the Location attribute

References getGeomLinePtr().

Referenced by staticCallback_getLocation().

GetType()

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

virtual

Reimplemented from Part::GeometryCurvePy.

PyInit()

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

virtual

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

Reimplemented from Part::GeometryCurvePy.

References Base::Distance(), getGeomLinePtr(), Part::PartExceptionOCCError, Base::VectorPy::Type, Type, and Part::GeometryCurvePy::value().

PyMake()

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

static

References LinePy().

representation()

std::string LinePy::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().

setCustomAttributes()

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

setter for special attributes (e.g.

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

setDirection()

void LinePy::setDirection

(

Py::Object

arg

)

setter for the Direction attribute

References getGeomLinePtr(), Base::VectorPy::Type, and Part::GeometryCurvePy::value().

Referenced by staticCallback_setDirection().

setLocation()

void LinePy::setLocation

(

Py::Object

arg

)

setter for the Location attribute

References getGeomLinePtr(), Base::VectorPy::Type, and Part::GeometryCurvePy::value().

Referenced by staticCallback_setLocation().

staticCallback_getDirection()

PyObject * LinePy::staticCallback_getDirection ( PyObject *  self, void *  closure  )

static

getter callback for the Direction attribute

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

staticCallback_getLocation()

PyObject * LinePy::staticCallback_getLocation ( PyObject *  self, void *  closure  )

static

getter callback for the Location attribute

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

staticCallback_setDirection()

int LinePy::staticCallback_setDirection ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Direction attribute

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

staticCallback_setLocation()

int LinePy::staticCallback_setLocation ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Location attribute

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

Member Data Documentation

GetterSetter

PyGetSetDef LinePy::GetterSetter

static

Initial value:

= {
    {"Location",
        (getter) staticCallback_getLocation,
        (setter) staticCallback_setLocation, 
        "Returns the location of this line.",
        NULL
    },
    {"Direction",
        (getter) staticCallback_getDirection,
        (setter) staticCallback_setDirection, 
        "Returns the direction of this line.",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of LinePy.

Methods

PyMethodDef LinePy::Methods

static

Initial value:

= {
    {NULL, NULL, 0, NULL}               
}

Methods structure of LinePy.

Type

PyTypeObject LinePy::Type

static

Type structure of LinePy.

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

---

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

• build/webdoc/src/Mod/Part/App/LinePy.h
• src/Mod/Part/App/LinePyImp.cpp
• build/webdoc/src/Mod/Part/App/LinePy.cpp