GetPoint

GetPoint class

Used to interactively get a point.

inheritence: Rhino.Input.Custom.GetBaseClassGetPoint

Namespace: Rhino.Input.Custom
GetPoint: references

Constructors (2)

GetBaseClass()

Initializes a new instance of the GetBaseClass class

GetPoint()

Create a new GetPoint.

Properties (4)

DynamicDrawColor

Color used by CRhinoGetPoint::DynamicDraw to draw the current point and the line from the base point to the current point.

FullFrameRedrawDuringGet

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.

OsnapEventType

Gets the type of object snap used to obtain the point.

Tag

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.

Methods (121)

AcceptColor(Boolean enable)

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(Boolean enable)

AcceptEnterWhenDone(Boolean enable)

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(Boolean enable)

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(Boolean enable,Boolean acceptZero)

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(Boolean enable)

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(Boolean enable)

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(Boolean enable)

If you want to allow the user to have an 'undo' option in GetPoint.Get(), GetObject.GetObjects(), etc., then call AcceptUndo(true) beforehand.

AddConstructionPoint(Point3d point)

Adds a point to the list of construction points.

AddConstructionPoints(Point3d[] points)

Adds points to the list of construction points.

AddOption(LocalizeStringPair optionName, LocalizeStringPair optionValue,Boolean hiddenOption)

Adds a command line option.

AddOption(LocalizeStringPair optionName, LocalizeStringPair optionValue)

Adds a command line option.

AddOption(LocalizeStringPair optionName)

Adds a command line option.

AddOption(String englishOption,String englishOptionValue,Boolean hiddenOption)

Adds a command line option.

AddOption(String englishOption,String englishOptionValue)

Adds a command line option.

AddOption(String englishOption)

Adds a command line option.

AddOptionColor(LocalizeStringPair optionName, ref OptionColor colorValue,String prompt)

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

AddOptionColor(LocalizeStringPair optionName, ref OptionColor colorValue)

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

AddOptionColor(String englishName, ref OptionColor colorValue,String prompt)

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

AddOptionColor(String englishName, ref OptionColor colorValue)

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

AddOptionDouble(LocalizeStringPair optionName, ref OptionDouble numberValue,String prompt)

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

AddOptionDouble(LocalizeStringPair optionName, ref OptionDouble numberValue)

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

AddOptionDouble(String englishName, ref OptionDouble numberValue,String prompt)

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

AddOptionDouble(String englishName, ref OptionDouble numberValue)

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

AddOptionEnumList(String englishOptionName, T defaultValue, T[] include)

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

AddOptionEnumList(String englishOptionName, T defaultValue)

Adds a choice of enumerated values as list option

AddOptionEnumSelectionList(String englishOptionName, IEnumerable<T> enumSelection,Int32 listCurrentIndex)

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

AddOptionInteger(LocalizeStringPair optionName, ref OptionInteger intValue,String prompt)

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

AddOptionInteger(LocalizeStringPair optionName, ref OptionInteger intValue)

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

AddOptionInteger(String englishName, ref OptionInteger intValue,String prompt)

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

AddOptionInteger(String englishName, ref OptionInteger intValue)

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

AddOptionList(LocalizeStringPair optionName, IEnumerable<LocalizeStringPair> listValues,Int32 listCurrentIndex)

Adds a command line list option.

AddOptionList(String englishOptionName, IEnumerable<string> listValues,Int32 listCurrentIndex)

Adds a command line list option.

AddOptionToggle(LocalizeStringPair optionName, ref OptionToggle toggleValue)

Adds a command line option to toggle a setting.

AddOptionToggle(String englishName, ref OptionToggle toggleValue)

Adds a command line option to toggle a setting.

AddSnapPoint(Point3d point)

Adds a point to the list of osnap points.

AddSnapPoints(Point3d[] points)

Adds points to the list of osnap points.

ClearCommandOptions()

Clear all command options.

ClearConstraints()

Removes any explicit constraints added by calls to GetPoint::Constraint() and enable the built-in constraint options.

ClearConstructionPoints()

Remove all construction points.

ClearDefault()

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

ClearSnapPoints()

Remove all snap points.

Color()

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

CommandResult()

Helper method for getting command result value from getter results.

Constrain(Arc arc)

Constrains the picked point to lie on an arc.

Constrain(Brep brep,Int32 wireDensity,Int32 faceIndex,Boolean allowPickingPointOffObject)

Constrains the picked point to lie on a brep.

Constrain(Circle circle)

Constrains the picked point to lie on a circle.

Constrain(Curve curve,Boolean allowPickingPointOffObject)

Constrains the picked point to lie on a curve.

Constrain(Cylinder cylinder)

Constrains the picked point to lie on a cylinder.

Constrain(Line line)

Constrains the picked point to lie on a line.

Constrain(Mesh mesh,Boolean allowPickingPointOffObject)

Constrains the picked point to lie on a mesh.

Constrain(Plane plane,Boolean allowElevator)

constrain the picked point to lie on a plane.

Constrain(Point3d from, Point3d to)

Constrains the picked point to lie on a line.

Constrain(Sphere sphere)

Constrains the picked point to lie on a sphere.

Constrain(Surface surface,Boolean allowPickingPointOffObject)

Constrains the picked point to lie on a surface.

ConstrainDistanceFromBasePoint(Double distance)

Sets distance constraint from base point.

ConstrainToConstructionPlane(Boolean throughBasePoint)

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.

ConstrainToTargetPlane()

Constrains point to lie on a plane that is parallel to the viewing plane and passes through the view's target point.

ConstrainToVirtualCPlaneIntersection(Plane plane)

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.

CustomMessage()

Dispose()

Dispose(Boolean disposing)

DrawLineFromPoint(Point3d startPoint,Boolean showDistanceInStatusBar)

Use DrawLineFromPoint() if you want a dynamic line drawn from a point to the point being picked.

EnableCurveSnapArrow(Boolean drawDirectionArrowAtSnapPoint,Boolean reverseArrow)

Controls display of the curve snap arrow icon.

EnableCurveSnapPerpBar(Boolean drawPerpBarAtSnapPoint,Boolean drawEndPoints)

Controls display of the curve snap perpendicular bar icon.

EnableCurveSnapTangentBar(Boolean drawTangentBarAtSnapPoint,Boolean drawEndPoints)

Controls display of the curve snap tangent bar icon.

EnableDrawLineFromPoint(Boolean enable)

Controls drawing of dynamic a line from the start point.

EnableNoRedrawOnExit(Boolean noRedraw)

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.

EnableObjectSnapCursors(Boolean enable)

Enables or disables object snap cursors. By default, object snap cursors are enabled.

EnableSnapToCurves(Boolean enable)

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.

EnableTransparentCommands(Boolean enable)

Control the availability of transparent commands during the get.

Get()

After setting up options and so on, call GetPoint::Get to get a 3d point. The point is retrieved when the mouse goes down.

Get(Boolean onMouseUp,Boolean get2DPoint)

After setting up options and so on, call this method to get a 2d or 3d point.

Get(Boolean onMouseUp)

After setting up options and so on, call this method to get a 3d point.

GetConstructionPoints()

Gets current construction points.

GetPlanarConstraint(ref RhinoViewport vp, out Plane plane)

GetSelectedEnumValue()

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

GetSelectedEnumValueFromSelectionList(IEnumerable<T> selectionList)

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

GetSnapPoints()

Gets current snap points.

GotDefault()

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

InterruptMouseMove()

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.

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.

Number()

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

NumberPreview(Double number)

If the user is typing a number, but hasn't pressed Enter, True is returned, along with the number the user typed.

OnDynamicDraw(GetPointDrawEventArgs e)

Default calls the DynamicDraw event.

OnMouseDown(GetPointMouseEventArgs e)

Default calls the MouseDown event.

OnMouseMove(GetPointMouseEventArgs e)

Calls the MouseMove event and can/should be called by overriding implementation.

OnPostDrawObjects(DrawEventArgs e)

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.

Option()

OptionIndex()

PermitConstraintOptions(Boolean permit)

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.

PermitElevatorMode(Int32 permitMode)

Permits the use of the control key to define a line constraint.

PermitFromOption(Boolean permit)

Control the availability of the built-in "From" option. By default, the "From" option is enabled.

PermitObjectSnap(Boolean permit)

By default, object snaps like "end", "near", etc. are controlled by the user. If you want to disable this ability, then call PermitObjectSnap(false).

PermitOrthoSnap(Boolean permit)

Controls availability of ortho snap. Default is true.

PermitTabMode(Boolean permit)

Permits the use of the tab key to define a line constraint.

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.

PointOnBrep(Double u,Double v)

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.

PointOnCurve(Double t)

Use to determine is point was on a curve.

PointOnObject()

Call this function to see if the point was on an object. If the point was on an object an ObjRef is returned; otherwise None is returned.

PointOnSurface(Double u,Double v)

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).

PostCustomMessage(Object messageData)

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.

SetBasePoint(Point3d basePoint,Boolean showDistanceInStatusBar)

Sets a base point used by ortho snap, from snap, planar snap, etc.

SetCommandPrompt(String prompt)

Sets prompt message that appears in the command prompt window.

SetCommandPromptDefault(String defaultValue)

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.

SetCursor(CursorStyle cursor)

Sets cursor that will be used when Get() is called and snap is not happening.

SetDefaultColor(Color defaultColor)

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

SetDefaultInteger(Int32 defaultValue)

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

SetDefaultNumber(Double defaultNumber)

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

SetDefaultPoint(Point3d point)

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

SetDefaultString(String defaultValue)

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

SetOptionVaries(Int32 optionIndex,Boolean varies)

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

SetWaitDuration(Int32 milliseconds)

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.

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).

View()

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

Nothing found