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)
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	applyInverseAngle (self, obj, clnBase, clnStock, axis, angle)
def	applyRotationalAnalysis (self, obj, base, angle, axis, subCount)
def	areaOpRetractTool (self, obj)
def	areaOpShapeForDepths (self, obj, job)
def	cloneBaseAndStock (self, obj, base, angle, axis, subCount)
def	faceRotationAnalysis (self, obj, norm, surf)
def	getFaceNormAndSurf (self, face)
def	guiMessage (self, title, msg, show=False)
def	initOperation (self, obj)
def	isFaceUp (self, base, face)
def	opDetermineRotationRadii (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)
def	setupAdditionalProperties (self, obj)
def	sortTuplesByIndex (self, TupleList, tagIdx)
def	useTempJobClones (self, cloneName)
def	visualAxis (self)
def	warnDisabledAxis (self, obj, axis, sub='')
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	onChanged (self, obj, prop)
def	onDocumentRestored (self, obj)
def	opExecute (self, obj)
def	opRejectAddBase (self, obj, base, sub)
def	setDefaultValues (self, obj)
def	setEditorModes (self, obj, features)
def	updateDepths (self, obj, ignoreErrors=False)

Public Attributes
	addNewProps
	cutSide
	cutSideTags
	depthparams
	eTAG
	inaccessibleMsg
	iTAG
	JOB
	offsetExtra
	ofstRadius
	profileshape
	propertiesReady
	removalshapes
	tmpGrp
	useComp
Public Attributes inherited from PathScripts.PathAreaOp.ObjectOp
	axialFeed
	axialRapid
	cloneNames
	depthparams
	endVector
	guiMsgs
	initWithRotation
	leadIn
	rotateFlag
	rotStartDepth
	stockBB
	tempObjectNames
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 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, and ifc4.ifcsphere.radius.

areaOpFeatures()

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

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

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

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, and PathScripts.PathProfile.ObjectProfile.setOpEditorProperties().

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.PathProfile.ObjectProfile.initAreaOpProperties(), PathScripts.PathProfile.ObjectProfile.propertiesReady, and PathScripts.PathProfile.ObjectProfile.setOpEditorProperties().

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.

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

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

)

areaOpPropertyEnumerations() ... returns a dictionary of enumeration lists
for the operation's enumeration type properties.

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, and PathScripts.PathProfile.ObjectProfile.areaOpApplyPropertyDefaults().

areaOpShapes()

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

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

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

areaOpUseProjection()

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

areaOpUseProjection(obj) ... returns True

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

initAreaOp()

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

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

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

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.

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

cutSide

PathScripts.PathProfile.ObjectProfile.cutSide

cutSideTags

PathScripts.PathProfile.ObjectProfile.cutSideTags

depthparams

PathScripts.PathProfile.ObjectProfile.depthparams

eTAG

PathScripts.PathProfile.ObjectProfile.eTAG

inaccessibleMsg

PathScripts.PathProfile.ObjectProfile.inaccessibleMsg

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

profileshape

PathScripts.PathProfile.ObjectProfile.profileshape

propertiesReady

PathScripts.PathProfile.ObjectProfile.propertiesReady

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpOnChanged(), PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored(), PathScripts.PathWaterline.ObjectWaterline.onChanged(), PathScripts.PathSurface.ObjectSurface.onChanged(), 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:

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