public class GetPoint : GetBaseClass
Used to interactively get a point.

Constructors

GetPoint

#ExampleSince v5.0
Create a new GetPoint.
public GetPoint()

Properties

DynamicDrawColor

#Since v5.0
Color used by CRhinoGetPoint::DynamicDraw to draw the current point and the line from the base point to the current point.
public Color DynamicDrawColor { get; set; }

FullFrameRedrawDuringGet

#Since v5.0
In the "RARE" case that you need to draw some depth buffered geometry during a Get() operation, setting this value to true will force entire frames to be redrawn while the user moves the mouse. This allows DisplayPipeline events to be triggered as well as OnPostDrawObjects NOTE!! Setting this value to true comes with a significant performance penalty because the scene needs to be fully regenerated every frame where the standard DynamicDraw event draws temporary decorations (geometry) on top of a static scene.
public bool FullFrameRedrawDuringGet { get; set; }

OsnapEventType

#Since v6.24
Gets the type of object snap used to obtain the point.
public OsnapModes OsnapEventType { get; }

Tag

#ExampleSince v5.0
Gets or sets an arbitrary object that can be attached to this GetPoint instance. Useful for passing some/ information that you may need in a DynamicDraw event since you can get at this Tag from the GetPointDrawEventArgs.
public object Tag { 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

AddConstructionPoint

#Since v5.0
Adds a point to the list of construction points.
public int AddConstructionPoint(
point
A point to be added.
)
Remarks: Construction points are like snap points except that they get snapped to even when point osnap is off. Typically, there are only a few construction points while there can be many snap points. For example, when polylines are drawn the start point is a construction point and the other points are snap points.
Total number of construction points.

AddConstructionPoints

#Since v5.0
Adds points to the list of construction points.
public int AddConstructionPoints(
points
An array of points to be added.
)
Remarks: Construction points are like snap points except that they get snapped to even when point osnap is off. Typically, there are only a few construction points while there can be many snap points. For example, when polylines are drawn the start point is a construction point and the other points are snap points.
Total number of construction points.

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.

AddSnapPoint

#Since v5.0
Adds a point to the list of osnap points.
public int AddSnapPoint(
point
A point.
)
Remarks: When point osnap is enabled, GetPoint will snap to points in the Rhino model. If you want the user to be able to snap to additional points, then use GetPoint::AddSnapPoints to specify the locations of these additional points.
Total number of snap points.

AddSnapPoints

#Since v5.0
Adds points to the list of osnap points.
public int AddSnapPoints(
points
An array of points to snap onto.
)
Remarks: When point osnap is enabled, GetPoint will snap to points in the Rhino model. If you want the user to be able to snap to additional points, then use GetPoint::AddSnapPoints to specify the locations of these additional points.
Total number of snap points.

ClearCommandOptions

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

ClearConstraints

#ExampleSince v5.0
Removes any explicit constraints added by calls to GetPoint::Constraint() and enable the built-in constraint options.
public void ClearConstraints()

ClearConstructionPoints

#Since v5.0
Remove all construction points.
public void ClearConstructionPoints()
Remarks: Construction points are like snap points except that they get snapped to even when point osnap is off. Typically, there are only a few construction points while there can be many snap points. For example, when polylines are drawn the start point is a construction point and the other points are snap points.

ClearDefault

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

ClearSnapPoints

#Since v5.0
Remove all snap points.
public void ClearSnapPoints()
Remarks: When point osnap is enabled, GetPoint will snap to points in the Rhino model. If you want the user to be able to snap to additional points, then use GetPoint::AddSnapPoints to specify the locations of these additional points.

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.

Constrain

#Since v5.0
Constrains the picked point to lie on an arc.
public bool Constrain(
arc
An arc to use as constraint.
)
true if constraint could be applied.

Constrain

#Since v5.0
Constrains the picked point to lie on a brep.
public bool Constrain(
brep,
A brep to use as constraint.
wireDensity,
When wire_density<0, isocurve intersection snapping is turned off, when wire_density>=0, the value defines the isocurve density used for isocurve intersection snapping.
faceIndex,
When face_index <0, constrain to whole brep. When face_index >=0, constrain to individual face.
allowPickingPointOffObject
defines whether the point pick is allowed to happen off object. When false, a "no no" cursor is shown when the cursor is not on the object. When true, a normal point picking cursor is used and the marker is visible also when the cursor is not on the object.
)
true if constraint could be applied.

Constrain

#Since v5.0
Constrains the picked point to lie on a circle.
public bool Constrain(
circle
A circle to use as constraint.
)
true if constraint could be applied.

Constrain

#ExampleSince v5.0
Constrains the picked point to lie on a curve.
public bool Constrain(
curve,
A curve to use as constraint.
allowPickingPointOffObject
defines whether the point pick is allowed to happen off object. When false, a "no no" cursor is shown when the cursor is not on the object. When true, a normal point picking cursor is used and the marker is visible also when the cursor is not on the object.
)
true if constraint could be applied.

Constrain

#Since v5.0
Constrains the picked point to lie on a cylinder.
public bool Constrain(
cylinder
A cylinder to use as constraint.
)
true if constraint could be applied.

Constrain

#ExampleSince v5.0
Constrains the picked point to lie on a line.
public bool Constrain(
line
A line to use as constraint.
)
true if constraint could be applied.

Constrain

#Since v5.0
Constrains the picked point to lie on a mesh.
public bool Constrain(
Mesh
mesh,
A mesh to use as constraint.
allowPickingPointOffObject
defines whether the point pick is allowed to happen off object. When false, a "no no" cursor is shown when the cursor is not on the object. When true, a normal point picking cursor is used and the marker is visible also when the cursor is not on the object.
)
true if constraint could be applied.

Constrain

#Since v5.0
constrain the picked point to lie on a plane.
public bool Constrain(
plane,
A plane to use as constraint.
allowElevator
true if elevator mode should be allowed at user request.
)
true if constraint could be applied.

Constrain

#ExampleSince v5.0
Constrains the picked point to lie on a line.
public bool Constrain(
from,
The start point of constraint.
to
The end point of constraint.
)
true if constraint could be applied.

Constrain

#Since v5.0
Constrains the picked point to lie on a sphere.
public bool Constrain(
sphere
A sphere to use as constraint.
)
true if constraint could be applied.

Constrain

#ExampleSince v5.0
Constrains the picked point to lie on a surface.
public bool Constrain(
surface,
A surface to use as constraint.
allowPickingPointOffObject
defines whether the point pick is allowed to happen off object. When false, a "no no" cursor is shown when the cursor is not on the object. When true, a normal point picking cursor is used and the marker is visible also when the cursor is not on the object.
)
true if constraint could be applied.

ConstrainDistanceFromBasePoint

#Since v5.0
Sets distance constraint from base point.
public void ConstrainDistanceFromBasePoint(
distance
pass UnsetValue to clear this constraint. Pass 0.0 to disable the ability to set this constraint by typing a number during GetPoint.
)
Remarks: If the base point is set and the distance from base point constraint is > 0, then the picked point is constrained to be this distance from the base point.

ConstrainToConstructionPlane

#ExampleSince v5.0
If enabled, the picked point is constrained to be on the active construction plane. If the base point is set, then the point is constrained to be on the plane that contains the base point and is parallel to the active construction plane. By default this constraint is enabled.
public bool ConstrainToConstructionPlane(
throughBasePoint
true if the base point should be used as compulsory level reference.
)
If true and the base point is set, then the point is constrained to be on the plane parallel to the construction plane that passes through the base point, even when planar mode is off. If throughBasePoint is false, then the base point shift only happens if planar mode is on.

ConstrainToTargetPlane

#Since v5.0
Constrains point to lie on a plane that is parallel to the viewing plane and passes through the view's target point.
public void ConstrainToTargetPlane()

ConstrainToVirtualCPlaneIntersection

#Since v5.0
If enabled, the picked point is constrained to be on the intersection of the plane and the virtual CPlane going through the plane origin. If the planes are parallel, the constraint works just like planar constraint.
public bool ConstrainToVirtualCPlaneIntersection(
plane
The plane used for the plane - virtual CPlane intersection.
)
true if the operation succeeded; false otherwise.

CustomMessage

public object CustomMessage()
inherited fromGetBaseClass

Dispose

public void Dispose()
inherited fromGetBaseClass

Dispose

protected virtual void Dispose(
disposing
)
inherited fromGetBaseClass

DrawLineFromPoint

#ExampleSince v5.0
Use DrawLineFromPoint() if you want a dynamic line drawn from a point to the point being picked.
public void DrawLineFromPoint(
startPoint,
The line is drawn from startPoint to the point being picked. If the base point has not been set, then it is set to startPoint.
showDistanceInStatusBar
if true, the distance from the basePoint to the point begin picked is shown in the status bar.
)
Remarks: Calling DrawLineFromPoint automatically enables drawing the line. Use EnableDrawLineFromPoint() to toggle the line drawing state.

EnableCurveSnapArrow

#Since v5.0
Controls display of the curve snap arrow icon.
public void EnableCurveSnapArrow(
drawDirectionArrowAtSnapPoint,
true to draw arrow icon whenever GetPoint snaps to a curve.
reverseArrow
true if arrow icon direction should be the reverse of the first derivative direction.
)
Remarks: The tangent bar is drawn by GetPoint::DynamicDraw. If you override GetPoint::DynamicDraw, then you must call the base class function.

EnableCurveSnapPerpBar

#Since v5.0
Controls display of the curve snap perpendicular bar icon.
public void EnableCurveSnapPerpBar(
drawPerpBarAtSnapPoint,
true to draw a tangent bar icon whenever GetPoint snaps to a curve.
drawEndPoints
true to draw points at the end of the tangent bar.
)

EnableCurveSnapTangentBar

#Since v5.0
Controls display of the curve snap tangent bar icon.
public void EnableCurveSnapTangentBar(
drawTangentBarAtSnapPoint,
true to draw a tangent bar icon whenever GetPoint snaps to a curve.
drawEndPoints
true to draw points at the end of the tangent bar.
)
Remarks: The tangent bar is drawn by GetPoint::DynamicDraw. If you override GetPoint::DynamicDraw, then you must call the base class function.

EnableDrawLineFromPoint

#Since v5.0
Controls drawing of dynamic a line from the start point.
public void EnableDrawLineFromPoint(
enable
if true, a dynamic line is drawn from the DrawLineFromPoint startPoint to the point being picked.
)

EnableNoRedrawOnExit

#Since v6.0
The default functionality of the GetPoint operation is to perform a redraw on exit. Calling this function with true turns off automatic redraw at the end of GetPoint. May be needed in some commands for flicker free feedback. When set to true, the caller is responsible for cleaning up the screen after GetPoint.
public void EnableNoRedrawOnExit(
noRedraw
)

EnableObjectSnapCursors

#Since v6.0
Enables or disables object snap cursors. By default, object snap cursors are enabled.
public void EnableObjectSnapCursors(
enable
If true then object snap cursors (plus sign with "near", "end", etc.) are used when the point snaps to a object.
)

EnableSnapToCurves

#Since v5.0
If you want GetPoint() to try to snap to curves when the mouse is near a curve (like the center point in the Circle command when the AroundCurve option is on), then enable the snap to curves option.
public void EnableSnapToCurves(
enable
Whether points should be enabled.
)

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.

Get

#ExampleSince v5.0
After setting up options and so on, call GetPoint::Get to get a 3d point. The point is retrieved when the mouse goes down.
[CLSCompliant(false)] public GetResult Get()

Get

#Since v5.12
After setting up options and so on, call this method to get a 2d or 3d point.
[CLSCompliant(false)] public GetResult Get(
onMouseUp,
If false, the point is returned when the left mouse button goes down. If true, the point is returned when the left mouse button goes up.
get2DPoint
If true then get a 2d point otherwise get a 2d point
)
GetResult.Point if the user chose a 3d point; GetResult.Point2d if the user chose a 2d point; other enumeration value otherwise.

Get

#Since v5.0
After setting up options and so on, call this method to get a 3d point.
[CLSCompliant(false)] public GetResult Get(
onMouseUp
If false, the point is returned when the left mouse button goes down. If true, the point is returned when the left mouse button goes up.
)
GetResult.Point if the user chose a point; other enumeration value otherwise.

GetConstructionPoints

#Since v5.0
Gets current construction points.
public Point3d[] GetConstructionPoints()
Remarks: Construction points are like snap points except that they get snapped to even when point osnap is off. Typically, there are only a few construction points while there can be many snap points. For example, when polylines are drawn the start point is a construction point and the other points are snap points.
An array of points.

GetPlanarConstraint

#Since v6.0
public bool GetPlanarConstraint(
vp,
out Plane
plane
)

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.

GetSnapPoints

#Since v5.0
Gets current snap points.
public Point3d[] GetSnapPoints()
An array of points.

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.

InterruptMouseMove

#Since v5.0
If you have lengthy computations in OnMouseMove() and/or DymanicDraw() overrides, then periodically call InterruptMouseMove() to see if you should interrupt your work because the mouse has moved again.
public bool InterruptMouseMove()
true if you should interrupt your work; false otherwise.

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.

NumberPreview

#Since v7.23
If the user is typing a number, but hasn't pressed Enter, true is returned, along with the number the user typed.
public bool NumberPreview(
out double
number
The number typed by the user.
)
true if successful, false otherwise.

OnDynamicDraw

#Example
Default calls the DynamicDraw event.
protected virtual void OnDynamicDraw(
e
Current argument for the event.
)

OnMouseDown

#
Default calls the MouseDown event.
protected virtual void OnMouseDown(
e
Current argument for the event.
)

OnMouseMove

#
Calls the MouseMove event and can/should be called by overriding implementation.
protected virtual void OnMouseMove(
e
Current argument for the event.
)

OnPostDrawObjects

#
In the "rare" case that you need to draw some depth buffered geometry during a GetPoint operation, override the OnPostDrawObjects function. NOTE!! Overriding this function comes with a significant performance penalty because the scene needs to be fully regenerated every frame where the standard DynamicDraw event draws temporary decorations (geometry) on top of a static scene.
protected virtual void OnPostDrawObjects(
e
Current argument for the event.
)

OptionIndex

public int OptionIndex()
inherited fromGetBaseClass

PermitConstraintOptions

#Since v5.0
Control the availability of the built-in linear, planar, curve, and surface constraint options like "Along", "AlongPerp", "AlongTan", "AlongParallel", "Between", "OnCrv", "OnSrf", ".x", ".y", ".z", ".xy", etc.
public void PermitConstraintOptions(
permit
if true, then the built-in constraint options are automatically available in GetPoint.
)
Remarks: By default, these built-in constraint options are available unless an explicit constraint is added by calling one of the GetPoint::Constrain functions. Calling GetPoint::ClearConstraints automatically enables the built-in constraint options. The built-in constraint options are never visible on the command line and the user must type the complete option name to activate these options.

PermitElevatorMode

#Since v5.0
Permits the use of the control key to define a line constraint.
public void PermitElevatorMode(
permitMode
0: no elevator modes are permitted 1: fixed plane elevator mode (like the Line command) 2: cplane elevator mode (like object dragging)
)

PermitFromOption

#Since v5.0
Control the availability of the built-in "From" option. By default, the "From" option is enabled.
public void PermitFromOption(
permit
if true, then the "From" option is automatically available in GetPoint.
)
Remarks: The GetPoint "From" option is never visible on the command line and the user must type the complete option name to activate the "From" option. When the GetPoint "From" snap is enabled, the user set/change the base point during GetPoint by typing "From" and picking a point. A related option is the built-in distance from base point constraint that is can be set before GetPoint is called by passing a value to GetPoint::ConstrainDistanceFromBasePoint or during GetPoint by entering a number.

PermitObjectSnap

#Since v5.0
By default, object snaps like "end", "near", etc. are controlled by the user. If you want to disable this ability, then call PermitObjectSnap(false).
public void PermitObjectSnap(
permit
true to permit snapping to objects.
)

PermitOrthoSnap

#Since v5.0
Controls availability of ortho snap. Default is true.
public void PermitOrthoSnap(
permit
if true, then GetPoint pays attention to the Rhino "ortho snap" and "planar snap" settings reported by ModelAidSettings.Ortho and ModelAidSettings.Planar.
)

PermitTabMode

#Since v5.0
Permits the use of the tab key to define a line constraint.
public void PermitTabMode(
permit
If true, then the built-in tab key mode is available.
)
Remarks: By default, use of the tab key is supported.

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.

PointOnBrep

#Since v6.0
Use to determine if point was on a Brep face. If the point was on a Brep face, then the (u,v) are the face parameters for the point.
public BrepFace PointOnBrep(
out double
u,
If the point was on a Brep face, then the u parameter.
out double
v
If the point was on a Brep face, then the v parameter.
)
A face on a copy of the Brep, or null if the point was not on a Brep face.

PointOnCurve

#ExampleSince v5.0
Use to determine is point was on a curve.
public Curve PointOnCurve(
out double
t
If the point was on a curve, then the t is the curve parameter for the point. The point returned by Point() is the same as curve.PointAt(t).
)
A copy of the curve, or null if the point was not on a curve. If the point was on a Brep edge, then an edge on a copy of the Brep is returned.

PointOnObject

#Since v5.0
Call this function to see if the point was on an object. If the point was on an object an ObjRef is returned; otherwise null is returned.
public ObjRef PointOnObject()
A point object reference.

PointOnSurface

#Since v6.0
Use to determine if point was on a surface. If the point was on a surface, then the (u,v) are the surface parameters for the point. The point returned by Point() is the same as surface.PointAt(u,v).
public Surface PointOnSurface(
out double
u,
If the point was on a surface, then the u parameter.
out double
v
If the point was on a surface, then the v parameter.
)
A copy of the surface or null if the point was not on a surface. If the point was on a Brep face, then a copy of the face is returned.

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.

SetBasePoint

#ExampleSince v5.0
Sets a base point used by ortho snap, from snap, planar snap, etc.
public void SetBasePoint(
basePoint,
The new base point.
showDistanceInStatusBar
If true, then the distance from base_point to the current point will be in the status bar distance pane.
)

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;

SetCursor

#Since v6.0
Sets cursor that will be used when Get() is called and snap is not happening.
public void SetCursor()

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

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

Snap

#Since v9.0
Calculates the point the current object snap settings would produce, in the specified view, given a test point. This function does not prompt.
public static bool Snap(
view,
The view in which to snap.
testPoint,
The world coordinate point to snap.
out Point3d
snapPoint,
The snapped point. If no object snap applied, then testPoint is returned.
osnapMode
The type of object snap used to obtain the point. If no object snap applied, then OsnapModes.None is returned.
)
true if successful, false otherwise.

StringResult

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

TryGetBasePoint

#Since v5.0
public bool TryGetBasePoint(
out Point3d
basePoint
)

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.

Events

DynamicDraw

#Since v5.0
Event to use if you want to dynamically draw things as the mouse/digitizer moves. Every time the mouse moves, DynamicDraw will be called once per viewport. The calls to DynamicDraw happen AFTER the call to MouseMove. If you are drawing anything that takes a long time, periodically call InterruptMouseMove() to see if you should stop.
public event EventHandler<GetPointDrawEventArgs> DynamicDraw

MouseDown

#Since v5.0
Called during Get2dRectangle, Get2dLine, and GetPoint(..,true) when the mouse down event for the initial point occurs. This function is not called during ordinary point getting because the mouse down event terminates an ordinary point get and returns a GetResult.Point result.
public event EventHandler<GetPointMouseEventArgs> MouseDown

MouseMove

#Since v5.0
Called every time the mouse moves. MouseMove is called once per mouse move and is called BEFORE any calls to OnDynamicDraw. If you are doing anything that takes a long time, periodically call InterruptMouseMove() to see if you should stop. If the view is such that the 2d screen point can't be mapped to a 3d point, the 'point' argument will be Unset.
public event EventHandler<GetPointMouseEventArgs> MouseMove

PostDrawObjects

#Since v5.0
Same as the DisplayPipeline.PostDrawObjects, but only works during the operation of the Get() function. NOTE: You must set FullFrameRedrawDuringGet to true in order for this event to be called.
public event EventHandler<DrawEventArgs> PostDrawObjects