Class SceneAnimationTimeline

The timeline editor for scene animation asset.

System.Object
Control
ContainerControl
FlaxEditor.GUI.Timeline.Timeline
SceneAnimationTimeline
Namespace: FlaxEditor.GUI.Timeline
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class SceneAnimationTimeline : Timeline, IComparable, IDrawable, IKeyframesEditorContext

Constructors

SceneAnimationTimeline(Undo)

Initializes a new instance of the SceneAnimationTimeline class.

Declaration
public SceneAnimationTimeline(Undo undo)
Parameters
Undo undo

The undo/redo to use for the history actions recording. Optional, can be null to disable undo support.

Properties

Player

Gets or sets the animation player actor used for the timeline preview.

Declaration
public SceneAnimationPlayer Player { get; set; }
Property Value
SceneAnimationPlayer

ShowSelected3dTrack

Gets or sets the selected 3D track showing option value.

Declaration
public bool ShowSelected3dTrack { get; set; }
Property Value
System.Boolean

Methods

Load(SceneAnimation)

Loads the timeline from the specified SceneAnimation asset.

Declaration
public void Load(SceneAnimation asset)
Parameters
SceneAnimation asset

The asset.

OnDestroy()

Declaration
public override void OnDestroy()
Overrides
FlaxEditor.GUI.Timeline.Timeline.OnDestroy()

OnPause()

Declaration
public override void OnPause()
Overrides
FlaxEditor.GUI.Timeline.Timeline.OnPause()

OnPlay()

Declaration
public override void OnPlay()
Overrides
FlaxEditor.GUI.Timeline.Timeline.OnPlay()

OnSeek(Int32)

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

Overrides
FlaxEditor.GUI.Timeline.Timeline.OnSeek(System.Int32)

OnShowViewContextMenu(ContextMenu)

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

Overrides
FlaxEditor.GUI.Timeline.Timeline.OnShowViewContextMenu(FlaxEditor.GUI.ContextMenu.ContextMenu)

OnStop()

Declaration
public override void OnStop()
Overrides
FlaxEditor.GUI.Timeline.Timeline.OnStop()

Save(SceneAnimation)

Saves the timeline data to the SceneAnimation asset.

Declaration
public void Save(SceneAnimation asset)
Parameters
SceneAnimation asset

The asset.

SetupDragDrop()

Declaration
protected override void SetupDragDrop()
Overrides
FlaxEditor.GUI.Timeline.Timeline.SetupDragDrop()

Update(Single)

Declaration
public override void Update(float deltaTime)
Parameters
System.Single deltaTime

Overrides
FlaxEditor.GUI.Timeline.Timeline.Update(System.Single)

Events

PlayerChanged

Occurs when the selected player gets changed.

Declaration
public event Action PlayerChanged
Event Type
System.Action

ShowSelected3dTrackChanged

Occurs when selected 3D track showing option gets changed.

Declaration
public event Action ShowSelected3dTrackChanged
Event Type
System.Action

Extension Methods

See Also

FlaxEditor.GUI.Timeline.Timeline