Sign in
2020 Class Back to 2020
C

PathOfTravel

Version comparison
2020 2021 2022 2023 2024 2025 2025.3 2026 2027

Members across versions

23 members across 9 versions · 9 added later · 8 changed

Member-name color: stable · changed · removed · obsolete · added later

Member 2020 2021 2022 2023 2024 2025 2025.3 2026 2027
M Create(View, XYZ, XYZ, PathOfTravelCalculationStatus%)
same same same same same changed same same same
M Create(View, XYZ, XYZ)
same same same same same changed same same same
M CreateMapped(View, IList<XYZ>, IList<XYZ>)
same same same same same changed same same same
M CreateMapped(View, IList<XYZ>, IList<XYZ>, IList<PathOfTravelCalculationStatus>)
same same same same same changed same same same
M CreateMultiple(View, IList<XYZ>, IList<XYZ>, IList<PathOfTravelCalculationStatus>)
same same same same same changed same same same
M CreateMultiple(View, IList<XYZ>, IList<XYZ>)
same same same same same changed same same same
M FindEndsOfShortestPaths(View, IList<XYZ>, IList<XYZ>)
not yet introduced added changed same same same same same same
M FindShortestPaths(View, IList<XYZ>, IList<XYZ>)
not yet introduced added changed same same changed same same same
M FindStartsOfLongestPathsFromRooms(View, IList<XYZ>)
not yet introduced added same same same same same same same
M GetCurves
same same same same same same same same same
M GetWaypoints
not yet introduced added same same same same same same same
M InsertWaypoint(XYZ, Int32)
not yet introduced added same same same same same same same
M IsInRevealObstaclesMode(View)
not yet introduced added same same same same same same same
M RemoveWaypoint(Int32)
not yet introduced added same same same same same same same
M SetRevealObstaclesMode(View, Boolean)
not yet introduced added same same same same same same same
M SetWaypoint(XYZ, Int32)
not yet introduced added same same same same same same same
M Update
same same same same same same same same same
M UpdateMultiple(Document, IList<ElementId>)
same same same same same same same same same
M UpdateMultiple(Document, IList<ElementId>, IList<PathOfTravelCalculationStatus>)
same same same same same same same same same
P LineStyle
same same same same same same same same same
P PathEnd
same same same same same same same same same
P PathMidpoint
same same same same same same same same same
P PathStart
same same same same same same same same same

Per-version detail

Click a version below to see what changed in that release vs your current frame (2020).
2020 current

Changes in 2025 vs 2020 9 added 6 changed

Flip API Versions →

Added in 2025 (new since 2020)

FindEndsOfShortestPaths(View, IList<XYZ>, IList<XYZ>) FindShortestPaths(View, IList<XYZ>, IList<XYZ>) FindStartsOfLongestPathsFromRooms(View, IList<XYZ>) GetWaypoints InsertWaypoint(XYZ, Int32) IsInRevealObstaclesMode(View) RemoveWaypoint(Int32) SetRevealObstaclesMode(View, Boolean) SetWaypoint(XYZ, Int32)

Changed members

PathOfTravel.Create(View, XYZ, XYZ, PathOfTravelCalculationStatus%)
DBView View The floor plan view to use when computing the shortest distance.
pathStart XYZ The start point of the path. The Z coordinate is ignored.
pathEnd XYZ The end point of the path. The Z coordinate is ignored.
resultStatus PathOfTravelCalculationStatus% Result status of path of travel creation.
→ returns PathOfTravel→nullNothingnullptr The newly created path of travel element, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found.
PathOfTravel.Create(View, XYZ, XYZ)
DBView View The floor plan view to use when computing the shortest distance.
pathStart XYZ The start point of the path. The Z coordinate is ignored.
pathEnd XYZ The end point of the path. The Z coordinate is ignored.
→ returns PathOfTravel→nullNothingnullptr The newly created path of travel element, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found.
PathOfTravel.CreateMapped(View, IList<XYZ>, IList<XYZ>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The number of elements is the number of start points multiplied by the number of end points. The order of elements corresponds to the order of end and then start points in the argument arrays: s0->e0, s1->e0, ... , s0->e1, s1->e1... etc. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMapped(View, IList<XYZ>, IList<XYZ>, IList<PathOfTravelCalculationStatus>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
resultStatus IList<PathOfTravelCalculationStatus> Result statuses of each path of travel creation. The order of statuses corresponds to the order of elements in the array returned by the function.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The number of elements is the number of start points multiplied by the number of end points. The order of elements corresponds to the order of end and then start points in the argument arrays: s0->e0, s1->e0, ... , s0->e1, s1->e1... etc. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMultiple(View, IList<XYZ>, IList<XYZ>, IList<PathOfTravelCalculationStatus>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
resultStatus IList<PathOfTravelCalculationStatus> Result statuses of each path of travel creation. The order of statuses corresponds to the order of elements in the array returned by the function.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The order of elements corresponds to the order of start/end points in the argument arrays. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMultiple(View, IList<XYZ>, IList<XYZ>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The order of elements corresponds to the order of start/end points in the argument arrays. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close

Changes in 2025.3 vs 2020 9 added 6 changed

Flip API Versions →

Added in 2025.3 (new since 2020)

FindEndsOfShortestPaths(View, IList<XYZ>, IList<XYZ>) FindShortestPaths(View, IList<XYZ>, IList<XYZ>) FindStartsOfLongestPathsFromRooms(View, IList<XYZ>) GetWaypoints InsertWaypoint(XYZ, Int32) IsInRevealObstaclesMode(View) RemoveWaypoint(Int32) SetRevealObstaclesMode(View, Boolean) SetWaypoint(XYZ, Int32)

Changed members

PathOfTravel.Create(View, XYZ, XYZ, PathOfTravelCalculationStatus%)
DBView View The floor plan view to use when computing the shortest distance.
pathStart XYZ The start point of the path. The Z coordinate is ignored.
pathEnd XYZ The end point of the path. The Z coordinate is ignored.
resultStatus PathOfTravelCalculationStatus% Result status of path of travel creation.
→ returns PathOfTravel→nullNothingnullptr The newly created path of travel element, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found.
PathOfTravel.Create(View, XYZ, XYZ)
DBView View The floor plan view to use when computing the shortest distance.
pathStart XYZ The start point of the path. The Z coordinate is ignored.
pathEnd XYZ The end point of the path. The Z coordinate is ignored.
→ returns PathOfTravel→nullNothingnullptr The newly created path of travel element, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found.
PathOfTravel.CreateMapped(View, IList<XYZ>, IList<XYZ>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The number of elements is the number of start points multiplied by the number of end points. The order of elements corresponds to the order of end and then start points in the argument arrays: s0->e0, s1->e0, ... , s0->e1, s1->e1... etc. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMapped(View, IList<XYZ>, IList<XYZ>, IList<PathOfTravelCalculationStatus>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
resultStatus IList<PathOfTravelCalculationStatus> Result statuses of each path of travel creation. The order of statuses corresponds to the order of elements in the array returned by the function.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The number of elements is the number of start points multiplied by the number of end points. The order of elements corresponds to the order of end and then start points in the argument arrays: s0->e0, s1->e0, ... , s0->e1, s1->e1... etc. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMultiple(View, IList<XYZ>, IList<XYZ>, IList<PathOfTravelCalculationStatus>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
resultStatus IList<PathOfTravelCalculationStatus> Result statuses of each path of travel creation. The order of statuses corresponds to the order of elements in the array returned by the function.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The order of elements corresponds to the order of start/end points in the argument arrays. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMultiple(View, IList<XYZ>, IList<XYZ>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The order of elements corresponds to the order of start/end points in the argument arrays. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close

Changes in 2026 vs 2020 9 added 6 changed

Flip API Versions →

Added in 2026 (new since 2020)

FindEndsOfShortestPaths(View, IList<XYZ>, IList<XYZ>) FindShortestPaths(View, IList<XYZ>, IList<XYZ>) FindStartsOfLongestPathsFromRooms(View, IList<XYZ>) GetWaypoints InsertWaypoint(XYZ, Int32) IsInRevealObstaclesMode(View) RemoveWaypoint(Int32) SetRevealObstaclesMode(View, Boolean) SetWaypoint(XYZ, Int32)

Changed members

PathOfTravel.Create(View, XYZ, XYZ, PathOfTravelCalculationStatus%)
DBView View The floor plan view to use when computing the shortest distance.
pathStart XYZ The start point of the path. The Z coordinate is ignored.
pathEnd XYZ The end point of the path. The Z coordinate is ignored.
resultStatus PathOfTravelCalculationStatus% Result status of path of travel creation.
→ returns PathOfTravel→nullNothingnullptr The newly created path of travel element, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found.
PathOfTravel.Create(View, XYZ, XYZ)
DBView View The floor plan view to use when computing the shortest distance.
pathStart XYZ The start point of the path. The Z coordinate is ignored.
pathEnd XYZ The end point of the path. The Z coordinate is ignored.
→ returns PathOfTravel→nullNothingnullptr The newly created path of travel element, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found.
PathOfTravel.CreateMapped(View, IList<XYZ>, IList<XYZ>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The number of elements is the number of start points multiplied by the number of end points. The order of elements corresponds to the order of end and then start points in the argument arrays: s0->e0, s1->e0, ... , s0->e1, s1->e1... etc. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMapped(View, IList<XYZ>, IList<XYZ>, IList<PathOfTravelCalculationStatus>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
resultStatus IList<PathOfTravelCalculationStatus> Result statuses of each path of travel creation. The order of statuses corresponds to the order of elements in the array returned by the function.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The number of elements is the number of start points multiplied by the number of end points. The order of elements corresponds to the order of end and then start points in the argument arrays: s0->e0, s1->e0, ... , s0->e1, s1->e1... etc. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMultiple(View, IList<XYZ>, IList<XYZ>, IList<PathOfTravelCalculationStatus>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
resultStatus IList<PathOfTravelCalculationStatus> Result statuses of each path of travel creation. The order of statuses corresponds to the order of elements in the array returned by the function.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The order of elements corresponds to the order of start/end points in the argument arrays. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMultiple(View, IList<XYZ>, IList<XYZ>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The order of elements corresponds to the order of start/end points in the argument arrays. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close

Changes in 2027 vs 2020 9 added 6 changed

Flip API Versions →

Added in 2027 (new since 2020)

FindEndsOfShortestPaths(View, IList<XYZ>, IList<XYZ>) FindShortestPaths(View, IList<XYZ>, IList<XYZ>) FindStartsOfLongestPathsFromRooms(View, IList<XYZ>) GetWaypoints InsertWaypoint(XYZ, Int32) IsInRevealObstaclesMode(View) RemoveWaypoint(Int32) SetRevealObstaclesMode(View, Boolean) SetWaypoint(XYZ, Int32)

Changed members

PathOfTravel.Create(View, XYZ, XYZ, PathOfTravelCalculationStatus%)
DBView View The floor plan view to use when computing the shortest distance.
pathStart XYZ The start point of the path. The Z coordinate is ignored.
pathEnd XYZ The end point of the path. The Z coordinate is ignored.
resultStatus PathOfTravelCalculationStatus% Result status of path of travel creation.
→ returns PathOfTravel→nullNothingnullptr The newly created path of travel element, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found.
PathOfTravel.Create(View, XYZ, XYZ)
DBView View The floor plan view to use when computing the shortest distance.
pathStart XYZ The start point of the path. The Z coordinate is ignored.
pathEnd XYZ The end point of the path. The Z coordinate is ignored.
→ returns PathOfTravel→nullNothingnullptr The newly created path of travel element, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found.
PathOfTravel.CreateMapped(View, IList<XYZ>, IList<XYZ>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The number of elements is the number of start points multiplied by the number of end points. The order of elements corresponds to the order of end and then start points in the argument arrays: s0->e0, s1->e0, ... , s0->e1, s1->e1... etc. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMapped(View, IList<XYZ>, IList<XYZ>, IList<PathOfTravelCalculationStatus>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
resultStatus IList<PathOfTravelCalculationStatus> Result statuses of each path of travel creation. The order of statuses corresponds to the order of elements in the array returned by the function.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The number of elements is the number of start points multiplied by the number of end points. The order of elements corresponds to the order of end and then start points in the argument arrays: s0->e0, s1->e0, ... , s0->e1, s1->e1... etc. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMultiple(View, IList<XYZ>, IList<XYZ>, IList<PathOfTravelCalculationStatus>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
resultStatus IList<PathOfTravelCalculationStatus> Result statuses of each path of travel creation. The order of statuses corresponds to the order of elements in the array returned by the function.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The order of elements corresponds to the order of start/end points in the argument arrays. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close
PathOfTravel.CreateMultiple(View, IList<XYZ>, IList<XYZ>)
DBView View The floor plan view to use when computing the shortest distance.
pathStarts IList<XYZ> The start points of the path. The Z coordinates are ignored.
pathEnds IList<XYZ> The end points of the path. The Z coordinates are ignored.
→ returns IList→nullNothingnullptr The array of newly created path of travel elements, or null Nothing nullptr a null reference ( Nothing in Visual Basic) if no path between the two points is found. The order of elements corresponds to the order of start/end points in the argument arrays. There are some additional conditions that are checked and if any condition is true the null Nothing nullptr a null reference ( Nothing in Visual Basic) value is returned: View has crop box active and start or end point lies outside of the crop Start and end points are too close