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

    Struct NavigationTask

    Namespace: Unity.Kinematica
    Syntax
    [Data("TrajectoryPath", "#2A3756", DataType.Flag.None)]
    public struct NavigationTask : Task

    Constructors

    NavigationTask(ref MotionSynthesizer, Identifier<Trajectory>)

    Declaration
    public NavigationTask(ref MotionSynthesizer synthesizer, Identifier<Trajectory> trajectory)
    Parameters
    Type Name Description
    MotionSynthesizer synthesizer
    Identifier<Trajectory> trajectory

    Fields

    self

    Declaration
    public Identifier<NavigationTask> self
    Field Value
    Type Description
    Identifier<NavigationTask>

    synthesizer

    Declaration
    public MemoryRef<MotionSynthesizer> synthesizer
    Field Value
    Type Description
    MemoryRef<MotionSynthesizer>

    trajectory

    Declaration
    [Output("Trajectory")]
    public Identifier<Trajectory> trajectory
    Field Value
    Type Description
    Identifier<Trajectory>

    Properties

    GoalReached

    Declaration
    public bool GoalReached { get; }
    Property Value
    Type Description
    Boolean

    IsPathValid

    Declaration
    public bool IsPathValid { get; }
    Property Value
    Type Description
    Boolean

    NextControlPoint

    Declaration
    public int NextControlPoint { get; }
    Property Value
    Type Description
    Int32

    Methods

    Create(ref MotionSynthesizer, Identifier<Trajectory>)

    Declaration
    public static NavigationTask Create(ref MotionSynthesizer synthesizer, Identifier<Trajectory> trajectory)
    Parameters
    Type Name Description
    MotionSynthesizer synthesizer
    Identifier<Trajectory> trajectory
    Returns
    Type Description
    NavigationTask

    DrawPath()

    Declaration
    public void DrawPath()

    Execute()

    Declaration
    public Result Execute()
    Returns
    Type Description
    Result
    Implements
    Task.Execute()

    ExecuteSelf(ref TaskRef)

    Declaration
    public static Result ExecuteSelf(ref TaskRef self)
    Parameters
    Type Name Description
    TaskRef self
    Returns
    Type Description
    Result

    FollowPath(float3[], NavigationParams)

    Move agent toward first control point, and then move them along path made of controlPoints until last control point

    Declaration
    public void FollowPath(float3[] controlPoints, NavigationParams navParams)
    Parameters
    Type Name Description
    float3[] controlPoints
    NavigationParams navParams

    Operators

    Implicit(NavigationTask to Identifier<NavigationTask>)

    Declaration
    public static implicit operator Identifier<NavigationTask>(NavigationTask task)
    Parameters
    Type Name Description
    NavigationTask task
    Returns
    Type Description
    Identifier<NavigationTask>
    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