Interface IGorgonTrackKeyBuilder<T>

A builder for building keys on a IGorgonAnimationTrack<T>.

Namespace: Gorgon.Animation

Assembly: Gorgon.Animation.dll

Syntax

public interface IGorgonTrackKeyBuilder<in T> where T : class, IGorgonKeyFrame

Type Parameters

Name	Description
T	The type of key frame, must implement IGorgonKeyFrame and be a reference type.

Methods

Clear()

Function to clear the key list for the track being edited.

Declaration

IGorgonTrackKeyBuilder<in T> Clear()

Returns

Type	Description
IGorgonTrackKeyBuilder<T>	The fluent interface for this builder.

See Also

IGorgonKeyFrame

DeleteKey(T)

Function to delete a key at the specified time index.

Declaration

IGorgonTrackKeyBuilder<in T> DeleteKey(T key)

Parameters

Type	Name	Description
T	key	The key to delete.

Returns

Type	Description
IGorgonTrackKeyBuilder<T>	The fluent interface for this builder.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the key is null.

See Also

IGorgonKeyFrame

DeleteKeyAtTime(float)

Function to delete a key at the specified time index.

Declaration

IGorgonTrackKeyBuilder<in T> DeleteKeyAtTime(float time)

Parameters

Type	Name	Description
float	time	The time index for the key.

Returns

Type	Description
IGorgonTrackKeyBuilder<T>	The fluent interface for this builder.

See Also

IGorgonKeyFrame

Disabled()

Function to mark the track as disabled.

Declaration

IGorgonTrackKeyBuilder<in T> Disabled()

Returns

Type	Description
IGorgonTrackKeyBuilder<T>	The fluent interface for this builder.

Remarks

Enabled tracks will play during the animation, disabled ones will not.

See Also

IGorgonKeyFrame

Enabled()

Function to mark the track as enabled.

Declaration

IGorgonTrackKeyBuilder<in T> Enabled()

Returns

Type	Description
IGorgonTrackKeyBuilder<T>	The fluent interface for this builder.

Remarks

Enabled tracks will play during the animation, disabled ones will not.

See Also

IGorgonKeyFrame

Enabled(bool)

Function to mark the track as enabled.

Declaration

IGorgonTrackKeyBuilder<in T> Enabled(bool isEnabled)

Parameters

Type	Name	Description
bool	isEnabled	true if the track should be enabled initially, or false if not.

Returns

Type	Description
IGorgonTrackKeyBuilder<T>	The fluent interface for this builder.

Remarks

Enabled tracks will play during the animation, disabled ones will not.

See Also

IGorgonKeyFrame

EndEdit()

Function to end editing of the track.

Declaration

GorgonAnimationBuilder EndEdit()

Returns

Type	Description
GorgonAnimationBuilder	The GorgonAnimationBuilder for the animation containing the track being edited.

See Also

GorgonAnimationBuilder

SetInterpolationMode(TrackInterpolationMode)

Function to set the interpolation mode for this track.

Declaration

IGorgonTrackKeyBuilder<in T> SetInterpolationMode(TrackInterpolationMode mode)

Parameters

Type	Name	Description
TrackInterpolationMode	mode	The interpolation mode to assign to the track.

Returns

Type	Description
IGorgonTrackKeyBuilder<T>	The fluent interface for this builder.

Remarks

Not all track types provide interpolation modes, in those cases, this value will be ignored.

See Also

IGorgonKeyFrame

SetKey(T)

Function to set a key to the track.

Declaration

IGorgonTrackKeyBuilder<in T> SetKey(T key)

Parameters

Type	Name	Description
T	key	The key to add.

Returns

Type	Description
IGorgonTrackKeyBuilder<T>	The fluent interface for this builder.

Remarks

This will add, or replace, using the Time index, a key frame on the track.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the key parameter is null.
ArgumentException	Thrown if the key is already in the key list.

See Also

IGorgonKeyFrame

SetKeys(IEnumerable<T>)

Function to assign a set of keys to the track.

Declaration

IGorgonTrackKeyBuilder<in T> SetKeys(IEnumerable<in T> keys)

Parameters

Type	Name	Description
IEnumerable<T>	keys	The list of keys to assign to the track.

Returns

Type	Description
IGorgonTrackKeyBuilder<T>	The fluent interface for this builder.

Remarks

This will add, or replace, using the Time index, a key frame on the track.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the keys parameter is null.
ArgumentException	Thrown if a key within the keys parameter is already in the key list.

See Also

IGorgonKeyFrame

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)

GorgonNullExtensions.AsNullable<T>(object)

GorgonNullExtensions.IfNull<T>(object, T)

GorgonNullExtensions.IsNull(object)

See Also

IGorgonKeyFrame