PathScripts.PathPocketShape.ObjectPocket Class Reference

Public Member Functions
def	areaOpFeatures (self, obj)
def	areaOpOnChanged (self, obj, prop)
def	areaOpOnDocumentRestored (self, obj)
def	areaOpSetDefaultValues (self, obj, job)
def	areaOpShapes (self, obj)
def	checkForFacesLoop (self, base, subsList)
def	createExtension (self, obj, extObj, extFeature, extSub)
def	getExtensions (self, obj)
def	initPocketOp (self, obj)
def	initRotationOp (self, obj)
def	pocketInvertExtraOffset (self)
def	setEditorProperties (self, obj)
def	setExtensions (self, obj, extensions)
Public Member Functions inherited from PathScripts.PathPocketBase.ObjectPocket
def	areaOpAreaParams (self, obj, isHole)
def	areaOpPathParams (self, obj, isHole)
def	areaOpRetractTool (self, obj)
def	areaOpUseProjection (self, obj)
def	initAreaOp (self, obj)
def	pocketOpFeatures (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	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	opUpdateDepths (self, obj)
def	setDefaultValues (self, obj)
def	setEditorModes (self, obj, features)
def	updateDepths (self, obj, ignoreErrors=False)

Public Attributes
	bodies
	exts
	horiz
	horizontal
	outlines
	removalshapes
	vert
	vertical
	vWires
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 Pocket operation.

Member Function Documentation

areaOpFeatures()

def PathScripts.PathPocketShape.ObjectPocket.areaOpFeatures	(		self,
			obj
	)

areaOpFeatures(obj) ... Pockets have a FinishDepth and work on Faces

Reimplemented from PathScripts.PathPocketBase.ObjectPocket.

areaOpOnChanged()

def PathScripts.PathPocketShape.ObjectPocket.areaOpOnChanged	(		self,
			obj,
			prop
	)

areaOpOnChanged(obj, porp) ... process operation specific changes to properties.

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

References PathScripts.PathArray.ObjectArray.setEditorProperties(), PathScripts.PathDressupRampEntry.ObjectDressup.setEditorProperties(), and PathScripts.PathPocketShape.ObjectPocket.setEditorProperties().

areaOpOnDocumentRestored()

def PathScripts.PathPocketShape.ObjectPocket.areaOpOnDocumentRestored	(		self,
			obj
	)

opOnDocumentRestored(obj) ... adds the UseOutline property, others, if they doesn't exist.

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

References PathScripts.PathPocketBase.ObjectPocket.initPocketOp(), PathScripts.PathMillFace.ObjectFace.initPocketOp(), PathScripts.PathPocket.ObjectPocket.initPocketOp(), PathScripts.PathArray.ObjectArray.setEditorProperties(), PathScripts.PathDressupRampEntry.ObjectDressup.setEditorProperties(), and PathScripts.PathPocketShape.ObjectPocket.setEditorProperties().

areaOpSetDefaultValues()

def PathScripts.PathPocketShape.ObjectPocket.areaOpSetDefaultValues	(		self,
			obj,
			job
	)

areaOpSetDefaultValues(obj, job) ... set default values

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

areaOpShapes()

def PathScripts.PathPocketShape.ObjectPocket.areaOpShapes	(		self,
			obj
	)

areaOpShapes(obj) ... return shapes representing the solids to be removed.

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

References DrawingGui::OrthoViews.horiz, PathScripts.PathPocketShape.ObjectPocket.horiz, PathScripts.PathAreaOp.ObjectOp.useTempJobClones(), DrawingGui::OrthoViews.vert, and PathScripts.PathPocketShape.ObjectPocket.vert.

checkForFacesLoop()

def PathScripts.PathPocketShape.ObjectPocket.checkForFacesLoop	(		self,
			base,
			subsList
	)

checkForFacesLoop(base, subsList)...
    Accepts a list of face names for the given base.
    Checks to determine if they are looped together.

References PathScripts.PathAreaOp.ObjectOp.getFaceNormAndSurf().

createExtension()

def PathScripts.PathPocketShape.ObjectPocket.createExtension	(		self,
			obj,
			extObj,
			extFeature,
			extSub
	)

Referenced by PathScripts.PathPocketShape.ObjectPocket.getExtensions().

getExtensions()

def PathScripts.PathPocketShape.ObjectPocket.getExtensions	(		self,
			obj
	)

References PathScripts.PathPocketShape.ObjectPocket.createExtension().

initPocketOp()

def PathScripts.PathPocketShape.ObjectPocket.initPocketOp	(		self,
			obj
	)

initPocketOp(obj) ... setup receiver

Reimplemented from PathScripts.PathPocketBase.ObjectPocket.

References PathScripts.PathPocketShape.ObjectPocket.initRotationOp().

initRotationOp()

def PathScripts.PathPocketShape.ObjectPocket.initRotationOp	(		self,
			obj
	)

initRotationOp(obj) ... setup receiver for rotation

Referenced by PathScripts.PathPocketShape.ObjectPocket.initPocketOp().

pocketInvertExtraOffset()

def PathScripts.PathPocketShape.ObjectPocket.pocketInvertExtraOffset

(

self

)

pocketInvertExtraOffset() ... return True if ExtraOffset's direction is inward.
Can safely be overwritten by subclass.

Reimplemented from PathScripts.PathPocketBase.ObjectPocket.

setEditorProperties()

def PathScripts.PathPocketShape.ObjectPocket.setEditorProperties	(		self,
			obj
	)

Referenced by PathScripts.PathPocketShape.ObjectPocket.areaOpOnChanged(), PathScripts.PathPocketShape.ObjectPocket.areaOpOnDocumentRestored(), PathScripts.PathWaterline.ObjectWaterline.onChanged(), PathScripts.PathSurface.ObjectSurface.onChanged(), PathScripts.PathSurface.ObjectSurface.opOnDocumentRestored(), and PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().

setExtensions()

def PathScripts.PathPocketShape.ObjectPocket.setExtensions	(		self,
			obj,
			extensions
	)

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setFields(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.toggleExtensionCorners(), and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.updateData().

Member Data Documentation

bodies

PathScripts.PathPocketShape.ObjectPocket.bodies

exts

PathScripts.PathPocketShape.ObjectPocket.exts

horiz

PathScripts.PathPocketShape.ObjectPocket.horiz

Referenced by PathScripts.PathPocketShape.ObjectPocket.areaOpShapes().

horizontal

PathScripts.PathPocketShape.ObjectPocket.horizontal

outlines

PathScripts.PathPocketShape.ObjectPocket.outlines

removalshapes

PathScripts.PathPocketShape.ObjectPocket.removalshapes

vert

PathScripts.PathPocketShape.ObjectPocket.vert

Referenced by PathScripts.PathPocketShape.ObjectPocket.areaOpShapes().

vertical

PathScripts.PathPocketShape.ObjectPocket.vertical

vWires

PathScripts.PathPocketShape.ObjectPocket.vWires

---

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

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