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()

◆ 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)

◆ onChanged()

◆ 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 
)

The documentation for this class was generated from the following file:
  • Sources/FreeCAD/src/Mod/Ship/Instance.py