GetObject

GetObject class

The GetObject class is the tool commands use to interactively select objects.

Inheritence: Rhino.Input.Custom.GetBaseClassGetObject
Derived Classes:

Namespace: Rhino.Input.Custom
GetObject: references

Constructors (2)

GetBaseClass()

Initializes a new instance of the GetBaseClass class

GetObject()

Properties (15)

AlreadySelectedObjectSelect

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().

BottomObjectPreference

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 preferred. (polysurface beats face beats edge). If you want the bottom most object to be preferred, then call EnableBottomObjectPreference = True before calling GetObjects().

ChooseOneQuestion

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().

DeselectAllBeforePostSelect

True if pre-selected input will be deselected before post-selection begins when no pre-selected input is valid.

GeometryAttributeFilter

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.

GeometryFilter

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.

GroupSelect

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.

InactiveDetailPickEnabled

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)

ObjectCount

Gets the number of objects that were selected.

ObjectsWerePreselected

OneByOnePostSelect

In one-by-one post selection, the user is forced to select objects by post picking them one at a time.

ProxyBrepFromSubD

If a subd (or a subd component) cannot be selected, but a brep (or brep component) can be selected, then automatically create and use a proxy brep.

ReferenceObjectSelect

By default, reference objects can be selected. If you do not want to be able to select reference objects, then call EnableReferenceObjectSelect=false.

SerialNumber

Each instance of GetObject has a unique runtime serial number that is used to identify object selection events associated with that instance.

SubObjectSelect

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.

Methods (86)

AcceptColor(bool enable)

If you want to allow the user to be able to type in a color r,g,b or name during GetPoint.Get(), GetObject::GetObjects(), etc., then call AcceptColor(true) before calling GetPoint()/GetObject(). If the user chooses to type in a color, then the result code GetResult.Color is returned and you can use RhinoGet.Color() to get the value of the color. If the get accepts points, then the user will not be able to type in r,g,b colors but will be able to type color names.

AcceptCustomMessage(bool enable)

AcceptEnterWhenDone(bool enable)

There are instances of RhinoGet that prompt with "Press Enter when Done." yet do not call AcceptNothing(). On the Mac, these instances need an additional call to AcceptEnterWhenDone() so the GetPointOptions dialog can correctly enable the Done button.

AcceptNothing(bool enable)

If you want to allow the user to be able to press enter in order to skip selecting a something in GetPoint.Get(), GetObject::GetObjects(), etc., then call AcceptNothing( True ) beforehand.

AcceptNumber(bool enable, bool acceptZero)

If you want to allow the user to be able to type in a number during GetPoint.Get(), GetObject::GetObjects(), etc., then call AcceptNumber() beforehand. If the user chooses to type in a number, then the result code GetResult.Number is returned and you can use RhinoGet.Number() to get the value of the number. If you are using GetPoint and you want "0" to return (0,0,0) instead of the number zero, then set acceptZero = false.

AcceptPoint(bool enable)

If you want to allow the user to be able to type in a point then call AcceptPoint(true) before calling GetPoint()/GetObject(). If the user chooses to type in a number, then the result code GetResult.Point is returned and you can use RhinoGet.Point() to get the value of the point.

AcceptString(bool enable)

If you want to allow the user to be able to type in a string during GetPoint.Get(), GetObject::GetObjects(), etc., then call AcceptString(true) before calling GetPoint()/GetObject(). If the user chooses to type in a string, then the result code GetResult.String is returned and you can use RhinoGet.String() to get the value of the string.

AcceptUndo(bool enable)

If you want to allow the user to have an 'undo' option in GetPoint.Get(), GetObject.GetObjects(), etc., then call AcceptUndo(true) beforehand.

ActiveGetObject(RhinoDoc doc)

Get the currently running GetObject for a given document

AddOption(LocalizeStringPair optionName, LocalizeStringPair optionValue, bool hiddenOption)

Adds a command line option.

AddOption(LocalizeStringPair optionName, LocalizeStringPair optionValue)

Adds a command line option.

AddOption(LocalizeStringPair optionName)

Adds a command line option.

AddOption(string englishOption, string englishOptionValue, bool hiddenOption)

Adds a command line option.

AddOption(string englishOption, string englishOptionValue)

Adds a command line option.

AddOption(string englishOption)

Adds a command line option.

AddOptionColor(LocalizeStringPair optionName, ref OptionColor colorValue, string prompt)

Add a command line option to get colors and automatically save the value.

AddOptionColor(LocalizeStringPair optionName, ref OptionColor colorValue)

Add a command line option to get colors and automatically save the value.

AddOptionColor(string englishName, ref OptionColor colorValue, string prompt)

Add a command line option to get colors and automatically save the value.

AddOptionColor(string englishName, ref OptionColor colorValue)

Add a command line option to get colors and automatically save the value.

AddOptionDouble(LocalizeStringPair optionName, ref OptionDouble numberValue, string prompt)

Adds a command line option to get numbers and automatically saves the value.

AddOptionDouble(LocalizeStringPair optionName, ref OptionDouble numberValue)

Adds a command line option to get numbers and automatically save the value.

AddOptionDouble(string englishName, ref OptionDouble numberValue, string prompt)

Adds a command line option to get numbers and automatically save the value.

AddOptionDouble(string englishName, ref OptionDouble numberValue)

Adds a command line option to get numbers and automatically save the value.

AddOptionEnumList(string englishOptionName, T defaultValue, T[] include)

Adds a choice of enumerated values as list option. Allows to include only some enumerated values.

AddOptionEnumList(string englishOptionName, T defaultValue)

Adds a choice of enumerated values as list option

AddOptionEnumSelectionList(string englishOptionName, IEnumerable<T> enumSelection, int listCurrentIndex)

Adds a list of enumerated values as option list. Use enumSelection[go.Option.CurrentListOptionIndex] to retrieve selection.

AddOptionInteger(LocalizeStringPair optionName, ref OptionInteger intValue, string prompt)

Adds a command line option to get integers and automatically save the value.

AddOptionInteger(LocalizeStringPair optionName, ref OptionInteger intValue)

Adds a command line option to get integers and automatically save the value.

AddOptionInteger(string englishName, ref OptionInteger intValue, string prompt)

Adds a command line option to get integers and automatically save the value.

AddOptionInteger(string englishName, ref OptionInteger intValue)

Adds a command line option to get integers and automatically save the value.

AddOptionList(LocalizeStringPair optionName, IEnumerable<LocalizeStringPair> listValues, int listCurrentIndex)

Adds a command line list option.

AddOptionList(string englishOptionName, IEnumerable<string> listValues, int listCurrentIndex)

Adds a command line list option.

AddOptionToggle(LocalizeStringPair optionName, ref OptionToggle toggleValue)

Adds a command line option to toggle a setting.

AddOptionToggle(string englishName, ref OptionToggle toggleValue)

Adds a command line option to toggle a setting.

AppendToPickList(ObjRef objref)

ClearCommandOptions()

Clear all command options.

ClearDefault()

Clears any defaults set using SetDefaultPoint, SetDefaultNumber, SetDefaultString, or SetCommandPromptDefault.

ClearObjects()

Clear possible special object drawing

Color()

Gets a color if Get*() returns GetResult.Color.

CommandResult()

Helper method for getting command result value from getter results.

CustomGeometryFilter(RhinoObject rhObject, GeometryBase geometry, ComponentIndex componentIndex)

Checks geometry to see if it can be selected. Override to provide fancy filtering.

CustomMessage()

DisablePreSelect()

Dispose()

Dispose(bool disposing)

EnableClearObjectsOnEntry(bool enable)

By default the picked object list is cleared when GetObject.GetObjects() is called. If you are reusing a GetObject class and do not want the existing object list cleared when you call Input, then call EnableClearObjectsOnEntry(false) before calling GetObjects().

EnableHighlight(bool enable)

By default, any object post-pick selected by GetObjects() is highlighted. If you want to post-pick objects and not have them automatically highlight, then call EnableHighlight = false.

EnableIgnoreGrips(bool enable)

By default, post selection will select objects with grips on. If you do not want to be able to post select objects with grips on, then call EnableIgnoreGrips = false. The ability to preselect an object with grips on is determined by the value returned by the virtual RhinoObject.IsSelectableWithGripsOn.

EnablePostSelect(bool enable)

Control the availability of post selection in GetObjects.

EnablePreSelect(bool enable, bool ignoreUnacceptablePreselectedObjects)

Control the pre-selection behavior GetObjects.

EnablePressEnterWhenDonePrompt(bool enable)

By default, when GetObject.GetObjects is called with minimumNumber > 0 and maximumNumber = 0, the command prompt automatically includes "Press Enter when done" after the user has selected at least minimumNumber of objects. If you want to prohibit the addition of the "Press Enter when done", then call EnablePressEnterWhenDonePrompt = false;

EnableSelPrevious(bool enable)

By default, any object selected during a command becomes part of the "previous selection set" and can be reselected by the SelPrev command. If you need to select objects but do not want them to be selected by a subsequent call to SelPrev, then call EnableSelPrev = false.

EnableTransparentCommands(bool enable)

Control the availability of transparent commands during the get.

EnableUnselectObjectsOnExit(bool enable)

By default any objects in the object list are unselected when GetObject.GetObjects() exits with any return code besides Object. If you want to leave the objects selected when non-object input is returned, then call EnableUnselectObjectsOnExit(false) before calling GetObjects().

Get()

Call to select a single object.

GetMultiple(int minimumNumber, int maximumNumber)

Call to select objects.

GetSelectedEnumValue()

Returns the selected enumerated value. Use this in combination with <b>AddOptionEnumList{T}(string, T)</b> .
This must be called directly after having called a Get method, and having obtained a value.

GetSelectedEnumValueFromSelectionList(IEnumerable<T> selectionList)

Returns the selected enumerated value by looking at the list of values from which to select. Use this in combination with <b>AddOptionEnumSelectionList{T}</b>

GotDefault()

Returns True if user pressed Enter to accept a default point, number, or string set using SetDefaultPoint, SetDefaultNumber, or SetDefaultString.

Line2d()

Returns two points defining the location in the view window of the 2d line selected in GetPoint::Get2dLine().
(0,0) = upper left corner of window.

Number()

Gets a number if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.Number.

Object(int index)

Objects()

Option()

OptionIndex()

PassesGeometryAttributeFilter(RhinoObject rhObject, GeometryBase geometry, ComponentIndex componentIndex)

Checks geometry to see if it passes the basic GeometryAttributeFilter.

PickRectangle()

If the get was a GetObjects() and the mouse was used to select the objects, then the returned rectangle has left < right and top < bottom. This rectangle is the Windows GDI screen coordinates of the picking rectangle. RhinoViewport.GetPickXform( pick_rect, pick_xform ) will calculate the picking transformation that was used. In all other cases, left=right=top=bottom=0;

Point()

Gets a point if Get*() returns GetResult.Point.

Point2d()

Returns location in view of point in selected in GetPoint::Get() or GetPoint::Get2dPoint(). (0,0) = upper left corner of window.

PostCustomMessage(object messageData)

Rectangle2d()

Returns the location in the view of the 2d rectangle selected in GetPoint::Get2dRectangle(). rect.left < rect.right and rect.top < rect.bottom (0,0) = upper left corner of window.

Result()

Returns result of the Get*() call.

SetCommandPrompt(string prompt)

Sets prompt message that appears in the command prompt window.

SetCommandPromptDefault(string defaultValue)

Sets message that describes what default value will be used if the user presses enter. This description appears in angle brackets <> in the command prompt window. You do not need to provide a default value description unless you explicitly enable AcceptNothing.

SetCustomGeometryFilter(GetObjectGeometryFilter filter)

Set filter callback function that will be called by the CustomGeometryFilter

SetDefaultColor(Color defaultColor)

Sets a color as default value that will be returned if the user presses ENTER key during the get.

SetDefaultInteger(int defaultValue)

Sets a number as default value that will be returned if the user presses ENTER key during the get.

SetDefaultNumber(double defaultNumber)

Sets a number as default value that will be returned if the user presses ENTER key during the get.

SetDefaultPoint(Point3d point)

Sets a point as default value that will be returned if the user presses the ENTER key during the get.

SetDefaultString(string defaultValue)

Sets a string as default value that will be returned if the user presses ENTER key during the get.

SetOptionVaries(int optionIndex, bool varies)

Sets a command line option value to print "Varies" instead of the regular value.

SetPressEnterWhenDonePrompt(string prompt)

The default prompt when EnablePressEnterWhenDonePrompt is enabled is "Press Enter when done". Use this function to specify a different string to be appended.

SetWaitDuration(int milliseconds)

Sets the wait duration (in milliseconds) of the getter. If the duration passes without the user making a decision, the GetResult.Timeout code is returned.

StringResult()

Gets a string if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.String.

Vector()

Gets a direction if Get*() returns GetResult.Point (Set by some digitizers, but in general it's (0,0,0).

View()

Gets a view the user clicked in during GetPoint.Get(), GetObject.GetObjects(), etc.

Nothing found