public class GetObject : GetBaseClass
The GetObject class is the tool commands use to interactively select objects.
GetObject go = new GetObject(); go.GetObjects(1,0); if( go.CommandResult() != Command.Result.Success ) ... use canceled or some other type of input was provided int object_count = go.ObjectCount(); for( int i=0; i<object_count; i++ ) { ObjectReference objref = go.Object(i); ON_Geometry geo = objref.Geometry(); ... }

Constructors

GetObject

#ExampleSince v5.0
public GetObject()

Properties

AlreadySelectedObjectSelect

#Since v5.0
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 bool AlreadySelectedObjectSelect { get; set; }

BottomObjectPreference

#Since v5.0
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().
public bool BottomObjectPreference { get; set; }

ChooseOneQuestion

#Since v5.0
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 bool ChooseOneQuestion { get; set; }

DeselectAllBeforePostSelect

#ExampleSince v5.0
true if pre-selected input will be deselected before post-selection begins when no pre-selected input is valid.
public bool DeselectAllBeforePostSelect { get; set; }

GeometryAttributeFilter

#ExampleSince v5.0
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.
[CLSCompliant(false)] public GeometryAttributeFilter GeometryAttributeFilter { get; set; }

GeometryFilter

#ExampleSince v5.0
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.
[CLSCompliant(false)] public ObjectType GeometryFilter { get; set; }

GroupSelect

#ExampleSince v5.0
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 bool GroupSelect { get; set; }

InactiveDetailPickEnabled

#Since v5.8
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 bool InactiveDetailPickEnabled { get; set; }

LockedObjectSelect

#Since v9.0
By default, locked objects cannot be selected. If you do want to be able to select locked objects, then call LockedObjectSelect=true.
public bool LockedObjectSelect { get; set; }

ObjectCount

#Since v5.0
Gets the number of objects that were selected.
public int ObjectCount { get; }

ObjectsWerePreselected

#Since v5.0
public bool ObjectsWerePreselected { get; }

OneByOnePostSelect

#ExampleSince v5.0
In one-by-one post selection, the user is forced to select objects by post picking them one at a time.
public bool OneByOnePostSelect { get; set; }

ProxyBrepFromSubD

#Since v7.0
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.
public bool ProxyBrepFromSubD { get; set; }

ReferenceObjectSelect

#ExampleSince v5.0
By default, reference objects can be selected. If you do not want to be able to select reference objects, then call EnableReferenceObjectSelect=false.
public bool ReferenceObjectSelect { get; set; }

SerialNumber

#Since v5.0
Each instance of GetObject has a unique runtime serial number that is used to identify object selection events associated with that instance.
[CLSCompliant(false)] public uint SerialNumber { get; }

SubObjectSelect

#ExampleSince v5.0
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.
public bool SubObjectSelect { get; set; }

Methods

AcceptColor

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.
public void AcceptColor(
enable
true if user is able to type a color.
)
inherited fromGetBaseClass

AcceptCustomMessage

public void AcceptCustomMessage(
enable
)
inherited fromGetBaseClass

AcceptEnterWhenDone

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.
public void AcceptEnterWhenDone(
enable
)
inherited fromGetBaseClass

AcceptNothing

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.
public void AcceptNothing(
enable
true if user is able to press enter in order to skip selecting.
)
inherited fromGetBaseClass

AcceptNumber

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.
public void AcceptNumber(
enable,
true if user is able to type a number.
acceptZero
If you are using GetPoint and you want "0" to return (0,0,0) instead of the number zero, then set acceptZero = false.
)
inherited fromGetBaseClass

AcceptPoint

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.
public void AcceptPoint(
enable
true if user is able to type in a point.
)
inherited fromGetBaseClass

AcceptString

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.
public void AcceptString(
enable
true if user is able to type a string.
)
inherited fromGetBaseClass

AcceptUndo

If you want to allow the user to have an 'undo' option in GetPoint.Get(), GetObject.GetObjects(), etc., then call AcceptUndo(true) beforehand.
public void AcceptUndo(
enable
true if user is able to choose the 'Undo' option.
)
inherited fromGetBaseClass

ActiveGetObject

#Since v6.3
Get the currently running GetObject for a given document
public static GetObject ActiveGetObject()

AddOption

Adds a command line option.
public int AddOption(
optionName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes).
optionValue,
The localized value visualized after an equality sign.
hiddenOption
If true, the option is not displayed on the command line and the full option name must be typed in order to activate the option.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOption

Adds a command line option.
public int AddOption(
optionName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes).
optionValue
The localized value visualized after an equality sign.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOption

Adds a command line option.
public int AddOption(
optionName
Must only consist of letters and numbers (no characters list periods, spaces, or dashes).
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOption

Adds a command line option.
public int AddOption(
englishOption,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes).
englishOptionValue,
The option value in English, visualized after an equality sign.
hiddenOption
If true, the option is not displayed on the command line and the full option name must be typed in order to activate the option.
)
inherited fromGetBaseClass
Option index value (>0) or 0 if option cannot be added.

AddOption

Adds a command line option.
public int AddOption(
englishOption,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes).
englishOptionValue
The option value in English, visualized after an equality sign.
)
inherited fromGetBaseClass
Option index value (>0) or 0 if option cannot be added.

AddOption

Adds a command line option.
public int AddOption(
englishOption
Must only consist of letters and numbers (no characters list periods, spaces, or dashes).
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionColor

Add a command line option to get colors and automatically save the value.
public int AddOptionColor(
optionName,
option description.
colorValue,
The current color value.
prompt
option prompt shown if the user selects this option
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionColor

Add a command line option to get colors and automatically save the value.
public int AddOptionColor(
optionName,
option description
colorValue
The current color value.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionColor

Add a command line option to get colors and automatically save the value.
public int AddOptionColor(
englishName,
option description
colorValue,
The current color value.
prompt
The command prompt will show this during picking.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionColor

Add a command line option to get colors and automatically save the value.
public int AddOptionColor(
englishName,
option description
colorValue
The current color value.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionDouble

Adds a command line option to get numbers and automatically saves the value.
public int AddOptionDouble(
optionName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
numberValue,
The current number value.
prompt
option prompt shown if the user selects this option. If null or empty, then the option name is used as the get number prompt.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionDouble

Adds a command line option to get numbers and automatically save the value.
public int AddOptionDouble(
optionName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
numberValue
The current number value.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionDouble

Adds a command line option to get numbers and automatically save the value.
public int AddOptionDouble(
englishName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
numberValue,
Current value.
prompt
option prompt shown if the user selects this option. If null or empty, then the option name is used as the get number prompt.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionDouble

Adds a command line option to get numbers and automatically save the value.
public int AddOptionDouble(
englishName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
numberValue
The current number value.
)
inherited fromGetBaseClass
Option index value (>0) or 0 if option cannot be added.

AddOptionEnumList<T>

Adds a choice of enumerated values as list option. Allows to include only some enumerated values.
[CLSCompliant(false)] public int AddOptionEnumList<T>(
optionName,
The name of the option
T
defaultValue,
The default value
T[]
include
An array of enumerated values to use. This argument can also be null; in this case, the whole enumerated is used.
)
inherited fromGetBaseClass
Option index
ArgumentExceptionGets thrown if defaultValue provided is not an enumerated type.

AddOptionEnumList<T>

Adds a choice of enumerated values as list option
[CLSCompliant(false)] public int AddOptionEnumList<T>(
optionName,
The name of the option
T
defaultValue
The default value
)
inherited fromGetBaseClass
Option index
ArgumentExceptionGets thrown if defaultValue provided is not an enumerated type.

AddOptionEnumList<T>

Adds a choice of enumerated values as list option. Allows to include only some enumerated values.
[CLSCompliant(false)] public int AddOptionEnumList<T>(
englishOptionName,
The name of the option
T
defaultValue,
The default value
T[]
include
An array of enumerated values to use. This argument can also be null; in this case, the whole enumerated is used.
)
inherited fromGetBaseClass
Option index
ArgumentExceptionGets thrown if defaultValue provided is not an enumerated type.

AddOptionEnumList<T>

Adds a choice of enumerated values as list option
[CLSCompliant(false)] public int AddOptionEnumList<T>(
englishOptionName,
The name of the option
T
defaultValue
The default value
)
inherited fromGetBaseClass
Option index
ArgumentExceptionGets thrown if defaultValue provided is not an enumerated type.

AddOptionEnumSelectionList<T>

Adds a list of enumerated values as option list. Use enumSelection[go.Option.CurrentListOptionIndex] to retrieve selection.
[CLSCompliant(false)] public int AddOptionEnumSelectionList<T>(
optionName,
The name of the option
enumSelection,
The enumerated values to use.
listCurrentIndex
Zero based index of current option.
)
inherited fromGetBaseClass
Option index

AddOptionEnumSelectionList<T>

Adds a list of enumerated values as option list. Use enumSelection[go.Option.CurrentListOptionIndex] to retrieve selection.
[CLSCompliant(false)] public int AddOptionEnumSelectionList<T>(
englishOptionName,
enumSelection,
listCurrentIndex
)
inherited fromGetBaseClass

AddOptionInteger

Adds a command line option to get integers and automatically save the value.
public int AddOptionInteger(
optionName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
intValue,
The current integer value.
prompt
option prompt shown if the user selects this option. If null or empty, then the option name is used as the get number prompt.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionInteger

Adds a command line option to get integers and automatically save the value.
public int AddOptionInteger(
optionName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
intValue
The current integer value.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionInteger

Adds a command line option to get integers and automatically save the value.
public int AddOptionInteger(
englishName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
intValue,
The current integer value.
prompt
option prompt shown if the user selects this option. If null or empty, then the option name is used as the get number prompt.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionInteger

Adds a command line option to get integers and automatically save the value.
public int AddOptionInteger(
englishName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
intValue
The current integer value.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionList

Adds a command line list option.
public int AddOptionList(
optionName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
listValues,
The string values.
listCurrentIndex
Zero based index of current option.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionList

Adds a command line list option.
public int AddOptionList(
englishOptionName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
listValues,
The string values.
listCurrentIndex
Zero based index of current option.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionString

Add a command line option to get a string and automatically save the value.
public int AddOptionString(
optionName,
The option description.
stringValue,
The current string value.
prompt
Command prompt to be shown if the picks this option.
)
inherited fromGetBaseClass
The option index value (>0) or 0 if option cannot be added.

AddOptionString

Add a command line option to get a string and automatically save the value.
public int AddOptionString(
optionName,
The option description.
stringValue
The current string value.
)
inherited fromGetBaseClass
The option index value (>0) or 0 if option cannot be added.

AddOptionString

Add a command line option to get a string and automatically save the value.
public int AddOptionString(
englishName,
The option description.
stringValue,
The current string value.
prompt
Command prompt to be shown if the picks this option.
)
inherited fromGetBaseClass
The option index value (>0) or 0 if option cannot be added.

AddOptionString

Add a command line option to get a string and automatically save the value.
public int AddOptionString(
englishName,
The option description.
stringValue
The current string value.
)
inherited fromGetBaseClass
The option index value (>0) or 0 if option cannot be added.

AddOptionToggle

Adds a command line option to toggle a setting.
public int AddOptionToggle(
optionName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
toggleValue
The current toggle value.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AddOptionToggle

Adds a command line option to toggle a setting.
public int AddOptionToggle(
englishName,
Must only consist of letters and numbers (no characters list periods, spaces, or dashes)
toggleValue
The current toggle value.
)
inherited fromGetBaseClass
option index value (>0) or 0 if option cannot be added.

AppendToPickList

#Since v6.3
public void AppendToPickList(
objref
)

ClearCommandOptions

Clear all command options.
public void ClearCommandOptions()
inherited fromGetBaseClass

ClearDefault

Clears any defaults set using SetDefaultPoint, SetDefaultNumber, SetDefaultString, or SetCommandPromptDefault.
public void ClearDefault()
inherited fromGetBaseClass

ClearObjects

#Since v6.12
Clear possible special object drawing
public void ClearObjects()

Color

Gets a color if Get*() returns GetResult.Color.
public Color Color()
inherited fromGetBaseClass
The color chosen by the user.

CommandResult

Helper method for getting command result value from getter results.
public Result CommandResult()
inherited fromGetBaseClass
The converted command result.

CustomGeometryFilter

#Since v5.0
Checks geometry to see if it can be selected. Override to provide fancy filtering.
public virtual bool CustomGeometryFilter(
rhObject,
parent object being considered.
geometry,
geometry being considered.
componentIndex
if >= 0, geometry is a proper sub-part of object->Geometry() with componentIndex.
)
Remarks: The delegate should not throw exceptions. If an exception is thrown, a message box will show and the filter will be disabled.
The default returns true unless you've set a custom geometry filter. If a custom filter has been set, that delegate is called.

CustomMessage

public object CustomMessage()
inherited fromGetBaseClass

DisablePreSelect

#Since v5.0
public void DisablePreSelect()

Dispose

public void Dispose()
inherited fromGetBaseClass

Dispose

protected virtual void Dispose(
disposing
)
inherited fromGetBaseClass

EnableClearObjectsOnEntry

#Since v5.0
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().
public void EnableClearObjectsOnEntry(
enable
The state to set.
)

EnableHighlight

#Since v5.0
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.
public void EnableHighlight(
enable
)

EnableIgnoreGrips

#Since v5.0
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.
public void EnableIgnoreGrips(
enable
)

EnablePostSelect

#Since v5.0
Control the availability of post selection in GetObjects.
public void EnablePostSelect(
enable
)
Remarks: By default, if no valid input is pre-selected when GetObjects is called, then the user is given the chance to post select. If you want to force the user to pre-select, then call EnablePostSelect(false).

EnablePreSelect

#Since v5.0
Control the pre-selection behavior GetObjects.
public void EnablePreSelect(
enable,
if true, pre-selection is enabled.
ignoreUnacceptablePreselectedObjects
If true and some acceptable objects are pre-selected, then any unacceptable pre-selected objects are ignored. If false and any unacceptable are pre-selected, then the user is forced to post-select.
)
Remarks: By default, if valid input is pre-selected when GetObjects() is called, then that input is returned and the user is not given the opportunity to post-select. If you want to force the user to post-select, then call EnablePreSelect(false).

EnablePressEnterWhenDonePrompt

#Since v5.0
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;
public void EnablePressEnterWhenDonePrompt(
enable
)

EnableSelPrevious

#Since v5.0
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.
public void EnableSelPrevious(
enable
)

EnableTransparentCommands

Control the availability of transparent commands during the get.
public void EnableTransparentCommands(
enable
If true, then transparent commands can be run during the get. If false, then transparent commands cannot be run during the get.
)
inherited fromGetBaseClass
Remarks: Some Rhino commands are "transparent" and can be run inside of other commands. Examples of transparent commands include the view manipulation commands like ZoomExtents, Top, etc., and the selection commands like SelAll, SelPoint, etc. By default transparent commands can be run during any get. If you want to disable this feature, then call EnableTransparentCommands(false) before calling GetString, GetPoint, GetObject, etc.

EnableUnselectObjectsOnExit

#Since v5.0
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().
public void EnableUnselectObjectsOnExit(
enable
The state to set.
)

Get

#Since v5.0
Call to select a single object.
[CLSCompliant(false)] public GetResult Get()
GetResult.Object if an object was selected. GetResult.Cancel if the user pressed ESCAPE to cancel the selection. See GetResults for other possible values that may be returned when options, numbers, etc., are acceptable responses.

GetMultiple

#ExampleSince v5.0
Call to select objects.
[CLSCompliant(false)] public GetResult GetMultiple(
minimumNumber,
minimum number of objects to select.
maximumNumber
maximum number of objects to select. If 0, then the user must press enter to finish object selection. If -1, then object selection stops as soon as there are at least minimumNumber of object selected. If >0, then the picking stops when there are maximumNumber objects. If a window pick, crossing pick, or Sel* command attempts to add more than maximumNumber, then the attempt is ignored.
)
GetResult.Object if one or more objects were selected. GetResult.Cancel if the user pressed ESCAPE to cancel the selection. See GetResults for other possible values that may be returned when options, numbers, etc., are acceptable responses.

GetSelectedEnumValue<T>

Returns the selected enumerated value. Use this in combination with GetBaseClass.AddOptionEnumList<T>(string, T).

This must be called directly after having called a Get method, and having obtained a GetResult.Option value.

[CLSCompliant(false)] public T GetSelectedEnumValue<T>()
inherited fromGetBaseClass
ArgumentExceptionGets thrown if type T is not an enumerated type.
IndexOutOfRangeExceptionIf 0 >= CurrentListOptionIndex or CurrentListOptionIndex > N where N is the number of enumerated values.

GetSelectedEnumValueFromSelectionList<T>

Returns the selected enumerated value by looking at the list of values from which to select. Use this in combination with AddOptionEnumSelectionList.
[CLSCompliant(false)] public T GetSelectedEnumValueFromSelectionList<T>(
selectionList
)
inherited fromGetBaseClass
ArgumentExceptionGets thrown if type T is not an enumerated type.
IndexOutOfRangeExceptionIf 0 >= CurrentListOptionIndex or CurrentListOptionIndex > N where N is the number of enumerated values.

GotDefault

Returns true if user pressed Enter to accept a default point, number, or string set using SetDefaultPoint, SetDefaultNumber, or SetDefaultString.
public bool GotDefault()
inherited fromGetBaseClass
true if the result if the default point, number or string set. Otherwise, false.

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.

public Point[] Line2d()
inherited fromGetBaseClass
An array with two 2D points.

Number

Gets a number if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.Number.
public double Number()
inherited fromGetBaseClass
The number chosen by the user.

Object

#ExampleSince v5.0
public ObjRef Object(
index
)

Objects

#Since v5.0
public ObjRef[] Objects()

OptionIndex

public int OptionIndex()
inherited fromGetBaseClass

PassesGeometryAttributeFilter

#Since v5.0
Checks geometry to see if it passes the basic GeometryAttributeFilter.
public bool PassesGeometryAttributeFilter(
rhObject,
parent object being considered.
geometry,
geometry being considered.
componentIndex
if >= 0, geometry is a proper sub-part of object->Geometry() with componentIndex.
)
true if the geometry passes the filter returned by 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;
public Rectangle PickRectangle()
inherited fromGetBaseClass
The picking rectangle; or 0 in the specified cases.

Point

Gets a point if Get*() returns GetResult.Point.
public Point3d Point()
inherited fromGetBaseClass
The point chosen by the user.

Point2d

Returns location in view of point in selected in GetPoint::Get() or GetPoint::Get2dPoint(). (0,0) = upper left corner of window.
public Point Point2d()
inherited fromGetBaseClass
The location.

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.
public Rectangle Rectangle2d()
inherited fromGetBaseClass
The rectangle.

Result

Returns result of the Get*() call.
[CLSCompliant(false)] public GetResult Result()
inherited fromGetBaseClass
The result of the last Get*() call.

SetCommandPrompt

Sets prompt message that appears in the command prompt window.
public void SetCommandPrompt(
prompt
command prompt message.
)
inherited fromGetBaseClass

SetCommandPromptDefault

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.
public void SetCommandPromptDefault(
defaultValue
description of default value.
)
inherited fromGetBaseClass
Remarks: If you have a simple default point, number, or string, it is easier to use SetDefaultPoint, SetDefaultNumber, or SetDefaultString. SetCommandPromptDefault and AcceptNothing can be used for providing more advanced UI behavior.
ON_3dPoint default_center = new ON_3dPoint(2,3,4); GetPoint gp = new GetPoint(); gp.SetCommandPrompt( "Center point" ); gp.SetCommandPromptDefault( "(2,3,4)" ); gp.AcceptNothing(true); gp.GetPoint(); if ( gp.Result() == GetResult.Nothing ) point = default_center;

SetCustomGeometryFilter

#ExampleSince v5.0
Set filter callback function that will be called by the CustomGeometryFilter
public void SetCustomGeometryFilter()

SetDefaultColor

Sets a color as default value that will be returned if the user presses ENTER key during the get.
public void SetDefaultColor(
defaultColor
value for default color.
)
inherited fromGetBaseClass
Remarks: Calling SetDefaultColor will automatically handle setting the command prompt default and reacting to the user pressing ENTER. If the user presses ENTER to accept the default color, GetResult.Color is returned and RhinoGet.GotDefault() will return true. Calling SetDefaultColor will clear any previous calls to SetDefaultString or SetDefaultPoint.

SetDefaultInteger

Sets a number as default value that will be returned if the user presses ENTER key during the get.
public void SetDefaultInteger(
defaultValue
value for default number.
)
inherited fromGetBaseClass
Remarks: Calling SetDefaultInteger will automatically handle setting the command prompt default and reacting to the user pressing ENTER. If the user presses ENTER to accept the default integer, GetResult.Number is returned and CRhinoGet.GotDefault() will return true. Calling SetDefaultNumber will clear any previous calls to SetDefaultString or SetDefaultPoint.

SetDefaultNumber

Sets a number as default value that will be returned if the user presses ENTER key during the get.
public void SetDefaultNumber(
defaultNumber
value for default number.
)
inherited fromGetBaseClass
Remarks: Calling SetDefaultNumber will automatically handle setting the command prompt default and reacting to the user pressing ENTER. If the user presses ENTER to accept the default number, GetResult.Number is returned and RhinoGet.GotDefault() will return true. Calling SetDefaultNumber will clear any previous calls to SetDefaultString or SetDefaultPoint.

SetDefaultPoint

Sets a point as default value that will be returned if the user presses the ENTER key during the get.
public void SetDefaultPoint(
point
value for default point.
)
inherited fromGetBaseClass
Remarks: Calling SetDefaultPoint will automatically handle setting the command prompt default and reacting to the user pressing ENTER. If the user presses enter to accept the default point, GetResult.Point is returned and RhinoGet.GotDefault() will return true. Calling SetDefaultPoint will clear any previous calls to SetDefaultString or SetDefaultNumber.

SetDefaultString

Sets a string as default value that will be returned if the user presses ENTER key during the get.
public void SetDefaultString(
defaultValue
value for default string.
)
inherited fromGetBaseClass
Remarks: Calling SetDefaultString will automatically handle setting the command prompt default and reacting to the user pressing ENTER. If the user presses ENTER to accept the default string, GetResult.String is returned and RhinoGet.GotDefault() will return true. Calling SetDefaultString will clear any previous calls to SetDefaultNumber or SetDefaultPoint.

SetOptionVaries

Sets a command line option value to print "Varies" instead of the regular value.
public void SetOptionVaries(
optionIndex,
The option index.
varies
True to print "Varies", false to print the option's current value.
)
inherited fromGetBaseClass

SetPressEnterWhenDonePrompt

#Since v5.0
The default prompt when EnablePressEnterWhenDonePrompt is enabled is "Press Enter when done". Use this function to specify a different string to be appended.
public void SetPressEnterWhenDonePrompt(
prompt
The text that will be displayed just after the prompt, after the selection has been made.
)

SetWaitDuration

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.
public void SetWaitDuration(
milliseconds
Number of milliseconds to wait.
)
inherited fromGetBaseClass

StringResult

Gets a string if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.String.
public string StringResult()
inherited fromGetBaseClass
The string chosen by the user.

Vector

Gets a direction if Get*() returns GetResult.Point (Set by some digitizers, but in general it's (0,0,0).
public Vector3d Vector()
inherited fromGetBaseClass
The vector chosen by the user.

View

Gets a view the user clicked in during GetPoint.Get(), GetObject.GetObjects(), etc.
public RhinoView View()
inherited fromGetBaseClass
The view chosen by the user.