Part::OffsetCurvePy Class Reference

The python export class for GeomOffsetCurve. More...

#include <OffsetCurvePy.h>

Public Types
typedef GeomOffsetCurve *	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)
	OffsetCurvePy (GeomOffsetCurve *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 OffsetCurvePy. More...
static PyMethodDef	Methods []
	Methods structure of OffsetCurvePy. More...
static PyTypeObject	Type
	Type structure of OffsetCurvePy. 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
	~OffsetCurvePy ()
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::Float	getOffsetValue (void) const
	getter for the OffsetValue attribute More...
void	setOffsetValue (Py::Float arg)
	setter for the OffsetValue attribute More...
Py::Object	getOffsetDirection (void) const
	getter for the OffsetDirection attribute More...
void	setOffsetDirection (Py::Object arg)
	setter for the OffsetDirection attribute More...
Py::Object	getBasisCurve (void) const
	getter for the BasisCurve attribute More...
void	setBasisCurve (Py::Object arg)
	setter for the BasisCurve 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...
GeomOffsetCurve *	getGeomOffsetCurvePtr (void) const
	getter for the object handled by this class More...
static PyObject *	staticCallback_getOffsetValue (PyObject *self, void *closure)
	getter callback for the OffsetValue attribute More...
static int	staticCallback_setOffsetValue (PyObject *self, PyObject *value, void *closure)
	setter callback for the OffsetValue attribute More...
static PyObject *	staticCallback_getOffsetDirection (PyObject *self, void *closure)
	getter callback for the OffsetDirection attribute More...
static int	staticCallback_setOffsetDirection (PyObject *self, PyObject *value, void *closure)
	setter callback for the OffsetDirection attribute More...
static PyObject *	staticCallback_getBasisCurve (PyObject *self, void *closure)
	getter callback for the BasisCurve attribute More...
static int	staticCallback_setBasisCurve (PyObject *self, PyObject *value, void *closure)
	setter callback for the BasisCurve attribute More...

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

Detailed Description

The python export class for GeomOffsetCurve.

Member Typedef Documentation

PointerType

typedef GeomOffsetCurve* Part::OffsetCurvePy::PointerType

Constructor & Destructor Documentation

~OffsetCurvePy()

OffsetCurvePy::~OffsetCurvePy ( )

protected

OffsetCurvePy()

OffsetCurvePy::OffsetCurvePy	(	GeomOffsetCurve *	pcObject,
		PyTypeObject *	T = &Type
	)

Referenced by PyMake().

Member Function Documentation

getBasisCurve()

Py::Object OffsetCurvePy::getBasisCurve

(

void

)

const

getter for the BasisCurve attribute

References Part::GeometryPy::getGeometryPtr().

Referenced by staticCallback_getBasisCurve().

getCustomAttributes()

PyObject * OffsetCurvePy::getCustomAttributes

(

const char *

attr

)

const

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

getGeomOffsetCurvePtr()

GeomOffsetCurve * OffsetCurvePy::getGeomOffsetCurvePtr

(

void

)

const

getter for the object handled by this class

Referenced by PyInit().

getOffsetDirection()

Py::Object OffsetCurvePy::getOffsetDirection

(

void

)

const

getter for the OffsetDirection attribute

References Part::GeometryPy::getGeometryPtr().

Referenced by staticCallback_getOffsetDirection().

getOffsetValue()

Py::Float OffsetCurvePy::getOffsetValue

(

void

)

const

getter for the OffsetValue attribute

References Part::GeometryPy::getGeometryPtr().

Referenced by staticCallback_getOffsetValue().

GetType()

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

virtual

Reimplemented from Part::GeometryCurvePy.

PyInit()

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

virtual

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

Reimplemented from Part::GeometryCurvePy.

References Part::GeometryPy::getGeometryPtr(), getGeomOffsetCurvePtr(), Part::PartExceptionOCCError, Part::GeomOffsetCurve::setHandle(), Base::VectorPy::Type, Part::GeometryPy::Type, Part::GeometryCurvePy::value(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

PyMake()

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

static

References OffsetCurvePy().

representation()

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

setBasisCurve()

void OffsetCurvePy::setBasisCurve

(

Py::Object

arg

)

setter for the BasisCurve attribute

References Part::GeometryPy::getGeometryPtr(), and Part::GeometryPy::Type.

Referenced by staticCallback_setBasisCurve().

setCustomAttributes()

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

setter for special attributes (e.g.

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

setOffsetDirection()

void OffsetCurvePy::setOffsetDirection

(

Py::Object

arg

)

setter for the OffsetDirection attribute

References Part::GeometryPy::getGeometryPtr(), Base::VectorPy::Type, Part::GeometryCurvePy::value(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

Referenced by staticCallback_setOffsetDirection().

setOffsetValue()

void OffsetCurvePy::setOffsetValue

(

Py::Float

arg

)

setter for the OffsetValue attribute

References Part::GeometryPy::getGeometryPtr().

Referenced by staticCallback_setOffsetValue().

staticCallback_getBasisCurve()

PyObject * OffsetCurvePy::staticCallback_getBasisCurve ( PyObject *  self, void *  closure  )

static

getter callback for the BasisCurve attribute

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

staticCallback_getOffsetDirection()

PyObject * OffsetCurvePy::staticCallback_getOffsetDirection ( PyObject *  self, void *  closure  )

static

getter callback for the OffsetDirection attribute

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

staticCallback_getOffsetValue()

PyObject * OffsetCurvePy::staticCallback_getOffsetValue ( PyObject *  self, void *  closure  )

static

getter callback for the OffsetValue attribute

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

staticCallback_setBasisCurve()

int OffsetCurvePy::staticCallback_setBasisCurve ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the BasisCurve attribute

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

staticCallback_setOffsetDirection()

int OffsetCurvePy::staticCallback_setOffsetDirection ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the OffsetDirection attribute

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

staticCallback_setOffsetValue()

int OffsetCurvePy::staticCallback_setOffsetValue ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the OffsetValue attribute

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

Member Data Documentation

GetterSetter

PyGetSetDef OffsetCurvePy::GetterSetter

static

Initial value:

= {
    {"OffsetValue",
        (getter) staticCallback_getOffsetValue,
        (setter) staticCallback_setOffsetValue, 
        "\n                                     Sets or gets the offset value to offset the underlying curve.\n                         ",
        NULL
    },
    {"OffsetDirection",
        (getter) staticCallback_getOffsetDirection,
        (setter) staticCallback_setOffsetDirection, 
        "\n                                     Sets or gets the offset direction to offset the underlying curve.\n                             ",
        NULL
    },
    {"BasisCurve",
        (getter) staticCallback_getBasisCurve,
        (setter) staticCallback_setBasisCurve, 
        "\n                                     Sets or gets the basic curve.\n                         ",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of OffsetCurvePy.

Methods

PyMethodDef OffsetCurvePy::Methods

static

Initial value:

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

Methods structure of OffsetCurvePy.

Type

PyTypeObject OffsetCurvePy::Type

static

Type structure of OffsetCurvePy.

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

---

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

• build/webdoc/src/Mod/Part/App/OffsetCurvePy.h
• src/Mod/Part/App/OffsetCurvePyImp.cpp
• build/webdoc/src/Mod/Part/App/OffsetCurvePy.cpp