Prompts the user to pick or select one or more objects.
rhinoscriptsyntax.GetObjects ( message=None, filter=0, group=True, preselect=False, select=False, objects=None, minimum_count=1, maximum_count=0, custom_filter=None )
rhinoscript.selection.GetObjects ( message=None, filter=0, group=True, preselect=False, select=False, objects=None, minimum_count=1, maximum_count=0, custom_filter=None )
message |
Optional. String. A prompt or message. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filter |
Optional. Number. The type(s) of geometry objects (points, curves, surfaces, meshes, etc.) that can be selected. Object types can be added together to filter several different kinds of geometry.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
group |
Optional. Boolean. Honor object grouping. If omitted and the user picks a group, the entire group will be picked (True). Note, if filter is set to a value other than 0 (All objects), then group selection will be disabled. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
preselect |
Optional. Boolean. Allow for the selection of pre-selected objects. If omitted, pre-selected objects are not accepted (False). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
select |
Optional. Boolean. Specifies whether or not the picked objects will remain selected when the function ends. If omitted, objects that were pre-picked will remain selected and the objects that were post-picked will not be selected. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
objects |
Optional. List. List of identifiers for objects that are allowed to be selected |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minimum_count |
Optional. Number. The minimum number of objects to select. If omitted, then at least one (1) object must be selected. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maximum_count |
Optional. Number. The maximum number of objects to select. If 0 (Default), then the user must press enter to finish object selection. If -1, then object selection stops as soon as there are at least minimum_count of object selected. If >0, then the picking stops when there are maximum_count objects. If a window pick, crossing pick, or Sel* command attempts to add more than maximum_count, then the attempt is ignored. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
custom_filter |
Optional. Function that takes a Rhino Object, Geometry, and component index and returns true or false indicating if the object can be selected |
list |
A list of Guids identifying the picked objects if successful. |
import rhinoscriptsyntax as rs
objectIds = rs.GetObjects("Pick some curves", rs.filter.curve)
for id in objectIds: print "Object identifier:", id