Class FloatAffordanceReceiver

Affordance receiver applying a Float affordance theme. Broadcasts new affordance value with Unity Event.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
BaseAffordanceStateReceiver<float>
BaseAsyncAffordanceStateReceiver<float>
FloatAffordanceReceiver
BlendShapeAffordanceReceiver
FloatMaterialPropertyAffordanceReceiver
UniformTransformScaleAffordanceReceiver
Implements
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.Receiver.Primitives
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
[AddComponentMenu("Affordance System/Receiver/Primitives/Float Affordance Receiver", 12)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.5/api/UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.Receiver.Primitives.FloatAffordanceReceiver.html")]
public class FloatAffordanceReceiver : BaseAsyncAffordanceStateReceiver<float>, IAffordanceStateReceiver<float>, IAsyncAffordanceStateReceiver, IAffordanceStateReceiver

Properties

affordanceThemeDatum

Affordance theme datum property used as a template for creating the runtime copy used during initialization.

Declaration
public FloatAffordanceThemeDatumProperty affordanceThemeDatum { get; set; }
Property Value
Type Description
FloatAffordanceThemeDatumProperty
Remarks

This value can be bypassed by directly setting the affordanceTheme at runtime.

See Also

affordanceValue

Bindable variable for current typed affordance value. Updated as scheduled tween jobs complete.

Declaration
protected override BindableVariable<float> affordanceValue { get; }
Property Value
Type Description
BindableVariable<float>
Overrides
See Also

defaultAffordanceTheme

The default affordance theme that is cloned and assigned to affordanceTheme during initialization if that property is not set.

Declaration
protected override BaseAffordanceTheme<float> defaultAffordanceTheme { get; }
Property Value
Type Description
BaseAffordanceTheme<float>
Overrides
Remarks

This should typically be the theme contained in a serialized ScriptableObject asset reference.

See Also

valueUpdated

The event that is called when the current affordance value is updated.

Declaration
public FloatUnityEvent valueUpdated { get; set; }
Property Value
Type Description
FloatUnityEvent

Methods

GenerateNewAffordanceThemeInstance()

Automatically called by Unity during initialization to create a new instance of the affordance theme used for this receiver.

Declaration
protected override BaseAffordanceTheme<float> GenerateNewAffordanceThemeInstance()
Returns
Type Description
BaseAffordanceTheme<float>

Returns a new instance of the affordance theme.
Overrides

OnAffordanceValueUpdated(float)

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
float newValue

New typed affordance value.
Overrides

ScheduleTweenJob(ref TweenJobData<float>)

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

Declaration
protected override JobHandle ScheduleTweenJob(ref TweenJobData<float> jobData)
Parameters
Type Name Description
TweenJobData<float> jobData

Typed job data used in tween job.
Returns
Type Description
JobHandle

Returns the handle identifying the scheduled job.
Overrides

Implements