Part::OffsetCurve2dPy Class Reference

The python export class for Geom2dOffsetCurve. More...

#include <OffsetCurve2dPy.h>

Public Types
typedef Geom2dOffsetCurve *	PointerType
Public Types inherited from Part::Curve2dPy
typedef Geom2dCurve *	PointerType
Public Types inherited from Part::Geometry2dPy
typedef Geometry2d *	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)
	OffsetCurve2dPy (Geom2dOffsetCurve *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::Curve2dPy
	Curve2dPy (Geom2dCurve *pcObject, PyTypeObject *T=&Type)
std::string	representation (void) const
PyObject *	reverse (PyObject *args)
	implementer for the reverse() method More...
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 *	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 *	intersectCC (PyObject *args)
	implementer for the intersectCC() method More...
PyObject *	toBSpline (PyObject *args)
	implementer for the toBSpline() method More...
PyObject *	approximateBSpline (PyObject *args)
	implementer for the approximateBSpline() method More...
Py::String	getContinuity (void) const
	getter for the Continuity attribute More...
Py::Boolean	getClosed (void) const
	getter for the Closed attribute More...
Py::Boolean	getPeriodic (void) const
	getter for the Periodic 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...
Geom2dCurve *	getGeom2dCurvePtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from Part::Geometry2dPy
	Geometry2dPy (Geometry2d *pcObject, PyTypeObject *T=&Type)
std::string	representation (void) const
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...
Geometry2d *	getGeometry2dPtr (void) const
	getter for the object handled by this class More...
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...
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::Curve2dPy
static PyObject *	PyMake (struct _typeobject *, PyObject *, PyObject *)
static PyObject *	staticCallback_reverse (PyObject *self, PyObject *args)
	callback for the reverse() method More...
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_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_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_approximateBSpline (PyObject *self, PyObject *args)
	callback for the approximateBSpline() 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_getClosed (PyObject *self, void *closure)
	getter callback for the Closed attribute More...
static int	staticCallback_setClosed (PyObject *self, PyObject *value, void *closure)
	setter callback for the Closed attribute More...
static PyObject *	staticCallback_getPeriodic (PyObject *self, void *closure)
	getter callback for the Periodic attribute More...
static int	staticCallback_setPeriodic (PyObject *self, PyObject *value, void *closure)
	setter callback for the Periodic 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::Geometry2dPy
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 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 OffsetCurve2dPy. More...
static PyMethodDef	Methods []
	Methods structure of OffsetCurve2dPy. More...
static PyTypeObject	Type
	Type structure of OffsetCurve2dPy. More...
Static Public Attributes inherited from Part::Curve2dPy
static PyGetSetDef	GetterSetter []
	Attribute structure of Curve2dPy. More...
static PyMethodDef	Methods []
	Methods structure of Curve2dPy. More...
static PyTypeObject	Type
	Type structure of Curve2dPy. More...
Static Public Attributes inherited from Part::Geometry2dPy
static PyGetSetDef	GetterSetter []
	Attribute structure of Geometry2dPy. More...
static PyMethodDef	Methods []
	Methods structure of Geometry2dPy. More...
static PyTypeObject	Type
	Type structure of Geometry2dPy. More...
Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef	Methods []
static PyTypeObject	Type
	Py_Header struct from python.h. More...

Protected Member Functions
	~OffsetCurve2dPy ()
Protected Member Functions inherited from Part::Curve2dPy
	~Curve2dPy ()
Protected Member Functions inherited from Part::Geometry2dPy
	~Geometry2dPy ()
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	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...
Geom2dOffsetCurve *	getGeom2dOffsetCurvePtr (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_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 Geom2dOffsetCurve.

Member Typedef Documentation

PointerType

typedef Geom2dOffsetCurve* Part::OffsetCurve2dPy::PointerType

Constructor & Destructor Documentation

~OffsetCurve2dPy()

OffsetCurve2dPy::~OffsetCurve2dPy ( )

protected

OffsetCurve2dPy()

OffsetCurve2dPy::OffsetCurve2dPy	(	Geom2dOffsetCurve *	pcObject,
		PyTypeObject *	T = &Type
	)

Referenced by PyMake().

Member Function Documentation

getBasisCurve()

Py::Object OffsetCurve2dPy::getBasisCurve

(

void

)

const

getter for the BasisCurve attribute

References Part::getCurve2dFromGeom2d(), Part::Geometry2dPy::getGeometry2dPtr(), and Base::BaseClass::getPyObject().

Referenced by staticCallback_getBasisCurve().

getCustomAttributes()

PyObject * OffsetCurve2dPy::getCustomAttributes

(

const char *

attr

)

const

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

getGeom2dOffsetCurvePtr()

Geom2dOffsetCurve * OffsetCurve2dPy::getGeom2dOffsetCurvePtr

(

void

)

const

getter for the object handled by this class

Referenced by PyInit().

getOffsetValue()

Py::Float OffsetCurve2dPy::getOffsetValue

(

void

)

const

getter for the OffsetValue attribute

References Part::Geometry2dPy::getGeometry2dPtr().

Referenced by staticCallback_getOffsetValue().

GetType()

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

virtual

Reimplemented from Part::Curve2dPy.

PyInit()

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

virtual

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

Reimplemented from Part::Curve2dPy.

References getGeom2dOffsetCurvePtr(), Part::Geometry2dPy::getGeometry2dPtr(), Part::PartExceptionOCCError, Part::Geom2dOffsetCurve::setHandle(), and Part::Curve2dPy::Type.

PyMake()

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

static

References OffsetCurve2dPy().

representation()

std::string OffsetCurve2dPy::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 OffsetCurve2dPy::setBasisCurve

(

Py::Object

arg

)

setter for the BasisCurve attribute

References Part::Geometry2dPy::getGeometry2dPtr(), and Part::Curve2dPy::Type.

Referenced by staticCallback_setBasisCurve().

setCustomAttributes()

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

setter for special attributes (e.g.

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

setOffsetValue()

void OffsetCurve2dPy::setOffsetValue

(

Py::Float

arg

)

setter for the OffsetValue attribute

References Part::Geometry2dPy::getGeometry2dPtr().

Referenced by staticCallback_setOffsetValue().

staticCallback_getBasisCurve()

PyObject * OffsetCurve2dPy::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_getOffsetValue()

PyObject * OffsetCurve2dPy::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 OffsetCurve2dPy::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_setOffsetValue()

int OffsetCurve2dPy::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 OffsetCurve2dPy::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
    },
    {"BasisCurve",
        (getter) staticCallback_getBasisCurve,
        (setter) staticCallback_setBasisCurve, 
        "\n                                     Sets or gets the basic curve.\n                         ",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of OffsetCurve2dPy.

Methods

PyMethodDef OffsetCurve2dPy::Methods

static

Initial value:

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

Methods structure of OffsetCurve2dPy.

Type

PyTypeObject OffsetCurve2dPy::Type

static

Type structure of OffsetCurve2dPy.

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/Geom2d/OffsetCurve2dPy.h
• src/Mod/Part/App/Geom2d/OffsetCurve2dPyImp.cpp
• build/webdoc/src/Mod/Part/App/Geom2d/OffsetCurve2dPy.cpp