Public Member Functions
def	attach (self, vobj)

def	claimChildren (self)

def	execute (self, vobj)

def	getDefaultDisplayMode (self)

def	getDisplayModes (self, vobj)

def	getIcon (self)

def	onChanged (self, vobj, prop)

def	setDisplayMode (self, mode)

def	setEdit (self, vobj, mode=0)

def	unsetEdit (self, vobj, mode=0)

def	updateData (self, obj, prop)

Public Attributes
	Object

	texcoords

	texture

Detailed Description

The base class for Draft view providers.

Parameters
----------
vobj : a base C++ view provider
    The view provider of the scripted object (`obj.ViewObject`),
    which commonly may be of types `PartGui::ViewProvider2DObjectPython`,
    `PartGui::ViewProviderPython`, or `Gui::ViewProviderPythonFeature`.

    A basic view provider is instantiated during the creation
    of the base C++ object, for example,
    `Part::Part2DObjectPython`, `Part::FeaturePython`,
    or `App::FeaturePython`.

        >>> obj = App.ActiveDocument.addObject('Part::Part2DObjectPython')
        >>> vobj = obj.ViewObject
        >>> ViewProviderDraft(vobj)

    This view provider class instance is stored in the `Proxy` attribute
    of the base view provider.
    ::
        vobj.Proxy = self

Attributes
----------
Object : the base C++ object
    The scripted document object that is associated
    with this view provider, which commonly may be of types
    `Part::Part2DObjectPython`, `Part::FeaturePython`,
    or `App::FeaturePython`.

texture : coin.SoTexture2
    A texture that could be added to this object.

texcoords : coin.SoTextureCoordinatePlane
    The coordinates defining a plane to use for aligning the texture.

These class attributes are accessible through the `Proxy` object:
`vobj.Proxy.Object`, `vobj.Proxy.texture`, etc.

Member Function Documentation

◆ attach()

def draftviewproviders.view_base.ViewProviderDraft.attach	(	self,
		vobj
	)

Set up the scene sub-graph of the view provider.

This method should always be defined, even if it does nothing.

Override this method to set up a custom scene.

Parameters
----------
vobj : the view provider of the scripted object.
    This is `obj.ViewObject`.

Reimplemented in draftviewproviders.view_wire.ViewProviderWire.

◆ claimChildren()

def draftviewproviders.view_base.ViewProviderDraft.claimChildren ( self )

Return objects that will be placed under it in the tree view.

Override this method to return a list with objects
that will appear under this object in the tree view.
That is, this object becomes the `parent`,
and all those under it are the `children`.

By default the returned list is composed of objects from
`Object.Base`, `Object.Objects`, `Object.Components`,
and `Object.Group`, if they exist.

Returns
-------
list
    List of objects.

Reimplemented in draftviewproviders.view_base.ViewProviderDraftAlt, draftviewproviders.view_draftlink.ViewProviderDraftLink, and draftviewproviders.view_wire.ViewProviderWire.

Referenced by femviewprovider.view_mesh_gmsh.VPMeshGmsh.onDelete(), femviewprovider.view_result_mechanical.VPResultMechanical.onDelete(), BOPTools.JoinFeatures.ViewProviderConnect.onDelete(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.onDelete(), BOPTools.SplitFeatures.ViewProviderSlice.onDelete(), and BOPTools.SplitFeatures.ViewProviderXOR.onDelete().

◆ execute()

def draftviewproviders.view_base.ViewProviderDraft.execute	(	self,
		vobj
	)

Run when the object is created or recomputed.

Override this method to produce effects when the object
is newly created, and whenever the document is recomputed.

By default it does nothing.

Parameters
----------
vobj : the view provider of the scripted object.
    This is `obj.ViewObject`.

Referenced by draftobjects.facebinder.Facebinder.addSubobjects(), PathScripts.PathDressupDogbone.ObjectDressup.boneStateList(), ArchSite.Compass.buildCoordinates(), PathScripts.PathDressupHoldingTags.ObjectTagDressup.generateTags(), ArchPanel.PanelCut.getWires(), ArchSchedule.CommandArchSchedule.IsActive(), Mod.PartDesign.Scripts.DistanceBolt.DistanceBolt.onChanged(), Mod.PartDesign.Scripts.Epitrochoid.Epitrochoid.onChanged(), Mod.PartDesign.Scripts.Parallelepiped.Parallelepiped.onChanged(), Mod.PartDesign.Scripts.Parallelepiped.BoxCylinder.onChanged(), Mod.PartDesign.Scripts.Spring.MySpring.onChanged(), FeaturePython.DistanceBolt.onChanged(), PathScripts.PathStock.StockFromBase.onChanged(), PathScripts.PathStock.StockCreateBox.onChanged(), PathScripts.PathStock.StockCreateCylinder.onChanged(), draftobjects.draftlink.DraftLink.onDocumentRestored(), draftobjects.patharray.PathArray.onDocumentRestored(), and draftobjects.pathtwistedarray.PathTwistedArray.onDocumentRestored().

◆ getDefaultDisplayMode()

def draftviewproviders.view_base.ViewProviderDraft.getDefaultDisplayMode ( self )

Return the default mode defined in getDisplayModes.

Override this method to return a string with the default display mode.

By default it returns `'Flat Lines'`.

Returns
-------
str
    `'Flat Lines'`

◆ getDisplayModes()

def draftviewproviders.view_base.ViewProviderDraft.getDisplayModes	(	self,
		vobj
	)

Return a list of display modes.

Override this method to return a list of strings with
display mode styles, such as `'Flat Lines'`, `'Shaded'`,
`'Wireframe'`, `'Points'`.

By default it returns an empty list.

Parameters
----------
vobj : the view provider of the scripted object.
    This is `obj.ViewObject`.

Returns
-------
list
    Empty list `[ ]`

◆ getIcon()

def draftviewproviders.view_base.ViewProviderDraft.getIcon ( self )

Return the path to the icon used by the view provider.

The path can be a full path in the system, or a relative path
inside the compiled resource file.
It can also be a string that defines the icon in XPM format.

Override this method to provide a specific icon
for the object in the tree view.

By default it returns the path to the `Draft_Draft.svg` icon.

Returns
-------
str
    `':/icons/Draft_Draft.svg'`

Referenced by ArchAxisSystem.AxisSystemTaskPanel.update(), ArchComponent.ComponentTaskPanel.update(), and ArchSectionPlane.SectionPlaneTaskPanel.update().

◆ onChanged()

def draftviewproviders.view_base.ViewProviderDraft.onChanged	(	self,
		vobj,
		prop
	)

Run when a view property is changed.

Override this method to handle the behavior
of the view provider depending on changes that occur to its properties
such as line color, line width, point color, point size,
draw style, shape color, transparency, and others.

This method  updates the texture and pattern if
the properties `TextureImage`, `Pattern`, `DiffuseColor`,
and `PatternSize` change.

Parameters
----------
vobj : the view provider of the scripted object.
    This is `obj.ViewObject`.

prop : str
    Name of the property that was modified.

Reimplemented in draftviewproviders.view_point.ViewProviderPoint, and draftviewproviders.view_wire.ViewProviderWire.

Referenced by ArchStructure.CommandStructuralSystem.Activated(), draftviewproviders.view_base.ViewProviderDraft.attach(), ArchSite.Compass.buildCoordinates(), draftobjects.wire.Wire.execute(), ArchBuildingPart.ViewProviderBuildingPart.updateData(), ArchPanel.ViewProviderPanelCut.updateData(), ArchPanel.ViewProviderPanelSheet.updateData(), draftviewproviders.view_label.ViewProviderLabel.updateData(), draftviewproviders.view_layer.ViewProviderLayer.updateData(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.updateData().

◆ setDisplayMode()

def draftviewproviders.view_base.ViewProviderDraft.setDisplayMode	(	self,
		mode
	)

Map the modes defined in attach with those in getDisplayModes.

This method is optional.

By default since they have the same names nothing needs to be done,
and it just returns the input `mode`.

Parameters
----------
str
    A string defining a display mode such as
    `'Flat Lines'`, `'Shaded'`, `'Wireframe'`, `'Points'`.

◆ setEdit()

def draftviewproviders.view_base.ViewProviderDraft.setEdit	(	self,
		vobj,
		mode = `0`
	)

Enter edit mode of the object.

Override this method to define a custom command to run when entering
the edit mode of the object in the tree view.
It must return `True` to successfully enter edit mode.
If the conditions to edit are not met, it should return `False`,
in which case the edit mode is not started.

By default it runs the `Draft_Edit` GuiCommand.
::
    Gui.runCommand('Draft_Edit')

Parameters
----------
vobj : the view provider of the scripted object.
    This is `obj.ViewObject`.

mode : int, optional
    It defaults to 0, in which case
    it runs the `Draft_Edit` GuiCommand.
    It indicates the type of edit in the underlying C++ code.

Returns
-------
bool or None
    It is `True` if `mode` is 0, and `Draft_Edit` ran successfully.
    None if mode is not zero.
    It is `False` otherwise.

Reimplemented in draftviewproviders.view_facebinder.ViewProviderFacebinder, and draftviewproviders.view_shapestring.ViewProviderShapeString.

References draftutils.translate.QT_TRANSLATE_NOOP.

Referenced by ArchGrid.ViewProviderArchGrid.doubleClicked(), ArchReference.ViewProviderArchReference.doubleClicked(), draftviewproviders.view_dimension.ViewProviderDimensionBase.doubleClicked(), draftviewproviders.view_hatch.ViewProviderDraftHatch.doubleClicked(), draftviewproviders.view_text.ViewProviderText.doubleClicked(), PathScripts.PathPropertyBagGui.ViewProvider.doubleClicked(), PathScripts.PathSetupSheetGui.ViewProvider.doubleClicked(), PathScripts.PathToolBitGui.ViewProvider.doubleClicked(), Spreadsheet_legacy.ViewProviderSpreadsheet.doubleClicked(), ArchSchedule.CommandArchSchedule.IsActive(), PathScripts.PathIconViewProvider.ViewProvider.setupContextMenu(), PathScripts.PathJobGui.ViewProvider.setupContextMenu(), PathScripts.PathOpGui.ViewProvider.setupContextMenu(), and PathScripts.PathToolControllerGui.ViewProvider.setupContextMenu().

◆ unsetEdit()

def draftviewproviders.view_base.ViewProviderDraft.unsetEdit	(	self,
		vobj,
		mode = `0`
	)

Terminate the edit mode of the object.

Override this method to define a custom command to run when
terminating the edit mode of the object in the tree view.

It should return `True` to indicate that the method already
cleaned up everything and there is no need to call
the `usetEdit` method of the base class.
It should return `False` to indicate that cleanup
is still required, so the `unsetEdit` method of the base class
is invoked to do the rest.

By default it runs the `finish` method of the active
Draft GuiCommand, and closes the task panel.
::
    App.activeDraftCommand.finish()
    Gui.Control.closeDialog()

Parameters
----------
vobj : the view provider of the scripted object.
    This is `obj.ViewObject`.

mode : int, optional
    It defaults to 0.
    It indicates the type of edit in the underlying C++ code.

Returns
-------
bool
    This method always returns `False` so it passes
    control to the base class to finish the edit mode.

Reimplemented in draftviewproviders.view_facebinder.ViewProviderFacebinder, and draftviewproviders.view_shapestring.ViewProviderShapeString.

Referenced by PathScripts.PathJobGui.ViewProvider.uneditObject().

◆ updateData()

def draftviewproviders.view_base.ViewProviderDraft.updateData	(	self,
		obj,
		prop
	)

Run when an object property is changed.

Override this method to handle the behavior of the view provider
depending on changes that occur to the real object's properties.

By default, no property is tested, and it does nothing.

Parameters
----------
obj : the base C++ object
    The scripted document object that is associated
    with this view provider, which commonly may be of types
    `Part::Part2DObjectPython`, `Part::FeaturePython`,
    or `App::FeaturePython`.

prop : str
    Name of the property that was modified.

Reimplemented in draftviewproviders.view_wire.ViewProviderWire.

Referenced by ArchStructure.CommandStructuralSystem.Activated(), PathScripts.PathJobDlg.JobCreate.exec_(), draftviewproviders.view_dimension.ViewProviderLinearDimension.onChanged(), draftviewproviders.view_dimension.ViewProviderAngularDimension.onChanged(), draftviewproviders.view_wire.ViewProviderWire.onChanged(), PathScripts.PathOpGui.TaskPanelPage.pageUpdateData(), PathScripts.PathPropertyBagGui.TaskPanel.setupUi(), and PathScripts.PathSetupSheetGui.OpTaskPanel.setupUi().

Member Data Documentation

◆ Object

draftviewproviders.view_base.ViewProviderDraft.Object

◆ texcoords

draftviewproviders.view_base.ViewProviderDraft.texcoords

Referenced by draftviewproviders.view_base.ViewProviderDraft.attach(), draftviewproviders.view_base.ViewProviderDraft.onChanged(), and ArchPanel.ViewProviderPanelSheet.updateData().

◆ texture

draftviewproviders.view_base.ViewProviderDraft.texture

Referenced by draftviewproviders.view_base.ViewProviderDraft.attach(), and draftviewproviders.view_base.ViewProviderDraft.onChanged().

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

FreeCAD/src/Mod/Draft/draftviewproviders/view_base.py

Public Member Functions

Public Attributes