Class ColorMaterialPropertyAffordanceReceiver

Apply affordance to material property block color property.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
BaseAffordanceStateReceiver<Color>
BaseAsyncAffordanceStateReceiver<Color>
ColorAffordanceReceiver
ColorMaterialPropertyAffordanceReceiver
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/Color 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.ColorMaterialPropertyAffordanceReceiver.html")]
[RequireComponent(typeof(MaterialPropertyBlockHelper))]
public class ColorMaterialPropertyAffordanceReceiver : ColorAffordanceReceiver, IAffordanceStateReceiver<Color>, IAsyncAffordanceStateReceiver, IAffordanceStateReceiver

Properties

colorPropertyName

Shader property name to set the color of.

Declaration
public string colorPropertyName { 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<UnityEngine.Color>.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 Color GetCurrentValueForCapture()
Returns
Type Description
Color

Initial value.
Overrides
UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.Receiver.BaseAffordanceStateReceiver<UnityEngine.Color>.GetCurrentValueForCapture()

OnAffordanceValueUpdated(Color)

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(Color newValue)
Parameters
Type Name Description
Color newValue
Overrides

OnValidate()

See MonoBehaviour.

Declaration
protected void OnValidate()