UxrAnimatedMaterial Class
Component that allows to animate material properties.
Inheritance Hierarchy
System.Object
Object
Component
Behaviour
MonoBehaviour
UltimateXR.Core.Components.UxrComponent
UltimateXR.Animation.UxrAnimatedComponent(UxrAnimatedMaterial)
UltimateXR.Animation.Materials.UxrAnimatedMaterial
Namespace: UltimateXR.Animation.Materials
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0
Syntax
C#
public class UxrAnimatedMaterial : UxrAnimatedComponent<UxrAnimatedMaterial>
The UxrAnimatedMaterial type exposes the following members.
Constructors
Name | Description | |
---|---|---|
UxrAnimatedMaterial |
Properties
Name | Description | |
---|---|---|
AnimateSelf | Gets or sets whether the animation will be applied to the GameObject where the component is, or an external one. | |
MaterialMode | Gets or sets the material mode, whether to use the instanced material or the shared material. | |
MaterialSlot | Gets or sets the material slot to apply the material animation to. | |
ParameterName | Gets or sets the material’s parameter name. | |
ParameterType | Gets or sets the material’s parameter type. | |
RestoreWhenFinished | Gets or sets if the original material value should be restored when finished. | |
TargetGameObject | Gets or sets the target GameObject when AnimateSelf is true. |
Methods
Name | Description | |
---|---|---|
Animate | Starts an animation at a constant speed | |
AnimateBlinkColor | Starts animating a GameObject’s material making one if its color parameters blink. | |
AnimateFloatBlink | Starts animating a GameObject’s material making one if its float parameters blink. | |
AnimateInterpolation | Starts a material parameter animation using an interpolation curve | |
AnimateNoise | Starts a material parameter animation using noise | |
Awake | Initializes internal variables (Overrides UxrComponent.Awake().) | |
GetParameterValue | Gets the parameter value from the material (Overrides UxrAnimatedComponent<T>.GetParameterValue().) | |
OnFinished | Called when the animation finished. (Overrides UxrAnimatedComponent<T>.OnFinished<T>.) | |
RestoreOriginalSharedMaterial | Restores the original (shared) material. This may have some performance advantages. | |
RestoreOriginalValue | Restores the original value before the animation started. (Overrides UxrAnimatedComponent<T>.RestoreOriginalValue().) | |
SetParameterValue | Sets the material parameter value (Overrides UxrAnimatedComponent<T>.SetParameterValue(Vector4).) |
Fields
Name | Description | |
---|---|---|
DefaultBlinkFrequency | The default blink frequency |
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.) |