Interface IGorgonAnimationTrack<T>
A track for a IGorgonAnimation.
Inherited Members
Namespace: Gorgon.Animation
Assembly: Gorgon.Animation.dll
Syntax
public interface IGorgonAnimationTrack<out T> : IGorgonNamedObject where T : IGorgonKeyFrameType Parameters
| Name | Description |
|---|---|
| T | The type of key frame, must implement IGorgonKeyFrame |
Remarks
Tracks contain a list of values in time, called key frames. These key frames tell the animation what the value for a property should be at the specified time.
Properties
| Edit this page View SourceInterpolationMode
Property to set or return the interpolation mode.
Declaration
TrackInterpolationMode InterpolationMode { get; set; }Property Value
| Type | Description |
|---|---|
| TrackInterpolationMode |
Remarks
If the value assigned is not supported by the track (use the SupportsInterpolation property), then the original value is kept.
See Also
| Edit this page View SourceIsEnabled
Property to set or return whether this track is enabled during animation.
Declaration
[JsonProperty("isEnabled")]
bool IsEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
| Edit this page View SourceKeyFrameDataType
Property to return the type of key frame data stored in this track.
Declaration
[JsonIgnore]
AnimationTrackKeyType KeyFrameDataType { get; }Property Value
| Type | Description |
|---|---|
| AnimationTrackKeyType |
See Also
| Edit this page View SourceKeyFrames
Property to return the key frames for the track.
Declaration
[JsonProperty("keyframes")]
IReadOnlyList<out T> KeyFrames { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<T> |
See Also
| Edit this page View SourceSplineController
Property to return the spline controller (if applicable) for the track.
Declaration
[JsonIgnore]
IGorgonSplineCalculation SplineController { get; }Property Value
| Type | Description |
|---|---|
| IGorgonSplineCalculation |
See Also
| Edit this page View SourceSupportsInterpolation
Property to return the type of interpolation supported by the track.
Declaration
[JsonIgnore]
TrackInterpolationMode SupportsInterpolation { get; }Property Value
| Type | Description |
|---|---|
| TrackInterpolationMode |
See Also
Methods
| Edit this page View SourceGetValueAtTime(float)
Function to retrieve the value at the specified time index.
Declaration
T GetValueAtTime(float timeIndex)Parameters
| Type | Name | Description |
|---|---|---|
| float | timeIndex | The time index, in seconds, within the track to retrieve the value from. |
Returns
| Type | Description |
|---|---|
| T | The value at the specified time index. |
Remarks
The value returned by this method may or may not be interpolated based on the value in InterpolationMode.