GetBaseClass

References
public abstract class GetBaseClass : IDisposable
Base class for GetObject, GetPoint, GetSphere, etc. You will never directly create a GetBaseClass but you will use its member functions after calling GetObject.Gets(), GetPoint.Get(), and so on. Provides tools to set command prompt, set command options, and specify if the "get" can optionally accept numbers, nothing (pressing enter), and undo.

Finalizer

~GetBaseClass

#
~GetBaseClass()

Methods

AcceptColor

#Since v5.0
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.
)

AcceptCustomMessage

#Since v5.0
public void AcceptCustomMessage(
enable
)

AcceptEnterWhenDone

#Since v6.0
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
)

AcceptNothing

#ExampleSince v5.0
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.
)

AcceptNumber

#Since v5.0
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.
)

AcceptPoint

#Since v5.0
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.
)

AcceptString

#Since v5.0
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.
)

AcceptUndo

#Since v5.0
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.
)

AddOption

#Since v6.9
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.
)
option index value (>0) or 0 if option cannot be added.

AddOption

#Since v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOption

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

AddOption

#Since v6.9
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.
)
Option index value (>0) or 0 if option cannot be added.

AddOption

#Since v5.0
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.
)
Option index value (>0) or 0 if option cannot be added.

AddOption

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

AddOptionColor

#Since v5.0
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
)
option index value (>0) or 0 if option cannot be added.

AddOptionColor

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

AddOptionColor

#Since v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionColor

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

AddOptionDouble

#Since v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionDouble

#ExampleSince v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionDouble

#Since v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionDouble

#ExampleSince v5.0
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.
)
Option index value (>0) or 0 if option cannot be added.

AddOptionEnumList<T>

#Since v8.37
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.
)
Option index
ArgumentExceptionGets thrown if defaultValue provided is not an enumerated type.

AddOptionEnumList<T>

#Since v8.37
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
)
Option index
ArgumentExceptionGets thrown if defaultValue provided is not an enumerated type.

AddOptionEnumList<T>

#Since v6.0
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.
)
Option index
ArgumentExceptionGets thrown if defaultValue provided is not an enumerated type.

AddOptionEnumList<T>

#Since v5.4
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
)
Option index
ArgumentExceptionGets thrown if defaultValue provided is not an enumerated type.

AddOptionEnumSelectionList<T>

#Since v8.37
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.
)
Option index

AddOptionEnumSelectionList<T>

#Since v5.4
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
)

AddOptionInteger

#Since v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionInteger

#ExampleSince v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionInteger

#Since v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionInteger

#ExampleSince v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionList

#ExampleSince v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionList

#ExampleSince v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionString

#Since v9.0
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.
)
The option index value (>0) or 0 if option cannot be added.

AddOptionString

#Since v9.0
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.
)
The option index value (>0) or 0 if option cannot be added.

AddOptionString

#Since v9.0
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.
)
The option index value (>0) or 0 if option cannot be added.

AddOptionString

#Since v9.0
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.
)
The option index value (>0) or 0 if option cannot be added.

AddOptionToggle

#ExampleSince v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

AddOptionToggle

#ExampleSince v5.0
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.
)
option index value (>0) or 0 if option cannot be added.

ClearCommandOptions

#ExampleSince v5.0
Clear all command options.
public void ClearCommandOptions()

ClearDefault

#Since v5.0
Clears any defaults set using SetDefaultPoint, SetDefaultNumber, SetDefaultString, or SetCommandPromptDefault.
public void ClearDefault()

Color

#Since v5.0
Gets a color if Get*() returns GetResult.Color.
public Color Color()
The color chosen by the user.

CommandResult

#ExampleSince v5.0
Helper method for getting command result value from getter results.
public Result CommandResult()
The converted command result.

CustomMessage

#Since v5.0
public object CustomMessage()

Dispose

#Since v5.0
public void Dispose()

Dispose

#
protected virtual void Dispose(
disposing
)

EnableTransparentCommands

#Since v5.0
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.
)
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.

GetSelectedEnumValue<T>

#Since v5.4
Returns the selected enumerated value. Use this in combination with 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>()
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>

#Since v5.4
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
)
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

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

IsValidOptionName

#Since v8.24
Test a string to see if it can be used as an option name in any of the AddOption...() functions.
public static bool IsValidOptionName(
optionName
String to test.
)
True if string can be used as an option name.

IsValidOptionValueName

#Since v8.24
Test a string to see if it can be used as an option value name in the AddOption, AddOptionToggle, AddOptionList functions.
public static bool IsValidOptionValueName(
optionValueName
)
True if string can be used as an option value.

Line2d

#Since v5.0
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()
An array with two 2D points.

Number

#ExampleSince v5.0
Gets a number if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.Number.
public double Number()
The number chosen by the user.

Option

#Since v5.0
public CommandLineOption Option()

OptionIndex

#Since v5.0
public int OptionIndex()

PickRectangle

#Since v5.0
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()
The picking rectangle; or 0 in the specified cases.

Point

#ExampleSince v5.0
Gets a point if Get*() returns GetResult.Point.
public Point3d Point()
The point chosen by the user.

Point2d

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

PostCustomMessage

#Since v5.0
public static void PostCustomMessage(
messageData
)

Rectangle2d

#Since v5.0
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()
The rectangle.

Result

#Since v5.0
Returns result of the Get*() call.
[CLSCompliant(false)] public GetResult Result()
The result of the last Get*() call.

SetCommandPrompt

#ExampleSince v5.0
Sets prompt message that appears in the command prompt window.
public void SetCommandPrompt(
prompt
command prompt message.
)

SetCommandPromptDefault

#Since v5.0
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.
)
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;

SetDefaultColor

#Since v5.0
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.
)
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

#Since v5.0
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.
)
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

#Since v5.0
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.
)
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

#Since v5.0
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.
)
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

#ExampleSince v5.0
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.
)
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

#Since v8.0
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.
)

SetWaitDuration

#Since v5.0
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.
)

StringResult

#ExampleSince v5.0
Gets a string if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.String.
public string StringResult()
The string chosen by the user.

Vector

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

View

#ExampleSince v5.0
Gets a view the user clicked in during GetPoint.Get(), GetObject.GetObjects(), etc.
public RhinoView View()
The view chosen by the user.