docs.unity3d.com
    Show / Hide Table of Contents

    Class BaseAsyncAffordanceStateReceiver<T>

    Base implementation of an asynchronous affordance state receiver to be used with affordance types to tween using the job system.

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    BaseAffordanceStateReceiver<T>
    BaseAsyncAffordanceStateReceiver<T>
    ColorAffordanceReceiver
    FloatAffordanceReceiver
    Vector2AffordanceReceiver
    Vector3AffordanceReceiver
    Vector4AffordanceReceiver
    Inherited Members
    BaseAffordanceStateReceiver<T>.affordanceStateProvider
    BaseAffordanceStateReceiver<T>.replaceIdleStateValueWithInitialValue
    BaseAffordanceStateReceiver<T>.affordanceTheme
    BaseAffordanceStateReceiver<T>.defaultAffordanceTheme
    BaseAffordanceStateReceiver<T>.affordanceValue
    BaseAffordanceStateReceiver<T>.currentAffordanceValue
    BaseAffordanceStateReceiver<T>.currentAffordanceStateData
    BaseAffordanceStateReceiver<T>.initialValue
    BaseAffordanceStateReceiver<T>.initialValueCaptured
    BaseAffordanceStateReceiver<T>.Awake()
    BaseAffordanceStateReceiver<T>.OnEnable()
    BaseAffordanceStateReceiver<T>.OnDisable()
    BaseAffordanceStateReceiver<T>.Start()
    BaseAffordanceStateReceiver<T>.GenerateNewAffordanceThemeInstance()
    BaseAffordanceStateReceiver<T>.OnAffordanceStateUpdated(AffordanceStateData, AffordanceStateData)
    BaseAffordanceStateReceiver<T>.ConsumeAffordance(T)
    BaseAffordanceStateReceiver<T>.OnAffordanceValueUpdated(T)
    BaseAffordanceStateReceiver<T>.CaptureInitialValue()
    BaseAffordanceStateReceiver<T>.GetCurrentValueForCapture()
    BaseAffordanceStateReceiver<T>.ProcessTargetAffordanceValue(T)
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    MonoBehaviour.CancelInvoke(String)
    MonoBehaviour.IsInvoking(String)
    MonoBehaviour.StartCoroutine(String)
    MonoBehaviour.StartCoroutine(String, Object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(String)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(Object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, Boolean)
    Component.GetComponentInParent(Type)
    UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(String)
    Component.SendMessageUpwards(String, Object, SendMessageOptions)
    Component.SendMessageUpwards(String, Object)
    Component.SendMessageUpwards(String)
    Component.SendMessageUpwards(String, SendMessageOptions)
    Component.SendMessage(String, Object)
    Component.SendMessage(String)
    Component.SendMessage(String, Object, SendMessageOptions)
    Component.SendMessage(String, SendMessageOptions)
    Component.BroadcastMessage(String, Object, SendMessageOptions)
    Component.BroadcastMessage(String, Object)
    Component.BroadcastMessage(String)
    Component.BroadcastMessage(String, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    UnityEngine.Object.FindFirstObjectByType<T>()
    UnityEngine.Object.FindAnyObjectByType<T>()
    UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
    UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.Receiver
    Syntax
    public abstract class BaseAsyncAffordanceStateReceiver<T> : BaseAffordanceStateReceiver<T>, IAffordanceStateReceiver<T>, IAsyncAffordanceStateReceiver, IAffordanceStateReceiver where T : struct, IEquatable<T>
    Type Parameters
    Name Description
    T

    The type of the value struct.

    Methods

    HandleTween(Single)

    Called to generate and schedule a tween job with a given tween target.

    Declaration
    public JobHandle HandleTween(float tweenTarget)
    Parameters
    Type Name Description
    Single tweenTarget

    Tween target parameter for the tween job. Used as a parameter in the theme's animation curve to find the value between the 0-1 animation state in the associated theme.

    Returns
    Type Description
    JobHandle

    Returns JobHandle used by affordance state provider.

    Implements
    IAsyncAffordanceStateReceiver.HandleTween(Single)

    OnAffordanceThemeChanged(BaseAffordanceTheme<T>)

    Called when the affordance theme changes for this receiver, allowing proper setup to take place as a result.

    Declaration
    protected override void OnAffordanceThemeChanged(BaseAffordanceTheme<T> newValue)
    Parameters
    Type Name Description
    BaseAffordanceTheme<T> newValue

    New affordance theme set for this receiver.

    Overrides
    UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.Receiver.BaseAffordanceStateReceiver<T>.OnAffordanceThemeChanged(UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.Theme.BaseAffordanceTheme<T>)
    See Also
    affordanceTheme

    OnDestroy()

    See MonoBehaviour.

    Declaration
    protected virtual void OnDestroy()

    ScheduleTweenJob(ref TweenJobData<T>)

    Generate the tween job from the given job data and schedule the job for execution on a worker thread.

    Declaration
    protected abstract JobHandle ScheduleTweenJob(ref TweenJobData<T> jobData)
    Parameters
    Type Name Description
    TweenJobData<T> jobData

    Typed job data used in tween job.

    Returns
    Type Description
    JobHandle

    Returns the handle identifying the scheduled job.

    UpdateStateFromCompletedJob()

    Read the affordance value written by the last completed affordance job and propagate that to listeners. Called by the affordance state provider to propagate the tween job's output.

    Declaration
    public void UpdateStateFromCompletedJob()
    Implements
    IAsyncAffordanceStateReceiver.UpdateStateFromCompletedJob()
    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