Class RouteFollower

Inheritance
System.Object
RouteFollower
Namespace: Eco.Shared.Pathing
Assembly: Eco.Shared.dll
Syntax
public class RouteFollower : Object

Constructors

RouteFollower()

Declaration
public RouteFollower()

RouteFollower(Route, Double)

Declaration
public RouteFollower(Route route, double startTime)
Parameters
Type Name Description
Route route
System.Double startTime

Properties

Arrivaltime

Declaration
public double Arrivaltime { get; }
Property Value
Type Description
System.Double

DesiredRotationSpeed

Declaration
public float DesiredRotationSpeed { get; }
Property Value
Type Description
System.Single

DesiredSpeed

Declaration
public float DesiredSpeed { get; }
Property Value
Type Description
System.Single

DesiredVelocity

Declaration
public Vector3 DesiredVelocity { get; }
Property Value
Type Description
System.Numerics.Vector3

EndTime

Declaration
public float EndTime { get; }
Property Value
Type Description
System.Single

PercentThrough

Declaration
public float PercentThrough { get; }
Property Value
Type Description
System.Single

Route

Declaration
public Route Route { get; }
Property Value
Type Description
Route

RouteAndDesc

Declaration
public IEnumerable<(Vector3, string)> RouteAndDesc { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.ValueTuple<System.Numerics.Vector3, System.String>>

RunningSpeed

Declaration
public float RunningSpeed { get; }
Property Value
Type Description
System.Single

StartPosition

Declaration
public Vector3 StartPosition { get; }
Property Value
Type Description
System.Numerics.Vector3

StartTime

Declaration
public double StartTime { get; }
Property Value
Type Description
System.Double

TargetPosition

Declaration
public Vector3 TargetPosition { get; }
Property Value
Type Description
System.Numerics.Vector3

TotalDistance

Declaration
public float TotalDistance { get; }
Property Value
Type Description
System.Single

TravelTime

Declaration
public float TravelTime { get; }
Property Value
Type Description
System.Single

Methods

DesiredDirection(Single)

Declaration
public Vector3 DesiredDirection(float lookAhead = 0F)
Parameters
Type Name Description
System.Single lookAhead
Returns
Type Description
System.Numerics.Vector3

FromBSON(BSONObject, INetObjectViewer)

Declaration
public bool FromBSON(BSONObject obj, INetObjectViewer viewer)
Parameters
Type Name Description
BSONObject obj
INetObjectViewer viewer
Returns
Type Description
System.Boolean

GetRoutePoints()

Declaration
public IEnumerable<Vector3> GetRoutePoints()
Returns
Type Description
System.Collections.Generic.IEnumerable<System.Numerics.Vector3>

Position(Single)

Take the expected position at given time.

Declaration
public virtual Vector3 Position(float lookAhead = 0F)
Parameters
Type Name Description
System.Single lookAhead

Offset distance is adding to a calculated position.
Returns
Type Description
System.Numerics.Vector3

PositionSmooth(Single)

Take the expected position at given time.

Declaration
public virtual Vector3 PositionSmooth(float lookAhead = 0F)
Parameters
Type Name Description
System.Single lookAhead

Offset distance is adding to a calculated position.
Returns
Type Description
System.Numerics.Vector3

Reset()

Declaration
public void Reset()

ToBSON(BSONObject, INetObjectViewer)

Declaration
public void ToBSON(BSONObject obj, INetObjectViewer viewer)
Parameters
Type Name Description
BSONObject obj
INetObjectViewer viewer

WaypointsAtTime(Single)

Returns previous waypoint, next waypoint and index of next waypoint.

Declaration
public (PathSegment, PathSegment, int) WaypointsAtTime(float lookAhead = 0F)
Parameters
Type Name Description
System.Single lookAhead

Add time here to look into the future.
Returns
Type Description
System.ValueTuple<PathSegment, PathSegment, System.Int32>

Extension Methods