PathOfTravel.FindShortestPaths Method

For a floor plan view, calculates paths from each start point to its closest destinations. Returns the path, represented by an array of XYZ points.

Namespace: Autodesk.Revit.DB.Analysis
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.4.0.0 (26.4.0.0)

Syntax

C#

public static IList<IList<XYZ>> FindShortestPaths(
	View DBView,
	IList<XYZ> destinationPoints,
	IList<XYZ> startPoints
)

Parameters

DBView View: The floor plan view to use when computing the points.
destinationPoints IList<XYZ>: Destination points. The input Z coordinates are ignored and set to the view's level elevation.
startPoints IList<XYZ>: Start points for which shortest paths are calculated.

Return Value

IList<IList<XYZ>>
Array of paths calculated from each start point to its corresponding closest destination. If a path cannot be caculated the corresponsing sub-array is set to an empty array.

Exceptions

Exception	Condition
ArgumentException	View is not a floor plan view.
ArgumentNullException	A non-optional argument was null
InvalidOperationException	The Path of Travel calculation service is not available -or- This functionality is not available in Revit LT.

Remarks

The calculation is done in a floor plan with one or more destinationPoints and one or more startPoints. The shortest path is calculated from each start point to its closest destination point.