Selection API: Difference between revisions
Renatorivo (talk | contribs) (languages it) |
Wandererfan (talk | contribs) m (Added getSelectionEx for subobject selection.) |
||
Line 6: | Line 6: | ||
{{APIFunction|addSelection|FreeCAD.Object|Adds an object to the selection| }} |
{{APIFunction|addSelection|FreeCAD.Object|Adds an object to the selection| }} |
||
{{APIFunction|clearSelection|[string]|Clears the selection of the given document name. If no document is given the complete selection is cleared.| }} |
{{APIFunction|clearSelection|[string]|Clears the selection of the given document name. If no document is given the complete selection is cleared.| }} |
||
{{APIFunction|getSelection|[string]|Returns a list of selected objects for a given document name. If no document is given the complete selection is returned.|a list of objects}} |
{{APIFunction|getSelection|[string]|Returns a list of selected document objects for a given document name. If no document is given the complete selection is returned.|a list of document objects in the order they were selected.}} |
||
{{APIFunction|getSelectionEx|[string]|Returns a list of SelectionObject for a given document name. If no document is given the complete selection is returned. Used for selecting subobjects (ex some Edges of a Face).|a list of SelectionObjects in the order they were selected}} |
|||
{{APIFunction|isSelected|FreeCAD.Object|Checks if a given object is selected| }} |
{{APIFunction|isSelected|FreeCAD.Object|Checks if a given object is selected| }} |
||
{{APIFunction|removeSelection|FreeCAD.Object|Removes an object from the selection| }} |
{{APIFunction|removeSelection|FreeCAD.Object|Removes an object from the selection| }} |
Revision as of 19:06, 23 November 2013
The selection submodule is part of the FreeCADGui module. Example:
import FreeCADGui sel = FreeCADGui.Selection.getSelection()
Description: Clears the selection of the given document name. If no document is given the complete selection is cleared.
Returns:
Description: Returns a list of selected document objects for a given document name. If no document is given the complete selection is returned.
Returns: a list of document objects in the order they were selected.
Description: Returns a list of SelectionObject for a given document name. If no document is given the complete selection is returned. Used for selecting subobjects (ex some Edges of a Face).
Returns: a list of SelectionObjects in the order they were selected