The python export class for Geom2dCircle. More...

#include <Circle2dPy.h>

Public Types

typedef Geom2dCirclePointerType
 
- Public Types inherited from Part::Conic2dPy
typedef Geom2dConicPointerType
 
- Public Types inherited from Part::Curve2dPy
typedef Geom2dCurvePointerType
 
- Public Types inherited from Part::Geometry2dPy
typedef Geometry2dPointerType
 
- Public Types inherited from Base::PyObjectBase
typedef void * PointerType
 
enum  Status { Valid = 0 , Immutable = 1 , Notify = 2 , NoTrack = 3 }
 

Public Member Functions

 Circle2dPy (Geom2dCircle *pcObject, PyTypeObject *T=&Type)
 
virtual PyTypeObject * GetType (void)
 
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::Conic2dPy
 Conic2dPy (Geom2dConic *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
Py::Object getLocation (void) const
 getter for the Location attribute More...
 
void setLocation (Py::Object arg)
 setter for the Location attribute More...
 
Py::Float getEccentricity (void) const
 getter for the Eccentricity attribute More...
 
Py::Object getXAxis (void) const
 getter for the XAxis attribute More...
 
void setXAxis (Py::Object arg)
 setter for the XAxis attribute More...
 
Py::Object getYAxis (void) const
 getter for the YAxis attribute More...
 
void setYAxis (Py::Object arg)
 setter for the YAxis attribute More...
 
PyObjectgetCustomAttributes (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...
 
Geom2dConicgetGeom2dConicPtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from Part::Curve2dPy
 Curve2dPy (Geom2dCurve *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
PyObjectreverse (PyObject *args)
 implementer for the reverse() method More...
 
PyObjecttoShape (PyObject *args)
 implementer for the toShape() method More...
 
PyObjectdiscretize (PyObject *args, PyObject *kwd)
 implementer for the discretize() method More...
 
PyObjectlength (PyObject *args)
 implementer for the length() method More...
 
PyObjectparameterAtDistance (PyObject *args)
 implementer for the parameterAtDistance() method More...
 
PyObjectvalue (PyObject *args)
 implementer for the value() method More...
 
PyObjecttangent (PyObject *args)
 implementer for the tangent() method More...
 
PyObjectparameter (PyObject *args)
 implementer for the parameter() method More...
 
PyObjectnormal (PyObject *args)
 implementer for the normal() method More...
 
PyObjectcurvature (PyObject *args)
 implementer for the curvature() method More...
 
PyObjectcenterOfCurvature (PyObject *args)
 implementer for the centerOfCurvature() method More...
 
PyObjectintersectCC (PyObject *args)
 implementer for the intersectCC() method More...
 
PyObjecttoBSpline (PyObject *args)
 implementer for the toBSpline() method More...
 
PyObjectapproximateBSpline (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...
 
PyObjectgetCustomAttributes (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...
 
Geom2dCurvegetGeom2dCurvePtr (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
 
PyObjectgetCustomAttributes (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...
 
Geometry2dgetGeometry2dPtr (void) const
 getter for the object handled by this class More...
 
PyObjectmirror (PyObject *args)
 implementer for the mirror() method More...
 
PyObjectrotate (PyObject *args)
 implementer for the rotate() method More...
 
PyObjectscale (PyObject *args)
 implementer for the scale() method More...
 
PyObjecttransform (PyObject *args)
 implementer for the transform() method More...
 
PyObjecttranslate (PyObject *args)
 implementer for the translate() method More...
 
PyObjectcopy (PyObject *args)
 implementer for the copy() method More...
 
- Public Member Functions inherited from Base::PyObjectBase
PyObjectBaseDecRef (void)
 decref method wrapper (see python extending manual) More...
 
PyObjectBaseIncRef (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 PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
- Static Public Member Functions inherited from Part::Conic2dPy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_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 PyObjectstaticCallback_getEccentricity (PyObject *self, void *closure)
 getter callback for the Eccentricity attribute More...
 
static int staticCallback_setEccentricity (PyObject *self, PyObject *value, void *closure)
 setter callback for the Eccentricity attribute More...
 
static PyObjectstaticCallback_getXAxis (PyObject *self, void *closure)
 getter callback for the XAxis attribute More...
 
static int staticCallback_setXAxis (PyObject *self, PyObject *value, void *closure)
 setter callback for the XAxis attribute More...
 
static PyObjectstaticCallback_getYAxis (PyObject *self, void *closure)
 getter callback for the YAxis attribute More...
 
static int staticCallback_setYAxis (PyObject *self, PyObject *value, void *closure)
 setter callback for the YAxis attribute More...
 
- Static Public Member Functions inherited from Part::Curve2dPy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_reverse (PyObject *self, PyObject *args)
 callback for the reverse() method More...
 
static PyObjectstaticCallback_toShape (PyObject *self, PyObject *args)
 callback for the toShape() method More...
 
static PyObjectstaticCallback_discretize (PyObject *self, PyObject *args, PyObject *kwd)
 callback for the discretize() method More...
 
static PyObjectstaticCallback_length (PyObject *self, PyObject *args)
 callback for the length() method More...
 
static PyObjectstaticCallback_parameterAtDistance (PyObject *self, PyObject *args)
 callback for the parameterAtDistance() method More...
 
static PyObjectstaticCallback_value (PyObject *self, PyObject *args)
 callback for the value() method More...
 
static PyObjectstaticCallback_tangent (PyObject *self, PyObject *args)
 callback for the tangent() method More...
 
static PyObjectstaticCallback_parameter (PyObject *self, PyObject *args)
 callback for the parameter() method More...
 
static PyObjectstaticCallback_normal (PyObject *self, PyObject *args)
 callback for the normal() method More...
 
static PyObjectstaticCallback_curvature (PyObject *self, PyObject *args)
 callback for the curvature() method More...
 
static PyObjectstaticCallback_centerOfCurvature (PyObject *self, PyObject *args)
 callback for the centerOfCurvature() method More...
 
static PyObjectstaticCallback_intersectCC (PyObject *self, PyObject *args)
 callback for the intersectCC() method More...
 
static PyObjectstaticCallback_toBSpline (PyObject *self, PyObject *args)
 callback for the toBSpline() method More...
 
static PyObjectstaticCallback_approximateBSpline (PyObject *self, PyObject *args)
 callback for the approximateBSpline() method More...
 
static PyObjectstaticCallback_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 PyObjectstaticCallback_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 PyObjectstaticCallback_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 PyObjectstaticCallback_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 PyObjectstaticCallback_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 PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_mirror (PyObject *self, PyObject *args)
 callback for the mirror() method More...
 
static PyObjectstaticCallback_rotate (PyObject *self, PyObject *args)
 callback for the rotate() method More...
 
static PyObjectstaticCallback_scale (PyObject *self, PyObject *args)
 callback for the scale() method More...
 
static PyObjectstaticCallback_transform (PyObject *self, PyObject *args)
 callback for the transform() method More...
 
static PyObjectstaticCallback_translate (PyObject *self, PyObject *args)
 callback for the translate() method More...
 
static PyObjectstaticCallback_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 Circle2dPy. More...
 
static PyMethodDef Methods []
 Methods structure of Circle2dPy. More...
 
static PyTypeObject Type
 Type structure of Circle2dPy. More...
 
- Static Public Attributes inherited from Part::Conic2dPy
static PyGetSetDef GetterSetter []
 Attribute structure of Conic2dPy. More...
 
static PyMethodDef Methods []
 Methods structure of Conic2dPy. More...
 
static PyTypeObject Type
 Type structure of Conic2dPy. 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

 ~Circle2dPy ()
 
- Protected Member Functions inherited from Part::Conic2dPy
 ~Conic2dPy ()
 
- Protected Member Functions inherited from Part::Curve2dPy
 ~Curve2dPy ()
 
- Protected Member Functions inherited from Part::Geometry2dPy
 ~Geometry2dPy ()
 
- Protected Member Functions inherited from Base::PyObjectBase
void setTwinPointer (void *ptr)
 Overrides the pointer to the twin object. More...
 
virtual ~PyObjectBase ()
 destructor More...
 

callbacks and implementers for the python object attributes

Py::Float getRadius (void) const
 getter for the Radius attribute More...
 
void setRadius (Py::Float arg)
 setter for the Radius attribute More...
 
PyObjectgetCustomAttributes (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...
 
Geom2dCirclegetGeom2dCirclePtr (void) const
 getter for the object handled by this class More...
 
static PyObjectstaticCallback_getRadius (PyObject *self, void *closure)
 getter callback for the Radius attribute More...
 
static int staticCallback_setRadius (PyObject *self, PyObject *value, void *closure)
 setter callback for the Radius attribute More...
 

Additional Inherited Members

- Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 > StatusBits
 

Detailed Description

The python export class for Geom2dCircle.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~Circle2dPy()

Circle2dPy::~Circle2dPy ( )
protected

◆ Circle2dPy()

Circle2dPy::Circle2dPy ( Geom2dCircle pcObject,
PyTypeObject *  T = &Type 
)

Referenced by PyMake().

Member Function Documentation

◆ getCustomAttributes()

PyObject * Circle2dPy::getCustomAttributes ( const char *  attr) const

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

◆ getGeom2dCirclePtr()

Geom2dCircle * Circle2dPy::getGeom2dCirclePtr ( void  ) const

getter for the object handled by this class

Referenced by getRadius(), PyInit(), and setRadius().

◆ getRadius()

Py::Float Circle2dPy::getRadius ( void  ) const

getter for the Radius attribute

References getGeom2dCirclePtr().

Referenced by staticCallback_getRadius().

◆ GetType()

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

Reimplemented from Part::Conic2dPy.

◆ PyInit()

int Circle2dPy::PyInit ( PyObject ,
PyObject  
)
virtual

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

Reimplemented from Part::Conic2dPy.

References DraftVecUtils::dist(), getGeom2dCirclePtr(), Part::PartExceptionOCCError, and Type.

◆ PyMake()

PyObject * Circle2dPy::PyMake ( struct _typeobject *  ,
PyObject ,
PyObject  
)
static

References Circle2dPy().

◆ representation()

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ setRadius()

void Circle2dPy::setRadius ( Py::Float  arg)

setter for the Radius attribute

References getGeom2dCirclePtr().

Referenced by draftguitools.gui_trackers.arcTracker::setBy3Points(), and staticCallback_setRadius().

◆ staticCallback_getRadius()

PyObject * Circle2dPy::staticCallback_getRadius ( PyObject self,
void *  closure 
)
static

◆ staticCallback_setRadius()

int Circle2dPy::staticCallback_setRadius ( PyObject self,
PyObject value,
void *  closure 
)
static

Member Data Documentation

◆ GetterSetter

PyGetSetDef Circle2dPy::GetterSetter
static
Initial value:
= {
{"Radius",
"The radius of the circle.",
NULL
},
{NULL, NULL, NULL, NULL, NULL}
}
static PyObject * staticCallback_getRadius(PyObject *self, void *closure)
getter callback for the Radius attribute
Definition: Circle2dPy.cpp:127
static int staticCallback_setRadius(PyObject *self, PyObject *value, void *closure)
setter callback for the Radius attribute
Definition: Circle2dPy.cpp:145

Attribute structure of Circle2dPy.

◆ Methods

PyMethodDef Circle2dPy::Methods
static
Initial value:
= {
{NULL, NULL, 0, NULL}
}

Methods structure of Circle2dPy.

◆ Type


The documentation for this class was generated from the following files:
  • Sources/FreeCAD-SourceDocs/src/Mod/Part/App/Geom2d/Circle2dPy.h
  • Sources/FreeCAD/src/Mod/Part/App/Geom2d/Circle2dPyImp.cpp
  • Sources/FreeCAD-SourceDocs/src/Mod/Part/App/Geom2d/Circle2dPy.cpp