Struct NavigationParams
Parameters of navigation query asked to Kinematica in order to move an agent along a path made of control points
Syntax
public struct NavigationParams
Fields
desiredSpeed
Agent will try to reach desiredSpeed over time while walking through the path
Declaration
public float desiredSpeed
Field Value
finalControlPointRadius
When agent distance from last control point become lower or equal to finalControlPointRadius, agent is considered to have reached target and navigation will stop.
Declaration
public float finalControlPointRadius
Field Value
When agent distance from current control point become lower or equal to intermediateControlPointRadius, agent is considered to have reached control point and will
start moving to the next control point. This doesn't apply to the last control point
Declaration
public float intermediateControlPointRadius
Field Value
maximumAcceleration
Maximum acceleration to increase agent speed toward desiredSpeed
Declaration
public float maximumAcceleration
Field Value
maximumDeceleration
Maximum deceleration to decrease current speed (absolute value of a negative acceleration). Use a small value so that agent start slowing down from a long distance
to stop smoothly at target.
Declaration
public float maximumDeceleration
Field Value
maxSpeedAtRightAngle
Max agent speed when crossing a control point at a 90 degrees angle. Angle at a control point n is computed as the angle between segment from control point n-1
to control point n and segment from control point n to control point n+1.
If corner angle is bigger than 90 degrees, maxSpeedAtRightAngle will still be used as max speed.
If corner angle is smaller than 90 degrees, max speed will be interpolated in function of corner angle between maxSpeedAtRightAngle at 90 degrees and
current speed at 0 degree.
Declaration
public float maxSpeedAtRightAngle
Field Value
pathCurvature
Approximate arc length (in meters) of each curvature of the path. A value of 0 means the agent will move in straight lines between each control point.
Declaration
public float pathCurvature
Field Value
Methods
ComputeAccelerationToReachSpeed(Single, Single)
Declaration
public static float ComputeAccelerationToReachSpeed(float targetSpeed, float distance)
Parameters
Returns
ComputeAccelerationToReachSpeed(Single, Single, Single)
Declaration
public static float ComputeAccelerationToReachSpeed(float startSpeed, float targetSpeed, float distance)
Parameters
Returns
ComputeDistanceToReachSpeed(Single, Single, Single)
Declaration
public static float ComputeDistanceToReachSpeed(float startSpeed, float targetSpeed, float acceleration)
Parameters
Returns
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.