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

NameDescription
Public methodUxrAnimatedMaterial

Properties

NameDescription
Public propertyAnimateSelf Gets or sets whether the animation will be applied to the GameObject where the component is, or an external one.
Public propertyMaterialMode Gets or sets the material mode, whether to use the instanced material or the shared material.
Public propertyMaterialSlot Gets or sets the material slot to apply the material animation to.
Public propertyParameterName Gets or sets the material’s parameter name.
Public propertyParameterType Gets or sets the material’s parameter type.
Public propertyRestoreWhenFinished Gets or sets if the original material value should be restored when finished.
Public propertyTargetGameObject Gets or sets the target GameObject when AnimateSelf is true.

Methods

NameDescription
Public methodStatic memberAnimate Starts an animation at a constant speed
Public methodStatic memberAnimateBlinkColor Starts animating a GameObject’s material making one if its color parameters blink.
Public methodStatic memberAnimateFloatBlink Starts animating a GameObject’s material making one if its float parameters blink.
Public methodStatic memberAnimateInterpolation Starts a material parameter animation using an interpolation curve
Public methodStatic memberAnimateNoise Starts a material parameter animation using noise
Protected methodAwake Initializes internal variables (Overrides UxrComponent.Awake().)
Protected methodGetParameterValue Gets the parameter value from the material (Overrides UxrAnimatedComponent<T>.GetParameterValue().)
Protected methodOnFinished Called when the animation finished. (Overrides UxrAnimatedComponent<T>.OnFinished<T>.)
Public methodRestoreOriginalSharedMaterial Restores the original (shared) material. This may have some performance advantages.
Protected methodRestoreOriginalValue Restores the original value before the animation started. (Overrides UxrAnimatedComponent<T>.RestoreOriginalValue().)
Protected methodSetParameterValue Sets the material parameter value (Overrides UxrAnimatedComponent<T>.SetParameterValue(Vector4).)

Fields

NameDescription
Public fieldStatic memberDefaultBlinkFrequency The default blink frequency

Extension Methods

NameDescription
Public Extension MethodCheckSetEnabled Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
Public Extension MethodGetOrAddComponent<T> Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
Public Extension MethodGetPathUnderScene Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
Public Extension MethodGetSceneUid Gets an unique identifier string for the given component. (Defined by ComponentExt.)
Public Extension MethodGetUniqueScenePath 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.)
Public Extension MethodLoopCoroutine Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
Public Extension MethodSafeGetComponentInParent<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.)
Public Extension MethodShowInInspector(Boolean)Overloaded.
Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
Public Extension MethodShowInInspector(Boolean, Boolean)Overloaded.
Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
Public Extension MethodThrowIfNull Throws an exception if the object is null. (Defined by ObjectExt.)

See Also

Reference

UltimateXR.Animation.Materials Namespace