Class FloatMaterialPropertyAffordanceReceiver

Apply affordance to material property block float property.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
BaseAffordanceStateReceiver<Single>
BaseAsyncAffordanceStateReceiver<Single>
FloatAffordanceReceiver
FloatMaterialPropertyAffordanceReceiver
Inherited Members
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
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)
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.4/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

OnValidate()

See MonoBehaviour.

Declaration
protected void OnValidate()