FeaturePython::ViewProviderBox Class Reference

List of all members.

Public Member Functions
def	__getstate__
def	__init__
def	__setstate__
def	attach
def	getDefaultDisplayMode
def	getDisplayModes
def	getIcon
def	onChanged
def	setDisplayMode
def	updateData

---

Detailed Description

Definition at line 57 of file FeaturePython.py.

---

Member Function Documentation

def FeaturePython::ViewProviderBox::__getstate__

(

self

)

When saving the document this object gets stored using Python's cPickle module.
Since we have some un-pickable here -- the Coin stuff -- we must define this method
to return a tuple of all pickable objects or None.

Definition at line 121 of file FeaturePython.py.

def FeaturePython::ViewProviderBox::__init__	(		self,
			obj
	)

Set this object to the proxy object of the actual view provider 

Definition at line 58 of file FeaturePython.py.

def FeaturePython::ViewProviderBox::__setstate__	(		self,
			state
	)

When restoring the pickled object from document we have the chance to set some
internals here. Since no data were pickled nothing needs to be done here.

Definition at line 128 of file FeaturePython.py.

def FeaturePython::ViewProviderBox::attach	(		self,
			obj
	)

Setup the scene sub-graph of the view provider, this method is mandatory 

Definition at line 62 of file FeaturePython.py.

def FeaturePython::ViewProviderBox::getDefaultDisplayMode

(

self

)

Return the name of the default display mode. It must be defined in getDisplayModes. 

Definition at line 75 of file FeaturePython.py.

def FeaturePython::ViewProviderBox::getDisplayModes	(		self,
			obj
	)

Return a list of display modes. 

Definition at line 70 of file FeaturePython.py.

def FeaturePython::ViewProviderBox::getIcon

(

self

)

Return the icon in XMP format which will appear in the tree view. This method is optional
and if not defined a default icon is shown.

Definition at line 89 of file FeaturePython.py.

def FeaturePython::ViewProviderBox::onChanged	(		self,
			vp,
			prop
	)

Print the name of the property that has changed 

Definition at line 85 of file FeaturePython.py.

def FeaturePython::ViewProviderBox::setDisplayMode	(		self,
			mode
	)

Map the display mode defined in attach with those defined in getDisplayModes.
Since they have the same names nothing needs to be done. This method is optinal.

Definition at line 79 of file FeaturePython.py.

def FeaturePython::ViewProviderBox::updateData	(		self,
			fp,
			prop
	)

If a property of the handled feature has changed we have the chance to handle this here 

Definition at line 66 of file FeaturePython.py.

---

The documentation for this class was generated from the following file:

• FeaturePython.py