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

    Struct CurrentPoseTask

    The current pose task updates a sampling time based on the current sampling time of the motion synthesizer.

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

    Fields

    samplingTime

    Denotes a reference to the sampling time to be updated.

    Declaration
    [Output("Time Index")]
    public Identifier<SamplingTime> samplingTime
    Field Value
    Type Description
    Identifier<SamplingTime>

    Methods

    Execute()

    Execute method for the current pose task.

    Declaration
    public Result Execute()
    Returns
    Type Description
    Result

    Always returns a success status.

    Implements
    Task.Execute()
    Remarks

    The current pose task extracts the current sampling time from the motion sysntehsizer. This sampling time can in turn be consumed by other tasks.

    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(CurrentPoseTask to Identifier<CurrentPoseTask>)

    Implicit cast operator that allows to convert a current pose task into a typed identifier.

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