Instance.ViewProviderShip Class Reference

Public Member Functions
def	attach (self, obj)
def	claimChildren (self)
def	getDefaultDisplayMode (self)
def	getDisplayModes (self, obj)
def	getIcon (self)
def	onChanged (self, vp, prop)
def	setDisplayMode (self, mode)
def	updateData (self, fp, prop)

Member Function Documentation

attach()

def Instance.ViewProviderShip.attach	(		self,
			obj
	)

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

claimChildren()

def Instance.ViewProviderShip.claimChildren

(

self

)

getDefaultDisplayMode()

def Instance.ViewProviderShip.getDefaultDisplayMode

(

self

)

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

getDisplayModes()

def Instance.ViewProviderShip.getDisplayModes	(		self,
			obj
	)

Return a list of display modes.

Keyword arguments:
obj -- Object associated with the view provider.

getIcon()

def Instance.ViewProviderShip.getIcon

(

self

)

Returns the icon for this kind of objects.

onChanged()

def Instance.ViewProviderShip.onChanged	(		self,
			vp,
			prop
	)

Detects the ship view provider data changes.

Keyword arguments:
vp -- View provider object affected.
prop -- Modified property name.

Referenced by ArchSite.Compass.buildCoordinates(), and ArchAxis.CommandArchGrid.IsActive().

setDisplayMode()

def Instance.ViewProviderShip.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 optional.

Keyword arguments:
mode -- Mode to be activated.

updateData()

def Instance.ViewProviderShip.updateData	(		self,
			fp,
			prop
	)

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

Keyword arguments:
fp -- Part::FeaturePython object affected.
prop -- Modified property name.

---

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

• src/Mod/Ship/Instance.py