UxrInterpolationSettings Class

Describes the different parameters of an interpolation.

Inheritance Hierarchy

System.Object
  UltimateXR.Animation.Interpolation.UxrInterpolationSettings
Namespace: UltimateXR.Animation.Interpolation
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

[SerializableAttribute]
public class UxrInterpolationSettings


The UxrInterpolationSettings type exposes the following members.

Constructors

NameDescription
Public methodUxrInterpolationSettings() Default constructor
Public methodUxrInterpolationSettings(Single, Single, UxrEasing, UxrLoopMode, Single, Boolean, Boolean) UxrInterpolationSettings constructor.

Properties

NameDescription
Public propertyDelaySeconds Gets or sets the interpolation delay in seconds. The delay is usually relative to the time the object that it uses was enabled and specifies an initial waiting time before the actual interpolation will start.
Public propertyDelayUsingEndValue Gets or sets whether to use the interpolation end value during the initial delay, if there is a DelaySeconds value specified. By default the interpolation uses the start value during the initial delay.
Public propertyDurationSeconds Gets or sets the interpolation duration in seconds. In looped interpolations it tells the duration of a single loop.
Public propertyEasing Gets or sets the easing function to use by the interpolation.
Public propertyLoopedDurationSeconds Gets or sets the total animation duration in interpolations that use looping. The duration of a single loop is described by DurationSeconds. A negative value tells to loop indefinitely.
Public propertyLoopMode Gets or sets if and how to loop the interpolation.
Public propertyUseUnscaledTime Gets or sets whether to use unscaled time (unscaledTime) or regular time time when interpolating. Regular time is affected by timeScale, which is normally used to pause the application or simulate slow motion effects.

Methods

NameDescription
Public methodCheckInterpolationHasFinished Checks if the given time has surpassed the interpolation duration.
Public methodGetInterpolationFactor Gets the T value used for linear interpolations given a time value.

Extension Methods

NameDescription
Public Extension MethodThrowIfNull Throws an exception if the object is null. (Defined by ObjectExt.)

See Also

Reference

UltimateXR.Animation.Interpolation Namespace