docs.unity3d.com
    Show / Hide Table of Contents

    Class FloatMaterialPropertyAffordanceReceiver

    Apply affordance to material property block float property.

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    BaseAffordanceStateReceiver<Single>
    BaseAsyncAffordanceStateReceiver<Single>
    FloatAffordanceReceiver
    FloatMaterialPropertyAffordanceReceiver
    Inherited Members
    FloatAffordanceReceiver.affordanceThemeDatum
    FloatAffordanceReceiver.valueUpdated
    FloatAffordanceReceiver.defaultAffordanceTheme
    FloatAffordanceReceiver.affordanceValue
    FloatAffordanceReceiver.ScheduleTweenJob(TweenJobData<Single>)
    FloatAffordanceReceiver.GenerateNewAffordanceThemeInstance()
    BaseAsyncAffordanceStateReceiver<Single>.OnDestroy()
    BaseAsyncAffordanceStateReceiver<Single>.HandleTween(Single)
    BaseAsyncAffordanceStateReceiver<Single>.UpdateStateFromCompletedJob()
    BaseAsyncAffordanceStateReceiver<Single>.OnAffordanceThemeChanged(BaseAffordanceTheme<Single>)
    BaseAffordanceStateReceiver<Single>.affordanceStateProvider
    BaseAffordanceStateReceiver<Single>.replaceIdleStateValueWithInitialValue
    BaseAffordanceStateReceiver<Single>.affordanceTheme
    BaseAffordanceStateReceiver<Single>.currentAffordanceValue
    BaseAffordanceStateReceiver<Single>.currentAffordanceStateData
    BaseAffordanceStateReceiver<Single>.initialValue
    BaseAffordanceStateReceiver<Single>.initialValueCaptured
    BaseAffordanceStateReceiver<Single>.OnEnable()
    BaseAffordanceStateReceiver<Single>.OnDisable()
    BaseAffordanceStateReceiver<Single>.Start()
    BaseAffordanceStateReceiver<Single>.OnAffordanceStateUpdated(AffordanceStateData, AffordanceStateData)
    BaseAffordanceStateReceiver<Single>.ConsumeAffordance(Single)
    BaseAffordanceStateReceiver<Single>.CaptureInitialValue()
    BaseAffordanceStateReceiver<Single>.ProcessTargetAffordanceValue(Single)
    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.Rendering
    Syntax
    [AddComponentMenu("Affordance System/Receiver/Rendering/Float Material Property Affordance Receiver", 12)]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.3/api/UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.Receiver.Rendering.FloatMaterialPropertyAffordanceReceiver.html")]
    [RequireComponent(typeof(MaterialPropertyBlockHelper))]
    public class FloatMaterialPropertyAffordanceReceiver : FloatAffordanceReceiver, IAffordanceStateReceiver<float>, IAsyncAffordanceStateReceiver, IAffordanceStateReceiver

    Properties

    floatPropertyName

    Shader property name to set the float value of.

    Declaration
    public string floatPropertyName { get; set; }
    Property Value
    Type Description
    String

    materialPropertyBlockHelper

    Material Property Block Helper component reference used to set material properties.

    Declaration
    public MaterialPropertyBlockHelper materialPropertyBlockHelper { get; set; }
    Property Value
    Type Description
    MaterialPropertyBlockHelper

    Methods

    Awake()

    See MonoBehaviour.

    Declaration
    protected override void Awake()
    Overrides
    UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.Receiver.BaseAffordanceStateReceiver<System.Single>.Awake()

    GetCurrentValueForCapture()

    Function used to get the current value of the receiver's target property. Is overriden for material properties or other targets where the initial state exists outside the receiver.

    Declaration
    protected override float GetCurrentValueForCapture()
    Returns
    Type Description
    Single

    Initial value.

    Overrides
    UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.Receiver.BaseAffordanceStateReceiver<System.Single>.GetCurrentValueForCapture()

    OnAffordanceValueUpdated(Single)

    Method that is called when the typed affordance value is updated. Implement this method in a derived class to apply the current affordance value, such as setting a material property or raising an event.

    Declaration
    protected override void OnAffordanceValueUpdated(float newValue)
    Parameters
    Type Name Description
    Single newValue
    Overrides
    FloatAffordanceReceiver.OnAffordanceValueUpdated(Single)

    OnValidate()

    See MonoBehaviour.

    Declaration
    protected void OnValidate()
    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