Public Member Functions
def	addContainer (self, container)

def	addObjects (self, objects)

def	apply (self, result=None)

def	clear (self)

def	getPlacements (self, result=None)

def	order (self, face, right=False)

def	run (self)

def	show (self, result=None)

def	stop (self)

def	update (self)

Public Attributes
	container

	indexedFaces

	indexedfaces

	objects

	progress

	results

	running

	setCounter

	shapes

Member Function Documentation

◆ addContainer()

def ArchNesting.Nester.addContainer	(	self,
		container
	)

addContainer(object): adds a FreeCAD DocumentObject as the container

References ArchNesting.Nester.container.

◆ addObjects()

def ArchNesting.Nester.addObjects	(	self,
		objects
	)

addObjects(objects): adds FreeCAD DocumentObjects to the nester

References Gui::MergeDocuments.objects, App::MergeDocuments.objects, ArchNesting.Nester.objects, and ArchNesting.Nester.shapes.

◆ apply()

def ArchNesting.Nester.apply	(	self,
		result = `None`
	)

apply([result]): Applies the computed placements of the given
result, or the last computed result if none is given, to the
document objects given to the nester via addObjects() before
running.

References ArchNesting.Nester.getPlacements(), Gui::MergeDocuments.objects, App::MergeDocuments.objects, and ArchNesting.Nester.objects.

◆ clear()

def ArchNesting.Nester.clear ( self )

clear(): Removes all objects and shape from the nester

References Gui::MergeDocuments.objects, App::MergeDocuments.objects, ArchNesting.Nester.objects, and ArchNesting.Nester.shapes.

◆ getPlacements()

def ArchNesting.Nester.getPlacements	(	self,
		result = `None`
	)

getPlacements([result]): returns a dictionary of hashCode:Placement
pairs from the given result or the last computed result if none
is given. The Placement contains a translation vector and a rotation
to be given to the final object.

References ArchNesting.Nester.container, ArchNesting.Nester.indexedfaces, and ArchNesting.Nester.results.

Referenced by ArchNesting.Nester.apply().

◆ order()

def ArchNesting.Nester.order	(	self,
		face,
		right = `False`
	)

order(face,[right]): returns a list of vertices
ordered clockwise. The first vertex will be the
lefmost one, unless right is True, in which case the
first vertex will be the rightmost one

References WorkingPlane.plane, and DraftVecUtils.project().

◆ run()

def ArchNesting.Nester.run ( self )

run(): Runs a nesting operation. Returns a list of lists of
   shapes, each primary list being one filled container, or None
   if the operation failed.

References ArchNesting.Nester.container, ArchNesting.Nester.progress, ArchNesting.Nester.running, App::PropertyExpressionEngine.running, Gui::GUISingleApplication::Private.running, Gui::PythonDebuggerP.running, ArchNesting.Nester.shapes, Gui::ViewProviderDocumentObjectPy.update(), Gui::ViewProviderDocumentObject.update(), SMESHDS_GroupOnFilter.update(), Gui::DocumentPy.update(), ArchNesting.Nester.update(), AddonManager.CommandAddonManager.update(), App::LinkBaseExtension.update(), Gui::ViewProvider.update(), Gui::LinkInfo.update(), ArchAxis._AxisTaskPanel.update(), ArchAxis.AxisSystemTaskPanel.update(), ArchCommands.SurveyTaskPanel.update(), ArchAxis.ArchGridTaskPanel.update(), and ArchComponent.ComponentTaskPanel.update().

Referenced by femsolver.task.Task.protector().

◆ show()

def ArchNesting.Nester.show	(	self,
		result = `None`
	)

show([result]): creates shapes in the document, showing
   the given result (list of sheets) or the last result if
   none is provided

References ArchNesting.Nester.container, and ArchNesting.Nester.results.

Referenced by Mod.Show.mTempoVis.TempoVis.show_all_dependencies(), and Mod.Show.mTempoVis.TempoVis.show_all_dependent().

◆ stop()

def ArchNesting.Nester.stop ( self )

stop((): stops the computation

References ArchNesting.Nester.running, App::PropertyExpressionEngine.running, Gui::GUISingleApplication::Private.running, and Gui::PythonDebuggerP.running.

Referenced by ArchPanel.NestTaskPanel.accept(), and ArchPanel.NestTaskPanel.reject().

◆ update()

def ArchNesting.Nester.update ( self )

update(): internal function to verify if computation can
go on

References ArchNesting.Nester.progress, ArchNesting.Nester.running, App::PropertyExpressionEngine.running, Gui::GUISingleApplication::Private.running, Gui::PythonDebuggerP.running, and ArchNesting.Nester.setCounter.

Referenced by ArchSectionPlane.SectionPlaneTaskPanel.addElement(), DraftGui.FacebinderTaskPanel.addElement(), femtaskpanels.task_result_mechanical._TaskPanel.calculate(), Spreadsheet_legacy.SpreadsheetView.changeCell(), draftguitools.gui_edit.Edit.endEditing(), draftguitools.gui_trackers.boxTracker.height(), ArchAxis.CommandArchGrid.IsActive(), draftguitools.gui_trackers.rectangleTracker.p3(), Plot.Plot.plot(), Spreadsheet_legacy.SpreadsheetView.recompute(), ArchSectionPlane.SectionPlaneTaskPanel.removeElement(), DraftGui.FacebinderTaskPanel.removeElement(), draftguitools.gui_trackers.gridTracker.reset(), ArchNesting.Nester.run(), and draftguitools.gui_edit.Edit.update_object().

Member Data Documentation

◆ container

ArchNesting.Nester.container

Referenced by ArchNesting.Nester.addContainer(), ArchPanel.NestTaskPanel.getContainer(), ArchNesting.Nester.getPlacements(), ArchPanel.NestTaskPanel.getShapes(), ArchNesting.Nester.run(), ArchNesting.Nester.show(), and ArchPanel.NestTaskPanel.start().

◆ indexedFaces

ArchNesting.Nester.indexedFaces

◆ indexedfaces

ArchNesting.Nester.indexedfaces

Referenced by ArchNesting.Nester.getPlacements().

◆ objects

ArchNesting.Nester.objects

Referenced by ArchNesting.Nester.addObjects(), ArchVRM.Renderer.addObjects(), ArchNesting.Nester.apply(), ArchNesting.Nester.clear(), and exportIFCHelper.ContextCreator.getProjectObject().

◆ progress

ArchNesting.Nester.progress

Referenced by ArchNesting.Nester.run(), and ArchNesting.Nester.update().

◆ results

ArchNesting.Nester.results

Referenced by ArchNesting.Nester.getPlacements(), femsolver.run.Machine.reset(), and ArchNesting.Nester.show().

◆ running

ArchNesting.Nester.running

Referenced by shipHydrostatics.TaskPanel.TaskPanel.accept(), draftguitools.gui_wire2spline.WireToBSpline.Activated(), draftguitools.gui_edit.Edit.Activated(), shipHydrostatics.TaskPanel.TaskPanel.externalFaces(), draftguitools.gui_offset.Offset.finish(), draftguitools.gui_edit.Edit.finish(), draftguitools.gui_snapper.Snapper.off(), shipHydrostatics.TaskPanel.TaskPanel.reject(), ArchNesting.Nester.run(), draftguitools.gui_snapper.Snapper.snap(), draftguitools.gui_snapper.Snapper.snapToObject(), femsolver.task.Task.start(), ArchNesting.Nester.stop(), and ArchNesting.Nester.update().

◆ setCounter

ArchNesting.Nester.setCounter

Referenced by ArchPanel.NestTaskPanel.start(), and ArchNesting.Nester.update().

◆ shapes

ArchNesting.Nester.shapes

Referenced by shipCreateWeight.TaskPanel.TaskPanel.accept(), ArchNesting.Nester.addObjects(), ArchVRM.Renderer.addObjects(), ArchVRM.Renderer.addShapes(), ArchNesting.Nester.clear(), ArchVRM.Renderer.cut(), ArchPanel.NestTaskPanel.getContainer(), ArchPanel.NestTaskPanel.getShapes(), PathScripts.PathDressupDogbone.ObjectDressup.insertBone(), ArchPanel.NestTaskPanel.removeShapes(), ArchNesting.Nester.run(), PathScripts.PathDressupDogbone.ObjectDressup.setup(), and ArchPanel.NestTaskPanel.start().

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

src/Mod/Arch/ArchNesting.py

Public Member Functions

Public Attributes