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

    Struct TrajectoryPredictionTask

    The trajectory prediction task generates a desired future trajectoy subject to a desired displacement direction, desired forward direction and desired linear speed.

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

    Fields

    forwardDirection

    Denotes the desired forward direction to be used for trajectory prediction.

    Declaration
    public float3 forwardDirection
    Field Value
    Type Description
    float3
    Remarks

    The forward direction is expressed in character space, i.e. relative to the current orientation of the character. It indicates the desired facing direction that is to be reached at the end of the predicted trajectory.

    linearSpeed

    Denotes the desired linear speed to be used for trajectory prediction.

    Declaration
    public float linearSpeed
    Field Value
    Type Description
    Single
    Remarks

    The linear speed is expressed in meters per second and indicates the desired root speed that is to be reached at the end of the predicted trajectory.

    movementDirection

    Denotes the desired movement direction to be used for trajectory prediction.

    Declaration
    public float3 movementDirection
    Field Value
    Type Description
    float3
    Remarks

    The movement direction is expressed in character space, i.e. relative to the current orientation of the character. It indicates the desired future root displacement that is to be reached at the end of the predicted trajectory.

    rotationFactor

    Denotes a canonical value that determines how fast the the prediction reaches the desired orientation.

    Declaration
    public float rotationFactor
    Field Value
    Type Description
    Single

    trajectory

    Denotes a reference to the trajectory to be generated.

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

    velocityFactor

    Denotes a canonical value that determines how fast the the prediction reaches the desired velocity.

    Declaration
    public float velocityFactor
    Field Value
    Type Description
    Single

    Methods

    Execute()

    Execute method for the trajectory prediction task.

    Declaration
    public Result Execute()
    Returns
    Type Description
    Result

    Always returns a success status.

    Implements
    Task.Execute()
    Remarks

    The trajectory prediction task generates a desired future trajectoy subject to a desired displacement direction, desired forward direction and desired linear speed. The better the predicted trajectory matches the poses (and therefore the implicitly contained trajectories for each pose) in a given input set, the better result can be expected from a pose reduction (pose matching).

    See Also
    ReduceTask

    ExecuteSelf(ref TaskRef)

    Surrogate method for automatic task execution.

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

    Task reference that is supposed to be executed.

    Returns
    Type Description
    Result

    Result of the task execution.

    Operators

    Implicit(TrajectoryPredictionTask to Identifier<TrajectoryPredictionTask>)

    Implicit cast operator that allows to convert a trajectory prediction task into a typed identifier.

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