Implementation of a simple CAM exporter that implements the RFileExporter interface. More...

Inheritance diagram for CamExporterV2:

Public Member Functions
void	activated ()
	Called when the configuration is activated by the user of on loading.

void	adjustOffsetLeadShapes (void leadShapes, void offsetShapes, void offsetBaseShapeUntrimmed, void leadIn)
	Adjusts the offset lead in / lead out to account for the move in which tool radius compensation is switched on / off.

void	afterExportToolpath (void entityIds, void toolpathBlock, void toolpathIndex, void createTransactionGroup, void updateConnections, void isNew)
	Implemented by exporters to do something after a toolpath is exported.

void	beforeExportContourPass (void contour)
	Called immediately before calling exportContourPass May implement radial stock offset or similar features.

void	beforeExportToolpath (void entityIds, void toolpathBlock, void toolpathIndex, void createTransactionGroup, void updateConnections, void isNew)
	Implemented by exporters to do something before a toolpath is exported.

void	beforeWrite (void fileName)

void	CamExporterV2 (void cadDocumentInterface, void camDocumentInterface)

void	checkContext (void context)

void	collectCamOffsetPath (void camEntity)
	Collects information about an additional path representing the center tool path including cutter compensation.

void	contourContains (void contour, void point)
	Allow exporters to implement their own test if point is inside contour.

void	createConfigOutputLayer ()
	Creates layers "CAM" and "CAM ... GCode".

void	createDrillToolpathDialog (void di, void toolpathBlock)
	Creates the standard QCAD/CAM drill toolpath dialog.

void	createLayer (void layerName, void color, void linetype, void options)

void	createPocketToolpathDialog (void di, void toolpathBlock)
	Creates the standard QCAD/CAM pocket toolpath dialog.

void	createProfileToolpathDialog (void di, void toolpathBlock)
	Creates the standard QCAD/CAM profile toolpath dialog.

void	createSpatialIndex (void contours)
	Creates a spatial index over all entry points of the given contours.

void	createToolDialog (void di, void toolBlock, void title)
	Creates the standard QCAD/CAM tool dialog.

void	decIndent ()

void	detectAndWriteToolChange (void toolHeaderWritten)
	Writes a tool change if necessary.

void	dumpContext ()

void	exportArc (void arc)
	Called when contour shapes, offset shapes or leads and overcuts are exported.

void	exportCamEntity (void camEntity, void noProperties, void noOffset, void noTabs, void ignore)
	Adds the given entity to the output document.

void	exportClosedContourShape (void shape)
	Called for entities of closed contours.

void	exportContour (void contours, void contourIndex, void shapeIndex, void siEntryPoints, void inner)
	Exports the given contour to the target document, starting at the entity at the given entityIndex.

void	exportContourPass (void contour, void shapeIndex)
	Exports the given contour to the target document, starting at the shape at the given shapeIndex.

void	exportContours (void contours, void siEntryPoints)
	Exports the given contours which are all part of the same toolpoth.

void	exportEllipse (void ellipse)
	Called when contour shapes are exported.

void	exportFirstClosedContourShape (void shape)
	Called for the first entity of a closed contour.

void	exportFirstContourShape (void shape)
	Called for the first entity of open and closed contours.

void	exportFirstOpenContourShape (void shape)
	Called for the first entity of an open contour.

void	exportLastClosedContourShape (void shape)
	Called for the last entity of a closed contour.

void	exportLastContourShape (void shape)
	Called for the last entity of open and closed contours.

void	exportLastOpenContourShape (void shape)
	Called for the last entity of an open contour.

void	exportLead (void shape, void leadIn)
	Exports the lead in/out for the given shape.

void	exportLeadIn (void shape)

void	exportLeadOut (void shape)

void	exportLine (void line)
	Called when contour shapes, offset shapes or leads and overcuts are exported.

void	exportOffsetPath ()
	Exports the previously collected path, offset by the tool radius.

void	exportOpenContourShape (void shape)
	Called for entities of an open contour.

void	exportPoint (void point)

void	exportPostContourPass (void contour)
	Override to export additional moves after contour pass (e.g.

void	exportPostContourPasses (void contour)
	Retreat to tool up level after completing all passes.

void	exportRapidMoveTo (void p)
	Called for a rapid move to the given position.

void	exportRapidMoveToolDown (void shape)
	Exports a rapid move to the given start point and a tool down if this entity is not ignored for exporting (offset when exporting real contours or not offset when exporting offset contour).

void	exportShape (void shape)
	Exports the given shape to the CAM output (toolpath block).

void	exportSingleContourShape (void shape)
	Called for single, isolated entities.

void	exportSpline (void spline)
	Called when contour shapes are exported.

void	exportSplitCamEntity (void camEntity, void noProperties, void noOffset, void ignore)
	Split up given entity at tabs and export segments.

void	exportToolDown (void zOverride)
	Executes a tool down move.

void	exportToolDownClearance ()
	Export line to Z clearance level (e.g.

void	exportToolDownClearancePass ()
	Export line to pass specific Z clearance level (e.g.

void	exportToolpath (void entityIds, void toolpathBlock, void toolpathIndex, void createTransactionGroup, void updateConnections, void isNew)
	Exports the given entities as one single tool path into the given toolpath block.

void	exportToolpathContours (void contours, void toolpathBlock, void toolpathIndex, void createTransactionGroup, void updateConnections, void isNew)
	Exports the given contours as one single tool path into the given toolpath block.

void	exportToolUp (void force)
	Executes a tool up move.

void	exportToolUpSafety (void toolName)
	Executes a tool up move to the safety level.

void	exportToolUpSafetyDummy ()
	Exports a dummy entity with length 0 which can be extended to a tool up to safety move if the next toolpath tool changes.

void	exportZMove (void z, void force)
	Executes a move in Z to given level (in source coordinates).

void	formatValue (void value, void decimals, void options)
	Formats the given value with the given number of decimals and additional formatting options.

void	fuzzyCompare (void v1, void v2)
	Compares v1 and v2 using the configured tolerance returned by this.getTolerance().

void	getAllowanceOffset ()

void	getArcInterpolation ()
	Overwrite to specify arc interpolation.

void	getArcSegmentLength ()
	Overwrite to specify length of line segments to use for interpolating arcs.

void	getAutoRegenerateToolpaths ()

void	getBlockFileNames (void name)

void	getCamConfigLayerName ()

void	getCamLayerId ()
	Overwrite to create individual layers (e.g.

void	getConfigName (void withMachine)

void	getContext ()

void	getContextValue (void contextId)

void	getCreateNewDocument ()

void	getCurrentEntity ()

void	getCurrentToolName ()

void	getCurrentToolpathType ()

void	getCurrentToolType ()

void	getCustomPropertyPrefix (void global)

void	getDirection ()

void	getDocument ()

void	getEllipseSegments ()
	Overwrite to specify number of segments to use for interpolating ellipses.

void	getEntityOption (void entity, void name, void def)

void	getEntityOptionBool (void entity, void name, void def)

void	getEntityOptionFloat (void entity, void name, void def)

void	getEntityOptionInt (void entity, void name, void def)

void	getFeedRate ()

void	getFileExtensions ()

void	getFirstToolType ()

void	getGlobalOption (void name, void def)

void	getGlobalOptionBool (void name, void def)

void	getGlobalOptionFloat (void name, void def)

void	getGlobalOptionInt (void name, void def)

void	getHome ()
	Overwrite to change home position.

void	getIgnoredContexts ()

void	getIgnoreOffsetContext ()

void	getIncrementalXYZ ()
	Overwrite to enable incremental X/Y/Z moves.

void	getLastToolType ()

void	getLeadAngle (void entity, void leadIn)

void	getLeadInAngle (void entity)

void	getLeadInSize ()

void	getLeadInType ()

void	getLeadOutAngle (void entity)

void	getLeadOutSize ()

void	getLeadOutType ()

void	getLeadPosition (void entity)

void	getLeadShapes (void shape, void leadIn)

void	getLeadSize (void leadIn)

void	getLeadType (void leadIn)

void	getName ()

void	getNextToolpathNameCounter (void nameTemplate)

void	getOffsetLeadShapes (void leadShapes, void baseShape, void leadIn, void hasOvercutShape)

void	getOvercutShape (void shape, void leadIn)

void	getPlungeRate ()

void	getSafetyLevel (void toolName)
	Can be overwritten to return the current safety level.

void	getScale ()
	Overwrite to change scale of output.

void	getSeparator ()

void	getSide ()

void	getSplineMaxRadius ()
	Overwrite to specify maximum radius for arcs when exploding splines into bi-arcs.

void	getSplineTolerance ()
	Overwrite to specify tolerance to use for interpolating splines.

void	getSplitFullCircles ()
	Overwrite to change split circle behavior.

void	getTabBlockReferences (void shape)

void	getTabInfo (void camEntity)

void	getTemplateLayerData ()

void	getTolerance ()
	Overwrite to change tolerance (maximum gap between connected entities).

void	getToolBlockName (void toolName)

void	getToolBlockNames (void doc, void toolTypeFilter)

void	getToolDiameter (void includeAllowance)

void	getToolDiameterOverride ()

void	getToolName (void toolBlockName)

void	getToolNames (void doc, void toolTypeFilter)

void	getToolpathOption (void name, void def)

void	getToolpathOptionFloat (void name, void def)

void	getToolpathOptionInt (void name, void def)

void	getToolpathZCuttingDepth ()

void	getToolTypeFilter (void dialogName)

void	getToolTypeTitle (void toolType)

void	getToolTypeTitleTemplate (void toolType)

void	getTransformationScale ()
	Converts the given value `v` from the document unit into the output unit.

void	getUnit ()
	Overwrite to change unit of output.

void	getUnitScale ()
	Overwrite to set fixed, custom unit scale.

void	getZClearanceLevel ()
	Can be overwritten to return the current clear level (used to move around without cutting).

void	getZClearanceLevelOverride (void z)

void	getZClearancePass ()

void	getZCuttingLevel ()
	Can be overwritten to return the current cutting level.

void	getZCuttingLevelOverride (void z)

void	hasBlock (void name)

void	hasBlockData (void name, void map)

void	hasBlockFile (void name, void map)

void	hasLead (void leadIn)

void	hasLeadIn ()

void	hasLeadOut ()

void	hasOffsetPath ()

void	hasOvercut ()

void	incIndent (void v)

void	initCollector (void collector)
	Can be overwritten to initialize the contour collector.

void	initConfigDialog (void dialog)
	Can be overwritten to initialize / modify the standard configuration dialog.

void	initDialog (void dialog, void di, void obj)
	Can be overwritten to initialize / modify the standard dialogs (e.g.

void	initDrillToolpathDialog (void dialog, void di, void block)
	Can be overwritten to initialize / modify the standard drill toolpath dialog.

void	initEntity (void entity)
	Initializes variables for this entity (start point, end point, etc).

void	initExtents ()
	Override to treat the first move differently.

void	initObject (void dialog, void di, void obj)
	Can be overwritten to initialize the object after a dialog has been used to create / edit the object.

void	initPass (void pass, void numberOfPasses)
	Overwrite to init pass 'pass' out of 'numberOfPasses'.

void	initProfileToolpathDialog (void dialog, void di, void block)
	Can be overwritten to initialize / modify the standard profile toolpath dialog.

void	initToolCombo (void toolCombo, void addNoneItem, void toolTypeFilter)
	Adds all available tools to the given combo box and an additonal item 'None' if addNoneItem is true.

void	initToolComboItem (void toolCombo, void toolName, void toolBlock)

void	initToolpath (void toolpathBlock)
	Initializes variables for this toolpath (tool, etc).

void	initToolpathListContextMenu (void menu, void item)

void	initToolpathListItem (void item, void toolpathBlock)
	Called to initialize the given toolpath list item from the given block.

void	isDrillTool (void toolType)

void	isIgnoredForWrite (void entity)
	Override to filter out entities by returning true.

void	mapBlockName (void name)

void	matchToolType (void toolType, void toolTypeFilter)

void	notifyUser (void msg)
	Displays a message to the user in the command line and (if visible) the progress dialog.

void	popContext (void context)

void	postInit ()
	Called after constructor to initialize variables that depend on the exporter being initialized.

void	postInitDialog (void obj, void dialog, void di, void block)
	Can be overwritten to initialize / modify the standard dialogs for toolpaths or tools after all widgets have been added / removed.

void	postTemplateLoading (void templateLoaded)

void	pushContext (void context)

void	queueAndWrite (void idx, void entity, void entityNext, void propertyName, void name)
	Queues the given entity for writing and writes the queue if the next entity is not marked with the same given property.

void	queueWriteEntity (void idx)
	Queues the given entity for later writing.

void	registerVariable (void name, void id, void always, void prefix, void decimals, void options)
	Registers the variable with the given name.

void	reset ()
	Resets internal variables before each export.

void	saveConfigDialog (void dialog)
	Can be overwritten to save the configuration dialog options.

void	saveDrillToolpathDialog (void dialog, void di, void toolpathBlock)
	Can be overwritten to save additional states of widgets from the standard drill toolpath dialog.

void	saveProfileToolpathDialog (void dialog, void di, void toolpathBlock)
	Can be overwritten to save additional states of widgets from the standard profile toolpath dialog.

void	saveToolpathDialog (void dialog, void di, void toolpathBlock)
	Can be overwritten to save additional states of widgets from the standard toolpath dialog.

void	setCamDocumentInterface (void camDocumentInterface)

void	setName (void n)

void	setToolDiameterOverride (void d)
	Used to override tool diameter (offset) level during Z stepping.

void	setZClearanceLevelOverride (void z)
	Used to override tool up (clearance) level during Z stepping.

void	setZCuttingLevelOverride (void z)
	Used to override tool down level during Z stepping.

void	transform (void e)
	Transforms the given entity from source document coordinates to output file coordinates.

void	trimOffsetLeadShapes (void leadShapes, void offsetShapes, void leadType, void hasOvercutShape, void leadIn)
	Trimms the offset lead in / out shapes.

void	uninitPass (void pass, void numberOfPasses)

void	unsetToolDiameterOverride ()

void	unsetZClearanceLevelOverride ()
	Disables tool up level override, after Z stepping.

void	unsetZCuttingLevelOverride ()
	Disables tool down level override, after Z stepping.

void	updateDialogLeads (void dialog, void di, void block, void senderWidget)

void	updateDialogSideDirection (void dialog, void di, void block)

void	updateDialogTool (void dialog, void di, void block)
	Called when current tool changes in a dialog.

void	updateDialogToolDescription (void dialog, void di, void block)

void	validateLeadRadius (void msgs, void leadSize, void toolDiameter, void leadIn)

void	validateLeads (void dialog, void obj, void msgs)
	Validate lead in / lead out radius against tool radius in dialog.

void	validateToolName (void dialog, void obj, void msgs)
	Validate tool name in dialog.

void	validateToolpathName (void dialog, void obj, void msgs, void initial)
	Validate toolpath name in dialog.

void	variableUsed (void id, void valueString)

void	warnUser (void msg)
	Displays a warning to the user in the command line.

void	write (void str)
	Writes the given string to the output stream.

void	writeArcCCWLeadIn ()
	Called for circular counter-clockwise lead in moves.

void	writeArcCCWLeadOut ()
	Called for circular counter-clockwise lead out moves.

void	writeArcCCWMove ()
	Called for counter-clockwise circular move.

void	writeArcCWLeadIn ()
	Called for circular clockwise lead in moves.

void	writeArcCWLeadOut ()
	Called for circular clockwise lead out moves.

void	writeArcCWMove ()
	Called for clockwise circular moves.

void	writeBlock (void name)
	Writes the given block from a file if available (this[name + "File"]) or from the variable this[name].

void	writeBlockFooter (void blockName)

void	writeBlockFromFiles (void name)
	Writes a text block from file(s) with the given name.

void	writeBlockFromQueue (void blockName, void name)

void	writeBlockFromString (void blockStrings)

void	writeBlockHeader (void blockName)
	Override to write the header for the block with the given name to the output file.

void	writeComment (void str)

void	writeContourFooter ()
	Override to write the contour footer to the output file.

void	writeContourHeader ()
	Override to write the contour header to the output file.

void	writeEntity ()
	Override to write the given CAM output entity to the output file.

void	writeFile (void fileName)
	Writes the output to the output file through the chosen configuration file (e.g.

void	writeFirstArcCCWMove ()
	Called for first counter-clockwise circular move.

void	writeFirstArcCWMove ()
	Called for first clockwise circular move.

void	writeFirstContourHeader ()
	Override to write the contour header to the output file.

void	writeFirstLinearMove ()
	Called for first linear move with new feedrate.

void	writeFirstLinearMoveZ ()
	Called for first linear Z move with new feedrate.

void	writeFirstMove ()
	Called for rapid moves to safety level before toolpath.

void	writeFirstMoveAndToolChange (void toolHeaderWritten)
	Writes the first move and a tool change if necessary.

void	writeFirstPointMoveZ ()
	Called for first point Z move with new feedrate (drilling).

void	writeFirstToolpathHeader ()
	Override to write the first toolpath header to the output file.

void	writeFooter ()
	Override to write the file footer to the output file.

void	writeHeader ()
	Override to write the file header to the output file.

void	writeLastMove ()
	Called for rapid moves to safety level after toolpath.

void	writeLastToolFooter ()
	Called for last tool footer.

void	writeLine (void line)
	Writes the given line (string + line ending) to the output stream.

void	writeLinearLeadIn ()
	Called for linear lead in moves.

void	writeLinearLeadOut ()
	Called for linear lead out moves.

void	writeLinearMove ()
	Called for linear moves.

void	writeLinearMoveCompensationLeft ()
	Called for linear moves switching on cutter radius compensation left.

void	writeLinearMoveCompensationOff ()
	Called for linear moves switching off cutter radius compensation.

void	writeLinearMoveCompensationRight ()
	Called for linear moves switching on cutter radius compensation right.

void	writeLinearMoveZ ()
	Called for linear Z moves.

void	writeMultiZPassFooter ()
	Override to write the footer for a multi pass to the output file.

void	writeMultiZPassHeader ()
	Override to write the header for a multi pass to the output file.

void	writePointMoveZ ()
	Called for point Z moves (drilling).

void	writeQueuedEntities ()
	Writes queued entities.

void	writeRapidMove ()
	Called for rapid moves.

void	writeRapidMoveZ ()
	Called for rapid moves in Z.

void	writeSingleZPassFooter ()
	Override to write the footer for a single pass to the output file.

void	writeSingleZPassHeader ()
	Override to write the header for a single pass to the output file.

void	writeTabFooter ()

void	writeTabHeader ()

void	writeTabTop ()

void	writeToolFooter ()
	Called for tool footer.

void	writeToolHeader ()
	Called for tool header (tool changes).

void	writeToolpathFooter ()
	Override to write the toolpath footer to the output file.

void	writeToolpathHeader ()
	Override to write the toolpath header to the output file.

void	writeZPassFirstHeader ()
	Override to write the first pass header to the output file.

void	writeZPassFooter ()
	Override to write the pass footer to the output file.

void	writeZPassHeader ()
	Override to write the pass header to the output file.

void	writeZPassLastFooter ()
	Override to write the last pass footer to the output file.

Public Attributes
int	__debug__

int	allowLeadForSideOn

int	allowNegativeTabs

int	alwaysUseStartPointForEntry

int	arcInterpolation

int	arcSegmentLength

int	blockNameMapping

int	cadDocument

int	cadDocumentInterface

int	ellipseSegments

int	fileExtensions

int	firstEntityOfProfile

int	id

int	ignoreContourSide

int	ignoredContexts

int	ignoredOutput

int	incrementalXYZ

int	lastEntityOfProfile

int	lineEnding

int	lineNumber

int	lineNumberIncrement

int	lineNumberStart

int	normalizeWhiteSpace

int	offsetJoin

int	oneToolpathPerContourDrill

int	oneToolpathPerContourProfile

int	options

int	outputOffsetPath

int	rapidMoveToOffset

int	scale

int	separator

int	splineMaxRadius

int	splineTolerance

int	splitArcsAtQuadrantLines

int	splitFullCircles

int	stopAtTab

int	tolerance

int	toolChangeMode

int	unit

int	unitScale

int	useProgressDialog

int	variables

int	zSafety

Detailed Description

Implementation of a simple CAM exporter that implements the RFileExporter interface.

This is the base class for all CAM postprocessor classes.

export* functions export CAM entities into the CAM blocks generated as visual representation of the output.

write* functions write to the output file.

Constructor & Destructor Documentation

◆ CamExporterV2()

void CamExporterV2::CamExporterV2	(	void	cadDocumentInterface,
		void	camDocumentInterface )

inline

Member Function Documentation

◆ activated()

void CamExporterV2::activated ( )

inline

Called when the configuration is activated by the user of on loading.

◆ adjustOffsetLeadShapes()

void CamExporterV2::adjustOffsetLeadShapes	(	void	leadShapes,
		void	offsetShapes,
		void	offsetBaseShapeUntrimmed,
		void	leadIn )

inline

Adjusts the offset lead in / lead out to account for the move in which tool radius compensation is switched on / off.

Parameters

leadShapes	Array of lead in / out shapes
offsetShapes	Array of offset lead in / out shapes
leadIn	True for lead in, false for lead out

◆ afterExportToolpath()

void CamExporterV2::afterExportToolpath	(	void	entityIds,
		void	toolpathBlock,
		void	toolpathIndex,
		void	createTransactionGroup,
		void	updateConnections,
		void	isNew )

inline

Implemented by exporters to do something after a toolpath is exported.

Used for example to update another, dependent toolpath.

◆ beforeExportContourPass()

void CamExporterV2::beforeExportContourPass ( void contour )

inline

Called immediately before calling exportContourPass May implement radial stock offset or similar features.

◆ beforeExportToolpath()

void CamExporterV2::beforeExportToolpath	(	void	entityIds,
		void	toolpathBlock,
		void	toolpathIndex,
		void	createTransactionGroup,
		void	updateConnections,
		void	isNew )

inline

Implemented by exporters to do something before a toolpath is exported.

Used for example to update another, dependent toolpath.

Returns: False to indicate that all has been done and to abort further processing.

◆ beforeWrite()

void CamExporterV2::beforeWrite ( void fileName )

inline

◆ checkContext()

void CamExporterV2::checkContext ( void context )

inline

◆ collectCamOffsetPath()

void CamExporterV2::collectCamOffsetPath ( void camEntity )

inline

Collects information about an additional path representing the center tool path including cutter compensation.

◆ contourContains()

void CamExporterV2::contourContains	(	void	contour,
		void	point )

inline

Allow exporters to implement their own test if point is inside contour.

◆ createConfigOutputLayer()

void CamExporterV2::createConfigOutputLayer ( )

inline

Creates layers "CAM" and "CAM ... GCode".

Returns: Name of configuration layer (e.g. "CAM ... GCode")

◆ createDrillToolpathDialog()

void CamExporterV2::createDrillToolpathDialog	(	void	di,
		void	toolpathBlock )

inline

Creates the standard QCAD/CAM drill toolpath dialog.

Can be overwritten to create a different toolpath dialog.

◆ createLayer()

void CamExporterV2::createLayer	(	void	layerName,
		void	color,
		void	linetype,
		void	options )

inline

◆ createPocketToolpathDialog()

void CamExporterV2::createPocketToolpathDialog	(	void	di,
		void	toolpathBlock )

inline

Creates the standard QCAD/CAM pocket toolpath dialog.

Can be overwritten to create a different tool dialog.

◆ createProfileToolpathDialog()

void CamExporterV2::createProfileToolpathDialog	(	void	di,
		void	toolpathBlock )

inline

Creates the standard QCAD/CAM profile toolpath dialog.

Can be overwritten to create a different toolpath dialog.

◆ createSpatialIndex()

void CamExporterV2::createSpatialIndex ( void contours )

inline

Creates a spatial index over all entry points of the given contours.

The contours are typically all using the same tool (optimize by tool).

◆ createToolDialog()

void CamExporterV2::createToolDialog	(	void	di,
		void	toolBlock,
		void	title )

inline

Creates the standard QCAD/CAM tool dialog.

Can be overwritten to create a different tool dialog.

◆ decIndent()

void CamExporterV2::decIndent ( )

inline

◆ detectAndWriteToolChange()

void CamExporterV2::detectAndWriteToolChange ( void toolHeaderWritten )

inline

Writes a tool change if necessary.

Parameters

toolHeaderWritten true: tool header written, don't write again

Returns: true: tool header has been written

◆ dumpContext()

void CamExporterV2::dumpContext ( )

inline

◆ exportArc()

void CamExporterV2::exportArc ( void arc )

inline

Called when contour shapes, offset shapes or leads and overcuts are exported.

◆ exportCamEntity()

void CamExporterV2::exportCamEntity	(	void	camEntity,
		void	noProperties,
		void	noOffset,
		void	noTabs,
		void	ignore )

inline

Adds the given entity to the output document.

Collects the geometry for adding the offset paths for cutter radius compensation if applicable. This is called for every entity along a contour and every offset entity.

Parameters

camEntity	Line, arc or point entity to be added to CAM output.
noProperties	True: don't transfer entity properties (typically Z moves).
noOffset	True: don't export offset path for cutter compensation.
noTabs	True: don't split at tabs.
ignore	True ignore entity for CAM output (not part of the connected tool path).

◆ exportClosedContourShape()

void CamExporterV2::exportClosedContourShape ( void shape )

inline

Called for entities of closed contours.

Default implementation calls exportShape.

◆ exportContour()

void CamExporterV2::exportContour	(	void	contours,
		void	contourIndex,
		void	shapeIndex,
		void	siEntryPoints,
		void	inner )

inline

Exports the given contour to the target document, starting at the entity at the given entityIndex.

Parameters

inner True for contours that take priority because they are inside another contour.

◆ exportContourPass()

void CamExporterV2::exportContourPass	(	void	contour,
		void	shapeIndex )

inline

Exports the given contour to the target document, starting at the shape at the given shapeIndex.

This can be called multiple times for contours with multiple Z-passes.

◆ exportContours()

void CamExporterV2::exportContours	(	void	contours,
		void	siEntryPoints )

inline

Exports the given contours which are all part of the same toolpoth.

The contour entry points are indexed by the given spatial index.

◆ exportEllipse()

void CamExporterV2::exportEllipse ( void ellipse )

inline

Called when contour shapes are exported.

◆ exportFirstClosedContourShape()

void CamExporterV2::exportFirstClosedContourShape ( void shape )

inline

Called for the first entity of a closed contour.

Default implementation calls exportFirstContourShape.

◆ exportFirstContourShape()

void CamExporterV2::exportFirstContourShape ( void shape )

inline

Called for the first entity of open and closed contours.

Default implementation calls exportShape.

◆ exportFirstOpenContourShape()

void CamExporterV2::exportFirstOpenContourShape ( void shape )

inline

Called for the first entity of an open contour.

◆ exportLastClosedContourShape()

void CamExporterV2::exportLastClosedContourShape ( void shape )

inline

Called for the last entity of a closed contour.

Default implementation calls exportLastContourShape.

◆ exportLastContourShape()

void CamExporterV2::exportLastContourShape ( void shape )

inline

Called for the last entity of open and closed contours.

Default implementation calls exportShape.

◆ exportLastOpenContourShape()

void CamExporterV2::exportLastOpenContourShape ( void shape )

inline

Called for the last entity of an open contour.

◆ exportLead()

void CamExporterV2::exportLead	(	void	shape,
		void	leadIn )

inline

Exports the lead in/out for the given shape.

Parameters

entity	Export lead in or lead out and overcut for this entity.
leadIn	True for lead in, false for lead out.

◆ exportLeadIn()

void CamExporterV2::exportLeadIn ( void shape )

inline

◆ exportLeadOut()

void CamExporterV2::exportLeadOut ( void shape )

inline

◆ exportLine()

void CamExporterV2::exportLine ( void line )

inline

Called when contour shapes, offset shapes or leads and overcuts are exported.

◆ exportOffsetPath()

void CamExporterV2::exportOffsetPath ( )

inline

Exports the previously collected path, offset by the tool radius.

◆ exportOpenContourShape()

void CamExporterV2::exportOpenContourShape ( void shape )

inline

Called for entities of an open contour.

Default implementation calls exportShape.

◆ exportPoint()

void CamExporterV2::exportPoint ( void point )

inline

◆ exportPostContourPass()

void CamExporterV2::exportPostContourPass ( void contour )

inline

Override to export additional moves after contour pass (e.g.

tool retreat to safety).

◆ exportPostContourPasses()

void CamExporterV2::exportPostContourPasses ( void contour )

inline

Retreat to tool up level after completing all passes.

Override to export additional moves or cancel the move to tool up.

◆ exportRapidMoveTo()

void CamExporterV2::exportRapidMoveTo ( void p )

inline

Called for a rapid move to the given position.

Tool is moved to up (or left at safety) position prior to the rapid move.

◆ exportRapidMoveToolDown()

void CamExporterV2::exportRapidMoveToolDown ( void shape )

inline

Exports a rapid move to the given start point and a tool down if this entity is not ignored for exporting (offset when exporting real contours or not offset when exporting offset contour).

Returns: True if entity is exported and not ignored.

◆ exportShape()

void CamExporterV2::exportShape ( void shape )

inline

Exports the given shape to the CAM output (toolpath block).

Called for original contour and offset contour.

◆ exportSingleContourShape()

void CamExporterV2::exportSingleContourShape ( void shape )

inline

Called for single, isolated entities.

◆ exportSpline()

void CamExporterV2::exportSpline ( void spline )

inline

Called when contour shapes are exported.

◆ exportSplitCamEntity()

void CamExporterV2::exportSplitCamEntity	(	void	camEntity,
		void	noProperties,
		void	noOffset,
		void	ignore )

inline

Split up given entity at tabs and export segments.

◆ exportToolDown()

void CamExporterV2::exportToolDown ( void zOverride )

inline

Executes a tool down move.

◆ exportToolDownClearance()

void CamExporterV2::exportToolDownClearance ( )

inline

Export line to Z clearance level (e.g.

2).

◆ exportToolDownClearancePass()

void CamExporterV2::exportToolDownClearancePass ( )

inline

Export line to pass specific Z clearance level (e.g.

-2.5 + 2).

◆ exportToolpath()

void CamExporterV2::exportToolpath	(	void	entityIds,
		void	toolpathBlock,
		void	toolpathIndex,
		void	createTransactionGroup,
		void	updateConnections,
		void	isNew )

inline

Exports the given entities as one single tool path into the given toolpath block.

Parameters

entityIds	Entity IDs to use as source for this toolpath or undefined to use previously used IDs.
toolpathBlock	Toolpath block to export into.
toolpathIndex	Toolpath index or undefined to find out on the fly.
createTransactionGroup	True to create a transaction group for this update, false if a transaction group has been created before the call.
updateConnections	True to update connecting rapid moved with previous and next path.
isNew	True if this is a new toolpath, false for existing toolpaths.

◆ exportToolpathContours()

void CamExporterV2::exportToolpathContours	(	void	contours,
		void	toolpathBlock,
		void	toolpathIndex,
		void	createTransactionGroup,
		void	updateConnections,
		void	isNew )

inline

Exports the given contours as one single tool path into the given toolpath block.

Parameters

contours	Contours to use as source for this toolpath.
toolpathBlock	Toolpath block to export into.
toolpathIndex	Toolpath index or undefined to find out on the fly.
createTransactionGroup	True to create a transaction group for this update, false if a transaction groupd has been created before the call.
updateConnections	True to update connecting rapid moved with previous and next path.
isNew	True if this is a new toolpath, false for existing toolpaths.

◆ exportToolUp()

void CamExporterV2::exportToolUp ( void force )

inline

Executes a tool up move.

◆ exportToolUpSafety()

void CamExporterV2::exportToolUpSafety ( void toolName )

inline

Executes a tool up move to the safety level.

Parameters

toolName Tool name of tool to use to retrieve safety level or undefined to use current tool.

◆ exportToolUpSafetyDummy()

void CamExporterV2::exportToolUpSafetyDummy ( )

inline

Exports a dummy entity with length 0 which can be extended to a tool up to safety move if the next toolpath tool changes.

◆ exportZMove()

void CamExporterV2::exportZMove	(	void	z,
		void	force )

inline

Executes a move in Z to given level (in source coordinates).

◆ formatValue()

void CamExporterV2::formatValue	(	void	value,
		void	decimals,
		void	options )

inline

Formats the given value with the given number of decimals and additional formatting options.

Parameters

decimals	Number of decimal places for 0 for an integer.
options	Additional options: { sign: true\|false } Force sign { width: number } Width of output, filled up with leading spaces or zeros { leadingZeroes: true\|false } Force leading zeroes { trailingZeroes: true\|false } Force trailing zeroes { decimalSeparator: string } Use given string instead of decimal point { factor: number } Apply given factor to value (e.g. 360/Math.PI/2 to convert from rad to deg)

◆ fuzzyCompare()

void CamExporterV2::fuzzyCompare	(	void	v1,
		void	v2 )

inline

Compares v1 and v2 using the configured tolerance returned by this.getTolerance().

◆ getAllowanceOffset()

void CamExporterV2::getAllowanceOffset ( )

inline

◆ getArcInterpolation()

void CamExporterV2::getArcInterpolation ( )

inline

Overwrite to specify arc interpolation.

◆ getArcSegmentLength()

void CamExporterV2::getArcSegmentLength ( )

inline

Overwrite to specify length of line segments to use for interpolating arcs.

◆ getAutoRegenerateToolpaths()

void CamExporterV2::getAutoRegenerateToolpaths ( )

inline

◆ getBlockFileNames()

void CamExporterV2::getBlockFileNames ( void name )

inline

◆ getCamConfigLayerName()

void CamExporterV2::getCamConfigLayerName ( )

inline

◆ getCamLayerId()

void CamExporterV2::getCamLayerId ( )

inline

Overwrite to create individual layers (e.g.

for Z-levels) on the fly.

◆ getConfigName()

void CamExporterV2::getConfigName ( void withMachine )

inline

◆ getContext()

void CamExporterV2::getContext ( )

inline

◆ getContextValue()

void CamExporterV2::getContextValue ( void contextId )

inline

◆ getCreateNewDocument()

void CamExporterV2::getCreateNewDocument ( )

inline

◆ getCurrentEntity()

void CamExporterV2::getCurrentEntity ( )

inline

◆ getCurrentToolName()

void CamExporterV2::getCurrentToolName ( )

inline

◆ getCurrentToolpathType()

void CamExporterV2::getCurrentToolpathType ( )

inline

◆ getCurrentToolType()

void CamExporterV2::getCurrentToolType ( )

inline

◆ getCustomPropertyPrefix()

void CamExporterV2::getCustomPropertyPrefix ( void global )

inline

◆ getDirection()

void CamExporterV2::getDirection ( )

inline

◆ getDocument()

void CamExporterV2::getDocument ( )

inline

◆ getEllipseSegments()

void CamExporterV2::getEllipseSegments ( )

inline

Overwrite to specify number of segments to use for interpolating ellipses.

◆ getEntityOption()

void CamExporterV2::getEntityOption	(	void	entity,
		void	name,
		void	def )

inline

◆ getEntityOptionBool()

void CamExporterV2::getEntityOptionBool	(	void	entity,
		void	name,
		void	def )

inline

◆ getEntityOptionFloat()

void CamExporterV2::getEntityOptionFloat	(	void	entity,
		void	name,
		void	def )

inline

◆ getEntityOptionInt()

void CamExporterV2::getEntityOptionInt	(	void	entity,
		void	name,
		void	def )

inline

◆ getFeedRate()

void CamExporterV2::getFeedRate ( )

inline

◆ getFileExtensions()

void CamExporterV2::getFileExtensions ( )

inline

◆ getFirstToolType()

void CamExporterV2::getFirstToolType ( )

inline

◆ getGlobalOption()

void CamExporterV2::getGlobalOption	(	void	name,
		void	def )

inline

◆ getGlobalOptionBool()

void CamExporterV2::getGlobalOptionBool	(	void	name,
		void	def )

inline

◆ getGlobalOptionFloat()

void CamExporterV2::getGlobalOptionFloat	(	void	name,
		void	def )

inline

◆ getGlobalOptionInt()

void CamExporterV2::getGlobalOptionInt	(	void	name,
		void	def )

inline

◆ getHome()

void CamExporterV2::getHome ( )

inline

Overwrite to change home position.

◆ getIgnoredContexts()

void CamExporterV2::getIgnoredContexts ( )

inline

◆ getIgnoreOffsetContext()

void CamExporterV2::getIgnoreOffsetContext ( )

inline

◆ getIncrementalXYZ()

void CamExporterV2::getIncrementalXYZ ( )

inline

Overwrite to enable incremental X/Y/Z moves.

Default is false.

◆ getLastToolType()

void CamExporterV2::getLastToolType ( )

inline

◆ getLeadAngle()

void CamExporterV2::getLeadAngle	(	void	entity,
		void	leadIn )

inline

◆ getLeadInAngle()

void CamExporterV2::getLeadInAngle ( void entity )

inline

◆ getLeadInSize()

void CamExporterV2::getLeadInSize ( )

inline

◆ getLeadInType()

void CamExporterV2::getLeadInType ( )

inline

◆ getLeadOutAngle()

void CamExporterV2::getLeadOutAngle ( void entity )

inline

◆ getLeadOutSize()

void CamExporterV2::getLeadOutSize ( )

inline

◆ getLeadOutType()

void CamExporterV2::getLeadOutType ( )

inline

◆ getLeadPosition()

void CamExporterV2::getLeadPosition ( void entity )

inline

◆ getLeadShapes()

void CamExporterV2::getLeadShapes	(	void	shape,
		void	leadIn )

inline

◆ getLeadSize()

void CamExporterV2::getLeadSize ( void leadIn )

inline

◆ getLeadType()

void CamExporterV2::getLeadType ( void leadIn )

inline

◆ getName()

void CamExporterV2::getName ( )

inline

◆ getNextToolpathNameCounter()

void CamExporterV2::getNextToolpathNameCounter ( void nameTemplate )

inline

◆ getOffsetLeadShapes()

void CamExporterV2::getOffsetLeadShapes	(	void	leadShapes,
		void	baseShape,
		void	leadIn,
		void	hasOvercutShape )

inline

◆ getOvercutShape()

void CamExporterV2::getOvercutShape	(	void	shape,
		void	leadIn )

inline

◆ getPlungeRate()

void CamExporterV2::getPlungeRate ( )

inline

◆ getSafetyLevel()

void CamExporterV2::getSafetyLevel ( void toolName )

inline

Can be overwritten to return the current safety level.

Parameters

toolName Tool name of tool to use to retrieve safety level or undefined to use current tool.

◆ getScale()

void CamExporterV2::getScale ( )

inline

Overwrite to change scale of output.

Default is 1.0.

◆ getSeparator()

void CamExporterV2::getSeparator ( )

inline

◆ getSide()

void CamExporterV2::getSide ( )

inline

◆ getSplineMaxRadius()

void CamExporterV2::getSplineMaxRadius ( )

inline

Overwrite to specify maximum radius for arcs when exploding splines into bi-arcs.

◆ getSplineTolerance()

void CamExporterV2::getSplineTolerance ( )

inline

Overwrite to specify tolerance to use for interpolating splines.

◆ getSplitFullCircles()

void CamExporterV2::getSplitFullCircles ( )

inline

Overwrite to change split circle behavior.

Return true to split full circles in two halves.

◆ getTabBlockReferences()

void CamExporterV2::getTabBlockReferences ( void shape )

inline

◆ getTabInfo()

void CamExporterV2::getTabInfo ( void camEntity )

inline

◆ getTemplateLayerData()

void CamExporterV2::getTemplateLayerData ( )

inline

◆ getTolerance()

void CamExporterV2::getTolerance ( )

inline

Overwrite to change tolerance (maximum gap between connected entities).

◆ getToolBlockName()

void CamExporterV2::getToolBlockName ( void toolName )

inline

◆ getToolBlockNames()

void CamExporterV2::getToolBlockNames	(	void	doc,
		void	toolTypeFilter )

inline

◆ getToolDiameter()

void CamExporterV2::getToolDiameter ( void includeAllowance )

inline

◆ getToolDiameterOverride()

void CamExporterV2::getToolDiameterOverride ( )

inline

◆ getToolName()

void CamExporterV2::getToolName ( void toolBlockName )

inline

◆ getToolNames()

void CamExporterV2::getToolNames	(	void	doc,
		void	toolTypeFilter )

inline

◆ getToolpathOption()

void CamExporterV2::getToolpathOption	(	void	name,
		void	def )

inline

◆ getToolpathOptionFloat()

void CamExporterV2::getToolpathOptionFloat	(	void	name,
		void	def )

inline

◆ getToolpathOptionInt()

void CamExporterV2::getToolpathOptionInt	(	void	name,
		void	def )

inline

◆ getToolpathZCuttingDepth()

void CamExporterV2::getToolpathZCuttingDepth ( )

inline

◆ getToolTypeFilter()

void CamExporterV2::getToolTypeFilter ( void dialogName )

inline

◆ getToolTypeTitle()

void CamExporterV2::getToolTypeTitle ( void toolType )

inline

◆ getToolTypeTitleTemplate()

void CamExporterV2::getToolTypeTitleTemplate ( void toolType )

inline

◆ getTransformationScale()

void CamExporterV2::getTransformationScale ( )

inline

Converts the given value v from the document unit into the output unit.

◆ getUnit()

void CamExporterV2::getUnit ( )

inline

Overwrite to change unit of output.

Default is None (which means 'same unit as input drawing').

◆ getUnitScale()

void CamExporterV2::getUnitScale ( )

inline

Overwrite to set fixed, custom unit scale.

Default is undefined (use unit scale defined by input and output unit).

◆ getZClearanceLevel()

void CamExporterV2::getZClearanceLevel ( )

inline

Can be overwritten to return the current clear level (used to move around without cutting).

◆ getZClearanceLevelOverride()

void CamExporterV2::getZClearanceLevelOverride ( void z )

inline

◆ getZClearancePass()

void CamExporterV2::getZClearancePass ( )

inline

◆ getZCuttingLevel()

void CamExporterV2::getZCuttingLevel ( )

inline

Can be overwritten to return the current cutting level.

◆ getZCuttingLevelOverride()

void CamExporterV2::getZCuttingLevelOverride ( void z )

inline

◆ hasBlock()

void CamExporterV2::hasBlock ( void name )

inline

◆ hasBlockData()

void CamExporterV2::hasBlockData	(	void	name,
		void	map )

inline

◆ hasBlockFile()

void CamExporterV2::hasBlockFile	(	void	name,
		void	map )

inline

◆ hasLead()

void CamExporterV2::hasLead ( void leadIn )

inline

◆ hasLeadIn()

void CamExporterV2::hasLeadIn ( )

inline

◆ hasLeadOut()

void CamExporterV2::hasLeadOut ( )

inline

◆ hasOffsetPath()

void CamExporterV2::hasOffsetPath ( )

inline

◆ hasOvercut()

void CamExporterV2::hasOvercut ( )

inline

◆ incIndent()

void CamExporterV2::incIndent ( void v )

inline

◆ initCollector()

void CamExporterV2::initCollector ( void collector )

inline

Can be overwritten to initialize the contour collector.

◆ initConfigDialog()

void CamExporterV2::initConfigDialog ( void dialog )

inline

Can be overwritten to initialize / modify the standard configuration dialog.

◆ initDialog()

void CamExporterV2::initDialog	(	void	dialog,
		void	di,
		void	obj )

inline

Can be overwritten to initialize / modify the standard dialogs (e.g.

for toolpaths, tools, layers).

◆ initDrillToolpathDialog()

void CamExporterV2::initDrillToolpathDialog	(	void	dialog,
		void	di,
		void	block )

inline

Can be overwritten to initialize / modify the standard drill toolpath dialog.

◆ initEntity()

void CamExporterV2::initEntity ( void entity )

inline

Initializes variables for this entity (start point, end point, etc).

Called before the entity is written to output.

◆ initExtents()

void CamExporterV2::initExtents ( )

inline

Override to treat the first move differently.

Default implementation calls writeEntity.

◆ initObject()

void CamExporterV2::initObject	(	void	dialog,
		void	di,
		void	obj )

inline

Can be overwritten to initialize the object after a dialog has been used to create / edit the object.

◆ initPass()

void CamExporterV2::initPass	(	void	pass,
		void	numberOfPasses )

inline

Overwrite to init pass 'pass' out of 'numberOfPasses'.

◆ initProfileToolpathDialog()

void CamExporterV2::initProfileToolpathDialog	(	void	dialog,
		void	di,
		void	block )

inline

Can be overwritten to initialize / modify the standard profile toolpath dialog.

◆ initToolCombo()

void CamExporterV2::initToolCombo	(	void	toolCombo,
		void	addNoneItem,
		void	toolTypeFilter )

inline

Adds all available tools to the given combo box and an additonal item 'None' if addNoneItem is true.

Parameters

toolTypeFilter Only show certain tools, e.g. Cam.ToolTypeFilter.All (default) or Cam.ToolTypeFilter.Drill

◆ initToolComboItem()

void CamExporterV2::initToolComboItem	(	void	toolCombo,
		void	toolName,
		void	toolBlock )

inline

◆ initToolpath()

void CamExporterV2::initToolpath ( void toolpathBlock )

inline

Initializes variables for this toolpath (tool, etc).

Called before the toolpath is written to output.

◆ initToolpathListContextMenu()

void CamExporterV2::initToolpathListContextMenu	(	void	menu,
		void	item )

inline

◆ initToolpathListItem()

void CamExporterV2::initToolpathListItem	(	void	item,
		void	toolpathBlock )

inline

Called to initialize the given toolpath list item from the given block.

◆ isDrillTool()

void CamExporterV2::isDrillTool ( void toolType )

inline

◆ isIgnoredForWrite()

void CamExporterV2::isIgnoredForWrite ( void entity )

inline

Override to filter out entities by returning true.

◆ mapBlockName()

void CamExporterV2::mapBlockName ( void name )

inline

◆ matchToolType()

void CamExporterV2::matchToolType	(	void	toolType,
		void	toolTypeFilter )

inline

◆ notifyUser()

void CamExporterV2::notifyUser ( void msg )

inline

Displays a message to the user in the command line and (if visible) the progress dialog.

◆ popContext()

void CamExporterV2::popContext ( void context )

inline

◆ postInit()

void CamExporterV2::postInit ( )

inline

Called after constructor to initialize variables that depend on the exporter being initialized.

◆ postInitDialog()

void CamExporterV2::postInitDialog	(	void	obj,
		void	dialog,
		void	di,
		void	block )

inline

Can be overwritten to initialize / modify the standard dialogs for toolpaths or tools after all widgets have been added / removed.

◆ postTemplateLoading()

void CamExporterV2::postTemplateLoading ( void templateLoaded )

inline

◆ pushContext()

void CamExporterV2::pushContext ( void context )

inline

◆ queueAndWrite()

void CamExporterV2::queueAndWrite	(	void	idx,
		void	entity,
		void	entityNext,
		void	propertyName,
		void	name )

inline

Queues the given entity for writing and writes the queue if the next entity is not marked with the same given property.

Used for lead in / lead out groups.

Parameters

propertyName	Name of property marker (e.g. CamLeadIn)
name	Human readable name (can be used in comments)

◆ queueWriteEntity()

void CamExporterV2::queueWriteEntity ( void idx )

inline

Queues the given entity for later writing.

◆ registerVariable()

void CamExporterV2::registerVariable	(	void	name,
		void	id,
		void	always,
		void	prefix,
		void	decimals,
		void	options )

inline

Registers the variable with the given name.

Parameters

name	Variable name. This must match one of the variables available.
id	Variable ID as used in blocks, e.g. "N" to substitute "[N]" in blocks.
always	True to always write the variable, false to only write if it changes since the last write.
decimals	Number of decimal places. 0 for an integer.
options	Additional options: { sign: true\|false } Force sign { width: number } Width of output, filled up with leading spaces or zeros { leadingZeroes: true\|false } Force leading zeroes { trailingZeroes: true\|false } Force trailing zeroes { decimalSeparator: string } Use given string instead of decimal point { factor: number } Apply given factor to value (e.g. 360/Math.PI/2 to convert from rad to deg)

Todo: accept alternative formats ("N|A|N|1.0")

◆ reset()

void CamExporterV2::reset ( )

inline

Resets internal variables before each export.

◆ saveConfigDialog()

void CamExporterV2::saveConfigDialog ( void dialog )

inline

Can be overwritten to save the configuration dialog options.

◆ saveDrillToolpathDialog()

void CamExporterV2::saveDrillToolpathDialog	(	void	dialog,
		void	di,
		void	toolpathBlock )

inline

Can be overwritten to save additional states of widgets from the standard drill toolpath dialog.

◆ saveProfileToolpathDialog()

void CamExporterV2::saveProfileToolpathDialog	(	void	dialog,
		void	di,
		void	toolpathBlock )

inline

Can be overwritten to save additional states of widgets from the standard profile toolpath dialog.

◆ saveToolpathDialog()

void CamExporterV2::saveToolpathDialog	(	void	dialog,
		void	di,
		void	toolpathBlock )

inline

Can be overwritten to save additional states of widgets from the standard toolpath dialog.

◆ setCamDocumentInterface()

void CamExporterV2::setCamDocumentInterface ( void camDocumentInterface )

inline

◆ setName()

void CamExporterV2::setName ( void n )

inline

◆ setToolDiameterOverride()

void CamExporterV2::setToolDiameterOverride ( void d )

inline

Used to override tool diameter (offset) level during Z stepping.

◆ setZClearanceLevelOverride()

void CamExporterV2::setZClearanceLevelOverride ( void z )

inline

Used to override tool up (clearance) level during Z stepping.

◆ setZCuttingLevelOverride()

void CamExporterV2::setZCuttingLevelOverride ( void z )

inline

Used to override tool down level during Z stepping.

◆ transform()

void CamExporterV2::transform ( void e )

inline

Transforms the given entity from source document coordinates to output file coordinates.

Used when writing the file.

◆ trimOffsetLeadShapes()

void CamExporterV2::trimOffsetLeadShapes	(	void	leadShapes,
		void	offsetShapes,
		void	leadType,
		void	hasOvercutShape,
		void	leadIn )

inline

Trimms the offset lead in / out shapes.

◆ uninitPass()

void CamExporterV2::uninitPass	(	void	pass,
		void	numberOfPasses )

inline

◆ unsetToolDiameterOverride()

void CamExporterV2::unsetToolDiameterOverride ( )

inline

◆ unsetZClearanceLevelOverride()

void CamExporterV2::unsetZClearanceLevelOverride ( )

inline

Disables tool up level override, after Z stepping.

◆ unsetZCuttingLevelOverride()

void CamExporterV2::unsetZCuttingLevelOverride ( )

inline

Disables tool down level override, after Z stepping.

◆ updateDialogLeads()

void CamExporterV2::updateDialogLeads	(	void	dialog,
		void	di,
		void	block,
		void	senderWidget )

inline

◆ updateDialogSideDirection()

void CamExporterV2::updateDialogSideDirection	(	void	dialog,
		void	di,
		void	block )

inline

◆ updateDialogTool()

void CamExporterV2::updateDialogTool	(	void	dialog,
		void	di,
		void	block )

inline

Called when current tool changes in a dialog.

◆ updateDialogToolDescription()

void CamExporterV2::updateDialogToolDescription	(	void	dialog,
		void	di,
		void	block )

inline

◆ validateLeadRadius()

void CamExporterV2::validateLeadRadius	(	void	msgs,
		void	leadSize,
		void	toolDiameter,
		void	leadIn )

inline

◆ validateLeads()

void CamExporterV2::validateLeads	(	void	dialog,
		void	obj,
		void	msgs )

inline

Validate lead in / lead out radius against tool radius in dialog.

◆ validateToolName()

void CamExporterV2::validateToolName	(	void	dialog,
		void	obj,
		void	msgs )

inline

Validate tool name in dialog.

◆ validateToolpathName()

void CamExporterV2::validateToolpathName	(	void	dialog,
		void	obj,
		void	msgs,
		void	initial )

inline

Validate toolpath name in dialog.

◆ variableUsed()

void CamExporterV2::variableUsed	(	void	id,
		void	valueString )

inline

◆ warnUser()

void CamExporterV2::warnUser ( void msg )

inline

Displays a warning to the user in the command line.

◆ write()

void CamExporterV2::write ( void str )

inline

Writes the given string to the output stream.

◆ writeArcCCWLeadIn()

void CamExporterV2::writeArcCCWLeadIn ( )

inline

Called for circular counter-clockwise lead in moves.

◆ writeArcCCWLeadOut()

void CamExporterV2::writeArcCCWLeadOut ( )

inline

Called for circular counter-clockwise lead out moves.

◆ writeArcCCWMove()

void CamExporterV2::writeArcCCWMove ( )

inline

Called for counter-clockwise circular move.

◆ writeArcCWLeadIn()

void CamExporterV2::writeArcCWLeadIn ( )

inline

Called for circular clockwise lead in moves.

◆ writeArcCWLeadOut()

void CamExporterV2::writeArcCWLeadOut ( )

inline

Called for circular clockwise lead out moves.

◆ writeArcCWMove()

void CamExporterV2::writeArcCWMove ( )

inline

Called for clockwise circular moves.

◆ writeBlock()

void CamExporterV2::writeBlock ( void name )

inline

Writes the given block from a file if available (this[name + "File"]) or from the variable this[name].

Variables ("[X]") are substituted with their formatted values ("X1.234").

◆ writeBlockFooter()

void CamExporterV2::writeBlockFooter ( void blockName )

inline

◆ writeBlockFromFiles()

void CamExporterV2::writeBlockFromFiles ( void name )

inline

Writes a text block from file(s) with the given name.

Used for complex post processors with extensive / many headers / footers.

◆ writeBlockFromQueue()

void CamExporterV2::writeBlockFromQueue	(	void	blockName,
		void	name )

inline

◆ writeBlockFromString()

void CamExporterV2::writeBlockFromString ( void blockStrings )

inline

◆ writeBlockHeader()

void CamExporterV2::writeBlockHeader ( void blockName )

inline

Override to write the header for the block with the given name to the output file.

◆ writeComment()

void CamExporterV2::writeComment ( void str )

inline

◆ writeContourFooter()

void CamExporterV2::writeContourFooter ( )

inline

Override to write the contour footer to the output file.

◆ writeContourHeader()

void CamExporterV2::writeContourHeader ( )

inline

Override to write the contour header to the output file.

◆ writeEntity()

void CamExporterV2::writeEntity ( )

inline

Override to write the given CAM output entity to the output file.

◆ writeFile()

void CamExporterV2::writeFile ( void fileName )

inline

Writes the output to the output file through the chosen configuration file (e.g.

GCode.js).

◆ writeFirstArcCCWMove()

void CamExporterV2::writeFirstArcCCWMove ( )

inline

Called for first counter-clockwise circular move.

◆ writeFirstArcCWMove()

void CamExporterV2::writeFirstArcCWMove ( )

inline

Called for first clockwise circular move.

◆ writeFirstContourHeader()

void CamExporterV2::writeFirstContourHeader ( )

inline

Override to write the contour header to the output file.

◆ writeFirstLinearMove()

void CamExporterV2::writeFirstLinearMove ( )

inline

Called for first linear move with new feedrate.

◆ writeFirstLinearMoveZ()

void CamExporterV2::writeFirstLinearMoveZ ( )

inline

Called for first linear Z move with new feedrate.

◆ writeFirstMove()

void CamExporterV2::writeFirstMove ( )

inline

Called for rapid moves to safety level before toolpath.

◆ writeFirstMoveAndToolChange()

void CamExporterV2::writeFirstMoveAndToolChange ( void toolHeaderWritten )

inline

Writes the first move and a tool change if necessary.

Parameters

toolHeaderWritten true: tool header written, don't write again

Returns: true: tool header has been written

◆ writeFirstPointMoveZ()

void CamExporterV2::writeFirstPointMoveZ ( )

inline

Called for first point Z move with new feedrate (drilling).

◆ writeFirstToolpathHeader()

void CamExporterV2::writeFirstToolpathHeader ( )

inline

Override to write the first toolpath header to the output file.

◆ writeFooter()

void CamExporterV2::writeFooter ( )

inline

Override to write the file footer to the output file.

◆ writeHeader()

void CamExporterV2::writeHeader ( )

inline

Override to write the file header to the output file.

◆ writeLastMove()

void CamExporterV2::writeLastMove ( )

inline

Called for rapid moves to safety level after toolpath.

◆ writeLastToolFooter()

void CamExporterV2::writeLastToolFooter ( )

inline

Called for last tool footer.

◆ writeLine()

void CamExporterV2::writeLine ( void line )

inline

Writes the given line (string + line ending) to the output stream.

◆ writeLinearLeadIn()

void CamExporterV2::writeLinearLeadIn ( )

inline

Called for linear lead in moves.

◆ writeLinearLeadOut()

void CamExporterV2::writeLinearLeadOut ( )

inline

Called for linear lead out moves.

◆ writeLinearMove()

void CamExporterV2::writeLinearMove ( )

inline

Called for linear moves.

◆ writeLinearMoveCompensationLeft()

void CamExporterV2::writeLinearMoveCompensationLeft ( )

inline

Called for linear moves switching on cutter radius compensation left.

◆ writeLinearMoveCompensationOff()

void CamExporterV2::writeLinearMoveCompensationOff ( )

inline

Called for linear moves switching off cutter radius compensation.

◆ writeLinearMoveCompensationRight()

void CamExporterV2::writeLinearMoveCompensationRight ( )

inline

Called for linear moves switching on cutter radius compensation right.

◆ writeLinearMoveZ()

void CamExporterV2::writeLinearMoveZ ( )

inline

Called for linear Z moves.

◆ writeMultiZPassFooter()

void CamExporterV2::writeMultiZPassFooter ( )

inline

Override to write the footer for a multi pass to the output file.

◆ writeMultiZPassHeader()

void CamExporterV2::writeMultiZPassHeader ( )

inline

Override to write the header for a multi pass to the output file.

◆ writePointMoveZ()

void CamExporterV2::writePointMoveZ ( )

inline

Called for point Z moves (drilling).

◆ writeQueuedEntities()

void CamExporterV2::writeQueuedEntities ( )

inline

Writes queued entities.

◆ writeRapidMove()

void CamExporterV2::writeRapidMove ( )

inline

Called for rapid moves.

◆ writeRapidMoveZ()

void CamExporterV2::writeRapidMoveZ ( )

inline

Called for rapid moves in Z.

◆ writeSingleZPassFooter()

void CamExporterV2::writeSingleZPassFooter ( )

inline

Override to write the footer for a single pass to the output file.

◆ writeSingleZPassHeader()

void CamExporterV2::writeSingleZPassHeader ( )

inline

Override to write the header for a single pass to the output file.

◆ writeTabFooter()

void CamExporterV2::writeTabFooter ( )

inline

◆ writeTabHeader()

void CamExporterV2::writeTabHeader ( )

inline

◆ writeTabTop()

void CamExporterV2::writeTabTop ( )

inline

◆ writeToolFooter()

void CamExporterV2::writeToolFooter ( )

inline

Called for tool footer.

◆ writeToolHeader()

void CamExporterV2::writeToolHeader ( )

inline

Called for tool header (tool changes).

◆ writeToolpathFooter()

void CamExporterV2::writeToolpathFooter ( )

inline

Override to write the toolpath footer to the output file.

◆ writeToolpathHeader()

void CamExporterV2::writeToolpathHeader ( )

inline

Override to write the toolpath header to the output file.

◆ writeZPassFirstHeader()

void CamExporterV2::writeZPassFirstHeader ( )

inline

Override to write the first pass header to the output file.

◆ writeZPassFooter()

void CamExporterV2::writeZPassFooter ( )

inline

Override to write the pass footer to the output file.

◆ writeZPassHeader()

void CamExporterV2::writeZPassHeader ( )

inline

Override to write the pass header to the output file.

◆ writeZPassLastFooter()

void CamExporterV2::writeZPassLastFooter ( )

inline

Override to write the last pass footer to the output file.

Member Data Documentation

◆ debug

int CamExporterV2::__debug__

◆ allowLeadForSideOn

int CamExporterV2::allowLeadForSideOn

◆ allowNegativeTabs

int CamExporterV2::allowNegativeTabs

◆ alwaysUseStartPointForEntry

int CamExporterV2::alwaysUseStartPointForEntry

◆ arcInterpolation

int CamExporterV2::arcInterpolation

◆ arcSegmentLength

int CamExporterV2::arcSegmentLength

◆ blockNameMapping

int CamExporterV2::blockNameMapping

◆ cadDocument

int CamExporterV2::cadDocument

◆ cadDocumentInterface

int CamExporterV2::cadDocumentInterface

◆ ellipseSegments

int CamExporterV2::ellipseSegments

◆ fileExtensions

int CamExporterV2::fileExtensions

◆ firstEntityOfProfile

int CamExporterV2::firstEntityOfProfile

◆ id

int CamExporterV2::id

◆ ignoreContourSide

int CamExporterV2::ignoreContourSide

◆ ignoredContexts

int CamExporterV2::ignoredContexts

◆ ignoredOutput

int CamExporterV2::ignoredOutput

◆ incrementalXYZ

int CamExporterV2::incrementalXYZ

◆ lastEntityOfProfile

int CamExporterV2::lastEntityOfProfile

◆ lineEnding

int CamExporterV2::lineEnding

◆ lineNumber

int CamExporterV2::lineNumber

◆ lineNumberIncrement

int CamExporterV2::lineNumberIncrement

◆ lineNumberStart

int CamExporterV2::lineNumberStart

◆ normalizeWhiteSpace

int CamExporterV2::normalizeWhiteSpace

◆ offsetJoin

int CamExporterV2::offsetJoin

◆ oneToolpathPerContourDrill

int CamExporterV2::oneToolpathPerContourDrill

◆ oneToolpathPerContourProfile

int CamExporterV2::oneToolpathPerContourProfile

◆ options

int CamExporterV2::options

◆ outputOffsetPath

int CamExporterV2::outputOffsetPath

◆ rapidMoveToOffset

int CamExporterV2::rapidMoveToOffset

◆ scale

int CamExporterV2::scale

◆ separator

int CamExporterV2::separator

◆ splineMaxRadius

int CamExporterV2::splineMaxRadius

◆ splineTolerance

int CamExporterV2::splineTolerance

◆ splitArcsAtQuadrantLines

int CamExporterV2::splitArcsAtQuadrantLines

◆ splitFullCircles

int CamExporterV2::splitFullCircles

◆ stopAtTab

int CamExporterV2::stopAtTab

◆ tolerance

int CamExporterV2::tolerance

◆ toolChangeMode

int CamExporterV2::toolChangeMode

◆ unit

int CamExporterV2::unit

◆ unitScale

int CamExporterV2::unitScale

◆ useProgressDialog

int CamExporterV2::useProgressDialog

◆ variables

int CamExporterV2::variables

◆ zSafety

int CamExporterV2::zSafety

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

/Users/andrew/data/RibbonSoft/projects/QCAD3/qcadcam/scripts/Cam/CamExportV2/CamExporterV2.js

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CamExporterV2()

Member Function Documentation

◆ activated()

◆ adjustOffsetLeadShapes()

◆ afterExportToolpath()

◆ beforeExportContourPass()

◆ beforeExportToolpath()

◆ beforeWrite()

◆ checkContext()

◆ collectCamOffsetPath()

◆ contourContains()

◆ createConfigOutputLayer()

◆ createDrillToolpathDialog()

◆ createLayer()

◆ createPocketToolpathDialog()

◆ createProfileToolpathDialog()

◆ createSpatialIndex()

◆ createToolDialog()

◆ decIndent()

◆ detectAndWriteToolChange()

◆ dumpContext()

◆ exportArc()

◆ exportCamEntity()

◆ exportClosedContourShape()

◆ exportContour()

◆ exportContourPass()

◆ exportContours()

◆ exportEllipse()

◆ exportFirstClosedContourShape()

◆ exportFirstContourShape()

◆ exportFirstOpenContourShape()

◆ exportLastClosedContourShape()

◆ exportLastContourShape()

◆ exportLastOpenContourShape()

◆ exportLead()

◆ exportLeadIn()

◆ exportLeadOut()

◆ exportLine()

◆ exportOffsetPath()

◆ exportOpenContourShape()

◆ exportPoint()

◆ exportPostContourPass()

◆ exportPostContourPasses()

◆ exportRapidMoveTo()

◆ exportRapidMoveToolDown()

◆ exportShape()

◆ exportSingleContourShape()

◆ exportSpline()

◆ exportSplitCamEntity()

◆ exportToolDown()

◆ exportToolDownClearance()

◆ exportToolDownClearancePass()

◆ exportToolpath()

◆ exportToolpathContours()

◆ exportToolUp()

◆ exportToolUpSafety()

◆ exportToolUpSafetyDummy()

◆ exportZMove()

◆ formatValue()

◆ fuzzyCompare()

◆ getAllowanceOffset()

◆ getArcInterpolation()

◆ getArcSegmentLength()

◆ getAutoRegenerateToolpaths()

◆ getBlockFileNames()

◆ getCamConfigLayerName()

◆ getCamLayerId()

◆ getConfigName()

◆ getContext()

◆ getContextValue()

◆ getCreateNewDocument()

◆ getCurrentEntity()

◆ getCurrentToolName()

◆ getCurrentToolpathType()

◆ getCurrentToolType()

◆ getCustomPropertyPrefix()