AgateLib.Sprites.FrameList< T > Class Template Reference
Class which contains a list of sprite frames. More...
Inheritance diagram for AgateLib.Sprites.FrameList< T >:
Public Member Functions | |
| int | IndexOf (T item) |
| Returns the index of the specified frame. | |
| void | Insert (int index, T item) |
| Inserts a sprite frame into the list. | |
| void | RemoveAt (int index) |
| Removes a sprite frame by index. | |
| void | Add (T item) |
| Adds a sprite frame to the list. | |
| void | Clear () |
| Clears the list of sprite frames. | |
| bool | Contains (T item) |
| Returns true if the specified frame is in the list. | |
| void | CopyTo (T[] array, int arrayIndex) |
| Copies the list to an array. | |
| bool | Remove (T item) |
| Removes the specified item, if it is in the list. | |
| IEnumerator< T > | GetEnumerator () |
| Enumerates through the frames. | |
Properties | |
| T | this [int index] [get, set] |
| Gets or sets the sprite frame at the specified index. | |
| int | Count [get] |
| Returns the number of frames in the list. | |
| bool | IsReadOnly [get] |
| Always false. | |
Detailed Description
template<T>
class AgateLib::Sprites::FrameList< T >
Class which contains a list of sprite frames.
- Template Parameters:
-
T Type which should implement the ISpriteFrame interface.
- Type Constraints
-
T : ISpriteFrame
Member Function Documentation
template<T >
| void AgateLib.Sprites.FrameList< T >.Add | ( | T | item | ) |
Adds a sprite frame to the list.
- Parameters:
-
item
template<T >
| void AgateLib.Sprites.FrameList< T >.Clear | ( | ) |
Clears the list of sprite frames.
template<T >
| bool AgateLib.Sprites.FrameList< T >.Contains | ( | T | item | ) |
Returns true if the specified frame is in the list.
- Parameters:
-
item
- Returns:
template<T >
| void AgateLib.Sprites.FrameList< T >.CopyTo | ( | T[] | array, | |
| int | arrayIndex | |||
| ) |
Copies the list to an array.
- Parameters:
-
array arrayIndex
template<T >
| IEnumerator<T> AgateLib.Sprites.FrameList< T >.GetEnumerator | ( | ) |
Enumerates through the frames.
- Returns:
template<T >
| int AgateLib.Sprites.FrameList< T >.IndexOf | ( | T | item | ) |
Returns the index of the specified frame.
- Parameters:
-
item
- Returns:
template<T >
| void AgateLib.Sprites.FrameList< T >.Insert | ( | int | index, | |
| T | item | |||
| ) |
Inserts a sprite frame into the list.
- Parameters:
-
index item
template<T >
| bool AgateLib.Sprites.FrameList< T >.Remove | ( | T | item | ) |
Removes the specified item, if it is in the list.
- Parameters:
-
item
- Returns:
template<T >
| void AgateLib.Sprites.FrameList< T >.RemoveAt | ( | int | index | ) |
Removes a sprite frame by index.
- Parameters:
-
index
Property Documentation
template<T >
int AgateLib.Sprites.FrameList< T >.Count [get] |
template<T >
bool AgateLib.Sprites.FrameList< T >.IsReadOnly [get] |
Always false.
template<T >
T AgateLib.Sprites.FrameList< T >.this[int index] [get, set] |
Gets or sets the sprite frame at the specified index.
- Parameters:
-
index
- Returns:
Implements AgateLib.Sprites.IFrameList.
The documentation for this class was generated from the following file:
- Sprites/FrameList.cs
