The python export class for Feature. More...

#include <FeaturePy.h>

Public Types

typedef Feature * PointerType
 
- Public Types inherited from Part::PartFeaturePy
typedef Feature * PointerType
 
- Public Types inherited from App::GeoFeaturePy
typedef GeoFeature * PointerType
 
- Public Types inherited from App::DocumentObjectPy
typedef DocumentObject * PointerType
 
- Public Types inherited from App::ExtensionContainerPy
typedef ExtensionContainer * PointerType
 
- Public Types inherited from App::PropertyContainerPy
typedef PropertyContainer * PointerType
 
- Public Types inherited from Base::PersistencePy
typedef Persistence * PointerType
 
- Public Types inherited from Base::BaseClassPy
typedef BaseClass * PointerType
 
- Public Types inherited from Base::PyObjectBase
typedef void * PointerType
 
enum  Status { Valid = 0, Immutable = 1, Notify = 2, NoTrack = 3 }
 

Public Member Functions

 FeaturePy (Feature *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
 
callbacks and implementers for the python object attributes
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...
 
Feature * getFeaturePtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from Part::PartFeaturePy
 PartFeaturePy (Feature *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...
 
Feature * getFeaturePtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from App::GeoFeaturePy
 GeoFeaturePy (GeoFeature *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...
 
GeoFeature * getGeoFeaturePtr (void) const
 getter for the object handled by this class More...
 
PyObject * getPaths (PyObject *args)
 implementer for the getPaths() method More...
 
PyObject * getGlobalPlacement (PyObject *args)
 implementer for the getGlobalPlacement() method More...
 
PyObject * getPropertyNameOfGeometry (PyObject *args)
 implementer for the getPropertyNameOfGeometry() method More...
 
- Public Member Functions inherited from App::DocumentObjectPy
 DocumentObjectPy (DocumentObject *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
PyObject * addProperty (PyObject *args)
 implementer for the addProperty() method More...
 
PyObject * removeProperty (PyObject *args)
 implementer for the removeProperty() method More...
 
PyObject * supportedProperties (PyObject *args)
 implementer for the supportedProperties() method More...
 
PyObject * touch (PyObject *args)
 implementer for the touch() method More...
 
PyObject * purgeTouched (PyObject *args)
 implementer for the purgeTouched() method More...
 
PyObject * enforceRecompute (PyObject *args)
 implementer for the enforceRecompute() method More...
 
PyObject * setExpression (PyObject *args)
 implementer for the setExpression() method More...
 
PyObject * recompute (PyObject *args)
 implementer for the recompute() method More...
 
PyObject * getParentGroup (PyObject *args)
 implementer for the getParentGroup() method More...
 
PyObject * getParentGeoFeatureGroup (PyObject *args)
 implementer for the getParentGeoFeatureGroup() method More...
 
PyObject * getPathsByOutList (PyObject *args)
 implementer for the getPathsByOutList() method More...
 
Py::List getOutList (void) const
 getter for the OutList attribute More...
 
Py::List getOutListRecursive (void) const
 getter for the OutListRecursive attribute More...
 
Py::List getInList (void) const
 getter for the InList attribute More...
 
Py::List getInListRecursive (void) const
 getter for the InListRecursive attribute More...
 
Py::String getName (void) const
 getter for the Name attribute More...
 
Py::Object getDocument (void) const
 getter for the Document attribute More...
 
Py::List getState (void) const
 getter for the State attribute More...
 
Py::Object getViewObject (void) const
 getter for the ViewObject 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...
 
DocumentObject * getDocumentObjectPtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from App::ExtensionContainerPy
 ExtensionContainerPy (ExtensionContainer *pcObject, PyTypeObject *T=&Type)
 
int finalization ()
 
int initialization ()
 
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...
 
ExtensionContainer * getExtensionContainerPtr (void) const
 getter for the object handled by this class More...
 
PyObject * addExtension (PyObject *args)
 implementer for the addExtension() method More...
 
PyObject * hasExtension (PyObject *args)
 implementer for the hasExtension() method More...
 
- Public Member Functions inherited from App::PropertyContainerPy
 PropertyContainerPy (PropertyContainer *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
PyObject * getPropertyByName (PyObject *args)
 implementer for the getPropertyByName() method More...
 
PyObject * getTypeOfProperty (PyObject *args)
 implementer for the getTypeOfProperty() method More...
 
PyObject * getTypeIdOfProperty (PyObject *args)
 implementer for the getTypeIdOfProperty() method More...
 
PyObject * setEditorMode (PyObject *args)
 implementer for the setEditorMode() method More...
 
PyObject * getEditorMode (PyObject *args)
 implementer for the getEditorMode() method More...
 
PyObject * getGroupOfProperty (PyObject *args)
 implementer for the getGroupOfProperty() method More...
 
PyObject * getDocumentationOfProperty (PyObject *args)
 implementer for the getDocumentationOfProperty() method More...
 
PyObject * dumpPropertyContent (PyObject *args, PyObject *kwd)
 implementer for the dumpPropertyContent() method More...
 
PyObject * restorePropertyContent (PyObject *args)
 implementer for the restorePropertyContent() method More...
 
Py::List getPropertiesList (void) const
 getter for the PropertiesList 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...
 
PropertyContainer * getPropertyContainerPtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from Base::PersistencePy
 PersistencePy (Persistence *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
PyObject * dumpContent (PyObject *args, PyObject *kwd)
 implementer for the dumpContent() method More...
 
PyObject * restoreContent (PyObject *args)
 implementer for the restoreContent() method More...
 
Py::String getContent (void) const
 getter for the Content attribute More...
 
Py::Int getMemSize (void) const
 getter for the MemSize 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...
 
Persistence * getPersistencePtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from Base::BaseClassPy
 BaseClassPy (BaseClass *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
PyObject * isDerivedFrom (PyObject *args)
 implementer for the isDerivedFrom() method More...
 
PyObject * getAllDerivedFrom (PyObject *args)
 implementer for the getAllDerivedFrom() method More...
 
Py::String getTypeId (void) const
 getter for the TypeId attribute More...
 
Py::String getModule (void) const
 getter for the Module 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...
 
BaseClass * getBaseClassPtr (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::PartFeaturePy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
- Static Public Member Functions inherited from App::GeoFeaturePy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObject * staticCallback_getPaths (PyObject *self, PyObject *args)
 callback for the getPaths() method More...
 
static PyObject * staticCallback_getGlobalPlacement (PyObject *self, PyObject *args)
 callback for the getGlobalPlacement() method More...
 
static PyObject * staticCallback_getPropertyNameOfGeometry (PyObject *self, PyObject *args)
 callback for the getPropertyNameOfGeometry() method More...
 
- Static Public Member Functions inherited from App::DocumentObjectPy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObject * staticCallback_addProperty (PyObject *self, PyObject *args)
 callback for the addProperty() method More...
 
static PyObject * staticCallback_removeProperty (PyObject *self, PyObject *args)
 callback for the removeProperty() method More...
 
static PyObject * staticCallback_supportedProperties (PyObject *self, PyObject *args)
 callback for the supportedProperties() method More...
 
static PyObject * staticCallback_touch (PyObject *self, PyObject *args)
 callback for the touch() method More...
 
static PyObject * staticCallback_purgeTouched (PyObject *self, PyObject *args)
 callback for the purgeTouched() method More...
 
static PyObject * staticCallback_enforceRecompute (PyObject *self, PyObject *args)
 callback for the enforceRecompute() method More...
 
static PyObject * staticCallback_setExpression (PyObject *self, PyObject *args)
 callback for the setExpression() method More...
 
static PyObject * staticCallback_recompute (PyObject *self, PyObject *args)
 callback for the recompute() method More...
 
static PyObject * staticCallback_getParentGroup (PyObject *self, PyObject *args)
 callback for the getParentGroup() method More...
 
static PyObject * staticCallback_getParentGeoFeatureGroup (PyObject *self, PyObject *args)
 callback for the getParentGeoFeatureGroup() method More...
 
static PyObject * staticCallback_getPathsByOutList (PyObject *self, PyObject *args)
 callback for the getPathsByOutList() method More...
 
static PyObject * staticCallback_getOutList (PyObject *self, void *closure)
 getter callback for the OutList attribute More...
 
static int staticCallback_setOutList (PyObject *self, PyObject *value, void *closure)
 setter callback for the OutList attribute More...
 
static PyObject * staticCallback_getOutListRecursive (PyObject *self, void *closure)
 getter callback for the OutListRecursive attribute More...
 
static int staticCallback_setOutListRecursive (PyObject *self, PyObject *value, void *closure)
 setter callback for the OutListRecursive attribute More...
 
static PyObject * staticCallback_getInList (PyObject *self, void *closure)
 getter callback for the InList attribute More...
 
static int staticCallback_setInList (PyObject *self, PyObject *value, void *closure)
 setter callback for the InList attribute More...
 
static PyObject * staticCallback_getInListRecursive (PyObject *self, void *closure)
 getter callback for the InListRecursive attribute More...
 
static int staticCallback_setInListRecursive (PyObject *self, PyObject *value, void *closure)
 setter callback for the InListRecursive attribute More...
 
static PyObject * staticCallback_getName (PyObject *self, void *closure)
 getter callback for the Name attribute More...
 
static int staticCallback_setName (PyObject *self, PyObject *value, void *closure)
 setter callback for the Name attribute More...
 
static PyObject * staticCallback_getDocument (PyObject *self, void *closure)
 getter callback for the Document attribute More...
 
static int staticCallback_setDocument (PyObject *self, PyObject *value, void *closure)
 setter callback for the Document attribute More...
 
static PyObject * staticCallback_getState (PyObject *self, void *closure)
 getter callback for the State attribute More...
 
static int staticCallback_setState (PyObject *self, PyObject *value, void *closure)
 setter callback for the State attribute More...
 
static PyObject * staticCallback_getViewObject (PyObject *self, void *closure)
 getter callback for the ViewObject attribute More...
 
static int staticCallback_setViewObject (PyObject *self, PyObject *value, void *closure)
 setter callback for the ViewObject attribute More...
 
- Static Public Member Functions inherited from App::ExtensionContainerPy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObject * staticCallback_addExtension (PyObject *self, PyObject *args)
 callback for the addExtension() method More...
 
static PyObject * staticCallback_hasExtension (PyObject *self, PyObject *args)
 callback for the hasExtension() method More...
 
- Static Public Member Functions inherited from App::PropertyContainerPy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObject * staticCallback_getPropertyByName (PyObject *self, PyObject *args)
 callback for the getPropertyByName() method More...
 
static PyObject * staticCallback_getTypeOfProperty (PyObject *self, PyObject *args)
 callback for the getTypeOfProperty() method More...
 
static PyObject * staticCallback_getTypeIdOfProperty (PyObject *self, PyObject *args)
 callback for the getTypeIdOfProperty() method More...
 
static PyObject * staticCallback_setEditorMode (PyObject *self, PyObject *args)
 callback for the setEditorMode() method More...
 
static PyObject * staticCallback_getEditorMode (PyObject *self, PyObject *args)
 callback for the getEditorMode() method More...
 
static PyObject * staticCallback_getGroupOfProperty (PyObject *self, PyObject *args)
 callback for the getGroupOfProperty() method More...
 
static PyObject * staticCallback_getDocumentationOfProperty (PyObject *self, PyObject *args)
 callback for the getDocumentationOfProperty() method More...
 
static PyObject * staticCallback_dumpPropertyContent (PyObject *self, PyObject *args, PyObject *kwd)
 callback for the dumpPropertyContent() method More...
 
static PyObject * staticCallback_restorePropertyContent (PyObject *self, PyObject *args)
 callback for the restorePropertyContent() method More...
 
static PyObject * staticCallback_getPropertiesList (PyObject *self, void *closure)
 getter callback for the PropertiesList attribute More...
 
static int staticCallback_setPropertiesList (PyObject *self, PyObject *value, void *closure)
 setter callback for the PropertiesList attribute More...
 
- Static Public Member Functions inherited from Base::PersistencePy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObject * staticCallback_dumpContent (PyObject *self, PyObject *args, PyObject *kwd)
 callback for the dumpContent() method More...
 
static PyObject * staticCallback_restoreContent (PyObject *self, PyObject *args)
 callback for the restoreContent() method More...
 
static PyObject * staticCallback_getContent (PyObject *self, void *closure)
 getter callback for the Content attribute More...
 
static int staticCallback_setContent (PyObject *self, PyObject *value, void *closure)
 setter callback for the Content attribute More...
 
static PyObject * staticCallback_getMemSize (PyObject *self, void *closure)
 getter callback for the MemSize attribute More...
 
static int staticCallback_setMemSize (PyObject *self, PyObject *value, void *closure)
 setter callback for the MemSize attribute More...
 
- Static Public Member Functions inherited from Base::BaseClassPy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObject * staticCallback_isDerivedFrom (PyObject *self, PyObject *args)
 callback for the isDerivedFrom() method More...
 
static PyObject * staticCallback_getAllDerivedFrom (PyObject *self, PyObject *args)
 callback for the getAllDerivedFrom() method More...
 
static PyObject * staticCallback_getTypeId (PyObject *self, void *closure)
 getter callback for the TypeId attribute More...
 
static int staticCallback_setTypeId (PyObject *self, PyObject *value, void *closure)
 setter callback for the TypeId attribute More...
 
static PyObject * staticCallback_getModule (PyObject *self, void *closure)
 getter callback for the Module attribute More...
 
static int staticCallback_setModule (PyObject *self, PyObject *value, void *closure)
 setter callback for the Module 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 FeaturePy. More...
 
static PyMethodDef Methods []
 Methods structure of FeaturePy. More...
 
static PyTypeObject Type
 Type structure of FeaturePy. More...
 
- Static Public Attributes inherited from Part::PartFeaturePy
static PyGetSetDef GetterSetter []
 Attribute structure of PartFeaturePy. More...
 
static PyMethodDef Methods []
 Methods structure of PartFeaturePy. More...
 
static PyTypeObject Type
 Type structure of PartFeaturePy. More...
 
- Static Public Attributes inherited from App::GeoFeaturePy
static PyGetSetDef GetterSetter []
 Attribute structure of GeoFeaturePy. More...
 
static PyMethodDef Methods []
 Methods structure of GeoFeaturePy. More...
 
static PyTypeObject Type
 Type structure of GeoFeaturePy. More...
 
- Static Public Attributes inherited from App::DocumentObjectPy
static PyGetSetDef GetterSetter []
 Attribute structure of DocumentObjectPy. More...
 
static PyMethodDef Methods []
 Methods structure of DocumentObjectPy. More...
 
static PyTypeObject Type
 Type structure of DocumentObjectPy. More...
 
- Static Public Attributes inherited from App::ExtensionContainerPy
static PyGetSetDef GetterSetter []
 Attribute structure of ExtensionContainerPy. More...
 
static PyMethodDef Methods []
 Methods structure of ExtensionContainerPy. More...
 
static PyTypeObject Type
 Type structure of ExtensionContainerPy. More...
 
- Static Public Attributes inherited from App::PropertyContainerPy
static PyGetSetDef GetterSetter []
 Attribute structure of PropertyContainerPy. More...
 
static PyMethodDef Methods []
 Methods structure of PropertyContainerPy. More...
 
static PyTypeObject Type
 Type structure of PropertyContainerPy. More...
 
- Static Public Attributes inherited from Base::PersistencePy
static PyGetSetDef GetterSetter []
 Attribute structure of PersistencePy. More...
 
static PyMethodDef Methods []
 Methods structure of PersistencePy. More...
 
static PyTypeObject Type
 Type structure of PersistencePy. More...
 
- Static Public Attributes inherited from Base::BaseClassPy
static PyGetSetDef GetterSetter []
 Attribute structure of BaseClassPy. More...
 
static PyMethodDef Methods []
 Methods structure of BaseClassPy. More...
 
static PyTypeObject Type
 Type structure of BaseClassPy. More...
 
- Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
 
static PyTypeObject Type
 Py_Header struct from python.h. More...
 

Protected Member Functions

 ~FeaturePy ()
 
- Protected Member Functions inherited from Part::PartFeaturePy
 ~PartFeaturePy ()
 
- Protected Member Functions inherited from App::GeoFeaturePy
 ~GeoFeaturePy ()
 
- Protected Member Functions inherited from App::DocumentObjectPy
 ~DocumentObjectPy ()
 
- Protected Member Functions inherited from App::ExtensionContainerPy
 ~ExtensionContainerPy ()
 
- Protected Member Functions inherited from App::PropertyContainerPy
 ~PropertyContainerPy ()
 
- Protected Member Functions inherited from Base::PersistencePy
 ~PersistencePy ()
 
- Protected Member Functions inherited from Base::BaseClassPy
 ~BaseClassPy ()
 
- Protected Member Functions inherited from Base::PyObjectBase
virtual ~PyObjectBase ()
 destructor More...
 

callbacks and implementers for the python object methods

PyObject * getBaseObject (PyObject *args)
 implementer for the getBaseObject() method More...
 
static PyObject * staticCallback_getBaseObject (PyObject *self, PyObject *args)
 callback for the getBaseObject() method More...
 

Additional Inherited Members

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

Detailed Description

The python export class for Feature.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~FeaturePy()

FeaturePy::~FeaturePy ( )
protected

◆ FeaturePy()

FeaturePy::FeaturePy ( Feature *  pcObject,
PyTypeObject *  T = &Type 
)

Member Function Documentation

◆ getBaseObject()

PyObject * FeaturePy::getBaseObject ( PyObject *  args)

implementer for the getBaseObject() method

References PartDesign::Feature::getBaseObject(), and getFeaturePtr().

Referenced by staticCallback_getBaseObject().

◆ getCustomAttributes()

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

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

◆ getFeaturePtr()

Feature * FeaturePy::getFeaturePtr ( void  ) const

getter for the object handled by this class

Referenced by getBaseObject(), and representation().

◆ GetType()

virtual PyTypeObject* PartDesign::FeaturePy::GetType ( void  )
virtual

Reimplemented from Part::PartFeaturePy.

◆ PyInit()

int FeaturePy::PyInit ( PyObject *  ,
PyObject *   
)
virtual

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

Reimplemented from Part::PartFeaturePy.

◆ PyMake()

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

◆ representation()

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ staticCallback_getBaseObject()

Member Data Documentation

◆ GetterSetter

PyGetSetDef FeaturePy::GetterSetter
static
Initial value:
= {
{NULL, NULL, NULL, NULL, NULL}
}

Attribute structure of FeaturePy.

◆ Methods

PyMethodDef FeaturePy::Methods
static
Initial value:
= {
{"getBaseObject",
reinterpret_cast<PyCFunction>( staticCallback_getBaseObject ),
METH_VARARGS,
"getBaseObject: returns feature this one fuses itself to, or None. Normally, this should be the same as BaseFeature property, except for legacy workflow. In legacy workflow, it will look up the support of referenced sketch."
},
{NULL, NULL, 0, NULL}
}

Methods structure of FeaturePy.

◆ Type


The documentation for this class was generated from the following files:
  • build/webdoc/src/Mod/PartDesign/App/FeaturePy.h
  • src/Mod/PartDesign/App/FeaturePyImp.cpp
  • build/webdoc/src/Mod/PartDesign/App/FeaturePy.cpp
static PyObject * staticCallback_getBaseObject(PyObject *self, PyObject *args)
callback for the getBaseObject() method
Definition: FeaturePy.cpp:98