GetBaseClass Class |
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.
Inheritance HierarchyNamespace: Rhino.Input.Custom
Assembly: RhinoCommon (in RhinoCommon.dll)
SyntaxThe GetBaseClass type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GetBaseClass | Initializes a new instance of the GetBaseClass class |
Methods| Name | Description | |
|---|---|---|
 | 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.
|
| AcceptCustomMessage | |
| 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.
|
 | 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.
|
| 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.
|
| 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.
|
| 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.
|
| AcceptUndo |
If you want to allow the user to have an 'undo' option in GetPoint.Get(),
GetObject.GetObjects(), etc., then call AcceptUndo(true) beforehand.
|
| AddOption(LocalizeStringPair) |
Adds a command line option.
|
| AddOption(String) |
Adds a command line option.
|
| AddOption(LocalizeStringPair, LocalizeStringPair) |
Adds a command line option.
|
| AddOption(String, String) |
Adds a command line option.
|
| AddOption(LocalizeStringPair, LocalizeStringPair, Boolean) |
Adds a command line option.
|
| AddOption(String, String, Boolean) |
Adds a command line option.
|
| AddOptionColor(LocalizeStringPair, OptionColor) |
Add a command line option to get colors and automatically save the value.
|
| AddOptionColor(String, OptionColor) |
Add a command line option to get colors and automatically save the value.
|
| AddOptionColor(LocalizeStringPair, OptionColor, String) |
Add a command line option to get colors and automatically save the value.
|
| AddOptionColor(String, OptionColor, String) |
Add a command line option to get colors and automatically save the value.
|
| AddOptionDouble(LocalizeStringPair, OptionDouble) |
Adds a command line option to get numbers and automatically save the value.
|
| AddOptionDouble(String, OptionDouble) |
Adds a command line option to get numbers and automatically save the value.
|
| AddOptionDouble(LocalizeStringPair, OptionDouble, String) |
Adds a command line option to get numbers and automatically saves the value.
|
| AddOptionDouble(String, OptionDouble, String) |
Adds a command line option to get numbers and automatically save the value.
|
| AddOptionEnumListT(String, T) |
Adds a choice of enumerated values as list option
|
| AddOptionEnumListT(String, T, T) |
Adds a choice of enumerated values as list option. Allows to include only some enumerated values.
|
| AddOptionEnumSelectionListT |
Adds a list of enumerated values as option list. Use enumSelection[go.Option.CurrentListOptionIndex] to retrieve selection.
|
| AddOptionInteger(LocalizeStringPair, OptionInteger) |
Adds a command line option to get integers and automatically save the value.
|
| AddOptionInteger(String, OptionInteger) |
Adds a command line option to get integers and automatically save the value.
|
| AddOptionInteger(LocalizeStringPair, OptionInteger, String) |
Adds a command line option to get integers and automatically save the value.
|
| AddOptionInteger(String, OptionInteger, String) |
Adds a command line option to get integers and automatically save the value.
|
| AddOptionList(LocalizeStringPair, IEnumerableLocalizeStringPair, Int32) |
Adds a command line list option.
|
| AddOptionList(String, IEnumerableString, Int32) |
Adds a command line list option.
|
| AddOptionToggle(LocalizeStringPair, OptionToggle) |
Adds a command line option to toggle a setting.
|
| AddOptionToggle(String, OptionToggle) |
Adds a command line option to toggle a setting.
|
| ClearCommandOptions | Clear all command options. |
| ClearDefault |
Clears any defaults set using SetDefaultPoint, SetDefaultNumber, SetDefaultString, or SetCommandPromptDefault.
|
| Color | Gets a color if Get*() returns GetResult.Color. |
| CommandResult |
Helper method for getting command result value from getter results.
|
| CustomMessage | |
| Dispose | Releases all resources used by the GetBaseClass |
| Dispose(Boolean) | Releases the unmanaged resources used by the GetBaseClass and optionally releases the managed resources |
| EnableTransparentCommands |
Control the availability of transparent commands during the get.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | (Overrides ObjectFinalize.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetSelectedEnumValueT |
Returns the selected enumerated value. Use this in combination with AddOptionEnumListT(String, T).
This must be called directly after having called a Get method, and having obtained a Option value. |
| GetSelectedEnumValueFromSelectionListT |
Returns the selected enumerated value by looking at the list of values from which to select.
Use this in combination with AddOptionEnumSelectionListT(String, IEnumerableT, Int32) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| 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. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Number |
Gets a number if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.Number.
|
| Option | |
| OptionIndex | |
| 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 | |
| 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 |
Sets prompt message that appears in the command prompt window.
|
| 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.
|
| SetDefaultColor |
Sets a color as default value that will be returned if the user presses ENTER key during the get.
|
| SetDefaultInteger |
Sets a number as default value that will be returned if the user presses ENTER key during the get.
|
| SetDefaultNumber |
Sets a number as default value that will be returned if the user presses ENTER key during the get.
|
| SetDefaultPoint |
Sets a point as default value that will be returned if the user presses the ENTER key during the get.
|
| SetDefaultString |
Sets a string as default value that will be returned
if the user presses ENTER key during the get.
|
| SetOptionVaries |
Sets a command line option value to print "Varies" instead of the regular value.
|
| 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.
|
| StringResult |
Gets a string if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.String.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| 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.
|
See AlsoReference
Inheritance Hierarchy