GetBase

Public 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 Hierarchy

System.Object
Rhino.Input.Custom.GetBaseClass

Namespace: Rhino.Input.Custom

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public abstract class GetBaseClass : IDisposable

The GetBaseClass type exposes the following members.

Constructors

Name

Description

---

Protected Method

GetBaseClass

Initializes a new instance of the GetBaseClass class

---

Methods

Name

Description

---

Public Method

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 Method

AcceptCustomMessage

---

Public Method

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 Method
Code Example

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 Method

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 Method

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 Method

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 Method

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 Method

AddOption(LocalizeStringPair)

Adds a command line option.

---

Public Method
Code Example

AddOption(String)

Adds a command line option.

---

Public Method

AddOption(LocalizeStringPair, LocalizeStringPair)

Adds a command line option.

---

Public Method

AddOption(String, String)

Adds a command line option.

---

Public Method

AddOption(LocalizeStringPair, LocalizeStringPair, Boolean)

Adds a command line option.

---

Public Method

AddOption(String, String, Boolean)

Adds a command line option.

---

Public Method

AddOptionColor(LocalizeStringPair, OptionColor.)

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

---

Public Method

AddOptionColor(String, OptionColor.)

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

---

Public Method

AddOptionColor(LocalizeStringPair, OptionColor., String)

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

---

Public Method

AddOptionColor(String, OptionColor., String)

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

---

Public Method
Code Example

AddOptionDouble(LocalizeStringPair, OptionDouble.)

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

---

Public Method
Code Example

AddOptionDouble(String, OptionDouble.)

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

---

Public Method

AddOptionDouble(LocalizeStringPair, OptionDouble., String)

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

---

Public Method

AddOptionDouble(String, OptionDouble., String)

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

---

Public Method

AddOptionEnumList.T.(String, T)

Adds a choice of enumerated values as list option

---

Public Method

AddOptionEnumList.T.(String, T, .T.)

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

---

Public Method

AddOptionEnumSelectionList.T.

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

---

Public Method
Code Example

AddOptionInteger(LocalizeStringPair, OptionInteger.)

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

---

Public Method
Code Example

AddOptionInteger(String, OptionInteger.)

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

---

Public Method

AddOptionInteger(LocalizeStringPair, OptionInteger., String)

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

---

Public Method

AddOptionInteger(String, OptionInteger., String)

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

---

Public Method
Code Example

AddOptionList(LocalizeStringPair, IEnumerable.LocalizeStringPair., Int32)

Adds a command line list option.

---

Public Method
Code Example

AddOptionList(String, IEnumerable.String., Int32)

Adds a command line list option.

---

Public Method
Code Example

AddOptionToggle(LocalizeStringPair, OptionToggle.)

Adds a command line option to toggle a setting.

---

Public Method
Code Example

AddOptionToggle(String, OptionToggle.)

Adds a command line option to toggle a setting.

---

Public Method
Code Example

ClearCommandOptions

Clear all command options.

---

Public Method

ClearDefault

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

---

Public Method

Color

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

---

Public Method
Code Example

CommandResult

Helper method for getting command result value from getter results.

---

Public Method

CustomMessage

---

Public Method

Dispose.

Releases all resources used by the GetBaseClass

---

Protected Method

Dispose(Boolean)

Releases the unmanaged resources used by the GetBaseClass and optionally releases the managed resources

---

Public Method
EnableTransparentCommands

Control the availability of transparent commands during the get.

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

(Overrides Object.Finalize..)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetSelectedEnumValue.T.

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 Option value.

---

Public Method

GetSelectedEnumValueFromSelectionList.T.

Returns the selected enumerated value by looking at the list of values from which to select. Use this in combination with

AddOptionEnumSelectionList.T.(String, IEnumerable.T., Int32)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

GotDefault

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

---

Public Method

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.

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method
Code Example

Number

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

---

Public Method

Option

---

Public Method

OptionIndex

---

Public Method

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 Method
Code Example

Point

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

---

Public Method

Point2d

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

---

Public Method
Static Member

PostCustomMessage

---

Public Method

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 Method

Result

Returns result of the Get*() call.

---

Public Method
Code Example

SetCommandPrompt

Sets prompt message that appears in the command prompt window.

---

Public Method
Code Example
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 Method
SetDefaultColor

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

---

Public Method
SetDefaultInteger

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

---

Public Method
SetDefaultNumber

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

---

Public Method
SetDefaultPoint

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

---

Public Method
Code Example
SetDefaultString

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

---

Public Method

SetOptionVaries

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

---

Public Method

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 Method
Code Example

StringResult

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

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Public Method

Vector

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

---

Public Method
Code Example

View

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

---

Inheritance Hierarchy

System.Object
Rhino.Input.Custom.GetBaseClass
Rhino.Input.Custom.GetCancel
Rhino.Input.Custom.GetInteger
Rhino.Input.Custom.GetNumber
Rhino.Input.Custom.GetObject
Rhino.Input.Custom.GetOption
Rhino.Input.Custom.GetPoint
Rhino.Input.Custom.GetString