Class KeyframesPropertyTrack

The timeline track for animating object property via keyframes collection.

System.Object
Control
ContainerControl
FlaxEditor.GUI.Timeline.Track
ConductorTrack
MemberTrack
KeyframesPropertyTrack
ObjectReferencePropertyTrack
StringPropertyTrack
Namespace: FlaxEditor.GUI.Timeline.Tracks
Assembly: FlaxEngine.CSharp.dll
Syntax
public class KeyframesPropertyTrack : MemberTrack, IComparable, IDrawable, IKeyframesEditorContext

Constructors

KeyframesPropertyTrack(ref TrackCreateOptions)

Declaration
public KeyframesPropertyTrack(ref TrackCreateOptions options)
Parameters
FlaxEditor.GUI.Timeline.TrackCreateOptions options

Fields

Keyframes

The keyframes editor.

Declaration
public KeyframesEditor Keyframes
Field Value
FlaxEditor.GUI.KeyframesEditor

Methods

Evaluate(Single)

Evaluates the member value at the specified time.

Declaration
public override object Evaluate(float time)
Parameters
System.Single time

The time to evaluate the member at.
Returns
System.Object

The member value at provided time.
Overrides

GetArchetype()

Gets the archetype.

Declaration
public static TrackArchetype GetArchetype()
Returns
FlaxEditor.GUI.Timeline.TrackArchetype

The archetype.

GetDefaultValue(Type)

Gets the default value for the given property type.

Declaration
protected virtual object GetDefaultValue(Type propertyType)
Parameters
System.Type propertyType

The type of the property.
Returns
System.Object

The default value.

GetNextKeyframeFrame(Single, out Int32)

Declaration
public override bool GetNextKeyframeFrame(float time, out int result)
Parameters
System.Single time

System.Int32 result

Returns
System.Boolean

Overrides
FlaxEditor.GUI.Timeline.Track.GetNextKeyframeFrame(System.Single, System.Int32)

GetPreviousKeyframeFrame(Single, out Int32)

Declaration
public override bool GetPreviousKeyframeFrame(float time, out int result)
Parameters
System.Single time

System.Int32 result

Returns
System.Boolean

Overrides
FlaxEditor.GUI.Timeline.Track.GetPreviousKeyframeFrame(System.Single, System.Int32)

OnContextMenu(ContextMenu)

Declaration
protected override void OnContextMenu(ContextMenu menu)
Parameters
FlaxEditor.GUI.ContextMenu.ContextMenu menu

Overrides
FlaxEditor.GUI.Timeline.Track.OnContextMenu(FlaxEditor.GUI.ContextMenu.ContextMenu)

OnDestroy()

Declaration
public override void OnDestroy()
Overrides

OnKeyframesCopy(IKeyframesEditor, Nullable<Single>, StringBuilder)

Called when keyframes selection should be copied.

Declaration
public void OnKeyframesCopy(IKeyframesEditor editor, Nullable<float> timeOffset, StringBuilder data)
Parameters
FlaxEditor.GUI.IKeyframesEditor editor

The source editor.
System.Nullable<System.Single> timeOffset

The additional time offset to apply to the copied keyframes (optional).
System.Text.StringBuilder data

The result copy data text stream.
Implements

OnKeyframesDelete(IKeyframesEditor)

Called when keyframes selection should be deleted for all editors.

Declaration
public void OnKeyframesDelete(IKeyframesEditor editor)
Parameters
FlaxEditor.GUI.IKeyframesEditor editor

The source editor.
Implements

OnKeyframesDeselect(IKeyframesEditor)

Called when keyframes selection should be cleared for all editors.

Declaration
public void OnKeyframesDeselect(IKeyframesEditor editor)
Parameters
FlaxEditor.GUI.IKeyframesEditor editor

The source editor.
Implements

OnKeyframesGet(Action<String, Single, Object>)

Called when collecting keyframes from the context.

Declaration
public void OnKeyframesGet(Action<string, float, object> get)
Parameters
System.Action<System.String, System.Single, System.Object> get

The getter function to call for all keyframes. Args are: track name, keyframe time, keyframe object.
Implements

OnKeyframesMove(IKeyframesEditor, ContainerControl, Float2, Boolean, Boolean)

Called when keyframes selection should be moved.

Declaration
public void OnKeyframesMove(IKeyframesEditor editor, ContainerControl control, Float2 location, bool start, bool end)
Parameters
FlaxEditor.GUI.IKeyframesEditor editor

The source editor.
ContainerControl control

The source movement control.
Float2 location

The source movement location (in source control local space).
System.Boolean start

The movement start flag.
System.Boolean end

The movement end flag.
Implements

OnKeyframesPaste(IKeyframesEditor, Nullable<Single>, String[], ref Int32)

Called when keyframes should be pasted (from clipboard).

Declaration
public void OnKeyframesPaste(IKeyframesEditor editor, Nullable<float> timeOffset, string[] datas, ref int index)
Parameters
FlaxEditor.GUI.IKeyframesEditor editor

The source editor.
System.Nullable<System.Single> timeOffset

The additional time offset to apply to the pasted keyframes (optional).
System.String[] datas

The pasted data text.
System.Int32 index

The counter for the current data index. Set to -1 until the calling editor starts paste operation.
Implements

OnKeyframesSelection(IKeyframesEditor, ContainerControl, Rectangle)

Called when keyframes selection rectangle gets updated.

Declaration
public void OnKeyframesSelection(IKeyframesEditor editor, ContainerControl control, Rectangle selection)
Parameters
FlaxEditor.GUI.IKeyframesEditor editor

The source editor.
ContainerControl control

The source selection control.
Rectangle selection

The source selection rectangle (in source control local space).
Implements

OnKeyframesSelectionCount()

Called to calculate the total amount of selected keyframes in the editor.

Declaration
public int OnKeyframesSelectionCount()
Returns
System.Int32

The selected keyframes amount.
Implements

OnKeyframesSet(List<KeyValuePair<Single, Object>>)

Called when setting keyframes data (opposite to OnKeyframesGet(Action<String, Single, Object>)).

Declaration
public void OnKeyframesSet(List<KeyValuePair<float, object>> keyframes)
Parameters
System.Collections.Generic.List<System.Collections.Generic.KeyValuePair<System.Single, System.Object>> keyframes

The list of keyframes, null for empty list. Keyframe data is: time and keyframe object.
Implements

OnMemberChanged(MemberInfo, Type)

Called when member gets changed.

Declaration
protected override void OnMemberChanged(MemberInfo value, Type type)
Parameters
System.Reflection.MemberInfo value

The member value assigned.
System.Type type

The member type assigned.
Overrides

OnTimelineArrange()

Declaration
public override void OnTimelineArrange()
Overrides

OnTimelineChanged(Timeline)

Declaration
public override void OnTimelineChanged(Timeline timeline)
Parameters
FlaxEditor.GUI.Timeline.Timeline timeline

Overrides

OnTimelineCurrentFrameChanged(Int32)

Declaration
public override void OnTimelineCurrentFrameChanged(int frame)
Parameters
System.Int32 frame

Overrides
FlaxEditor.GUI.Timeline.Track.OnTimelineCurrentFrameChanged(System.Int32)

OnTimelineFpsChanged(Single, Single)

Declaration
public override void OnTimelineFpsChanged(float before, float after)
Parameters
System.Single before

System.Single after

Overrides

OnTimelineZoomChanged()

Declaration
public override void OnTimelineZoomChanged()
Overrides

OnUndo()

Declaration
public override void OnUndo()
Overrides
FlaxEditor.GUI.Timeline.Track.OnUndo()

OnVisibleChanged()

Called when visible state gets changed.

Declaration
protected override void OnVisibleChanged()
Overrides

Extension Methods

See Also