PathScripts.PathAreaOp.ObjectOp Class Reference

Public Member Functions
def	areaOpAreaParams (self, obj, isHole)
def	areaOpFeatures (self, obj)
def	areaOpOnChanged (self, obj, prop)
def	areaOpOnDocumentRestored (self, obj)
def	areaOpPathParams (self, obj, isHole)
def	areaOpRetractTool (self, obj)
def	areaOpSetDefaultValues (self, obj, job)
def	areaOpShapeForDepths (self, obj, job)
def	areaOpShapes (self, obj)
def	areaOpUseProjection (self, obj)
def	initAreaOp (self, obj)
def	initOperation (self, obj)
def	opExecute (self, obj, getsim=False)
def	opFeatures (self, obj)
def	opOnChanged (self, obj, prop)
def	opOnDocumentRestored (self, obj)
def	opSetDefaultValues (self, obj, job)
Public Member Functions inherited from PathScripts.PathOp.ObjectOp
def	addBase (self, obj, base, sub)
def	addBaseProperty (self, obj)
def	addOpValues (self, obj, values)
def	applyExpression (self, obj, prop, expr)
def	execute (self, obj)
def	getCycleTimeEstimate (self, obj)
def	getJob (self, obj)
def	initOperation (self, obj)
def	isToolSupported (self, obj, tool)
def	onChanged (self, obj, prop)
def	onDocumentRestored (self, obj)
def	opExecute (self, obj)
def	opFeatures (self, obj)
def	opOnChanged (self, obj, prop)
def	opOnDocumentRestored (self, obj)
def	opPropertyEnumerations (self, dataType="data")
def	opRejectAddBase (self, obj, base, sub)
def	opSetDefaultValues (self, obj, job)
def	opUpdateDepths (self, obj)
def	sanitizeBase (self, obj)
def	setDefaultValues (self, obj)
def	setEditorModes (self, obj, features)
def	updateDepths (self, obj, ignoreErrors=False)

Public Attributes
	depthparams
	endVector
	leadIn
Public Attributes inherited from PathScripts.PathOp.ObjectOp
	addNewProps
	commandlist
	horizFeed
	horizRapid
	job
	model
	radius
	stock
	tool
	vertFeed
	vertRapid

Detailed Description

Base class for all Path.Area based operations.
Provides standard features including debugging properties AreaParams,
PathParams and removalshape, all hidden.
The main reason for existence is to implement the standard interface
to Path.Area so subclasses only have to provide the shapes for the
operations.

Member Function Documentation

areaOpAreaParams()

def PathScripts.PathAreaOp.ObjectOp.areaOpAreaParams	(		self,
			obj,
			isHole
	)

areaOpAreaParams(obj, isHole) ... return operation specific area parameters in a dictionary.
Note that the resulting parameters are stored in the property AreaParams.
Must be overwritten by subclasses.

Reimplemented in PathScripts.PathPocketBase.ObjectPocket, and PathScripts.PathProfile.ObjectProfile.

Referenced by PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues(), and PathScripts.PathAreaOp.ObjectOp.opExecute().

areaOpFeatures()

def PathScripts.PathAreaOp.ObjectOp.areaOpFeatures	(		self,
			obj
	)

areaOpFeatures(obj) ... overwrite to add operation specific features.
Can safely be overwritten by subclasses.

Reimplemented in PathScripts.PathPocketBase.ObjectPocket, PathScripts.PathPocketShape.ObjectPocket, and PathScripts.PathProfile.ObjectProfile.

Referenced by PathScripts.PathAreaOp.ObjectOp.opFeatures().

areaOpOnChanged()

def PathScripts.PathAreaOp.ObjectOp.areaOpOnChanged	(		self,
			obj,
			prop
	)

areaOpOnChanged(obj, porp) ... overwrite to process operation specific changes to properties.
Can safely be overwritten by subclasses.

Reimplemented in PathScripts.PathMillFace.ObjectFace, and PathScripts.PathProfile.ObjectProfile.

Referenced by PathScripts.PathAreaOp.ObjectOp.opOnChanged().

areaOpOnDocumentRestored()

def PathScripts.PathAreaOp.ObjectOp.areaOpOnDocumentRestored	(		self,
			obj
	)

areaOpOnDocumentRestored(obj) ... overwrite to fully restore receiver

Reimplemented in PathScripts.PathPocketShape.ObjectPocket, and PathScripts.PathProfile.ObjectProfile.

Referenced by PathScripts.PathAreaOp.ObjectOp.opOnDocumentRestored().

areaOpPathParams()

def PathScripts.PathAreaOp.ObjectOp.areaOpPathParams	(		self,
			obj,
			isHole
	)

areaOpPathParams(obj, isHole) ... return operation specific path parameters in a dictionary.
Note that the resulting parameters are stored in the property PathParams.
Must be overwritten by subclasses.

Reimplemented in PathScripts.PathPocketBase.ObjectPocket, and PathScripts.PathProfile.ObjectProfile.

Referenced by PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues(), and PathScripts.PathAreaOp.ObjectOp.opExecute().

areaOpRetractTool()

def PathScripts.PathAreaOp.ObjectOp.areaOpRetractTool	(		self,
			obj
	)

areaOpRetractTool(obj) ... return False to keep the tool at current level between shapes. Default is True.

Reimplemented in PathScripts.PathPocketBase.ObjectPocket.

Referenced by PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues().

areaOpSetDefaultValues()

def PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues	(		self,
			obj,
			job
	)

areaOpSetDefaultValues(obj, job) ... overwrite to set initial values of operation specific properties.
Can safely be overwritten by subclasses.

Reimplemented in PathScripts.PathMillFace.ObjectFace, PathScripts.PathPocket.ObjectPocket, PathScripts.PathPocketBase.ObjectPocket, PathScripts.PathPocketShape.ObjectPocket, and PathScripts.PathProfile.ObjectProfile.

References PathScripts.PathAreaOp.ObjectOp.areaOpAreaParams(), PathScripts.PathPocketBase.ObjectPocket.areaOpAreaParams(), PathScripts.PathProfile.ObjectProfile.areaOpAreaParams(), PathScripts.PathAreaOp.ObjectOp.areaOpPathParams(), PathScripts.PathPocketBase.ObjectPocket.areaOpPathParams(), PathScripts.PathProfile.ObjectProfile.areaOpPathParams(), PathScripts.PathAreaOp.ObjectOp.areaOpRetractTool(), PathScripts.PathPocketBase.ObjectPocket.areaOpRetractTool(), PathScripts.PathAreaOp.ObjectOp.areaOpUseProjection(), PathScripts.PathPocketBase.ObjectPocket.areaOpUseProjection(), PathScripts.PathProfile.ObjectProfile.areaOpUseProjection(), PathScripts.PathAreaOp.ObjectOp.depthparams, PathScripts.PathAreaOp.ObjectOp.endVector, PathScripts.PathWaterline.ObjectWaterline.endVector, PathScripts.PathOp.ObjectOp.horizFeed, PathScripts.PathToolControllerGui.ToolControllerEditor.horizFeed, PathScripts.PathAdaptive.PathAdaptive.opFeatures(), PathScripts.PathAreaOp.ObjectOp.opFeatures(), PathScripts.PathCircularHoleBase.ObjectOp.opFeatures(), PathScripts.PathCustom.ObjectCustom.opFeatures(), PathScripts.PathDeburr.ObjectDeburr.opFeatures(), PathScripts.PathEngrave.ObjectEngrave.opFeatures(), PathScripts.PathOp.ObjectOp.opFeatures(), PathScripts.PathProbe.ObjectProbing.opFeatures(), PathScripts.PathSlot.ObjectSlot.opFeatures(), PathScripts.PathSurface.ObjectSurface.opFeatures(), PathScripts.PathVcarve.ObjectVcarve.opFeatures(), PathScripts.PathWaterline.ObjectWaterline.opFeatures(), Ui_SphereWidget.radius, PartGui::Ui_DlgPartCylinder.radius, e57::CylindricalRepresentation.radius, DraftGui.DraftToolBar.radius, draftguitools.gui_snapper.Snapper.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, automotive_design.circle.radius, automotive_design.right_circular_cone.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, automotive_design.conical_surface.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, config_control_design.conical_surface.radius, ifc2x3.ifccranerailashapeprofiledef.radius, ifc2x3.ifcroundededgefeature.radius, ifc2x3.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, ifc2x3.ifccircle.radius, ifc2x3.ifcsphere.radius, ifc4.ifcsweptdisksolid.radius, ifc4.ifcrightcircularcylinder.radius, ifc4.ifccircleprofiledef.radius, ifc4.ifclightsourcepositional.radius, ifc4.ifccircle.radius, ifc4.ifccylindricalsurface.radius, ifc4.ifcsphere.radius, Inspection::DistanceInspection.radius, Measure::Measurement.radius(), MeshCore::CylinderSurfaceFit.radius, MeshCore::SphereSurfaceFit.radius, Part::TangentialArc.radius(), PartGui::DimensionAngular.radius, PartGui::ArcEngine.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, PathScripts.PathDressupAxisMap.TaskPanel.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PathScripts.PathDressupTag.TagSolid.radius, PathScripts.PathOp.ObjectOp.radius, PathScripts.PathSurface.ObjectSurface.radius, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.radius, PathScripts.PathWaterline.ObjectWaterline.radius, cSimTool.radius, KDL::Path_Circle.radius, KDL::Path_RoundedComposite.radius, ObjectObserver.radius, SketcherGui::DrawSketchHandler3PointArc.radius, SketcherGui::DrawSketchHandler3PointCircle.radius, SketcherGui::DrawSketchHandlerOblong.radius, TechDraw::arcPoints.radius, TechDraw::Circle.radius, PathScripts.PathOp.ObjectOp.vertFeed, and PathScripts.PathToolControllerGui.ToolControllerEditor.vertFeed.

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored(), and PathScripts.PathAreaOp.ObjectOp.opSetDefaultValues().

areaOpShapeForDepths()

def PathScripts.PathAreaOp.ObjectOp.areaOpShapeForDepths	(		self,
			obj,
			job
	)

areaOpShapeForDepths(obj) ... returns the shape used to make an initial calculation for the depths being used.
The default implementation returns the job's Base.Shape

Referenced by PathScripts.PathAreaOp.ObjectOp.opSetDefaultValues().

areaOpShapes()

def PathScripts.PathAreaOp.ObjectOp.areaOpShapes	(		self,
			obj
	)

areaOpShapes(obj) ... return all shapes to be processed by Path.Area for this op.
Must be overwritten by subclasses.

Reimplemented in PathScripts.PathMillFace.ObjectFace, PathScripts.PathPocket.ObjectPocket, PathScripts.PathPocketShape.ObjectPocket, and PathScripts.PathProfile.ObjectProfile.

Referenced by PathScripts.PathAreaOp.ObjectOp.opExecute().

areaOpUseProjection()

def PathScripts.PathAreaOp.ObjectOp.areaOpUseProjection	(		self,
			obj
	)

areaOpUseProcjection(obj) ... return True if the operation can use procjection, defaults to False.
Can safely be overwritten by subclasses.

Reimplemented in PathScripts.PathPocketBase.ObjectPocket, and PathScripts.PathProfile.ObjectProfile.

Referenced by PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues(), and PathScripts.PathAreaOp.ObjectOp.opExecute().

initAreaOp()

def PathScripts.PathAreaOp.ObjectOp.initAreaOp	(		self,
			obj
	)

initAreaOp(obj) ... overwrite if the receiver class needs initialisation.
Can safely be overwritten by subclasses.

Reimplemented in PathScripts.PathPocketBase.ObjectPocket, and PathScripts.PathProfile.ObjectProfile.

Referenced by PathScripts.PathAreaOp.ObjectOp.initOperation().

initOperation()

def PathScripts.PathAreaOp.ObjectOp.initOperation	(		self,
			obj
	)

initOperation(obj) ... sets up standard Path.Area properties and calls initAreaOp().
Do not overwrite, overwrite initAreaOp(obj) instead.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathAreaOp.ObjectOp.initAreaOp(), PathScripts.PathPocketBase.ObjectPocket.initAreaOp(), PathScripts.PathProfile.ObjectProfile.initAreaOp(), and draftutils.translate.QT_TRANSLATE_NOOP.

opExecute()

def PathScripts.PathAreaOp.ObjectOp.opExecute	(		self,
			obj,
			getsim = False
	)

opExecute(obj, getsim=False) ... implementation of Path.Area ops.
determines the parameters for _buildPathArea().
Do not overwrite, implement
    areaOpAreaParams(obj, isHole) ... op specific area param dictionary
    areaOpPathParams(obj, isHole) ... op specific path param dictionary
    areaOpShapes(obj)             ... the shape for path area to process
    areaOpUseProjection(obj)      ... return true if operation can use projection
instead.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathAreaOp.ObjectOp.areaOpAreaParams(), PathScripts.PathAreaOp.ObjectOp.areaOpPathParams(), PathScripts.PathAreaOp.ObjectOp.areaOpShapes(), PathScripts.PathAreaOp.ObjectOp.areaOpUseProjection(), PathScripts.PathAreaOp.ObjectOp.endVector, and PathScripts.PathWaterline.ObjectWaterline.endVector.

Referenced by PathScripts.PathOp.ObjectOp.execute().

opFeatures()

def PathScripts.PathAreaOp.ObjectOp.opFeatures	(		self,
			obj
	)

opFeatures(obj) ... returns the base features supported by all Path.Area based operations.
The standard feature list is OR'ed with the return value of areaOpFeatures().
Do not overwrite, implement areaOpFeatures(obj) instead.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathAreaOp.ObjectOp.areaOpFeatures(), PathScripts.PathPocketBase.ObjectPocket.areaOpFeatures(), PathScripts.PathPocketShape.ObjectPocket.areaOpFeatures(), and PathScripts.PathProfile.ObjectProfile.areaOpFeatures().

Referenced by PathScripts.PathOp.ObjectOp.addOpValues(), PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues(), PathScripts.PathOp.ObjectOp.execute(), PathScripts.PathOp.ObjectOp.onDocumentRestored(), PathScripts.PathCircularHoleBase.ObjectOp.opExecute(), PathScripts.PathAreaOp.ObjectOp.opSetDefaultValues(), PathScripts.PathEngraveBase.ObjectOp.opSetDefaultValues(), PathScripts.PathVcarve.ObjectVcarve.opSetDefaultValues(), PathScripts.PathOp.ObjectOp.setDefaultValues(), and PathScripts.PathOp.ObjectOp.updateDepths().

opOnChanged()

def PathScripts.PathAreaOp.ObjectOp.opOnChanged	(		self,
			obj,
			prop
	)

opOnChanged(obj, prop) ... base implementation of the notification framework - do not overwrite.
The base implementation takes a stab at determining Heights and Depths if the operations's Base
changes.
Do not overwrite, overwrite areaOpOnChanged(obj, prop) instead.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathAreaOp.ObjectOp.areaOpOnChanged(), PathScripts.PathMillFace.ObjectFace.areaOpOnChanged(), and PathScripts.PathProfile.ObjectProfile.areaOpOnChanged().

Referenced by PathScripts.PathOp.ObjectOp.onChanged().

opOnDocumentRestored()

def PathScripts.PathAreaOp.ObjectOp.opOnDocumentRestored	(		self,
			obj
	)

opOnDocumentRestored(obj) ... implement if an op needs special handling like migrating the data model.
Should be overwritten by subclasses.

Reimplemented from PathScripts.PathOp.ObjectOp.

Reimplemented in PathScripts.PathPocket.ObjectPocket, and PathScripts.PathPocketBase.ObjectPocket.

References PathScripts.PathAreaOp.ObjectOp.areaOpOnDocumentRestored(), PathScripts.PathPocketShape.ObjectPocket.areaOpOnDocumentRestored(), PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored(), and draftutils.translate.QT_TRANSLATE_NOOP.

Referenced by PathScripts.PathOp.ObjectOp.onDocumentRestored().

opSetDefaultValues()

def PathScripts.PathAreaOp.ObjectOp.opSetDefaultValues	(		self,
			obj,
			job
	)

opSetDefaultValues(obj) ... base implementation, do not overwrite.
The base implementation sets the depths and heights based on the
areaOpShapeForDepths() return value.
Do not overwrite, overwrite areaOpSetDefaultValues(obj, job) instead.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues(), PathScripts.PathMillFace.ObjectFace.areaOpSetDefaultValues(), PathScripts.PathPocket.ObjectPocket.areaOpSetDefaultValues(), PathScripts.PathPocketBase.ObjectPocket.areaOpSetDefaultValues(), PathScripts.PathPocketShape.ObjectPocket.areaOpSetDefaultValues(), PathScripts.PathProfile.ObjectProfile.areaOpSetDefaultValues(), PathScripts.PathAreaOp.ObjectOp.areaOpShapeForDepths(), PathScripts.PathAdaptive.PathAdaptive.opFeatures(), PathScripts.PathAreaOp.ObjectOp.opFeatures(), PathScripts.PathCircularHoleBase.ObjectOp.opFeatures(), PathScripts.PathCustom.ObjectCustom.opFeatures(), PathScripts.PathDeburr.ObjectDeburr.opFeatures(), PathScripts.PathEngrave.ObjectEngrave.opFeatures(), PathScripts.PathOp.ObjectOp.opFeatures(), PathScripts.PathProbe.ObjectProbing.opFeatures(), PathScripts.PathSlot.ObjectSlot.opFeatures(), PathScripts.PathSurface.ObjectSurface.opFeatures(), PathScripts.PathVcarve.ObjectVcarve.opFeatures(), and PathScripts.PathWaterline.ObjectWaterline.opFeatures().

Referenced by PathScripts.PathEngrave.ObjectEngrave.opUpdateDepths(), PathScripts.PathVcarve.ObjectVcarve.opUpdateDepths(), and PathScripts.PathOp.ObjectOp.setDefaultValues().

Member Data Documentation

depthparams

PathScripts.PathAreaOp.ObjectOp.depthparams

Referenced by PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues(), and PathScripts.PathPocket.ObjectPocket.areaOpShapes().

endVector

PathScripts.PathAreaOp.ObjectOp.endVector

Referenced by PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues(), and PathScripts.PathAreaOp.ObjectOp.opExecute().

leadIn

PathScripts.PathAreaOp.ObjectOp.leadIn

---

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

• FreeCAD/src/Mod/Path/PathScripts/PathAreaOp.py