Click or drag to resize
GetObject Properties

The GetObject type exposes the following members.

Public propertyAlreadySelectedObjectSelect
Allow selecting objects that are already selected. By default, GetObjects() disallows selection of objects that are already selected to avoid putting the same object in the selection set more than once. Calling EnableAlreadySelectedObjectSelect = true overrides that restriction and allows selected objects to be selected and returned by GetObjects. This is useful because, coupled with the return immediately mode of GetObjects(1, -1), it is possible to select a selected object to deselect when the selected objects are being managed outside GetObjects() as in the case of CRhinoPolyEdge::GetEdge().
Public propertyBottomObjectPreference
By default, if a call to Input is permitted to select different parts of the same object, like a polysurface, a surface and an edge, then the top-most object is prefered. (polysurface beats face beats edge). If you want the bottom most object to be prefered, then call EnableBottomObjectPreference = true before calling GetObjects().
Public propertyChooseOneQuestion
By default, if a call to Input is permitted to select different parts of the same object, like a polysurface and an edge of that polysurface, then the top-most object is automatically selected. If you want the choose-one-object mechanism to include pop up in these cases, then call EnableChooseOneQuestion = true before calling GetObjects().
Public propertyCode exampleDeselectAllBeforePostSelect
true if pre-selected input will be deselected before post-selection begins when no pre-selected input is valid.
Public propertyCode exampleGeometryAttributeFilter
The geometry attribute filter provides a secondary filter that can be used to restrict which objects can be selected. Control of the type of geometry (points, curves, surfaces, meshes, etc.) is provided by GetObject.SetGeometryFilter. The geometry attribute filter is used to require the selected geometry to have certain attributes (open, closed, etc.). The default attribute filter permits selection of all types of geometry.
Public propertyCode exampleGeometryFilter
The geometry type filter controls which types of geometry (points, curves, surfaces, meshes, etc.) can be selected. The default geometry type filter permits selection of all types of geometry. NOTE: the filter can be a bitwise combination of multiple ObjectTypes.
Public propertyCode exampleGroupSelect
By default, groups are ignored in GetObject. If you want your call to GetObjects() to select every object in a group that has any objects selected, then enable group selection.
Public propertyInactiveDetailPickEnabled
By default, objects in inactive details are not permitted to be picked. In a few rare cases this is used (ex. picking circles during DimRadius)
Public propertyObjectCount
Gets the number of objects that were selected.
Public propertyObjectsWerePreselected
Public propertyCode exampleOneByOnePostSelect
In one-by-one post selection, the user is forced to select objects by post picking them one at a time.
Public propertyCode exampleReferenceObjectSelect
By default, reference objects can be selected. If you do not want to be able to select reference objects, then call EnableReferenceObjectSelect=false.
Public propertySerialNumber
Each instance of GetObject has a unique runtime serial number that is used to identify object selection events associated with that instance.
Public propertyCode exampleSubObjectSelect
By default, GetObject.Input will permit a user to select sub-objects (like a curve in a b-rep or a curve in a group). If you only want the user to select "top" level objects, then call EnableSubObjectSelect = false.
See Also