GetPoint Class

Create a new GetPoint.

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

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.

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

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.

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.

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.

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.

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.

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.

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.

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

Adds a point to the list of construction points.

Adds points to the list of construction points.

Adds a command line option.

Adds a command line option.

Adds a command line option.

Adds a command line option.

Adds a command line option.

Adds a command line option.

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

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

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

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

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

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

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

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

Adds a choice of enumerated values as list option

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

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

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

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

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

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

Adds a command line list option.

Adds a command line list option.

Adds a command line option to toggle a setting.

Adds a command line option to toggle a setting.

Adds a point to the list of osnap points.

Adds points to the list of osnap points.

Clear all command options.

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

Remove all construction points.

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

Remove all snap points.

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

Helper method for getting command result value from getter results.

Constrains the picked point to lie on an arc.

Constrains the picked point to lie on a circle.

Constrains the picked point to lie on a cylinder.

Constrains the picked point to lie on a line.

Constrains the picked point to lie on a sphere.

Constrains the picked point to lie on a curve.

Constrains the picked point to lie on a mesh.

constrain the picked point to lie on a plane.

Constrains the picked point to lie on a line.

Constrains the picked point to lie on a surface.

Constrains the picked point to lie on a brep.

Sets distance constraint from base point.

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.

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

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.

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

Controls display of the curve snap arrow icon.

Controls display of the curve snap perpendicular bar icon.

Controls display of the curve snap tangent bar icon.

Controls drawing of dynamic a line from the start point.

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.

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

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.

Control the availability of transparent commands during the get.

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

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

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

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

Gets current construction points.

Serves as the default hash function.

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.

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)

Gets current snap points.

Gets the Type of the current instance.

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

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.

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.

Creates a shallow copy of the current Object.

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

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

Default calls the DynamicDraw event.

Default calls the MouseDown event.

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

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.

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.

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

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

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

Controls availability of ortho snap. Default is true.

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

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;

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

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

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.

Use to determine is point was on a curve.

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.

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

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.

Returns result of the Get*() call.

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

Sets prompt message that appears in the command prompt window.

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.

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

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

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

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

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

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

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

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.

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

Returns a string that represents the current object.

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

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

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.

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.

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.

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.