UxrAnimatedLightIntensity Class

Component that allows to animate a light’s intensity.

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UltimateXR.Core.Components.UxrComponent
            UltimateXR.Animation.UxrAnimatedComponent(UxrAnimatedLightIntensity)
              UltimateXR.Animation.Lights.UxrAnimatedLightIntensity
Namespace: UltimateXR.Animation.Lights
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public class UxrAnimatedLightIntensity : UxrAnimatedComponent<UxrAnimatedLightIntensity>

The UxrAnimatedLightIntensity type exposes the following members.

Constructors

	Name	Description
	UxrAnimatedLightIntensity

Properties

	Name	Description
	InterpolatedValueEnd	Gets or sets the end value when the animation mode is set to Interpolate.
	InterpolatedValueStart	Gets or sets the start value when the animation mode is set to Interpolate.
	InterpolatedValueWhenDisabled	Gets or sets the value to set when the component is disabled, when the animation mode is set to Interpolate.
	NoiseFrequency	Gets or sets the noise frequency when the animation mode is set to Noise.
	NoiseOffset	Gets or sets the noise offset when the animation mode is set to Noise.
	NoiseValueEnd	Gets or sets the end value when the animation mode is set to Noise.
	NoiseValueMax	Gets or sets the noise max value when the animation mode is set to Noise.
	NoiseValueMin	Gets or sets the noise min value when the animation mode is set to Noise.
	NoiseValueStart	Gets or sets the start value when the animation mode is set to Noise.
	Speed	Gets or sets the increment per second when the animation mode is set to Speed.

Methods

	Name	Description
	Animate	Starts an animation at a constant speed
	AnimateInterpolation	Starts an animation using an interpolation curve
	AnimateNoise	Starts an animation using noise.
	Awake	Stores the initial light intensity (Overrides UxrComponent.Awake().)
	GetParameterValue	Gets the current parameter value (Overrides UxrAnimatedComponent<T>.GetParameterValue().)
	OnFinished	Called when the animation finished. (Overrides UxrAnimatedComponent<T>.OnFinished<T>.)
	RestoreOriginalValue	Restores the animated component to the state before the animation started. (Overrides UxrAnimatedComponent<T>.RestoreOriginalValue().)
	SetParameterValue	Sets the parameter value (Overrides UxrAnimatedComponent<T>.SetParameterValue(Vector4).)

Extension Methods

	Name	Description
	CheckSetEnabled	Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
	GetOrAddComponent<T>	Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
	GetPathUnderScene	Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
	GetSceneUid	Gets an unique identifier string for the given component. (Defined by ComponentExt.)
	GetUniqueScenePath	Gets an unique path in the scene for the given component. It will include scene name, sibling and component indices to make it unique. (Defined by ComponentExt.)
	LoopCoroutine	Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
	SafeGetComponentInParent<T>	Gets the Component of a given type in the GameObject or any of its parents. It also works on prefabs, where regular GetComponentInParent(Type, Boolean) will not work: https://issuetracker.unity3d.com/issues/getcomponentinparent-is-returning-null-when-the-gameobject-is-a-prefab (Defined by ComponentExt.)
	ShowInInspector(Boolean)	Overloaded. Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
	ShowInInspector(Boolean, Boolean)	Overloaded. Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
	ThrowIfNull	Throws an exception if the object is null. (Defined by ObjectExt.)

See Also

Reference

UltimateXR.Animation.Lights Namespace