UxrAnimatedTransform Class

Component that allows to animate transforms on objects or even camera properties. Both at runtime through scripting or at edit time through the inspector properties.

Inheritance Hierarchy

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

Syntax

public sealed class UxrAnimatedTransform : UxrComponent

The UxrAnimatedTransform type exposes the following members.

Constructors

	Name	Description
	UxrAnimatedTransform

Properties

	Name	Description
	HasRotationFinished	Gets whether the rotation interpolation curve finished. If no rotation interpolation curve was started it will return false.
	HasScalingFinished	Gets whether the scaling interpolation curve finished. If no scaling interpolation curve was started it will return false.
	HasTranslationFinished	Gets whether the translation interpolation curve finished. If no translation interpolation curve was started it will return false.

Methods

	Name	Description
	PositionInterpolation	Starts a translation using an interpolation curve
	Rotate	Starts a rotation at a constant speed
	RotationInterpolation(GameObject, UxrTransformRotationSpace, Quaternion, Quaternion, UxrInterpolationSettings, Action)	Starts a rotation using an interpolation curve
	RotationInterpolation(GameObject, UxrTransformRotationSpace, Vector3, Vector3, UxrInterpolationSettings, Action)	Starts a rotation using an interpolation curve
	Scale	Starts scaling at a constant speed
	ScalingInterpolation	Starts scaling using an interpolation curve
	StopAll(Boolean)	Stops the position/rotation/scaling animations on an object if it has an UxrAnimatedTransform component currently attached.
	StopAll(GameObject, Boolean)	Stops the position/rotation/scaling animations on an object if it has an UxrAnimatedTransform component currently attached.
	StopRotation(Boolean)	Stops the rotation animation on an object if it has an UxrAnimatedTransform component currently attached.
	StopRotation(GameObject, Boolean)	Stops the rotation animation on an object if it has an UxrAnimatedTransform component currently attached.
	StopScaling(Boolean)	Stops the scaling animation on an object if it has an UxrAnimatedTransform component currently attached.
	StopScaling(GameObject, Boolean)	Stops the scaling animation on an object if it has an UxrAnimatedTransform component currently attached.
	StopTranslation(Boolean)	Stops the translation animation on an object if it has an UxrAnimatedTransform component currently attached.
	StopTranslation(GameObject, Boolean)	Stops the translation animation on an object if it has an UxrAnimatedTransform component currently attached.
	Translate	Starts a translation at a constant speed

Events

	Name	Description
	RotationFinished	Event called when the rotation animation finished. This only applies to rotation animations that end.
	ScalingFinished	Event called when the scaling animation finished. This only applies to scaling animations that end.
	TranslationFinished	Event called when the translation animation finished. This only applies to translation animations that end.

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.)