Public Member Functions
def	attach (self, vobj)

def	claimChildren (self)

def	flatten (self)

def	onChanged (self, vobj, prop)

def	setupContextMenu (self, vobj, menu)

def	updateData (self, obj, prop)

Public Member Functions inherited from draftviewproviders.view_base.ViewProviderDraft
def	execute (self, vobj)

def	getDefaultDisplayMode (self)

def	getDisplayModes (self, vobj)

def	getIcon (self)

def	setDisplayMode (self, mode)

def	setEdit (self, vobj, mode=0)

def	unsetEdit (self, vobj, mode=0)

Public Attributes
	coords

	Object

	pt

	symbol

Public Attributes inherited from draftviewproviders.view_base.ViewProviderDraft
	Object

	texcoords

	texture

Detailed Description

A base View Provider for the Wire object.

Member Function Documentation

◆ attach()

def draftviewproviders.view_wire.ViewProviderWire.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 from draftviewproviders.view_base.ViewProviderDraft.

◆ claimChildren()

def draftviewproviders.view_wire.ViewProviderWire.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 from draftviewproviders.view_base.ViewProviderDraft.

References draftviewproviders.view_base.ViewProviderDraft.Object, DraftLayer.Layer.Object, Base::Writer::FileEntry.Object, Gui::SelectionChanges.Object, ArchFloor._Floor.Object, ArchMaterial._ViewProviderArchMaterialContainer.Object, DraftLayer.ViewProviderLayer.Object, Base::XMLReader::FileEntry.Object, ArchReference.ViewProviderArchReference.Object, ArchEquipment._ViewProviderEquipment.Object, ArchFloor._ViewProviderFloor.Object, ArchSchedule._ViewProviderArchSchedule.Object, ArchMaterial._ViewProviderArchMaterial.Object, DraftLayer.ViewProviderLayerContainer.Object, ArchSpace._ViewProviderSpace.Object, ArchBuildingPart.ViewProviderBuildingPart.Object, ArchRoof._ViewProviderRoof.Object, ArchSite._ViewProviderSite.Object, ArchSectionPlane._ViewProviderSectionPlane.Object, ArchStructure.StructureTaskPanel.Object, ArchComponent.ViewProviderComponent.Object, and ArchWall._ViewProviderWall.Object.

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

◆ flatten()

def draftviewproviders.view_wire.ViewProviderWire.flatten ( self )

References draftviewproviders.view_base.ViewProviderDraft.Object, DraftLayer.Layer.Object, Base::Writer::FileEntry.Object, Gui::SelectionChanges.Object, ArchFloor._Floor.Object, ArchMaterial._ViewProviderArchMaterialContainer.Object, DraftLayer.ViewProviderLayer.Object, Base::XMLReader::FileEntry.Object, ArchReference.ViewProviderArchReference.Object, ArchEquipment._ViewProviderEquipment.Object, ArchFloor._ViewProviderFloor.Object, ArchSchedule._ViewProviderArchSchedule.Object, ArchMaterial._ViewProviderArchMaterial.Object, DraftLayer.ViewProviderLayerContainer.Object, ArchSpace._ViewProviderSpace.Object, ArchBuildingPart.ViewProviderBuildingPart.Object, ArchRoof._ViewProviderRoof.Object, ArchSite._ViewProviderSite.Object, ArchSectionPlane._ViewProviderSectionPlane.Object, ArchStructure.StructureTaskPanel.Object, ArchComponent.ViewProviderComponent.Object, and ArchWall._ViewProviderWall.Object.

Referenced by draftviewproviders.view_wire.ViewProviderWire.setupContextMenu().

◆ onChanged()

def draftviewproviders.view_wire.ViewProviderWire.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 from draftviewproviders.view_base.ViewProviderDraft.

Referenced by ArchSite.Compass.buildCoordinates(), ArchAxis.CommandArchGrid.IsActive(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.updateData().

◆ setupContextMenu()

def draftviewproviders.view_wire.ViewProviderWire.setupContextMenu	(	self,
		vobj,
		menu
	)

References draftviewproviders.view_wire.ViewProviderWire.flatten().

◆ updateData()

def draftviewproviders.view_wire.ViewProviderWire.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 from draftviewproviders.view_base.ViewProviderDraft.

References Gui::SoFCColorLegend.coords, draftviewproviders.view_wire.ViewProviderWire.coords, Gui::SoFCColorGradient.coords, draftguitools.gui_trackers.snapTracker.coords, draftguitools.gui_trackers.lineTracker.coords, draftguitools.gui_trackers.rectangleTracker.coords, draftviewproviders.view_dimension.ViewProviderLinearDimension.coords, draftguitools.gui_trackers.dimTracker.coords, ArchEquipment._ViewProviderEquipment.coords, ArchSpace._ViewProviderSpace.coords, draftguitools.gui_trackers.ghostTracker.coords, draftviewproviders.view_dimension.ViewProviderAngularDimension.coords, draftguitools.gui_trackers.editTracker.coords, draftguitools.gui_trackers.wireTracker.coords, ArchSite._ViewProviderSite.coords, ArchStructure._ViewProviderStructure.coords, ArchPanel.ViewProviderPanelCut.coords, ArchPanel.ViewProviderPanelSheet.coords, and DraftVecUtils.isNull().