UxrPositionTween Class

Tweening component to animate anchoredPosition programatically or using the inspector.

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UltimateXR.Core.Components.UxrComponent
            UltimateXR.Core.Components.UxrComponent(UxrTween)
              UltimateXR.Core.Components.UxrComponent(Canvas, UxrTween)
                UltimateXR.Animation.UI.UxrTween
                  UltimateXR.Animation.UI.UxrGraphicTween
                    UltimateXR.Animation.UI.UxrPositionTween
Namespace: UltimateXR.Animation.UI
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public class UxrPositionTween : UxrGraphicTween


The UxrPositionTween type exposes the following members.

Constructors

NameDescription
Public methodUxrPositionTween

Properties

NameDescription
Public propertyEndPosition Animation end position
Public propertyStartPosition Animation start position

Methods

NameDescription
Public methodStatic memberAnimate Creates and starts a position tweening animation for the anchoredPosition of a Unity UI Graphic component.
Protected methodInterpolate Interpolates and assigns the value corresponding to the given LERP value. (Overrides UxrTween.Interpolate(Single).)
Public methodStatic memberMoveIn Creates and starts a position tweening animation for the anchoredPosition of a Unity UI Graphic component. The animation will start using an offset with respect to the initial graphic position and will end in the initial graphic position.
Public methodStatic memberMoveOut Creates and starts a position tweening animation for the anchoredPosition of a Unity UI Graphic component. The animation will start in the initial graphic position and end with an offset with respect to the initial graphic position.
Protected methodRestoreOriginalValue Restores the animated component to the state before the animation started. (Overrides UxrTween.RestoreOriginalValue().)

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.UI Namespace