RhinoGetGetOneObject Method (String, Boolean, GetObjectGeometryFilter, ObjRef)

Easy to use object getter.

Namespace: Rhino.Input
Assembly: RhinoCommon (in RhinoCommon.dll)

Since: 5.0

Syntax

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.

Reference

RhinoGet Class

GetOneObject Overload

Rhino.Input Namespace

RhinoGetAddLanguageSpecificTextSet("LSTCDCB1C3_0?cpp=::|nu=.");GetOneObject Method (String, Boolean, GetObjectGeometryFilter, ObjRefAddLanguageSpecificTextSet("LSTCDCB1C3_1?cpp=%");)

Parameters

Return Value

Reference

RhinoGetGetOneObject Method (String, Boolean, GetObjectGeometryFilter, ObjRef)