RhinoGet.GetOneObject Method (String, Boolean, GetObjectGeometryFilter, ObjRef)

RhinoGetGetOneObject Method (String, Boolean, GetObjectGeometryFilter, ObjRef)

Easy to use object getter.

Namespace:  Rhino.Input
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
public static Result GetOneObject(
	string prompt,
	bool acceptNothing,
	GetObjectGeometryFilter filter,
	out ObjRef objref
)
Public Shared Function GetOneObject ( 
	prompt As String,
	acceptNothing As Boolean,
	filter As GetObjectGeometryFilter,
	<OutAttribute> ByRef objref As ObjRef
) As Result

Parameters

prompt
Type: SystemString
command prompt.
acceptNothing
Type: SystemBoolean
if true, the user can press enter.
filter
Type: Rhino.Input.CustomGetObjectGeometryFilter
geometry filter to use when getting objects.
objref
Type: Rhino.DocObjectsObjRef
result of the get. may be null.

Return Value

Type: Result
Commands.Result.Success - got object Commands.Result.Nothing - user pressed enter Commands.Result.Cancel - user cancel object getting.
Remarks
If you need options or more advanced user interface, then use GetObject class.
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.14
See Also

M:Rhino.Input.RhinoGet.GetOneObject(System.String,System.Boolean,Rhino.Input.Custom.GetObjectGeometryFilter,Rhino.DocObjects.ObjRef@)