Gui::ViewProviderPy Class Reference

The python export class for ViewProvider. More...

#include <ViewProviderPy.h>

Inheritance diagram for Gui::ViewProviderPy:

Public Types
typedef ViewProvider *	PointerType
Public Member Functions
PyObject *	_getattr (char *attr)
	GetAttribute implementation This method implements the retriavel of object attributes.
virtual PyObject *	_repr (void)
	_repr method Overide this method to return a string object with some invormation about the object.
int	_setattr (char attr, PyObject value)
	SetAttribute implementation This method implements the seting of object attributes.
PyObject *	getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones)
virtual PyParentObject *	GetParents (void)
virtual PyTypeObject *	GetType (void)
ViewProvider *	getViewProviderPtr (void) const
	getter for the object handled by this class
virtual int	PyInit (PyObject args, PyObject k)
	PyInit method Overide this method to initialize a newly created instance of the class (Constuctor).
std::string	representation (void) const
int	setCustomAttributes (const char attr, PyObject obj)
	setter for special attributes (e.g. dynamic ones)
	ViewProviderPy (ViewProvider pcObject, PyTypeObject T=&Type)
	~ViewProviderPy ()
Static Public Member Functions
static PyObject *	PyMake (struct _typeobject , PyObject , PyObject *)
Static Public Attributes
static PyGetSetDef	GetterSetter []
	Attribute structure of ViewProviderPy.
static PyMethodDef	Methods []
	Methods structure of ViewProviderPy.
static PyParentObject	Parents [] = { PARENTSGuiViewProviderPy }
static PyTypeObject	Type
	Type structure of ViewProviderPy.
callbacks and implementers for the python object methods

PyObject *	finishEditing (PyObject *args)
	implementer for the finishEditing() method
PyObject *	hide (PyObject *args)
	implementer for the hide() method
PyObject *	isEditing (PyObject *args)
	implementer for the isEditing() method
PyObject *	isVisible (PyObject *args)
	implementer for the isVisible() method
PyObject *	listDisplayModes (PyObject *args)
	implementer for the listDisplayModes() method
PyObject *	setTransformation (PyObject *args)
	implementer for the setTransformation() method
PyObject *	show (PyObject *args)
	implementer for the show() method
PyObject *	startEditing (PyObject *args)
	implementer for the startEditing() method
PyObject *	toString (PyObject *args)
	implementer for the toString() method
static PyObject *	staticCallback_finishEditing (PyObject self, PyObject args)
	callback for the finishEditing() method
static PyObject *	staticCallback_hide (PyObject self, PyObject args)
	callback for the hide() method
static PyObject *	staticCallback_isEditing (PyObject self, PyObject args)
	callback for the isEditing() method
static PyObject *	staticCallback_isVisible (PyObject self, PyObject args)
	callback for the isVisible() method
static PyObject *	staticCallback_listDisplayModes (PyObject self, PyObject args)
	callback for the listDisplayModes() method
static PyObject *	staticCallback_setTransformation (PyObject self, PyObject args)
	callback for the setTransformation() method
static PyObject *	staticCallback_show (PyObject self, PyObject args)
	callback for the show() method
static PyObject *	staticCallback_startEditing (PyObject self, PyObject args)
	callback for the startEditing() method
static PyObject *	staticCallback_toString (PyObject self, PyObject args)
	callback for the toString() method
callbacks and implementers for the python object attributes

Py::Object	getAnnotation (void) const
	getter for the Annotation attribute
Py::String	getIV (void) const
	getter for the IV attribute
Py::Object	getRootNode (void) const
	getter for the RootNode attribute
void	setAnnotation (Py::Object arg)
	setter for the Annotation attribute
void	setRootNode (Py::Object arg)
	setter for the RootNode attribute
static PyObject *	staticCallback_getAnnotation (PyObject self, void closure)
	getter callback for the Annotation attribute
static PyObject *	staticCallback_getIV (PyObject self, void closure)
	getter callback for the IV attribute
static PyObject *	staticCallback_getRootNode (PyObject self, void closure)
	getter callback for the RootNode attribute
static int	staticCallback_setAnnotation (PyObject self, PyObject value, void *closure)
	setter callback for the Annotation attribute
static int	staticCallback_setIV (PyObject self, PyObject value, void *closure)
	setter callback for the IV attribute
static int	staticCallback_setRootNode (PyObject self, PyObject value, void *closure)
	setter callback for the RootNode attribute

Detailed Description

The python export class for ViewProvider.

Definition at line 20 of file ViewProviderPy.h.

Member Typedef Documentation

typedef ViewProvider* Gui::ViewProviderPy::PointerType

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 36 of file ViewProviderPy.h.

Constructor & Destructor Documentation

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

Definition at line 962 of file ViewProviderPy.cpp.

ViewProviderPy::~ViewProviderPy ( )

Definition at line 983 of file ViewProviderPy.cpp.

Member Function Documentation

PyObject * ViewProviderPy::_getattr ( char * attr ) [virtual]

GetAttribute implementation This method implements the retriavel of object attributes.

If you want to implement attributes in your class, reimplement this method. You have to call the method of the base class. Note: if you reimplement _gettattr() in a inheriting class you need to call the method of the base class! Otherwise even the methods of the object will disapiear!

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 998 of file ViewProviderPy.cpp.

References Base::Console(), getCustomAttributes(), Methods, Base::Exception::ReportException(), and Base::Exception::what().

PyObject * ViewProviderPy::_repr ( void ) [virtual]

_repr method Overide this method to return a string object with some invormation about the object.

 PyObject *MeshFeaturePy::_repr(void)
 {
   std::stringstream a;
   a << "MeshFeature: [ ";
   a << "some realy important info about the object!";
   a << "]" << std::endl;
   return Py_BuildValue("s", a.str().c_str());
 }

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 990 of file ViewProviderPy.cpp.

References representation().

int ViewProviderPy::_setattr	(	char *	attr,
		PyObject *	value
	)			`[virtual]`

SetAttribute implementation This method implements the seting of object attributes.

If you want to implement attributes in your class, reimplement this method. You have to call the method of the base class.

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 1066 of file ViewProviderPy.cpp.

References Base::Console(), Base::Exception::ReportException(), setCustomAttributes(), and Base::Exception::what().

PyObject * ViewProviderPy::finishEditing ( PyObject * args )

implementer for the finishEditing() method

Definition at line 120 of file ViewProviderPyImp.cpp.

References Gui::ViewProvider::finishEditing(), getViewProviderPtr(), and Py_Return.

Py::Object ViewProviderPy::getAnnotation ( void ) const

getter for the Annotation attribute

Definition at line 167 of file ViewProviderPyImp.cpp.

References Gui::ViewProvider::getAnnotation(), getViewProviderPtr(), Base::Interpreter(), and Base::Exception::what().

Referenced by staticCallback_getAnnotation().

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

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

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 157 of file ViewProviderPyImp.cpp.

Referenced by _getattr().

Py::String ViewProviderPy::getIV ( void ) const

getter for the IV attribute

Definition at line 230 of file ViewProviderPyImp.cpp.

References buffer_writeaction(), and getViewProviderPtr().

Referenced by staticCallback_getIV().

virtual PyParentObject* Gui::ViewProviderPy::GetParents ( void ) [inline, virtual]

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 28 of file ViewProviderPy.h.

Py::Object ViewProviderPy::getRootNode ( void ) const

getter for the RootNode attribute

Definition at line 185 of file ViewProviderPyImp.cpp.

References Gui::ViewProvider::getRoot(), getViewProviderPtr(), Base::Interpreter(), and Base::Exception::what().

Referenced by staticCallback_getRootNode().

virtual PyTypeObject* Gui::ViewProviderPy::GetType ( void ) [inline, virtual]

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 27 of file ViewProviderPy.h.

ViewProvider * ViewProviderPy::getViewProviderPtr ( void ) const

getter for the object handled by this class

Definition at line 1125 of file ViewProviderPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Referenced by finishEditing(), getAnnotation(), getIV(), getRootNode(), hide(), isEditing(), isVisible(), listDisplayModes(), setTransformation(), show(), startEditing(), and toString().

PyObject * ViewProviderPy::hide ( PyObject * args )

implementer for the hide() method

Definition at line 63 of file ViewProviderPyImp.cpp.

References getViewProviderPtr(), Gui::ViewProvider::hide(), PY_CATCH, Py_Return, and PY_TRY.

PyObject * ViewProviderPy::isEditing ( PyObject * args )

implementer for the isEditing() method

Definition at line 128 of file ViewProviderPyImp.cpp.

References getViewProviderPtr(), Gui::ViewProvider::isEditing(), and Py::new_reference_to().

PyObject * ViewProviderPy::isVisible ( PyObject * args )

implementer for the isVisible() method

Definition at line 73 of file ViewProviderPyImp.cpp.

References getViewProviderPtr(), PY_CATCH, and PY_TRY.

PyObject * ViewProviderPy::listDisplayModes ( PyObject * args )

implementer for the listDisplayModes() method

Definition at line 82 of file ViewProviderPyImp.cpp.

References Gui::ViewProvider::getDisplayModes(), getViewProviderPtr(), PY_CATCH, and PY_TRY.

int ViewProviderPy::PyInit	(	PyObject *	,
		PyObject *
	)			`[virtual]`

PyInit method Overide this method to initialize a newly created instance of the class (Constuctor).

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 975 of file ViewProviderPy.cpp.

PyObject * ViewProviderPy::PyMake	(	struct _typeobject *	,
		PyObject *	,
		PyObject *
	)			`[static]`

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 967 of file ViewProviderPy.cpp.

std::string ViewProviderPy::representation ( void ) const

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 48 of file ViewProviderPyImp.cpp.

Referenced by _repr().

void ViewProviderPy::setAnnotation ( Py::Object arg )

setter for the Annotation attribute

Definition at line 180 of file ViewProviderPyImp.cpp.

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

setter for special attributes (e.g. dynamic ones)

Reimplemented from App::PropertyContainerPy.

Reimplemented in Gui::ViewProviderDocumentObjectPy, and Gui::ViewProviderPythonFeaturePy.

Definition at line 162 of file ViewProviderPyImp.cpp.

Referenced by _setattr().

void ViewProviderPy::setRootNode ( Py::Object arg )

setter for the RootNode attribute

Definition at line 198 of file ViewProviderPyImp.cpp.

PyObject * ViewProviderPy::setTransformation ( PyObject * args )

implementer for the setTransformation() method

Definition at line 137 of file ViewProviderPyImp.cpp.

References Base::PlacementPy::getPlacementPtr(), getViewProviderPtr(), draftTools::p, Py_Return, Gui::ViewProvider::setTransformation(), Base::PlacementPy::Type, and Base::MatrixPy::Type.

PyObject * ViewProviderPy::show ( PyObject * args )

implementer for the show() method

Definition at line 53 of file ViewProviderPyImp.cpp.

References getViewProviderPtr(), PY_CATCH, Py_Return, PY_TRY, and Gui::ViewProvider::show().

PyObject * ViewProviderPy::startEditing ( PyObject * args )

implementer for the startEditing() method

Definition at line 110 of file ViewProviderPyImp.cpp.

References getViewProviderPtr(), Py::new_reference_to(), and Gui::ViewProvider::startEditing().

PyObject * ViewProviderPy::staticCallback_finishEditing	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the finishEditing() method

Definition at line 607 of file ViewProviderPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * ViewProviderPy::staticCallback_getAnnotation	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the Annotation attribute

Definition at line 835 of file ViewProviderPy.cpp.

References getAnnotation(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * ViewProviderPy::staticCallback_getIV	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the IV attribute

Definition at line 923 of file ViewProviderPy.cpp.

References getIV(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * ViewProviderPy::staticCallback_getRootNode	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the RootNode attribute

Definition at line 879 of file ViewProviderPy.cpp.

References getRootNode(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * ViewProviderPy::staticCallback_hide	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the hide() method

Definition at line 227 of file ViewProviderPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * ViewProviderPy::staticCallback_isEditing	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the isEditing() method

Definition at line 683 of file ViewProviderPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * ViewProviderPy::staticCallback_isVisible	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the isVisible() method

Definition at line 303 of file ViewProviderPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * ViewProviderPy::staticCallback_listDisplayModes	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the listDisplayModes() method

Definition at line 379 of file ViewProviderPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

int ViewProviderPy::staticCallback_setAnnotation	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the Annotation attribute

Definition at line 853 of file ViewProviderPy.cpp.

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

int ViewProviderPy::staticCallback_setIV	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the IV attribute

Definition at line 941 of file ViewProviderPy.cpp.

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

int ViewProviderPy::staticCallback_setRootNode	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the RootNode attribute

Definition at line 897 of file ViewProviderPy.cpp.

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

PyObject * ViewProviderPy::staticCallback_setTransformation	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the setTransformation() method

Definition at line 759 of file ViewProviderPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * ViewProviderPy::staticCallback_show	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the show() method

Definition at line 151 of file ViewProviderPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * ViewProviderPy::staticCallback_startEditing	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the startEditing() method

Definition at line 531 of file ViewProviderPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * ViewProviderPy::staticCallback_toString	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the toString() method

Definition at line 455 of file ViewProviderPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * ViewProviderPy::toString ( PyObject * args )

implementer for the toString() method

Definition at line 100 of file ViewProviderPyImp.cpp.

References buffer, getViewProviderPtr(), Py::new_reference_to(), PY_CATCH, PY_TRY, and Gui::ViewProvider::toString().

Member Data Documentation

PyGetSetDef ViewProviderPy::GetterSetter [static]

Initial value:

 {
    {"Annotation",
        (getter) staticCallback_getAnnotation,
        (setter) staticCallback_setAnnotation, 
        "A pivy Separator to add a custom scene graph to this ViewProvider",
        NULL
    },
    {"RootNode",
        (getter) staticCallback_getRootNode,
        (setter) staticCallback_setRootNode, 
        "A pivy Separator with the root of this ViewProvider",
        NULL
    },
    {"IV",
        (getter) staticCallback_getIV,
        (setter) staticCallback_setIV, 
        "Represents the whole ViewProvider as an Inventor string.",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}