PartDesignGui::ViewProviderPy Class Reference

The python export class for ViewProvider. More...

#include <ViewProviderPy.h>

Public Types
typedef ViewProvider * PointerType
Public Types inherited from Gui::ViewProviderDocumentObjectPy
typedef ViewProviderDocumentObject * PointerType
Public Types inherited from Gui::ViewProviderPy
typedef ViewProvider * 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
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
ViewProviderPy (ViewProvider *pcObject, PyTypeObject *T=&Type)
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...
ViewProvider * getViewProviderPtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from Gui::ViewProviderDocumentObjectPy
std::string representation (void) const
ViewProviderDocumentObjectPy (ViewProviderDocumentObject *pcObject, PyTypeObject *T=&Type)
PyObject * update (PyObject *args)
	implementer for the update() method More...
Py::Object getObject (void) const
	getter for the Object attribute More...
Py::Object getDocument (void) const
	getter for the Document 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...
ViewProviderDocumentObject * getViewProviderDocumentObjectPtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from Gui::ViewProviderPy
std::string representation (void) const
ViewProviderPy (ViewProvider *pcObject, PyTypeObject *T=&Type)
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 * show (PyObject *args)
	implementer for the show() method More...
PyObject * hide (PyObject *args)
	implementer for the hide() method More...
PyObject * isVisible (PyObject *args)
	implementer for the isVisible() method More...
PyObject * addDisplayMode (PyObject *args)
	implementer for the addDisplayMode() method More...
PyObject * listDisplayModes (PyObject *args)
	implementer for the listDisplayModes() method More...
PyObject * toString (PyObject *args)
	implementer for the toString() method More...
PyObject * setTransformation (PyObject *args)
	implementer for the setTransformation() method More...
PyObject * claimChildren (PyObject *args)
	implementer for the claimChildren() method More...
Py::Object getAnnotation (void) const
	getter for the Annotation attribute More...
void setAnnotation (Py::Object arg)
	setter for the Annotation attribute More...
Py::Object getIcon (void) const
	getter for the Icon attribute More...
Py::Object getRootNode (void) const
	getter for the RootNode attribute More...
void setRootNode (Py::Object arg)
	setter for the RootNode attribute More...
Py::String getIV (void) const
	getter for the IV 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...
ViewProvider * getViewProviderPtr (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 Gui::ViewProviderDocumentObjectPy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
static PyObject * staticCallback_update (PyObject *self, PyObject *args)
	callback for the update() method More...
static PyObject * staticCallback_getObject (PyObject *self, void *closure)
	getter callback for the Object attribute More...
static int staticCallback_setObject (PyObject *self, PyObject *value, void *closure)
	setter callback for the Object 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 Public Member Functions inherited from Gui::ViewProviderPy
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_show (PyObject *self, PyObject *args)
	callback for the show() method More...
static PyObject * staticCallback_hide (PyObject *self, PyObject *args)
	callback for the hide() method More...
static PyObject * staticCallback_isVisible (PyObject *self, PyObject *args)
	callback for the isVisible() method More...
static PyObject * staticCallback_addDisplayMode (PyObject *self, PyObject *args)
	callback for the addDisplayMode() method More...
static PyObject * staticCallback_listDisplayModes (PyObject *self, PyObject *args)
	callback for the listDisplayModes() method More...
static PyObject * staticCallback_toString (PyObject *self, PyObject *args)
	callback for the toString() method More...
static PyObject * staticCallback_setTransformation (PyObject *self, PyObject *args)
	callback for the setTransformation() method More...
static PyObject * staticCallback_claimChildren (PyObject *self, PyObject *args)
	callback for the claimChildren() method More...
static PyObject * staticCallback_getAnnotation (PyObject *self, void *closure)
	getter callback for the Annotation attribute More...
static int staticCallback_setAnnotation (PyObject *self, PyObject *value, void *closure)
	setter callback for the Annotation attribute More...
static PyObject * staticCallback_getIcon (PyObject *self, void *closure)
	getter callback for the Icon attribute More...
static int staticCallback_setIcon (PyObject *self, PyObject *value, void *closure)
	setter callback for the Icon attribute More...
static PyObject * staticCallback_getRootNode (PyObject *self, void *closure)
	getter callback for the RootNode attribute More...
static int staticCallback_setRootNode (PyObject *self, PyObject *value, void *closure)
	setter callback for the RootNode attribute More...
static PyObject * staticCallback_getIV (PyObject *self, void *closure)
	getter callback for the IV attribute More...
static int staticCallback_setIV (PyObject *self, PyObject *value, void *closure)
	setter callback for the IV 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 ViewProviderPy. More...
static PyMethodDef Methods []
	Methods structure of ViewProviderPy. More...
static PyTypeObject Type
	Type structure of ViewProviderPy. More...
Static Public Attributes inherited from Gui::ViewProviderDocumentObjectPy
static PyGetSetDef GetterSetter []
	Attribute structure of ViewProviderDocumentObjectPy. More...
static PyMethodDef Methods []
	Methods structure of ViewProviderDocumentObjectPy. More...
static PyTypeObject Type
	Type structure of ViewProviderDocumentObjectPy. More...
Static Public Attributes inherited from Gui::ViewProviderPy
static PyGetSetDef GetterSetter []
	Attribute structure of ViewProviderPy. More...
static PyMethodDef Methods []
	Methods structure of ViewProviderPy. More...
static PyTypeObject Type
	Type structure of ViewProviderPy. 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
~ViewProviderPy ()
Protected Member Functions inherited from Gui::ViewProviderDocumentObjectPy
~ViewProviderDocumentObjectPy ()
Protected Member Functions inherited from Gui::ViewProviderPy
~ViewProviderPy ()
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 * setBodyMode (PyObject *args)
	implementer for the setBodyMode() method More...
PyObject * makeTemporaryVisible (PyObject *args)
	implementer for the makeTemporaryVisible() method More...
static PyObject * staticCallback_setBodyMode (PyObject *self, PyObject *args)
	callback for the setBodyMode() method More...
static PyObject * staticCallback_makeTemporaryVisible (PyObject *self, PyObject *args)
	callback for the makeTemporaryVisible() method More...

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

Detailed Description

The python export class for ViewProvider.

Member Typedef Documentation

PointerType

typedef ViewProvider* PartDesignGui::ViewProviderPy::PointerType

Constructor & Destructor Documentation

~ViewProviderPy()

ViewProviderPy::~ViewProviderPy ( )

protected

ViewProviderPy()

ViewProviderPy::ViewProviderPy	(	ViewProvider *	pcObject,
		PyTypeObject *	T = &Type
	)

Member Function Documentation

getCustomAttributes()

PyObject * ViewProviderPy::getCustomAttributes

(

const char *

attr

)

const

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

GetType()

virtual PyTypeObject* PartDesignGui::ViewProviderPy::GetType ( void  )

virtual

Reimplemented from Gui::ViewProviderDocumentObjectPy.

getViewProviderPtr()

ViewProvider * ViewProviderPy::getViewProviderPtr

(

void

)

const

getter for the object handled by this class

Referenced by makeTemporaryVisible(), and setBodyMode().

makeTemporaryVisible()

PyObject * ViewProviderPy::makeTemporaryVisible

(

PyObject *

args

)

implementer for the makeTemporaryVisible() method

References getViewProviderPtr().

Referenced by staticCallback_makeTemporaryVisible().

PyInit()

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

virtual

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

Reimplemented from Gui::ViewProviderDocumentObjectPy.

PyMake()

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

static

representation()

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

setBodyMode()

PyObject * ViewProviderPy::setBodyMode

(

PyObject *

args

)

implementer for the setBodyMode() method

References getViewProviderPtr().

Referenced by staticCallback_setBodyMode().

setCustomAttributes()

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

setter for special attributes (e.g.

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

staticCallback_makeTemporaryVisible()

PyObject * ViewProviderPy::staticCallback_makeTemporaryVisible ( PyObject *  self, PyObject *  args  )

static

callback for the makeTemporaryVisible() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), makeTemporaryVisible(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_setBodyMode()

PyObject * ViewProviderPy::staticCallback_setBodyMode ( PyObject *  self, PyObject *  args  )

static

callback for the setBodyMode() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), setBodyMode(), and Base::PyObjectBase::startNotify().

Member Data Documentation

GetterSetter

PyGetSetDef ViewProviderPy::GetterSetter

static

Initial value:

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

Attribute structure of ViewProviderPy.

Methods

PyMethodDef ViewProviderPy::Methods

static

Initial value:

= {
    {"setBodyMode",
        reinterpret_cast<PyCFunction>( staticCallback_setBodyMode ),
        METH_VARARGS,
        "setBodyMode(bool): body mode means that the object is part of a body\nand that the body is used to set the visual properties, not the features. Hence\nsetting body mode to true will hide most viewprovider properties."
    },
    {"makeTemporaryVisible",
        reinterpret_cast<PyCFunction>( staticCallback_makeTemporaryVisible ),
        METH_VARARGS,
        "makeTemporaryVisible(bool): makes this viewprovider visible in the\nscene graph without changing any properties, not the visibility one and also not\nthe display mode. This can be used to show the shape of this viewprovider from\nother viewproviders without doing anything to the document and properties.\n"
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of ViewProviderPy.

Type

PyTypeObject ViewProviderPy::Type

static

Type structure of ViewProviderPy.

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/PartDesign/Gui/ViewProviderPy.h
• src/Mod/PartDesign/Gui/ViewProviderPyImp.cpp
• build/webdoc/src/Mod/PartDesign/Gui/ViewProviderPy.cpp