RhinoGet

RhinoGet class

Base class for GetObject, GetPoint, GetSphere, etc. You will never directly create a RhinoGet but you will use its member functions after calling GetObject::GetObjects(), GetPoint::GetPoint(), and so on. Provides tools to set command prompt, set command options, and specify if the "get" can optionally accept numbers, nothing (pressing enter), and undo.

Derived Classes:

Namespace: Rhino.Input
RhinoGet: references

Constructors (1)

RhinoGet()

Initializes a new instance of the RhinoGet class

Properties (1)

AllBitmapFileTypes

Methods (48)

Get2dRectangle(bool solidPen, out Rectangle rectangle, out RhinoView rectView)

Gets a rectangle in view window coordinates.

GetAngle(string commandPrompt, Point3d basePoint, Point3d referencePoint, double defaultAngleRadians, out double angleRadians)

Allows user to interactively pick an angle

GetArc(out Arc arc)

GetBool(string prompt, bool acceptNothing, string offPrompt, string onPrompt, ref bool boolValue)

Easy to use Boolean getter.

GetBox(out Box box, GetBoxMode mode, Point3d basePoint, string prompt1, string prompt2, string prompt3)

Asks the user to select a Box in the viewport.

GetBox(out Box box)

Asks the user to select a Box in the viewport.

GetBoxWithCounts(int xMin, ref int xCount, int yMin, ref int yCount, int zMin, ref int zCount, out Point3d[] corners)

Gets a 3d box with prompts for counts in X, Y and Z directions.

GetCircle(out Circle circle)

GetColor(string prompt, bool acceptNothing, ref Color color)

Easy to use color getter.

GetFileName(GetFileNameMode mode, string defaultName, string title, object parent, BitmapFileTypes fileTypes)

GetFileName(GetFileNameMode mode, string defaultName, string title, object parent)

GetFileNameScripted(GetFileNameMode mode, string defaultName)

GetGrip(out GripObject grip, string prompt)

GetGrips(out GripObject[] grips, string prompt)

GetHelix(out NurbsCurve helix)

GetInteger(string prompt, bool acceptNothing, ref int outputNumber, int lowerLimit, int upperLimit)

Easy to use number getter.

GetInteger(string prompt, bool acceptNothing, ref int outputNumber)

Easy to use number getter.

GetLine(out Line line)

GetLinearDimension(out LinearDimension dimension)

GetMeshParameters(RhinoDoc doc, ref MeshingParameters parameters, ref int uiStyle)

Asks the user to specify meshing parameters.

GetMultipleObjects(string prompt, bool acceptNothing, GetObjectGeometryFilter filter, out ObjRef[] rhObjects)

Easy to use object getter for getting multiple objects.

GetMultipleObjects(string prompt, bool acceptNothing, ObjectType filter, out ObjRef[] rhObjects)

Easy to use object getter for getting multiple objects.

GetNumber(string prompt, bool acceptNothing, ref double outputNumber, double lowerLimit, double upperLimit)

Easy to use number getter.

GetNumber(string prompt, bool acceptNothing, ref double outputNumber)

Easy to use number getter.

GetOneObject(string prompt, bool acceptNothing, GetObjectGeometryFilter filter, out ObjRef objref)

Easy to use object getter.

GetOneObject(string prompt, bool acceptNothing, ObjectType filter, out ObjRef rhObject)

Easy to use object getter.

GetPlane(out Plane plane)

Gets an oriented infinite plane.

GetPoint(string prompt, bool acceptNothing, out Point3d point)

Gets a point coordinate from the document.

GetPointOnMesh(MeshObject meshObject, string prompt, bool acceptNothing, out Point3d point)

Gets a point constrained to an existing mesh in the document.

GetPointOnMesh(RhinoDoc doc, MeshObject meshObject, string prompt, bool acceptNothing, out Point3d point)

Gets a point constrained to an existing mesh in the document.

GetPointOnMesh(RhinoDoc doc,Guid meshObjectId, string prompt, bool acceptNothing, out Point3d point)

Gets a point constrained to an existing mesh in the document.

GetPointOnMesh(Guid meshObjectId, string prompt, bool acceptNothing, out Point3d point)

Gets a point constrained to an existing mesh in the document.

GetPolygon(bool useActiveLayerLinetype, ref int numberSides, ref bool inscribed, out Polyline polyline)

GetPolygon(ref int numberSides, ref bool inscribed, out Polyline polyline)

GetPolyline(out Polyline polyline)

GetPrintWindow(ref ViewCaptureSettings settings)

GetRectangle(GetBoxMode mode, Point3d firstPoint, IEnumerable<string> prompts, out Point3d[] corners)

Gets a 3d rectangle made up of four points.

GetRectangle(out Point3d[] corners)

Gets a 3d rectangle.

GetRectangle(string firstPrompt, out Point3d[] corners)

Gets a 3d rectangle.

GetRectangleWithCounts(int xMin, ref int xCount, int yMin, ref int yCount, out Point3d[] corners)

Gets a 3d rectangle with prompts for counts in X and Y directions.

GetSpiral(out NurbsCurve spiral)

GetString(string prompt, bool acceptNothing, ref string outputString)

Easy to use string getter.

GetView(string commandPrompt, out RhinoView view)

Allows the user to interactively pick a viewport.

InGet(RhinoDoc doc)

Returns True if the document is current in a "Get" operation.

InGetObject(RhinoDoc doc)

Returns True if currently in a GetObject.GetObjects()

InGetPoint(RhinoDoc doc)

Returns True if currently in a GetPoint.Get()

StringToCommandOptionName(string englishString, string localizedString)

Convert some arbitrary string value to a valid command option name removing any invalid characters.

StringToCommandOptionName(string stringToConvert)

Convert some arbitrary string value to a valid command option name removing any invalid characters.

Nothing found