Class ObjectTrack

The timeline track for animating managed objects.

System.Object
Control
ContainerControl
FlaxEditor.GUI.Timeline.Track
ConductorTrack
ObjectTrack
ActorTrack
ScriptTrack
Namespace: FlaxEditor.GUI.Timeline.Tracks
Assembly: FlaxEngine.CSharp.dll
Syntax
public abstract class ObjectTrack : ConductorTrack, IComparable, IDrawable, IKeyframesEditorContext, IObjectTrack

Constructors

ObjectTrack(ref TrackCreateOptions, Boolean)

Initializes a new instance of the ObjectTrack class.

Declaration
protected ObjectTrack(ref TrackCreateOptions options, bool useProxyKeyframes = true)
Parameters
FlaxEditor.GUI.Timeline.TrackCreateOptions options

The track initial options.
System.Boolean useProxyKeyframes

True if show sub-tracks keyframes as a proxy on this track, otherwise false.

Fields

_addButton

The add button.

Declaration
protected Button _addButton
Field Value
Button

BasicTypesTrackArchetypes

Maps the type to the default track archetype for it.

Declaration
protected static readonly Dictionary<Type, TrackArchetype> BasicTypesTrackArchetypes
Field Value
System.Collections.Generic.Dictionary<System.Type, FlaxEditor.GUI.Timeline.TrackArchetype>

Properties

Object

Gets the object instance (may be null if reference is invalid or data is missing).

Declaration
public abstract object Object { get; }
Property Value
System.Object

Methods

AddEvents(Track, ContextMenu, Type, Func<MemberInfo, Boolean>)

Adds the object events track options to menu.

Declaration
public static int AddEvents(Track parentTrack, ContextMenu menu, Type type, Func<MemberInfo, bool> memberCheck = null)
Parameters
FlaxEditor.GUI.Timeline.Track parentTrack

The parent track.
FlaxEditor.GUI.ContextMenu.ContextMenu menu

The menu.
System.Type type

The object type.
System.Func<System.Reflection.MemberInfo, System.Boolean> memberCheck

The custom callback that can reject the members that should not be animated. Returns true if member is valid. Can be null to skip this feature.
Returns
System.Int32

The added options count.

AddProperties(Track, ContextMenu, Type, Func<MemberInfo, Boolean>)

Adds the object properties animation track options to menu.

Declaration
public static int AddProperties(Track parentTrack, ContextMenu menu, Type type, Func<MemberInfo, bool> memberCheck = null)
Parameters
FlaxEditor.GUI.Timeline.Track parentTrack

The parent track.
FlaxEditor.GUI.ContextMenu.ContextMenu menu

The menu.
System.Type type

The object type.
System.Func<System.Reflection.MemberInfo, System.Boolean> memberCheck

The custom callback that can reject the members that should not be animated. Returns true if member is valid. Can be null to skip this feature.
Returns
System.Int32

The added options count.

AddPropertyTrack(MemberInfo)

Adds the property or field track to this object track.

Declaration
public MemberTrack AddPropertyTrack(MemberInfo m)
Parameters
System.Reflection.MemberInfo m

The member (property or a field).
Returns
MemberTrack

The created track or null if failed.

OnAddMemberTrack(ContextMenuButton)

Called on context menu button click to add new object property animation track. Button should have FlaxEditor.GUI.Timeline.Tracks.ObjectTrack.AddMemberTag value assigned to the FlaxEngine.GUI.Control.Tag field.

Declaration
public static void OnAddMemberTrack(ContextMenuButton button)
Parameters
FlaxEditor.GUI.ContextMenu.ContextMenuButton button

The button (with FlaxEditor.GUI.Timeline.Tracks.ObjectTrack.AddMemberTag value assigned to the FlaxEngine.GUI.Control.Tag field.).

OnDestroy()

Declaration
public override void OnDestroy()
Overrides

OnObjectExistenceChanged(Object)

Called when object existence gets changed (eg. object found after being not found).

Declaration
protected virtual void OnObjectExistenceChanged(object obj)
Parameters
System.Object obj

The object.

OnShowAddContextMenu(ContextMenu)

Called when showing the context menu for add button (for sub-tracks adding).

Declaration
protected virtual void OnShowAddContextMenu(ContextMenu menu)
Parameters
FlaxEditor.GUI.ContextMenu.ContextMenu menu

The menu.

Update(Single)

Perform control update and all its children

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

Delta time in seconds
Overrides

Extension Methods

See Also

FlaxEditor.GUI.Timeline.Track