FreeCAD: draftguitools.gui_pointarray.PointArray Class Reference

Public Member Functions
def	Activated (self, name="Point array")

def	GetResources (self)

def	proceed (self)

def	Activated (self, name="None", noplanesetup=False, is_subtool=False)

Public Member Functions inherited from draftguitools.gui_base_original.DraftTool
def	Activated (self, name="None", noplanesetup=False, is_subtool=False)

def	commit (self, name, func)

def	finish (self, close=False)

def	getStrings (self, addrot=None)

def	IsActive (self)

Public Attributes
	use_link

Public Attributes inherited from draftguitools.gui_base_original.Modifier
	copymode

Public Attributes inherited from draftguitools.gui_base_original.DraftTool
	call

	commitList

	constrain

	doc

	extendedCopy

	featureName

	node

	obj

	planetrack

	point

	pos

	support

	ui

	view

Detailed Description

Gui Command for the Point array tool.

Parameters
----------
use_link: bool, optional
    It defaults to `False`. If it is `True`, the created object
    will be a `Point link array`.

Member Function Documentation

◆ Activated()

def draftguitools.gui_pointarray.PointArray.Activated	(		self,
			name = `"Point array"`
	)

Execute when the command is called.

Reimplemented from draftguitools.gui_base_original.Modifier.

Reimplemented in draftguitools.gui_pointarray.PointLinkArray.

References draftguitools.gui_pointarray.PointArray.Activated(), draftguitools.gui_array_simple.Array.proceed(), draftguitools.gui_clone.Clone.proceed(), draftguitools.gui_downgrade.Downgrade.proceed(), draftguitools.gui_draft2sketch.Draft2Sketch.proceed(), draftguitools.gui_drawing.Drawing.proceed(), draftguitools.gui_edit.Edit.proceed(), draftguitools.gui_facebinders.Facebinder.proceed(), draftguitools.gui_join.Join.proceed(), draftguitools.gui_mirror.Mirror.proceed(), draftguitools.gui_move.Move.proceed(), draftguitools.gui_offset.Offset.proceed(), draftguitools.gui_patharray.PathArray.proceed(), draftguitools.gui_pathtwistedarray.PathTwistedArray.proceed(), draftguitools.gui_pointarray.PointArray.proceed(), draftguitools.gui_rotate.Rotate.proceed(), draftguitools.gui_scale.Scale.proceed(), draftguitools.gui_shape2dview.Shape2DView.proceed(), draftguitools.gui_stretch.Stretch.proceed(), draftguitools.gui_subelements.SubelementHighlight.proceed(), draftguitools.gui_trimex.Trimex.proceed(), draftguitools.gui_upgrade.Upgrade.proceed(), draftguitools.gui_split.Split.proceed(), draftguitools.gui_groups.AddToGroup.proceed(), and draftguitools.gui_groups.SetAutoGroup.proceed().

Referenced by ArchStructure.CommandStructuralSystem.Activated(), draftguitools.gui_pointarray.PointArray.Activated(), draftguitools.gui_arcs.Arc.finish(), draftguitools.gui_beziers.BezCurve.finish(), draftguitools.gui_beziers.CubicBezCurve.finish(), draftguitools.gui_ellipses.Ellipse.finish(), draftguitools.gui_lines.Line.finish(), draftguitools.gui_mirror.Mirror.finish(), draftguitools.gui_move.Move.finish(), draftguitools.gui_polygons.Polygon.finish(), draftguitools.gui_rectangles.Rectangle.finish(), draftguitools.gui_rotate.Rotate.finish(), draftguitools.gui_splines.BSpline.finish(), draftguitools.gui_texts.Text.finish(), draftguitools.gui_points.Point.finish(), draftguitools.gui_shapestrings.ShapeString.finish(), draftguitools.gui_arcs.Arc_3Points.getPoint(), and ArchPanel.CommandPanel.getPoint().

◆ GetResources()

def draftguitools.gui_pointarray.PointArray.GetResources ( self )

Set icon, menu and tooltip.

Reimplemented in draftguitools.gui_pointarray.PointLinkArray.

References draftutils.translate.QT_TRANSLATE_NOOP.

◆ proceed()

def draftguitools.gui_pointarray.PointArray.proceed ( self )

Proceed with the command if one object was selected.

References draftguitools.gui_base.GuiCommandBase.commit(), draftguitools.gui_base_original.DraftTool.commit(), Gui::MacroManager.commit(), Gui::ManualAlignment.finish(), Gui::SoFCBoundingBox.finish(), Gui::SoFCColorBarBase.finish(), Gui::SoFCColorBar.finish(), Gui::SoFCColorGradient.finish(), Gui::SoFCColorLegend.finish(), Gui::SoFCDB.finish(), zipios::GZIPOutputStream.finish(), zipios::GZIPOutputStreambuf.finish(), zipios::ZipOutputStream.finish(), zipios::ZipOutputStreambuf.finish(), DraftGui.DraftToolBar.finish(), draftguitools.gui_base.GuiCommandBase.finish(), draftguitools.gui_subelements.SubelementHighlight.finish(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.finish(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.finish(), drafttaskpanels.task_polararray.TaskPanelPolarArray.finish(), drafttaskpanels.task_shapestring.ShapeStringTaskPanelEdit.finish(), draftviewproviders.view_text.ViewProviderText.finish(), draftguitools.gui_arcs.Arc_3Points.finish(), draftguitools.gui_base_original.DraftTool.finish(), draftguitools.gui_clone.Clone.finish(), draftguitools.gui_fillets.Fillet.finish(), draftguitools.gui_selectplane.Draft_SelectPlane.finish(), draftguitools.gui_dimensions.Dimension.finish(), draftguitools.gui_edit.Edit.finish(), draftguitools.gui_offset.Offset.finish(), draftguitools.gui_stretch.Stretch.finish(), draftguitools.gui_trimex.Trimex.finish(), draftguitools.gui_arcs.Arc.finish(), draftguitools.gui_beziers.BezCurve.finish(), draftguitools.gui_beziers.CubicBezCurve.finish(), draftguitools.gui_ellipses.Ellipse.finish(), draftguitools.gui_labels.Label.finish(), draftguitools.gui_lines.Line.finish(), draftguitools.gui_mirror.Mirror.finish(), draftguitools.gui_move.Move.finish(), draftguitools.gui_polygons.Polygon.finish(), draftguitools.gui_rectangles.Rectangle.finish(), draftguitools.gui_rotate.Rotate.finish(), draftguitools.gui_scale.Scale.finish(), draftguitools.gui_splines.BSpline.finish(), draftguitools.gui_texts.Text.finish(), draftguitools.gui_points.Point.finish(), draftguitools.gui_shapestrings.ShapeString.finish(), Gui::SoFCBackgroundGradient.finish(), Gui::SoSkipBoundingGroup.finish(), Gui::SoFCSelection.finish(), Gui::SoFCHighlightAction.finish(), Gui::SoFCSelectionAction.finish(), Gui::SoFCEnableSelectionAction.finish(), Gui::SoFCEnableHighlightAction.finish(), Gui::SoFCSelectionColorAction.finish(), Gui::SoFCHighlightColorAction.finish(), Gui::SoFCDocumentAction.finish(), Gui::SoFCDocumentObjectAction.finish(), Gui::SoUpdateVBOAction.finish(), Gui::SoFCUnifiedSelection.finish(), Gui::SoFCPathAnnotation.finish(), Gui::SoFCSeparator.finish(), Gui::SoFCSelectionRoot.finish(), ifc4.ifcworktime.finish, draftguitools.gui_array_simple.Array.use_link, draftguitools.gui_patharray.PathArray.use_link, draftguitools.gui_pathtwistedarray.PathTwistedArray.use_link, draftguitools.gui_pointarray.PointArray.use_link, draftobjects.draftlink.DraftLink.use_link, drafttaskpanels.task_circulararray.TaskPanelCircularArray.use_link, drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.use_link, and drafttaskpanels.task_polararray.TaskPanelPolarArray.use_link.

Referenced by draftguitools.gui_split.Split.action(), draftguitools.gui_edit.Edit.Activated(), draftguitools.gui_pointarray.PointArray.Activated(), draftguitools.gui_move.Move.get_object_selection(), draftguitools.gui_rotate.Rotate.get_object_selection(), draftguitools.gui_scale.Scale.get_object_selection(), and draftguitools.gui_subelements.SubelementHighlight.get_selection().

Member Data Documentation

◆ use_link

draftguitools.gui_pointarray.PointArray.use_link

Referenced by draftobjects.draftlink.DraftLink.attach(), draftobjects.draftlink.DraftLink.buildShape(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.create_object(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.create_object(), drafttaskpanels.task_polararray.TaskPanelPolarArray.create_object(), draftobjects.draftlink.DraftLink.getViewProviderName(), draftobjects.draftlink.DraftLink.migrate_attributes(), draftobjects.draftlink.DraftLink.onDocumentRestored(), draftobjects.patharray.PathArray.onDocumentRestored(), draftobjects.pathtwistedarray.PathTwistedArray.onDocumentRestored(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.print_messages(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.print_messages(), drafttaskpanels.task_polararray.TaskPanelPolarArray.print_messages(), draftguitools.gui_array_simple.Array.proceed(), draftguitools.gui_patharray.PathArray.proceed(), draftguitools.gui_pathtwistedarray.PathTwistedArray.proceed(), draftguitools.gui_pointarray.PointArray.proceed(), draftobjects.patharray.PathArray.set_general_properties(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.set_link(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.set_link(), drafttaskpanels.task_polararray.TaskPanelPolarArray.set_link(), draftobjects.array.Array.set_link_properties(), draftobjects.pathtwistedarray.PathTwistedArray.set_properties(), draftobjects.pointarray.PointArray.set_properties(), drafttaskpanels.task_polararray.TaskPanelPolarArray.validate_input(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.validate_input(), and drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.validate_input().

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

FreeCAD/src/Mod/Draft/draftguitools/gui_pointarray.py