TransportPathfindOptionsBuilder (Class)
Namespace: Wrld.Transport
A convenience builder to construct instances of Wrld.Transport.TransportPathfindOptions.
Methods
TransportPathfindOptionsBuilder SetPointOnGraphA (TransportPositionerPointOnGraph pointOnGraph)
Set the start point from the given TransportPositionerPointOnGraph object.
Returns: This object, with the start point set.
| Argument | Type | Description |
|---|---|---|
| pointOnGraph | TransportPositionerPointOnGraph | A TransportPositionerPointOnGraph object, for example as supplied by TransportPositioner.GetPointOnGraph() |
TransportPathfindOptionsBuilder SetPointOnGraphB (TransportPositionerPointOnGraph pointOnGraph)
Set the goal point from the given TransportPositionerPointOnGraph object.
Returns: This object, with the goal point set.
| Argument | Type | Description |
|---|---|---|
| pointOnGraph | TransportPositionerPointOnGraph | A TransportPositionerPointOnGraph object, for example as supplied by TransportPositioner.GetPointOnGraph() |
TransportPathfindOptionsBuilder SetPointOnGraphA (TransportDirectedEdgeId directedEdgeIdA, double parameterizedPointOnEdgeA)
Explicitly set the start point.
Returns: This object, with the start point set.
| Argument | Type | Description |
|---|---|---|
| directedEdgeIdA | TransportDirectedEdgeId | The id of a directed edge object on which the start point lies. |
| parameterizedPointOnEdgeA | double | A point on the start directed edge, specified as a parameterised distance along the edge, in range 0.0 to 1.0. |
TransportPathfindOptionsBuilder SetPointOnGraphB (TransportDirectedEdgeId directedEdgeIdB, double parameterizedPointOnEdgeB)
Explicitly set the goal point.
Returns: This object, with the goal point set.
| Argument | Type | Description |
|---|---|---|
| directedEdgeIdB | TransportDirectedEdgeId | The id of a directed edge object on which the goal point lies. |
| parameterizedPointOnEdgeB | double | A point on the goal directed edge, specified as a parameterised distance along the edge, in range 0.0 to 1.0. |
TransportPathfindOptionsBuilder SetUTurnAllowedAtA (bool uTurnAllowedAtA)
Sets whether an immediate U-turn is permitted at the start point.
Returns: This object, with the start U-turn constraint set.
| Argument | Type | Description |
|---|---|---|
| uTurnAllowedAtA | bool |
TransportPathfindOptionsBuilder SetUTurnAllowedAtB (bool uTurnAllowedAtB)
Sets whether an immediate U-turn is permitted at the goal point.
Returns: This object, with the goal U-turn constraint set.
| Argument | Type | Description |
|---|---|---|
| uTurnAllowedAtB | bool |
TransportPathfindOptions Build ()
Create the options object.
Returns: The TransportPathfindOptions object.