PathScripts.PathWaterline.ObjectWaterline Class Reference

Public Member Functions
def	deleteOpVariables (self, all=True)
def	initOperation (self, obj)
def	initOpProperties (self, obj, warn=False)
def	onChanged (self, obj, prop)
def	opApplyPropertyDefaults (self, obj, job, propList)
def	opApplyPropertyLimits (self, obj)
def	opExecute (self, obj)
def	opFeatures (self, obj)
def	opOnDocumentRestored (self, obj)
def	opPropertyDefaults (self, obj, job)
def	opPropertyDefinitions (self)
def	opPropertyEnumerations (self)
def	opSetDefaultValues (self, obj, job)
def	resetOpVariables (self, all=True)
def	setEditorProperties (self, obj)
def	setOclCutter (self, obj, safe=False)
def	showDebugObject (self, objShape, objName)
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	onDocumentRestored (self, obj)
def	opOnChanged (self, obj, prop)
def	opRejectAddBase (self, obj, base, sub)
def	opUpdateDepths (self, obj)
def	setDefaultValues (self, obj)
def	setEditorModes (self, obj, features)
def	updateDepths (self, obj, ignoreErrors=False)

Public Attributes
	addNewProps
	avoidShapes
	axialFeed
	axialRapid
	bbRadius
	boundBoxes
	clearHeight
	ClearHeightOffset
	closedGap
	collectiveShapes
	CutClimb
	cutOut
	cutter
	depthParams
	endVector
	faceZMax
	FinalDepth
	fullSTL
	gaps
	geoTlrnc
	holdPntCnt
	holdPoint
	individualShapes
	layerEndPnt
	layerEndzMax
	midDep
	modelSTLs
	modelTypes
	module
	onHold
	profileShapes
	propertiesReady
	radius
	resetTolerance
	safeHeight
	SafeHeightOffset
	safeSTLs
	showDebugObjects
	stl
	stockZMin
	tempGroup
	tmpCOM
	toolDiam
	topoMap
	useTiltCutter
	wpc
Public Attributes inherited from PathScripts.PathOp.ObjectOp
	addNewProps
	commandlist
	horizFeed
	horizRapid
	job
	model
	radius
	stock
	tool
	vertFeed
	vertRapid

Detailed Description

Proxy object for Surfacing operation.

Member Function Documentation

deleteOpVariables()

def PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables	(		self,
			all = True
	)

deleteOpVariables() ... Reset class variables used for instance of operation.

References PathScripts.PathCircularHoleBase.ObjectOp.axialFeed, PathScripts.PathAreaOp.ObjectOp.axialFeed, PathScripts.PathSurface.ObjectSurface.axialFeed, PathScripts.PathWaterline.ObjectWaterline.axialFeed, PathScripts.PathCircularHoleBase.ObjectOp.axialRapid, PathScripts.PathAreaOp.ObjectOp.axialRapid, PathScripts.PathSurface.ObjectSurface.axialRapid, PathScripts.PathWaterline.ObjectWaterline.axialRapid, PathScripts.PathSurface.ObjectSurface.bbRadius, PathScripts.PathWaterline.ObjectWaterline.bbRadius, PathScripts.PathCircularHoleBase.ObjectOp.clearHeight, PathScripts.PathSurface.ObjectSurface.clearHeight, PathScripts.PathWaterline.ObjectWaterline.clearHeight, PathScripts.PathWaterline.ObjectWaterline.ClearHeightOffset, PathScripts.PathSurface.ObjectSurface.ClearHeightOffset, PathScripts.PathSurfaceSupport.PathGeometryGenerator.cutOut, PathScripts.PathWaterline.ObjectWaterline.cutOut, PathScripts.PathSurface.ObjectSurface.cutOut, PathScripts.PathWaterline.ObjectWaterline.cutter, PathScripts.PathSurface.ObjectSurface.cutter, PathScripts.PathWaterline.ObjectWaterline.faceZMax, PathScripts.PathSurface.ObjectSurface.faceZMax, PathScripts.PathSurface.ObjectSurface.FinalDepth, PathScripts.PathWaterline.ObjectWaterline.FinalDepth, PathScripts.PathWaterline.ObjectWaterline.fullSTL, PathScripts.PathSurface.ObjectSurface.fullSTL, PathScripts.PathWaterline.ObjectWaterline.holdPntCnt, PathScripts.PathSurface.ObjectSurface.holdPntCnt, PathScripts.PathWaterline.ObjectWaterline.holdPoint, PathScripts.PathSurface.ObjectSurface.holdPoint, PathScripts.PathWaterline.ObjectWaterline.layerEndPnt, PathScripts.PathSurface.ObjectSurface.layerEndPnt, PathScripts.PathSurface.ObjectSurface.layerEndzMax, PathScripts.PathWaterline.ObjectWaterline.layerEndzMax, PathScripts.PathWaterline.ObjectWaterline.onHold, PathScripts.PathSurface.ObjectSurface.onHold, PathScripts.PathDressupTag.TagSolid.radius, draftguitools.gui_snapper.Snapper.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PartGui::DimensionAngular.radius, MeshCore::CylinderSurfaceFit.radius, PartGui::ArcEngine.radius, PathScripts.PathOp.ObjectOp.radius, MeshCore::SphereSurfaceFit.radius, DraftGui.DraftToolBar.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, Inspection::DistanceInspection.radius, ifc2x3.ifccranerailashapeprofiledef.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, ifc2x3.ifcroundededgefeature.radius, config_control_design.conical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ifc4.ifcsweptdisksolid.radius, ifc2x3.ifcrightcircularcylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ifc4.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc4.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, automotive_design.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ifc2x3.ifccircle.radius, ifc4.ifclightsourcepositional.radius, ifc2x3.ifcsphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ifc4.ifccircle.radius, automotive_design.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.sphere.radius, automotive_design.cylindrical_surface.radius, ifc4.ifccylindricalsurface.radius, automotive_design.conical_surface.radius, ifc4.ifcsphere.radius, PathScripts.PathSurface.ObjectSurface.resetTolerance, PathScripts.PathWaterline.ObjectWaterline.resetTolerance, PathScripts.PathDressupPathBoundary.DressupPathBoundary.safeHeight, PathScripts.PathCircularHoleBase.ObjectOp.safeHeight, PathScripts.PathOpGui.TaskPanelHeightsPage.safeHeight, PathScripts.PathOpGui.TaskPanel.safeHeight, PathScripts.PathSurface.ObjectSurface.safeHeight, PathScripts.PathWaterline.ObjectWaterline.safeHeight, PathScripts.PathSetupSheet.Template.SafeHeightOffset, PathScripts.PathWaterline.ObjectWaterline.SafeHeightOffset, PathScripts.PathSurface.ObjectSurface.SafeHeightOffset, PathScripts.PathWaterline.ObjectWaterline.stl, PathScripts.PathSurface.ObjectSurface.stl, PathScripts.PathWaterline.ObjectWaterline.useTiltCutter, and PathScripts.PathSurface.ObjectSurface.useTiltCutter.

initOperation()

def PathScripts.PathWaterline.ObjectWaterline.initOperation	(		self,
			obj
	)

initOperation(obj) ... Initialize the operation by
managing property creation and property editor status.

Reimplemented from PathScripts.PathOp.ObjectOp.

initOpProperties()

def PathScripts.PathWaterline.ObjectWaterline.initOpProperties	(		self,
			obj,
			warn = False
	)

initOpProperties(obj) ... create operation specific properties

Referenced by PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().

onChanged()

def PathScripts.PathWaterline.ObjectWaterline.onChanged	(		self,
			obj,
			prop
	)

onChanged(obj, prop) ... base implementation of the FC notification framework.
Do not overwrite, overwrite opOnChanged() instead.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathProfile.ObjectProfile.propertiesReady, PathScripts.PathWaterline.ObjectWaterline.propertiesReady, PathScripts.PathSurface.ObjectSurface.propertiesReady, PathScripts.PathArray.ObjectArray.setEditorProperties(), PathScripts.PathDressupRampEntry.ObjectDressup.setEditorProperties(), PathScripts.PathWaterline.ObjectWaterline.setEditorProperties(), PathScripts.PathSurface.ObjectSurface.setEditorProperties(), and PathScripts.PathPocketShape.ObjectPocket.setEditorProperties().

Referenced by ArchSite.Compass.buildCoordinates(), and ArchAxis.CommandArchGrid.IsActive().

opApplyPropertyDefaults()

def PathScripts.PathWaterline.ObjectWaterline.opApplyPropertyDefaults	(		self,
			obj,
			job,
			propList
	)

References PathScripts.PathWaterline.ObjectWaterline.opPropertyDefaults(), and PathScripts.PathSurface.ObjectSurface.opPropertyDefaults().

Referenced by PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored(), and PathScripts.PathWaterline.ObjectWaterline.opSetDefaultValues().

opApplyPropertyLimits()

def PathScripts.PathWaterline.ObjectWaterline.opApplyPropertyLimits	(		self,
			obj
	)

opApplyPropertyLimits(obj) ... Apply necessary limits to user input property values before performing main operation.

opExecute()

def PathScripts.PathWaterline.ObjectWaterline.opExecute	(		self,
			obj
	)

opExecute(obj) ... process surface operation

Reimplemented from PathScripts.PathOp.ObjectOp.

opFeatures()

def PathScripts.PathWaterline.ObjectWaterline.opFeatures	(		self,
			obj
	)

opFeatures(obj) ... return all standard features

Reimplemented from PathScripts.PathOp.ObjectOp.

opOnDocumentRestored()

def PathScripts.PathWaterline.ObjectWaterline.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.

References PathScripts.PathOp.ObjectOp.addNewProps, PathScripts.PathWaterline.ObjectWaterline.initOpProperties(), PathScripts.PathSurface.ObjectSurface.initOpProperties(), PathScripts.PathSurface.ObjectSurface.opApplyPropertyDefaults(), PathScripts.PathWaterline.ObjectWaterline.opApplyPropertyDefaults(), PathScripts.PathWaterline.ObjectWaterline.opPropertyEnumerations(), PathScripts.PathSurface.ObjectSurface.opPropertyEnumerations(), PathScripts.PathProfile.ObjectProfile.propertiesReady, PathScripts.PathWaterline.ObjectWaterline.propertiesReady, PathScripts.PathSurface.ObjectSurface.propertiesReady, PathScripts.PathArray.ObjectArray.setEditorProperties(), PathScripts.PathDressupRampEntry.ObjectDressup.setEditorProperties(), PathScripts.PathWaterline.ObjectWaterline.setEditorProperties(), PathScripts.PathSurface.ObjectSurface.setEditorProperties(), and PathScripts.PathPocketShape.ObjectPocket.setEditorProperties().

opPropertyDefaults()

def PathScripts.PathWaterline.ObjectWaterline.opPropertyDefaults	(		self,
			obj,
			job
	)

opPropertyDefaults(obj, job) ... returns a dictionary
of default values for the operation's properties.

Referenced by PathScripts.PathWaterline.ObjectWaterline.opApplyPropertyDefaults().

opPropertyDefinitions()

def PathScripts.PathWaterline.ObjectWaterline.opPropertyDefinitions

(

self

)

opPropertyDefinitions() ... return list of tuples containing operation specific properties

opPropertyEnumerations()

def PathScripts.PathWaterline.ObjectWaterline.opPropertyEnumerations

(

self

)

Referenced by PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().

opSetDefaultValues()

def PathScripts.PathWaterline.ObjectWaterline.opSetDefaultValues	(		self,
			obj,
			job
	)

opSetDefaultValues(obj, job) ... initialize defaults

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathOp.ObjectOp.addNewProps, PathScripts.PathSurface.ObjectSurface.opApplyPropertyDefaults(), and PathScripts.PathWaterline.ObjectWaterline.opApplyPropertyDefaults().

resetOpVariables()

def PathScripts.PathWaterline.ObjectWaterline.resetOpVariables	(		self,
			all = True
	)

resetOpVariables() ... Reset class variables used for instance of operation.

References PathScripts.PathWaterline.ObjectWaterline.holdPoint, PathScripts.PathSurface.ObjectSurface.holdPoint, PathScripts.PathWaterline.ObjectWaterline.layerEndPnt, and PathScripts.PathSurface.ObjectSurface.layerEndPnt.

setEditorProperties()

def PathScripts.PathWaterline.ObjectWaterline.setEditorProperties	(		self,
			obj
	)

Referenced by PathScripts.PathWaterline.ObjectWaterline.onChanged(), and PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().

setOclCutter()

def PathScripts.PathWaterline.ObjectWaterline.setOclCutter	(		self,
			obj,
			safe = False
	)

setOclCutter(obj) ... Translation function to convert FreeCAD tool definition to OCL formatted tool. 

References PathScripts.PathWaterline.ObjectWaterline.useTiltCutter, and PathScripts.PathSurface.ObjectSurface.useTiltCutter.

showDebugObject()

def PathScripts.PathWaterline.ObjectWaterline.showDebugObject	(		self,
			objShape,
			objName
	)

References PathScripts.PathWaterline.ObjectWaterline.showDebugObjects, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.showDebugObjects, PathScripts.PathSurface.ObjectSurface.showDebugObjects, PathScripts.PathWaterline.ObjectWaterline.tempGroup, PathScripts.PathSurface.ObjectSurface.tempGroup, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.tempGroup, and PathScripts.PathSurfaceSupport.FindUnifiedRegions.tempGroup.

Member Data Documentation

addNewProps

PathScripts.PathWaterline.ObjectWaterline.addNewProps

avoidShapes

PathScripts.PathWaterline.ObjectWaterline.avoidShapes

axialFeed

PathScripts.PathWaterline.ObjectWaterline.axialFeed

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

axialRapid

PathScripts.PathWaterline.ObjectWaterline.axialRapid

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

bbRadius

PathScripts.PathWaterline.ObjectWaterline.bbRadius

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

boundBoxes

PathScripts.PathWaterline.ObjectWaterline.boundBoxes

clearHeight

PathScripts.PathWaterline.ObjectWaterline.clearHeight

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

ClearHeightOffset

PathScripts.PathWaterline.ObjectWaterline.ClearHeightOffset

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

closedGap

PathScripts.PathWaterline.ObjectWaterline.closedGap

collectiveShapes

PathScripts.PathWaterline.ObjectWaterline.collectiveShapes

CutClimb

PathScripts.PathWaterline.ObjectWaterline.CutClimb

cutOut

PathScripts.PathWaterline.ObjectWaterline.cutOut

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

cutter

PathScripts.PathWaterline.ObjectWaterline.cutter

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

depthParams

PathScripts.PathWaterline.ObjectWaterline.depthParams

endVector

PathScripts.PathWaterline.ObjectWaterline.endVector

faceZMax

PathScripts.PathWaterline.ObjectWaterline.faceZMax

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

FinalDepth

PathScripts.PathWaterline.ObjectWaterline.FinalDepth

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

fullSTL

PathScripts.PathWaterline.ObjectWaterline.fullSTL

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

gaps

PathScripts.PathWaterline.ObjectWaterline.gaps

geoTlrnc

PathScripts.PathWaterline.ObjectWaterline.geoTlrnc

holdPntCnt

PathScripts.PathWaterline.ObjectWaterline.holdPntCnt

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

holdPoint

PathScripts.PathWaterline.ObjectWaterline.holdPoint

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables(), and PathScripts.PathWaterline.ObjectWaterline.resetOpVariables().

individualShapes

PathScripts.PathWaterline.ObjectWaterline.individualShapes

layerEndPnt

PathScripts.PathWaterline.ObjectWaterline.layerEndPnt

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables(), and PathScripts.PathWaterline.ObjectWaterline.resetOpVariables().

layerEndzMax

PathScripts.PathWaterline.ObjectWaterline.layerEndzMax

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

midDep

PathScripts.PathWaterline.ObjectWaterline.midDep

modelSTLs

PathScripts.PathWaterline.ObjectWaterline.modelSTLs

modelTypes

PathScripts.PathWaterline.ObjectWaterline.modelTypes

module

PathScripts.PathWaterline.ObjectWaterline.module

onHold

PathScripts.PathWaterline.ObjectWaterline.onHold

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

profileShapes

PathScripts.PathWaterline.ObjectWaterline.profileShapes

propertiesReady

PathScripts.PathWaterline.ObjectWaterline.propertiesReady

Referenced by PathScripts.PathWaterline.ObjectWaterline.onChanged(), and PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().

radius

PathScripts.PathWaterline.ObjectWaterline.radius

resetTolerance

PathScripts.PathWaterline.ObjectWaterline.resetTolerance

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

safeHeight

PathScripts.PathWaterline.ObjectWaterline.safeHeight

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

SafeHeightOffset

PathScripts.PathWaterline.ObjectWaterline.SafeHeightOffset

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

safeSTLs

PathScripts.PathWaterline.ObjectWaterline.safeSTLs

showDebugObjects

PathScripts.PathWaterline.ObjectWaterline.showDebugObjects

Referenced by PathScripts.PathWaterline.ObjectWaterline.showDebugObject().

stl

PathScripts.PathWaterline.ObjectWaterline.stl

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables().

stockZMin

PathScripts.PathWaterline.ObjectWaterline.stockZMin

tempGroup

PathScripts.PathWaterline.ObjectWaterline.tempGroup

Referenced by PathScripts.PathWaterline.ObjectWaterline.showDebugObject().

tmpCOM

PathScripts.PathWaterline.ObjectWaterline.tmpCOM

toolDiam

PathScripts.PathWaterline.ObjectWaterline.toolDiam

topoMap

PathScripts.PathWaterline.ObjectWaterline.topoMap

useTiltCutter

PathScripts.PathWaterline.ObjectWaterline.useTiltCutter

Referenced by PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables(), and PathScripts.PathWaterline.ObjectWaterline.setOclCutter().

wpc

PathScripts.PathWaterline.ObjectWaterline.wpc

---

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

• src/Mod/Path/PathScripts/PathWaterline.py