DocumentObject.ViewProvider Class Reference

Public Member Functions

def addDisplayMode (self, node, mode)
 
def addProperty (self, type, name='', group='', doc='', attr=0, readonly=False, hidden=False)
 
def Annotation (self)
 
def Content (self)
 
def DisplayModes (self)
 
def getAllDerivedFrom (self)
 
def getDocumentationOfProperty (self, attr)
 
def getGroupOfProperty (self, attr)
 
def getProperty (self, attr)
 
def getTypeOfProperty (self, attr)
 
def hide (self)
 
def isDerivedFrom (self, obj)
 
def isVisible (self)
 
def MemSize (self)
 
def Module (self)
 
def Object (self)
 
def PropertiesList (self)
 
def RootNode (self)
 
def setTransformation (self, trsf)
 
def show (self)
 
def supportedProperties (self)
 
def toString (self)
 
def Type (self)
 
def update (self)
 

Detailed Description

The ViewProvider is the counterpart of the DocumentObject in
the GUI space. It is only present when FreeCAD runs in GUI mode.
It contains all that is needed to represent the DocumentObject in
the 3D view and the FreeCAD interface

Member Function Documentation

◆ addDisplayMode()

def DocumentObject.ViewProvider.addDisplayMode (   self,
  node,
  mode 
)

References DocumentObject.ViewProvider.__vobject__.

◆ addProperty()

def DocumentObject.ViewProvider.addProperty (   self,
  type,
  name = '',
  group = '',
  doc = '',
  attr = 0,
  readonly = False,
  hidden = False 
)

References DocumentObject.ViewProvider.__vobject__.

Referenced by DocumentObject.Box.init(), and DocumentObject.DocumentObject.onChanged().

◆ Annotation()

def DocumentObject.ViewProvider.Annotation (   self)

References DocumentObject.ViewProvider.__vobject__.

◆ Content()

def DocumentObject.ViewProvider.Content (   self)
shows the contents of the properties of this object as an xml string.
This is the content that is saved when the file is saved by FreeCAD

References DocumentObject.ViewProvider.__vobject__.

◆ DisplayModes()

def DocumentObject.ViewProvider.DisplayModes (   self)

References DocumentObject.ViewProvider.__vobject__.

◆ getAllDerivedFrom()

def DocumentObject.ViewProvider.getAllDerivedFrom (   self)

References DocumentObject.ViewProvider.__vobject__.

◆ getDocumentationOfProperty()

def DocumentObject.ViewProvider.getDocumentationOfProperty (   self,
  attr 
)

References DocumentObject.ViewProvider.__vobject__.

◆ getGroupOfProperty()

def DocumentObject.ViewProvider.getGroupOfProperty (   self,
  attr 
)

References DocumentObject.ViewProvider.__vobject__.

◆ getProperty()

def DocumentObject.ViewProvider.getProperty (   self,
  attr 
)

References DocumentObject.ViewProvider.__vobject__.

◆ getTypeOfProperty()

def DocumentObject.ViewProvider.getTypeOfProperty (   self,
  attr 
)

References DocumentObject.ViewProvider.__vobject__.

◆ hide()

◆ isDerivedFrom()

def DocumentObject.ViewProvider.isDerivedFrom (   self,
  obj 
)
returns True if this object is derived from the given C++ class, for
example Part::Feature

References DocumentObject.ViewProvider.__vobject__.

◆ isVisible()

def DocumentObject.ViewProvider.isVisible (   self)

References DocumentObject.ViewProvider.__vobject__.

Referenced by ArchVRM.Renderer.removeHidden().

◆ MemSize()

def DocumentObject.ViewProvider.MemSize (   self)

References DocumentObject.ViewProvider.__vobject__.

◆ Module()

def DocumentObject.ViewProvider.Module (   self)

References DocumentObject.ViewProvider.__vobject__.

◆ Object()

def DocumentObject.ViewProvider.Object (   self)

References DocumentObject.ViewProvider.__vobject__.

Referenced by draftviewproviders.view_layer.ViewProviderLayer.activate(), ArchPanel.CommandPanelSheet.Activated(), OpenSCADFeatures.ViewProviderTree.attach(), draftviewproviders.view_base.ViewProviderDraft.attach(), draftviewproviders.view_dimension.ViewProviderLinearDimension.attach(), draftviewproviders.view_dimension.ViewProviderAngularDimension.attach(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.attach(), draftviewproviders.view_layer.ViewProviderLayer.attach(), draftviewproviders.view_layer.ViewProviderLayerContainer.attach(), PathScripts.PathArray.ViewProviderArray.attach(), PathScripts.PathCopy.ViewProviderPathCopy.attach(), PathScripts.PathDressupDragknife.ViewProviderDressup.attach(), PathScripts.PathHop.ViewProviderPathHop.attach(), PathScripts.PathOpGui.ViewProvider.attach(), ArchSite.Compass.buildCoordinates(), ArchReference.ViewProviderArchReference.checkChanges(), ArchComponent.ViewProviderComponent.claimChildren(), draftviewproviders.view_base.ViewProviderDraft.claimChildren(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.claimChildren(), draftviewproviders.view_draftlink.ViewProviderDraftLink.claimChildren(), draftviewproviders.view_layer.ViewProviderLayer.claimChildren(), draftviewproviders.view_wire.ViewProviderWire.claimChildren(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.claimChildren(), femviewprovider.view_result_mechanical.VPResultMechanical.claimChildren(), OpenSCADFeatures.ViewProviderTree.claimChildren(), BOPTools.JoinFeatures.ViewProviderConnect.claimChildren(), BOPTools.JoinFeatures.ViewProviderEmbed.claimChildren(), BOPTools.JoinFeatures.ViewProviderCutout.claimChildren(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.claimChildren(), BOPTools.SplitFeatures.ViewProviderSlice.claimChildren(), BOPTools.SplitFeatures.ViewProviderXOR.claimChildren(), PathScripts.PathArray.ViewProviderArray.claimChildren(), PathScripts.PathDressupDragknife.ViewProviderDressup.claimChildren(), Spreadsheet_legacy.ViewProviderSpreadsheet.claimChildren(), PathScripts.PathOpGui.ViewProvider.clearTaskPanel(), ArchBuildingPart.ViewProviderBuildingPart.cloneUp(), ArchStructure.StructureTaskPanel.connectNodes(), ArchBuildingPart.ViewProviderBuildingPart.createGroup(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.doubleClicked(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.dragObject(), BOPTools.JoinFeatures.ViewProviderConnect.dragObject(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.dragObject(), BOPTools.SplitFeatures.ViewProviderXOR.dragObject(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.dropObject(), BOPTools.JoinFeatures.ViewProviderConnect.dropObject(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.dropObject(), BOPTools.SplitFeatures.ViewProviderXOR.dropObject(), ArchStructure.StructureTaskPanel.extendNodes(), draftviewproviders.view_wire.ViewProviderWire.flatten(), Mod.Show.Containers.Container.getCSChildren(), Mod.Show.Containers.Container.getDynamicChildren(), ArchBuildingPart.ViewProviderBuildingPart.getIcon(), ArchComponent.ViewProviderComponent.getIcon(), draftviewproviders.view_array.ViewProviderDraftArray.getIcon(), draftviewproviders.view_base.ViewProviderDraft.getIcon(), draftviewproviders.view_dimension.ViewProviderDimensionBase.getIcon(), draftviewproviders.view_draftlink.ViewProviderDraftLink.getIcon(), femviewprovider.view_base_femobject.VPBaseFemObject.getIcon(), femviewprovider.view_material_common.VPMaterialCommon.getIcon(), OpenSCADFeatures.ViewProviderTree.getIcon(), PathScripts.PathOpGui.ViewProvider.getIcon(), Mod.Show.Containers.Container.getStaticChildren(), Mod.Show.Containers.Container.getVisGroupChildren(), Mod.Show.Containers.Container.hasObjectRecursive(), draftviewproviders.view_dimension.ViewProviderLinearDimension.is_linked_to_circle(), Mod.Show.Containers.Container.isACS(), ArchSchedule.CommandArchSchedule.IsActive(), Mod.Show.Containers.Container.isAVisGroup(), Mod.Show.Containers.Container.isChildVisible(), draftviewproviders.view_layer.ViewProviderLayerContainer.merge_by_name(), draftviewproviders.view_base.ViewProviderDraft.onChanged(), BOPTools.JoinFeatures.ViewProviderEmbed.onDelete(), BOPTools.JoinFeatures.ViewProviderCutout.onDelete(), ArchReference.ViewProviderArchReference.onOpen(), ArchReference.ViewProviderArchReference.onReload(), ArchBuildingPart.ViewProviderBuildingPart.reorder(), ArchStructure.StructureTaskPanel.resetNodes(), draftviewproviders.view_layer.ViewProviderLayer.select_contents(), Mod.Show.Containers.Container.self_check(), ArchComponent.ViewProviderComponent.setDisplayMode(), ArchComponent.ViewProviderComponent.setEdit(), Mod.PartDesign.SprocketFeature.ViewProviderSprocket.setEdit(), PathScripts.PathOpGui.ViewProvider.setupTaskPanel(), ArchBuildingPart.ViewProviderBuildingPart.setWorkingPlane(), femviewprovider.view_result_mechanical.VPResultMechanical.unsetEdit(), ArchBuildingPart.ViewProviderBuildingPart.writeCamera(), draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.writeCamera(), ArchBuildingPart.ViewProviderBuildingPart.writeInventor(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.writeState().

◆ PropertiesList()

def DocumentObject.ViewProvider.PropertiesList (   self)

References DocumentObject.ViewProvider.__vobject__.

◆ RootNode()

def DocumentObject.ViewProvider.RootNode (   self)

References DocumentObject.ViewProvider.__vobject__.

◆ setTransformation()

def DocumentObject.ViewProvider.setTransformation (   self,
  trsf 
)

References DocumentObject.ViewProvider.__vobject__.

◆ show()

def DocumentObject.ViewProvider.show (   self)

References DocumentObject.ViewProvider.__vobject__.

Referenced by Mod.Show.mTempoVis.TempoVis.show_all_dependencies(), and Mod.Show.mTempoVis.TempoVis.show_all_dependent().

◆ supportedProperties()

def DocumentObject.ViewProvider.supportedProperties (   self)

References DocumentObject.ViewProvider.__vobject__.

◆ toString()

def DocumentObject.ViewProvider.toString (   self)

References DocumentObject.ViewProvider.__vobject__.

◆ Type()

◆ update()


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