Pick Point Methods

The PickPoint and PickPoints methods allow users to interactively select points in the Revit model space. These methods are part of the Launchpad UI class and provide a simple way to get coordinates.

PickPoint Method

Description

Prompts the user to pick a single point in the model space.

Syntax

csharppublic XYZ PickPoint(string promptMessage = "Pick a point:", bool showTaskDialog = true)

Parameters

• promptMessage (string, optional): The message displayed to guide the user. Default: "Pick a point:"

• showTaskDialog (bool, optional): Whether to show a confirmation dialog before picking. Default: true

Returns

• XYZ: The selected point coordinates

• null: If the user cancels the operation

Example Usage

// Basic usage - pick a single point with default prompt
XYZ point = UI.PickPoint();
if (point != null)
{    
    Console.WriteLine($"Selected point: X={point.X:F2}, Y={point.Y:F2}, Z={point.Z:F2}");
}
    
// Custom prompt message
XYZ insertionPoint = UI.PickPoint("Select insertion point for family:");
if (insertionPoint != null)
{
    // Place family at selected point    
    doc.Create.NewFamilyInstance(insertionPoint, familySymbol, StructuralType.NonStructural);
}
        
// Skip confirmation dialog for faster workflow
XYZ quickPoint = UI.PickPoint("Click to place marker:", false);
        
// Calculate distance between two points
XYZ startPoint = UI.PickPoint("Pick start point:");
XYZ endPoint = UI.PickPoint("Pick end point:");
        
if (startPoint != null && endPoint != null)
{    
    double distance = startPoint.DistanceTo(endPoint);    
    Console.WriteLine($"Distance: {distance:F2} feet");
}

---

PickPoints Method

Description

Prompts the user to pick multiple points in the model space. The user continues picking points until pressing ESC to finish.

Syntax

public List<XYZ> PickPoints(string promptMessage = "Pick points (ESC when done):", bool showTaskDialog = true, bool showCount = true)

Parameters

• promptMessage (string, optional): The message displayed to guide the user. Default: "Pick points (ESC when done):"

• showTaskDialog (bool, optional): Whether to show a confirmation dialog before picking. Default: true

• showCount (bool, optional): Whether to display the point count during selection and show a summary. Default: true

Returns

• List<XYZ>: A list of selected points (empty list if cancelled immediately)

Example Usage

// Basic usage - create a polyline from picked points
List<XYZ> vertices = UI.PickPoints();
if (vertices.Count >= 2)
{
    for (int i = 0; i < vertices.Count - 1; i++)
    {        
        Line line = Line.CreateBound(vertices[i], vertices[i + 1]);        
        doc.Create.NewDetailCurve(doc.ActiveView, line);    
    }   
} 
Console.WriteLine($"Created polyline with {vertices.Count} vertices");

// Custom prompt for specific use case. 
List <XYZ> boundaryPoints = UI.PickPoints("Select boundary points for area calculation:"); 
if (boundaryPoints.Count >= 3)
{    
    // Calculate area using boundary points 
    double area = CalculatePolygonArea(boundaryPoints);    
    Console.WriteLine($"Area: {area:F2} sq ft");
}
    
// Fast selection without dialogs or counting
List<XYZ> points = UI.PickPoints("Click points:", false, false);
    
// Create a spline through points
List<XYZ> splinePoints = UI.PickPoints("Pick points for spline curve:");
if (splinePoints.Count >= 2)
{    
    HermiteSpline spline = HermiteSpline.Create(splinePoints, false);
    doc.Create.NewModelCurve(spline, sketchPlane);
}
    
// Mark locations with text notes. 
List <XYZ> markerLocations = UI.PickPoints("Click locations to mark:");
int counter = 1;
foreach (XYZ location in markerLocations)
{    
    TextNote.Create(doc, doc.ActiveView.Id, location, $"Point {counter}", noteTypeId);    
    counter++;
}

// Create a closed polygon
List<XYZ> polygonPoints = UI.PickPoints("Select polygon vertices:"); 
if (polygonPoints.Count >= 3)
{    
    // Close the polygon by connecting the last point to the first point of the polygon
    Points.Add(polygonPoints[0]);        
    for (int i = 0; i < polygonPoints.Count - 1; i++)
    {
        Line edge = Line.CreateBound(polygonPoints[i], polygonPoints[i + 1]);
        doc.Create.NewModelCurve(edge, sketchPlane);    
    }
}