GH_PointGetter

public class GH_PointGetter

Properties

AcceptPreselected

#
public bool AcceptPreselected { get; set; }
Gets or sets a value indicating whether or not preselected point objects are accepted.

PointRefType

#
public GH_PointRefType PointRefType { get; set; }
Gets or sets the Point Reference type.

Methods

DefaultRefType

#
public GH_PointRefType DefaultRefType()
Gets the default point reference type based on the layout of the active doc.

GetPoint

#
public static GH_GetterResult GetPoint(string prompt, Point3d basePoint, ref Point3d outPoint)
Utility function for getting single points. This function properly Handles Nothing results.
Parameters:
prompt (string)Prompt to display during GetPoint.
basePoint (Point3d)Base point for getter or Point3d.Unset for not base point.
outPoint (ref Point3d)Resulting point. Only filled out if return is GH_GetterResult.success
Returns: Result of operation.

GetPoint

#
public GH_Point GetPoint()

GetPoint

#
public GH_Point GetPoint(Point3d base)
Parameters:
base (Point3d)

GetPoints

#
public List<GH_Point> GetPoints()

RecreateSetup

#
public void RecreateSetup(GH_Point pt)
Use this function to set up all the properties to mimic an initial getter operation similar to the one that resulted in the given point.
Parameters:
pt (GH_Point)Point to infer getter options from.