Click or drag to resize
GetNumber Class
Used to get double precision numbers.
Inheritance Hierarchy

Namespace: Rhino.Input.Custom
Assembly: RhinoCommon (in RhinoCommon.dll) Version: 5.1.50000.0 (5.0.20693.0)
Syntax
public class GetNumber : GetBaseClass

The GetNumber type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleGetNumber
Create a new GetNumber.
Top
Methods
  NameDescription
Public methodAcceptColor
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.
(Inherited from GetBaseClass.)
Public methodAcceptCustomMessage (Inherited from GetBaseClass.)
Public methodCode exampleAcceptNothing
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.
(Inherited from GetBaseClass.)
Public methodAcceptNumber
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.
(Inherited from GetBaseClass.)
Public methodAcceptPoint
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.
(Inherited from GetBaseClass.)
Public methodAcceptString
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.
(Inherited from GetBaseClass.)
Public methodAcceptUndo
If you want to allow the user to have an 'undo' option in GetPoint.Get(), GetObject.GetObjects(), etc., then call AcceptUndo(true) beforehand.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOption(String)
Adds a command line option.
(Inherited from GetBaseClass.)
Public methodAddOption(LocalizeStringPair)
Adds a command line option.
(Inherited from GetBaseClass.)
Public methodAddOption(String, String)
Adds a command line option.
(Inherited from GetBaseClass.)
Public methodAddOption(LocalizeStringPair, LocalizeStringPair)
Adds a command line option.
(Inherited from GetBaseClass.)
Public methodAddOptionColor(String, OptionColor)
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionColor(LocalizeStringPair, OptionColor)
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionColor(String, OptionColor, String)
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionColor(LocalizeStringPair, OptionColor, String)
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionDouble(String, OptionDouble)
Adds a command line option to get numbers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionDouble(LocalizeStringPair, OptionDouble)
Adds a command line option to get numbers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionDouble(String, OptionDouble, String)
Adds a command line option to get numbers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionDouble(LocalizeStringPair, OptionDouble, String)
Adds a command line option to get numbers and automatically saves the value.
(Inherited from GetBaseClass.)
Public methodAddOptionEnumListT
Add a choice of enum values as list option
(Inherited from GetBaseClass.)
Public methodAddOptionEnumSelectionListT
Add a list of enum values as option list. Use enumSelection[go.Option.CurrentListOptionIndex] to retrieve selection.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionInteger(String, OptionInteger)
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionInteger(LocalizeStringPair, OptionInteger)
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionInteger(String, OptionInteger, String)
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionInteger(LocalizeStringPair, OptionInteger, String)
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionList(String, IEnumerableString, Int32)
Adds a command line list option.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionList(LocalizeStringPair, IEnumerableLocalizeStringPair, Int32)
Adds a command line list option.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionToggle(String, OptionToggle)
Adds a command line option to toggle a setting.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionToggle(LocalizeStringPair, OptionToggle)
Adds a command line option to toggle a setting.
(Inherited from GetBaseClass.)
Public methodCode exampleClearCommandOptions
Clear all command options.
(Inherited from GetBaseClass.)
Public methodClearDefault
Clears any defaults set using SetDefaultPoint, SetDefaultNumber, SetDefaultString, or SetCommandPromptDefault.
(Inherited from GetBaseClass.)
Public methodColor
Gets a color if Get*() returns GetResult.Color.
(Inherited from GetBaseClass.)
Public methodCode exampleCommandResult
Helper method for getting command result value from getter results.
(Inherited from GetBaseClass.)
Public methodCustomMessage (Inherited from GetBaseClass.)
Public methodDispose (Inherited from GetBaseClass.)
Protected methodDispose(Boolean) (Inherited from GetBaseClass.)
Public methodEnableTransparentCommands
Control the availability of transparent commands during the get.
(Inherited from GetBaseClass.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize (Inherited from GetBaseClass.)
Public methodCode exampleGet
Call to get a number.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetSelectedEnumValueT (Inherited from GetBaseClass.)
Public methodGetSelectedEnumValueFromSelectionListT (Inherited from GetBaseClass.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGotDefault
Returns true if user pressed Enter to accept a default point, number, or string set using SetDefaultPoint, SetDefaultNumber, or SetDefaultString.
(Inherited from GetBaseClass.)
Public methodLine2d
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.

(Inherited from GetBaseClass.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodCode exampleNumber
Gets a number if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.Number.
(Inherited from GetBaseClass.)
Public methodOption (Inherited from GetBaseClass.)
Public methodOptionIndex (Inherited from GetBaseClass.)
Public methodPickRectangle
If the get was a GetObjects() and the mouse was used to select the objects, then the returned rect has left < right and top < bottom. This rect 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;
(Inherited from GetBaseClass.)
Public methodCode examplePoint
Gets a point if Get*() returns GetResult.Point.
(Inherited from GetBaseClass.)
Public methodPoint2d
Returns location in view of point in selected in GetPoint::Get() or GetPoint::Get2dPoint(). (0,0) = upper left corner of window.
(Inherited from GetBaseClass.)
Public methodRectangle2d
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.
(Inherited from GetBaseClass.)
Public methodResult
Returns result of the Get*() call.
(Inherited from GetBaseClass.)
Public methodCode exampleSetCommandPrompt
Sets prompt message that appears in the command prompt window.
(Inherited from GetBaseClass.)
Public methodCode exampleSetCommandPromptDefault
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 explicity enable AcceptNothing.
(Inherited from GetBaseClass.)
Public methodSetDefaultColor
Sets a color as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.)
Public methodSetDefaultInteger
Sets a number as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.)
Public methodSetDefaultNumber
Sets a number as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.)
Public methodSetDefaultPoint
Sets a point as default value that will be returned if the user presses the ENTER key during the get.
(Inherited from GetBaseClass.)
Public methodCode exampleSetDefaultString
Sets a string as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.)
Public methodCode exampleSetLowerLimit
Sets a lower limit on the number that can be returned. By default there is no lower limit.
Public methodSetUpperLimit
Sets an upper limit on the number that can be returned. By default there is no upper limit.
Public methodSetWaitDuration
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.
(Inherited from GetBaseClass.)
Public methodCode exampleStringResult
Gets a string if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.String.
(Inherited from GetBaseClass.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodVector
Gets a direction if Get*() returns GetResult.Point (Set by some digitizers, but in general it's (0,0,0).
(Inherited from GetBaseClass.)
Public methodCode exampleView
Gets a view the user clicked in during GetPoint.Get(), GetObject.GetObjects(), etc.
(Inherited from GetBaseClass.)
Top
See Also