PathScripts.PathProfile.ObjectProfile Class Reference

Public Member Functions
def	areaOpApplyPropertyDefaults (self, obj, job, propList)
def	areaOpAreaParams (self, obj, isHole)
def	areaOpFeatures (self, obj)
def	areaOpOnChanged (self, obj, prop)
def	areaOpOnDocumentRestored (self, obj)
def	areaOpPathParams (self, obj, isHole)
def	areaOpProperties (self)
def	areaOpPropertyDefaults (self, obj, job)
def	areaOpPropertyEnumerations (self, dataType="data")
def	areaOpSetDefaultValues (self, obj, job)
def	areaOpShapes (self, obj)
def	areaOpUseProjection (self, obj)
def	initAreaOp (self, obj)
def	initAreaOpProperties (self, obj, warn=False)
def	opUpdateDepths (self, obj)
def	setOpEditorProperties (self, obj)
Public Member Functions inherited from PathScripts.PathAreaOp.ObjectOp
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
	addNewProps
	cutOut
	cutSide
	cutSideTags
	eTAG
	inaccessibleMsg
	isDebug
	iTAG
	JOB
	offsetExtra
	ofstRadius
	propertiesReady
	removalshapes
	tmpGrp
	useComp
Public Attributes inherited from PathScripts.PathAreaOp.ObjectOp
	depthparams
	endVector
	leadIn
Public Attributes inherited from PathScripts.PathOp.ObjectOp
	addNewProps
	commandlist
	horizFeed
	horizRapid
	job
	model
	radius
	stock
	tool
	vertFeed
	vertRapid

Detailed Description

Proxy object for Profile operations based on faces.

Member Function Documentation

areaOpApplyPropertyDefaults()

def PathScripts.PathProfile.ObjectProfile.areaOpApplyPropertyDefaults	(		self,
			obj,
			job,
			propList
	)

References PathScripts.PathProfile.ObjectProfile.areaOpPropertyDefaults().

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpSetDefaultValues().

areaOpAreaParams()

def PathScripts.PathProfile.ObjectProfile.areaOpAreaParams	(		self,
			obj,
			isHole
	)

areaOpAreaParams(obj, isHole) ... returns dictionary with area parameters.
Do not overwrite.

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

References 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, and TechDraw::Circle.radius.

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

areaOpFeatures()

def PathScripts.PathProfile.ObjectProfile.areaOpFeatures	(		self,
			obj
	)

areaOpFeatures(obj) ... returns operation-specific features

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

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

areaOpOnChanged()

def PathScripts.PathProfile.ObjectProfile.areaOpOnChanged	(		self,
			obj,
			prop
	)

areaOpOnChanged(obj, prop) ... updates certain property visibilities depending on changed properties.

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

References PathScripts.PathProfile.ObjectProfile.propertiesReady, PathScripts.PathSlot.ObjectSlot.propertiesReady, PathScripts.PathSurface.ObjectSurface.propertiesReady, PathScripts.PathWaterline.ObjectWaterline.propertiesReady, and PathScripts.PathProfile.ObjectProfile.setOpEditorProperties().

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

areaOpOnDocumentRestored()

def PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored	(		self,
			obj
	)

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

Reimplemented from PathScripts.PathAreaOp.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.PathProfile.ObjectProfile.initAreaOpProperties(), PathScripts.PathProfile.ObjectProfile.propertiesReady, PathScripts.PathSlot.ObjectSlot.propertiesReady, PathScripts.PathSurface.ObjectSurface.propertiesReady, PathScripts.PathWaterline.ObjectWaterline.propertiesReady, and PathScripts.PathProfile.ObjectProfile.setOpEditorProperties().

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

areaOpPathParams()

def PathScripts.PathProfile.ObjectProfile.areaOpPathParams	(		self,
			obj,
			isHole
	)

areaOpPathParams(obj, isHole) ... returns dictionary with path parameters.
Do not overwrite.

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

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

areaOpProperties()

def PathScripts.PathProfile.ObjectProfile.areaOpProperties

(

self

)

areaOpProperties(obj) ... returns a tuples.
Each tuple contains property declaration information in the
form of (prototype, name, section, tooltip).

References draftutils.translate.QT_TRANSLATE_NOOP.

areaOpPropertyDefaults()

def PathScripts.PathProfile.ObjectProfile.areaOpPropertyDefaults	(		self,
			obj,
			job
	)

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

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpApplyPropertyDefaults().

areaOpPropertyEnumerations()

def PathScripts.PathProfile.ObjectProfile.areaOpPropertyEnumerations	(		self,
			dataType = "data"
	)

opPropertyEnumerations(dataType="data")... return property enumeration lists of specified dataType.
Args:
    dataType = 'data', 'raw', 'translated'
Notes:
'data' is list of internal string literals used in code
'raw' is list of (translated_text, data_string) tuples
'translated' is list of translated string literals

areaOpSetDefaultValues()

def PathScripts.PathProfile.ObjectProfile.areaOpSetDefaultValues	(		self,
			obj,
			job
	)

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

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

References PathScripts.PathOp.ObjectOp.addNewProps, PathScripts.PathProfile.ObjectProfile.addNewProps, PathScripts.PathSlot.ObjectSlot.addNewProps, PathScripts.PathSurface.ObjectSurface.addNewProps, PathScripts.PathWaterline.ObjectWaterline.addNewProps, and PathScripts.PathProfile.ObjectProfile.areaOpApplyPropertyDefaults().

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

areaOpShapes()

def PathScripts.PathProfile.ObjectProfile.areaOpShapes	(		self,
			obj
	)

areaOpShapes(obj) ... returns envelope for all base shapes or wires

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

areaOpUseProjection()

def PathScripts.PathProfile.ObjectProfile.areaOpUseProjection	(		self,
			obj
	)

areaOpUseProjection(obj) ... returns True

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

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

initAreaOp()

def PathScripts.PathProfile.ObjectProfile.initAreaOp	(		self,
			obj
	)

initAreaOp(obj) ... creates all profile specific properties.

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

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

initAreaOpProperties()

def PathScripts.PathProfile.ObjectProfile.initAreaOpProperties	(		self,
			obj,
			warn = False
	)

initAreaOpProperties(obj) ... create operation specific properties

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored().

opUpdateDepths()

def PathScripts.PathProfile.ObjectProfile.opUpdateDepths	(		self,
			obj
	)

opUpdateDepths(obj) ... overwrite to implement special depths calculation.
Can safely be overwritten by subclass.

Reimplemented from PathScripts.PathOp.ObjectOp.

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

setOpEditorProperties()

def PathScripts.PathProfile.ObjectProfile.setOpEditorProperties	(		self,
			obj
	)

setOpEditorProperties(obj, porp) ... Process operation-specific changes to properties visibility.

References PathScripts.PathProfile.ObjectProfile._getOperationType().

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpOnChanged(), and PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored().

Member Data Documentation

addNewProps

PathScripts.PathProfile.ObjectProfile.addNewProps

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpSetDefaultValues(), PathScripts.PathSlot.ObjectSlot.opOnDocumentRestored(), PathScripts.PathSurface.ObjectSurface.opOnDocumentRestored(), PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored(), PathScripts.PathSlot.ObjectSlot.opSetDefaultValues(), PathScripts.PathSurface.ObjectSurface.opSetDefaultValues(), and PathScripts.PathWaterline.ObjectWaterline.opSetDefaultValues().

cutOut

PathScripts.PathProfile.ObjectProfile.cutOut

Referenced by PathScripts.PathSurface.ObjectSurface.deleteOpVariables(), PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables(), and PathScripts.PathSurfaceSupport.PathGeometryGenerator.generatePathGeometry().

cutSide

PathScripts.PathProfile.ObjectProfile.cutSide

cutSideTags

PathScripts.PathProfile.ObjectProfile.cutSideTags

eTAG

PathScripts.PathProfile.ObjectProfile.eTAG

inaccessibleMsg

PathScripts.PathProfile.ObjectProfile.inaccessibleMsg

isDebug

PathScripts.PathProfile.ObjectProfile.isDebug

iTAG

PathScripts.PathProfile.ObjectProfile.iTAG

JOB

PathScripts.PathProfile.ObjectProfile.JOB

Referenced by PathScripts.PathSurfaceSupport.ProcessSelectedFaces.preProcessModel().

offsetExtra

PathScripts.PathProfile.ObjectProfile.offsetExtra

ofstRadius

PathScripts.PathProfile.ObjectProfile.ofstRadius

propertiesReady

PathScripts.PathProfile.ObjectProfile.propertiesReady

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpOnChanged(), PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored(), PathScripts.PathSlot.ObjectSlot.onChanged(), PathScripts.PathSurface.ObjectSurface.onChanged(), PathScripts.PathWaterline.ObjectWaterline.onChanged(), PathScripts.PathSlot.ObjectSlot.opOnDocumentRestored(), PathScripts.PathSurface.ObjectSurface.opOnDocumentRestored(), and PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().

removalshapes

PathScripts.PathProfile.ObjectProfile.removalshapes

tmpGrp

PathScripts.PathProfile.ObjectProfile.tmpGrp

useComp

PathScripts.PathProfile.ObjectProfile.useComp

---

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

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