Public Member Functions
def	checkIgnoreAbove (self, edge)

def	createCommands (self, obj, edges)

def	createHelix (self, rampedges, startPoint, endPoint)

def	createRampEdge (self, originalEdge, startPoint, endPoint)

def	createRampMethod1 (self, rampedges, p0, projectionlen, rampangle)

def	createRampMethod2 (self, rampedges, p0, projectionlen, rampangle)

def	createRampMethod3 (self, rampedges, p0, projectionlen, rampangle)

def	execute (self, obj)

def	findMinZ (self, edges)

def	generateHelix (self)

def	generateRamps (self, allowBounce=True)

def	getreversed (self, edges)

def	getSplitPoint (self, edge, remaining)

def	onChanged (self, obj, prop)

def	onDocumentRestored (self, obj)

def	propertyEnumerations (self, dataType="data")

def	setEditorProperties (self, obj)

def	setup (self, obj)

Public Attributes
	angle

	ignoreAbove

	ignoreAboveEnabled

	method

	obj

	outedges

	rapids

	wire

Member Function Documentation

◆ checkIgnoreAbove()

def PathScripts.PathDressupRampEntry.ObjectDressup.checkIgnoreAbove	(	self,
		edge
	)

References PathScripts.PathDressupRampEntry.ObjectDressup.ignoreAbove, and PathScripts.PathDressupRampEntry.ObjectDressup.ignoreAboveEnabled.

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.generateHelix(), and PathScripts.PathDressupRampEntry.ObjectDressup.generateRamps().

◆ createCommands()

def PathScripts.PathDressupRampEntry.ObjectDressup.createCommands	(	self,
		obj,
		edges
	)

References PathScripts.PathDressupLeadInOut.ObjectDressup.rapids, and PathScripts.PathDressupRampEntry.ObjectDressup.rapids.

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.execute().

◆ createHelix()

def PathScripts.PathDressupRampEntry.ObjectDressup.createHelix	(	self,
		rampedges,
		startPoint,
		endPoint
	)

References PathScripts.PathDressupRampEntry.ObjectDressup.createRampEdge().

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.generateHelix().

◆ createRampEdge()

def PathScripts.PathDressupRampEntry.ObjectDressup.createRampEdge	(	self,
		originalEdge,
		startPoint,
		endPoint
	)

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.createHelix(), PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod1(), PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod2(), and PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod3().

◆ createRampMethod1()

def PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod1	(	self,
		rampedges,
		p0,
		projectionlen,
		rampangle
	)

This method generates ramp with following pattern:
1. Start from the original startpoint of the plunge
2. Ramp down along the path that comes after the plunge
3. When reaching the Z level of the original plunge, return back to the beginning
   by going the path backwards until the original plunge end point is reached
4. Continue with the original path

This method causes many unnecessary moves with tool down.

References PathScripts.PathDressupRampEntry.ObjectDressup.createRampEdge(), PathScripts.PathDressupRampEntry.ObjectDressup.getreversed(), and PathScripts.PathDressupRampEntry.ObjectDressup.getSplitPoint().

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.generateRamps().

◆ createRampMethod2()

def PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod2	(	self,
		rampedges,
		p0,
		projectionlen,
		rampangle
	)

This method generates ramp with following pattern:
1. Start from the original startpoint of the plunge
2. Calculate the distance on the path which is needed to implement the ramp
   and travel that distance while maintaining start depth
3. Start ramping while traveling the original path backwards until reaching the
   original plunge end point
4. Continue with the original path

References PathScripts.PathDressupRampEntry.ObjectDressup.createRampEdge(), and PathScripts.PathDressupRampEntry.ObjectDressup.getSplitPoint().

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.generateRamps().

◆ createRampMethod3()

def PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod3	(	self,
		rampedges,
		p0,
		projectionlen,
		rampangle
	)

This method generates ramp with following pattern:
1. Start from the original startpoint of the plunge
2. Ramp down along the path that comes after the plunge until
   traveled half of the Z distance
3. Change direction and ramp backwards to the original plunge end point
4. Continue with the original path

This method causes many unnecessary moves with tool down.

References PathScripts.PathDressupRampEntry.ObjectDressup.createRampEdge(), PathScripts.PathDressupRampEntry.ObjectDressup.getreversed(), and PathScripts.PathDressupRampEntry.ObjectDressup.getSplitPoint().

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.generateRamps().

◆ execute()

def PathScripts.PathDressupRampEntry.ObjectDressup.execute	(	self,
		obj
	)

Referenced by draftobjects.facebinder.Facebinder.addSubobjects(), PathScripts.PathDressupDogbone.ObjectDressup.boneStateList(), ArchSite.Compass.buildCoordinates(), PathScripts.PathDressupHoldingTags.ObjectTagDressup.generateTags(), ArchPanel.PanelCut.getWires(), ArchSchedule.CommandArchSchedule.IsActive(), Mod.PartDesign.Scripts.DistanceBolt.DistanceBolt.onChanged(), Mod.PartDesign.Scripts.Epitrochoid.Epitrochoid.onChanged(), Mod.PartDesign.Scripts.Parallelepiped.Parallelepiped.onChanged(), Mod.PartDesign.Scripts.Parallelepiped.BoxCylinder.onChanged(), Mod.PartDesign.Scripts.Spring.MySpring.onChanged(), FeaturePython.DistanceBolt.onChanged(), PathScripts.PathStock.StockFromBase.onChanged(), PathScripts.PathStock.StockCreateBox.onChanged(), PathScripts.PathStock.StockCreateCylinder.onChanged(), draftobjects.draftlink.DraftLink.onDocumentRestored(), draftobjects.patharray.PathArray.onDocumentRestored(), and draftobjects.pathtwistedarray.PathTwistedArray.onDocumentRestored().

◆ findMinZ()

def PathScripts.PathDressupRampEntry.ObjectDressup.findMinZ	(	self,
		edges
	)

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.generateHelix().

◆ generateHelix()

def PathScripts.PathDressupRampEntry.ObjectDressup.generateHelix ( self )

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.execute().

◆ generateRamps()

def PathScripts.PathDressupRampEntry.ObjectDressup.generateRamps	(	self,
		allowBounce = `True`
	)

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.execute().

◆ getreversed()

def PathScripts.PathDressupRampEntry.ObjectDressup.getreversed	(	self,
		edges
	)

Reverses the edge array and the direction of each edge

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod1(), and PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod3().

◆ getSplitPoint()

def PathScripts.PathDressupRampEntry.ObjectDressup.getSplitPoint	(	self,
		edge,
		remaining
	)

Referenced by PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod1(), PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod2(), and PathScripts.PathDressupRampEntry.ObjectDressup.createRampMethod3().

◆ onChanged()

def PathScripts.PathDressupRampEntry.ObjectDressup.onChanged	(	self,
		obj,
		prop
	)

References PathScripts.PathDressupRampEntry.ObjectDressup.setEditorProperties(), PathScripts.PathSurface.ObjectSurface.setEditorProperties(), and PathScripts.PathWaterline.ObjectWaterline.setEditorProperties().

Referenced by ArchStructure.CommandStructuralSystem.Activated(), draftviewproviders.view_base.ViewProviderDraft.attach(), ArchSite.Compass.buildCoordinates(), draftobjects.wire.Wire.execute(), ArchBuildingPart.ViewProviderBuildingPart.updateData(), ArchPanel.ViewProviderPanelCut.updateData(), ArchPanel.ViewProviderPanelSheet.updateData(), draftviewproviders.view_label.ViewProviderLabel.updateData(), draftviewproviders.view_layer.ViewProviderLayer.updateData(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.updateData().

◆ onDocumentRestored()

def PathScripts.PathDressupRampEntry.ObjectDressup.onDocumentRestored	(	self,
		obj
	)

References PathScripts.PathDressupRampEntry.ObjectDressup.setEditorProperties(), PathScripts.PathSurface.ObjectSurface.setEditorProperties(), and PathScripts.PathWaterline.ObjectWaterline.setEditorProperties().

◆ propertyEnumerations()

def PathScripts.PathDressupRampEntry.ObjectDressup.propertyEnumerations	(	self,
		dataType = `"data"`
	)

PropertyEnumerations(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

Referenced by PathScripts.PathDrilling.ObjectDrilling.initCircularHoleOperation(), PathScripts.PathThreadMilling.ObjectThreadMilling.initCircularHoleOperation(), PathScripts.PathAdaptive.PathAdaptive.initOperation(), PathScripts.PathDeburr.ObjectDeburr.initOperation(), PathScripts.PathMillFace.ObjectFace.initPocketOp(), PathScripts.PathPocket.ObjectPocket.initPocketOp(), PathScripts.PathJob.ObjectJob.onDocumentRestored(), and PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().