Struct NavigationParams | Kinematica | 0.5.0-preview.1
docs.unity3d.com
    Show / Hide Table of Contents

    Struct NavigationParams

    Parameters of navigation query asked to Kinematica in order to move an agent along a path made of control points

    Namespace: Unity.Kinematica
    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
    Type Description
    Single

    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
    Type Description
    Single

    intermediateControlPointRadius

    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
    Type Description
    Single

    maximumAcceleration

    Maximum acceleration to increase agent speed toward desiredSpeed

    Declaration
    public float maximumAcceleration
    Field Value
    Type Description
    Single

    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
    Type Description
    Single

    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
    Type Description
    Single

    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
    Type Description
    Single

    Methods

    ComputeAccelerationToReachSpeed(Single, Single)

    Declaration
    public static float ComputeAccelerationToReachSpeed(float targetSpeed, float distance)
    Parameters
    Type Name Description
    Single targetSpeed
    Single distance
    Returns
    Type Description
    Single

    ComputeAccelerationToReachSpeed(Single, Single, Single)

    Declaration
    public static float ComputeAccelerationToReachSpeed(float startSpeed, float targetSpeed, float distance)
    Parameters
    Type Name Description
    Single startSpeed
    Single targetSpeed
    Single distance
    Returns
    Type Description
    Single

    ComputeDistanceToReachSpeed(Single, Single, Single)

    Declaration
    public static float ComputeDistanceToReachSpeed(float startSpeed, float targetSpeed, float acceleration)
    Parameters
    Type Name Description
    Single startSpeed
    Single targetSpeed
    Single acceleration
    Returns
    Type Description
    Single
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023