C# Class geek.GameEngine.Utils.Timeline

A class that can execute events at given points of time.

Show file Open project: impworks/xna.geek.engine Class Usage Examples

Public Properties

Property	Type	Description
IsLooped	bool
Paused	bool

Public Methods

Method	Description
Add ( float time, System.Action action, string comment = null ) : int	Add a keyframe to the list.
AddAbsolute ( float time, System.Action action, string comment = null ) : int
Remove ( int id ) : void	Remove a keyframe by it's ID.
Timeline ( ) : System
Update ( ) : void	Update the timeline and execute current action.

Private Methods

Method	Description
clearSkipped ( ) : void
shiftCurrent ( ) : void

Method Details

Add() public method

Add a keyframe to the list.

public Add ( float time, System.Action action, string comment = null ) : int
time	float	Desired time.
action	System.Action	Desired action.
comment	string	Optional debugging comment.
return	int

AddAbsolute() public method

public AddAbsolute ( float time, System.Action action, string comment = null ) : int
time	float
action	System.Action
comment	string
return	int

Remove() public method

Remove a keyframe by it's ID.

public Remove ( int id ) : void
id	int	Keyframe's unique ID in the timeline returned by 'Add' method.
return	void

Timeline() public method

public Timeline ( ) : System
return	System

Update() public method

Update the timeline and execute current action.

public Update ( ) : void
return	void

Property Details

IsLooped public property

Gets or sets the looping flag.

public bool IsLooped
return	bool

Paused public property

Gets or sets the paused flag.

public bool Paused
return	bool