PathScripts.PathPocketShape.ObjectPocket Class Reference

Public Member Functions
def	areaOpFeatures (self, obj)
def	areaOpOnDocumentRestored (self, obj)
def	areaOpSetDefaultValues (self, obj, job)
def	areaOpShapes (self, obj)
def	clasifySub (self, bs, sub)
def	initPocketOp (self, obj)
def	isVerticalExtrusionFace (self, face)
def	pocketInvertExtraOffset (self)
Public Member Functions inherited from PathScripts.PathPocketBase.ObjectPocket
def	areaOpAreaParams (self, obj, isHole)
def	areaOpFeatures (self, obj)
def	areaOpPathParams (self, obj, isHole)
def	areaOpRetractTool (self, obj)
def	areaOpSetDefaultValues (self, obj, job)
def	areaOpUseProjection (self, obj)
def	initAreaOp (self, obj)
def	initPocketOp (self, obj)
def	opOnDocumentRestored (self, obj)
def	pocketInvertExtraOffset (self)
def	pocketOpFeatures (self, obj)
def	pocketPropertyEnumerations (cls, dataType="data")
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
	bodies
	exts
	horiz
	horizontal
	outlines
	removalshapes
	vert
	vertical
	vWires
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 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.

References PathScripts.PathPocketShape.ObjectPocket.areaOpFeatures().

Referenced by PathScripts.PathPocketShape.ObjectPocket.areaOpFeatures(), and PathScripts.PathAreaOp.ObjectOp.opFeatures().

areaOpOnDocumentRestored()

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

opOnDocumentRestored(obj) ... adds the UseOutline property if it doesn't exist.

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

References PathScripts.PathMillFace.ObjectFace.initPocketOp(), PathScripts.PathPocket.ObjectPocket.initPocketOp(), PathScripts.PathPocketBase.ObjectPocket.initPocketOp(), and PathScripts.PathPocketShape.ObjectPocket.initPocketOp().

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

areaOpSetDefaultValues()

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

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

Reimplemented from PathScripts.PathPocketBase.ObjectPocket.

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

areaOpShapes()

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

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

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

clasifySub()

def PathScripts.PathPocketShape.ObjectPocket.clasifySub	(		self,
			bs,
			sub
	)

clasifySub(bs, sub)...
Given a base and a sub-feature name, returns True
if the sub-feature is a horizontally oriented flat face.

References DrawingGui::OrthoViews.horiz, PathScripts.PathPocketShape.ObjectPocket.horiz, PathScripts.PathPocketShape.ObjectPocket.isVerticalExtrusionFace(), DrawingGui::OrthoViews.vert, and PathScripts.PathPocketShape.ObjectPocket.vert.

initPocketOp()

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

initPocketOp(obj) ... setup receiver

Reimplemented from PathScripts.PathPocketBase.ObjectPocket.

References draftutils.translate.QT_TRANSLATE_NOOP.

Referenced by PathScripts.PathPocketShape.ObjectPocket.areaOpOnDocumentRestored(), PathScripts.PathPocketBase.ObjectPocket.initAreaOp(), and PathScripts.PathPocket.ObjectPocket.opOnDocumentRestored().

isVerticalExtrusionFace()

def PathScripts.PathPocketShape.ObjectPocket.isVerticalExtrusionFace	(		self,
			face
	)

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

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.

Referenced by PathScripts.PathPocketBase.ObjectPocket.areaOpAreaParams().

Member Data Documentation

bodies

PathScripts.PathPocketShape.ObjectPocket.bodies

exts

PathScripts.PathPocketShape.ObjectPocket.exts

horiz

PathScripts.PathPocketShape.ObjectPocket.horiz

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

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

vertical

PathScripts.PathPocketShape.ObjectPocket.vertical

vWires

PathScripts.PathPocketShape.ObjectPocket.vWires

---

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

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