draftobjects.wire.Wire Class Reference

Public Member Functions
def	execute (self, obj)
def	onChanged (self, obj, prop)
def	execute (self, obj)
def	onChanged (self, obj, prop)

Additional Inherited Members
Public Attributes inherited from draftobjects.base.DraftObject
	Type

Detailed Description

The Wire object

Member Function Documentation

execute()

def draftobjects.wire.Wire.execute	(		self,
			obj
	)

Run this method 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
----------
obj : the scripted object.
    This commonly may be of types `Part::Part2DObjectPython`,
    `Part::FeaturePython`, or `App::FeaturePython`.

Reimplemented from draftobjects.base.DraftObject.

References DraftVecUtils.equals(), App::VRMLObject.onChanged(), FemGui::ViewProviderFemPostPlaneFunction.onChanged(), Part::Circle.onChanged(), Part::Vertex.onChanged(), Part::Line.onChanged(), Part::Ellipse.onChanged(), PartDesignGui::ViewProviderDatumCoordinateSystem.onChanged(), Surface::GeomFillSurface.onChanged(), PartDesign::Chamfer.onChanged(), Sketcher::SketchObject.onChanged(), TechDrawGui::ViewProviderBalloon.onChanged(), TechDrawGui::ViewProviderDimension.onChanged(), TechDrawGui::ViewProviderLeader.onChanged(), TechDrawGui::ViewProviderRichAnno.onChanged(), TechDrawGui::ViewProviderWeld.onChanged(), Gui::ViewProvider.onChanged(), Gui::ViewProviderAnnotation.onChanged(), Gui::ViewProviderAnnotationLabel.onChanged(), Gui::ViewProviderGeometryObject.onChanged(), Gui::ViewProviderMeasureDistance.onChanged(), Gui::ViewProviderOrigin.onChanged(), Gui::ViewProviderOriginFeature.onChanged(), Gui::ViewProviderPythonFeatureImp.onChanged(), Gui::ViewProviderTextDocument.onChanged(), Drawing::FeatureClip.onChanged(), Drawing::FeaturePage.onChanged(), Drawing::FeatureViewSymbol.onChanged(), Fem::Constraint.onChanged(), Fem::ConstraintBearing.onChanged(), Fem::ConstraintContact.onChanged(), Fem::ConstraintDisplacement.onChanged(), Fem::ConstraintFixed.onChanged(), Fem::ConstraintFluidBoundary.onChanged(), Fem::ConstraintForce.onChanged(), Fem::ConstraintGear.onChanged(), Fem::ConstraintHeatflux.onChanged(), Fem::ConstraintInitialTemperature.onChanged(), Fem::ConstraintPlaneRotation.onChanged(), Fem::ConstraintPressure.onChanged(), Fem::ConstraintPulley.onChanged(), Fem::ConstraintSpring.onChanged(), Fem::ConstraintTemperature.onChanged(), Fem::ConstraintTransform.onChanged(), Fem::FemMeshObject.onChanged(), Fem::FemPostClipFilter.onChanged(), Fem::FemPostDataAlongLineFilter.onChanged(), Fem::FemPostDataAtPointFilter.onChanged(), Fem::FemPostScalarClipFilter.onChanged(), Fem::FemPostWarpVectorFilter.onChanged(), Fem::FemPostCutFilter.onChanged(), Fem::FemPostFunctionProvider.onChanged(), Fem::FemPostPlaneFunction.onChanged(), Fem::FemPostSphereFunction.onChanged(), Fem::FemPostPipeline.onChanged(), FemGui::ViewProviderFemConstraint.onChanged(), FemGui::ViewProviderFemMesh.onChanged(), FemGui::ViewProviderFemPostFunctionProvider.onChanged(), FemGui::ViewProviderFemPostFunction.onChanged(), FemGui::ViewProviderFemPostObject.onChanged(), InspectionGui::ViewProviderInspection.onChanged(), Mesh::Feature.onChanged(), MeshGui::ViewProviderMesh.onChanged(), MeshGui::ViewProviderMeshCurvature.onChanged(), MeshGui::ViewProviderMeshDefects.onChanged(), MeshGui::ViewProviderMeshNode.onChanged(), Part::Mirroring.onChanged(), Part::Box.onChanged(), Part::RuledSurface.onChanged(), Part::Loft.onChanged(), Part::Sweep.onChanged(), Part::Helix.onChanged(), Part::Spiral.onChanged(), Part::Wedge.onChanged(), PartGui::ViewProvider2DObjectGrid.onChanged(), PartGui::ViewProviderCustom.onChanged(), PartGui::ViewProviderPartReference.onChanged(), PartDesign::Line.onChanged(), PartDesign::Plane.onChanged(), PartDesign::FeatureBase.onChanged(), PartDesign::DressUp.onChanged(), PartDesign::Helix.onChanged(), PartDesign::Hole.onChanged(), PartDesign::ProfileBased.onChanged(), PartDesignGui::ViewProviderDatumPoint.onChanged(), Path::Feature.onChanged(), PathGui::ViewProviderPath.onChanged(), Points::Feature.onChanged(), PointsGui::ViewProviderPoints.onChanged(), Robot::Edge2TracObject.onChanged(), Robot::RobotObject.onChanged(), Robot::TrajectoryDressUpObject.onChanged(), Robot::TrajectoryObject.onChanged(), RobotGui::ViewProviderRobotObject.onChanged(), Sandbox::SandboxObject.onChanged(), SketcherGui::ViewProviderCustom.onChanged(), Spreadsheet::Sheet.onChanged(), TechDraw::DrawParametricTemplate.onChanged(), TechDraw::DrawRichAnno.onChanged(), TechDraw::DrawSVGTemplate.onChanged(), TechDraw::DrawTemplate.onChanged(), TechDraw::DrawTile.onChanged(), TechDraw::DrawTileWeld.onChanged(), TechDraw::DrawViewAnnotation.onChanged(), TechDraw::DrawViewClip.onChanged(), TechDraw::DrawViewCollection.onChanged(), TechDraw::DrawViewDimExtent.onChanged(), TechDraw::DrawViewSpreadsheet.onChanged(), TechDraw::DrawWeldSymbol.onChanged(), TechDrawGui::ViewProviderImage.onChanged(), TechDrawGui::ViewProviderProjGroup.onChanged(), TechDrawGui::ViewProviderViewPart.onChanged(), TechDrawGui::ViewProviderViewSection.onChanged(), Gui::ViewProviderDocumentObject.onChanged(), Gui::ViewProviderLink.onChanged(), Gui::ViewProviderPart.onChanged(), Gui::ViewProviderPlacement.onChanged(), Gui::ViewProviderPythonFeatureT< ViewProviderT >.onChanged(), Part::BodyBase.onChanged(), Part::Revolution.onChanged(), Part::Feature.onChanged(), Part::Primitive.onChanged(), PartGui::ViewProviderPartExt.onChanged(), PartDesign::Body.onChanged(), PartDesign::Point.onChanged(), PartDesign::Boolean.onChanged(), PartDesign::FeaturePrimitive.onChanged(), PartDesign::ShapeBinder.onChanged(), PartDesign::SubShapeBinder.onChanged(), PartDesignGui::ViewProvider.onChanged(), PartDesignGui::ViewProviderBody.onChanged(), PartDesignGui::ViewProviderBoolean.onChanged(), PartDesignGui::ViewProviderSubShapeBinder.onChanged(), SketcherGui::ViewProviderSketch.onChanged(), Surface::Extend.onChanged(), TechDraw::DrawGeomHatch.onChanged(), TechDraw::DrawHatch.onChanged(), TechDraw::DrawLeaderLine.onChanged(), TechDraw::DrawPage.onChanged(), TechDraw::DrawProjGroup.onChanged(), TechDraw::DrawProjGroupItem.onChanged(), TechDraw::DrawView.onChanged(), TechDraw::DrawViewBalloon.onChanged(), TechDraw::DrawViewDetail.onChanged(), TechDraw::DrawViewDimension.onChanged(), TechDraw::DrawViewImage.onChanged(), TechDraw::DrawViewMulti.onChanged(), TechDraw::DrawViewPart.onChanged(), TechDraw::DrawViewSection.onChanged(), TechDraw::DrawViewSymbol.onChanged(), TechDraw::LandmarkDimension.onChanged(), TechDrawGui::ViewProviderDrawingView.onChanged(), TechDrawGui::ViewProviderGeomHatch.onChanged(), TechDrawGui::ViewProviderHatch.onChanged(), TechDrawGui::ViewProviderPage.onChanged(), TechDrawGui::ViewProviderTemplate.onChanged(), App::PropertyContainer.onChanged(), App::ExtensionContainer.onChanged(), App::FeatureCustomT< FeatureT >.onChanged(), App::FeaturePythonImp.onChanged(), App::MeasureDistance.onChanged(), App::TextDocument.onChanged(), App::Document.onChanged(), App::DocumentObject.onChanged(), App::FeaturePythonT< FeatureT >.onChanged(), draftobjects.bezcurve.BezCurve.onChanged(), draftobjects.bspline.BSpline.onChanged(), OpenSCADFeatures.Resize.onChanged(), OpenSCADFeatures.MatrixTransform.onChanged(), OpenSCADFeatures.ImportObject.onChanged(), OpenSCADFeatures.RefineShape.onChanged(), OpenSCADFeatures.IncreaseTolerance.onChanged(), OpenSCADFeatures.GetWire.onChanged(), OpenSCADFeatures.Frustum.onChanged(), OpenSCADFeatures.Twist.onChanged(), OpenSCADFeatures.PrismaticToroid.onChanged(), OpenSCADFeatures.OffsetShape.onChanged(), Mod.PartDesign.FeatureHole.FeatureHole.Hole.onChanged(), 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(), PathScripts.PathDressupZCorrect.ObjectDressup.onChanged(), FeaturePython.Box.onChanged(), FeaturePython.PointFeature.onChanged(), FeaturePython.MeshFeature.onChanged(), FeaturePython.DistanceBolt.onChanged(), Texture.Texture.onChanged(), ArchAxis._Axis.onChanged(), ArchAxisSystem._AxisSystem.onChanged(), ArchBuildingPart.BuildingPart.onChanged(), ArchComponent.Component.onChanged(), ArchCurtainWall.CurtainWall.onChanged(), ArchEquipment._Equipment.onChanged(), ArchFloor._Floor.onChanged(), ArchIFC.IfcRoot.onChanged(), ArchMaterial._ArchMaterial.onChanged(), ArchPanel.PanelView.onChanged(), ArchRebar._Rebar.onChanged(), ArchReference.ArchReference.onChanged(), ArchSchedule._ArchSchedule.onChanged(), ArchSectionPlane._SectionPlane.onChanged(), ArchSite._Site.onChanged(), ArchSpace._Space.onChanged(), ArchStructure._Structure.onChanged(), ArchTruss.Truss.onChanged(), ArchWall._Wall.onChanged(), ArchWindow._Window.onChanged(), draftobjects.array.Array.onChanged(), draftobjects.base.DraftObject.onChanged(), draftobjects.dimension.LinearDimension.onChanged(), draftobjects.dimension.AngularDimension.onChanged(), draftobjects.draft_annotation.DraftAnnotation.onChanged(), draftobjects.draftlink.DraftLink.onChanged(), draftobjects.fillet.Fillet.onChanged(), draftobjects.label.Label.onChanged(), draftobjects.patharray.PathArray.onChanged(), draftobjects.pathtwistedarray.PathTwistedArray.onChanged(), draftobjects.wire.Wire.onChanged(), draftobjects.wpproxy.WorkingPlaneProxy.onChanged(), PathScripts.PathArray.ObjectArray.onChanged(), PathScripts.PathComment.Comment.onChanged(), PathScripts.PathDressupAxisMap.ObjectDressup.onChanged(), PathScripts.PathDressupRampEntry.ObjectDressup.onChanged(), PathScripts.PathJob.ObjectJob.onChanged(), PathScripts.PathOp.ObjectOp.onChanged(), PathScripts.PathSlot.ObjectSlot.onChanged(), PathScripts.PathStock.StockFromBase.onChanged(), PathScripts.PathStock.StockCreateBox.onChanged(), PathScripts.PathStock.StockCreateCylinder.onChanged(), PathScripts.PathStop.Stop.onChanged(), PathScripts.PathSurface.ObjectSurface.onChanged(), PathScripts.PathToolBit.ToolBit.onChanged(), PathScripts.PathWaterline.ObjectWaterline.onChanged(), Spreadsheet_legacy.SpreadsheetController.onChanged(), Spreadsheet_legacy.SpreadsheetPropertyController.onChanged(), Texture.ViewProviderTexture.onChanged(), DocumentObject.DocumentObject.onChanged(), ArchAxis._ViewProviderAxis.onChanged(), ArchAxisSystem._ViewProviderAxisSystem.onChanged(), ArchBuildingPart.ViewProviderBuildingPart.onChanged(), ArchComponent.ViewProviderComponent.onChanged(), ArchCurtainWall.ViewProviderCurtainWall.onChanged(), ArchFence._ViewProviderFence.onChanged(), ArchMaterial._ViewProviderArchMaterial.onChanged(), ArchPanel.ViewProviderPanelCut.onChanged(), ArchPanel.ViewProviderPanelSheet.onChanged(), ArchRebar._ViewProviderRebar.onChanged(), ArchReference.ViewProviderArchReference.onChanged(), ArchSectionPlane._ViewProviderSectionPlane.onChanged(), ArchSite._ViewProviderSite.onChanged(), ArchSpace._ViewProviderSpace.onChanged(), ArchStructure._ViewProviderStructure.onChanged(), ArchWindow._ViewProviderWindow.onChanged(), draftviewproviders.view_base.ViewProviderDraft.onChanged(), draftviewproviders.view_dimension.ViewProviderDimensionBase.onChanged(), draftviewproviders.view_dimension.ViewProviderLinearDimension.onChanged(), draftviewproviders.view_dimension.ViewProviderAngularDimension.onChanged(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.onChanged(), draftviewproviders.view_label.ViewProviderLabel.onChanged(), draftviewproviders.view_layer.ViewProviderLayer.onChanged(), draftviewproviders.view_point.ViewProviderPoint.onChanged(), draftviewproviders.view_text.ViewProviderText.onChanged(), draftviewproviders.view_wire.ViewProviderWire.onChanged(), draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.onChanged(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.onChanged(), PathScripts.PathComment._ViewProviderComment.onChanged(), PathScripts.PathFixture._ViewProviderFixture.onChanged(), PathScripts.PathPlane._ViewProviderPlane.onChanged(), PathScripts.PathStop._ViewProviderStop.onChanged(), PathScripts.PathToolControllerGui.ViewProvider.onChanged(), OpenSCADFeatures.ViewProviderTree.onChanged(), Mod.PartDesign.FeatureHole.ViewProviderHole.ViewProviderHole.onChanged(), FeaturePython.ViewProviderBox.onChanged(), FeaturePython.ViewProviderOctahedron.onChanged(), FeaturePython.ViewProviderPoints.onChanged(), and DraftVecUtils.scaleTo().

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

onChanged()

def draftobjects.wire.Wire.onChanged	(		self,
			obj,
			prop
	)

Run this method when a property is changed.

Override this method to handle the behavior
of the object depending on changes that occur to its properties.

By default it does nothing.

Parameters
----------
obj : the scripted object.
    This commonly may be of types `Part::Part2DObjectPython`,
    `Part::FeaturePython`, or `App::FeaturePython`.

prop : str
    Name of the property that was modified.

Reimplemented from draftobjects.base.DraftObject.

References DraftVecUtils.scaleTo().

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

---

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

• FreeCAD/src/Mod/Draft/draftobjects/wire.py