Interface IKeyframesEditorContext

Interface for context for collection of FlaxEditor.GUI.IKeyframesEditor.

Namespace: FlaxEditor.GUI
Assembly: FlaxEngine.CSharp.dll
Syntax
public interface IKeyframesEditorContext

Methods

OnKeyframesCopy(IKeyframesEditor, Nullable<Single>, StringBuilder)

Called when keyframes selection should be copied.

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

OnKeyframesDelete(IKeyframesEditor)

Called when keyframes selection should be deleted for all editors.

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

The source editor.

OnKeyframesDeselect(IKeyframesEditor)

Called when keyframes selection should be cleared for all editors.

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

The source editor.

OnKeyframesGet(Action<String, Single, Object>)

Called when collecting keyframes from the context.

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

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

Called when keyframes selection should be moved.

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

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

Called when keyframes should be pasted (from clipboard).

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

OnKeyframesSelection(IKeyframesEditor, ContainerControl, Rectangle)

Called when keyframes selection rectangle gets updated.

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

OnKeyframesSelectionCount()

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

Declaration
int OnKeyframesSelectionCount()
Returns
System.Int32

The selected keyframes amount.

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

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

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

Extension Methods