| SpriteCollection Class |
Categorizes / collects sprite instances
Inheritance HierarchyNamespace: (Default Namespace)
Assembly: Default (in Default.exe) Version: 1.0.0.0
SyntaxC#
[SerializableAttribute] public class SpriteCollection : CollectionBase
The SpriteCollection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SpriteCollection |
Constructs a sprite collection given a list of all the sprites it should contain.
|
Methods| Name | Description | |
|---|---|---|
| Add |
Add a dynamic sprite to the end of this sprite collection.
|
| Clean |
Remove inactive dynamic sprites from the collection
|
| Clear | Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator | Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf |
Determine the index of the specified sprite in the collection.
|
| Remove |
Remove the specified sprite from this collection.
|
| RemoveAt | Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
  | maxCollectionSize |
Defines a maximum sprite collection size to help ensure dynamic sprites are not
"leaking" into the system without getting cleaned up.
|
| staticSize |
Indicates the initial size of this collection, and the size below which
sprites are never removed.
|
Properties| Name | Description | |
|---|---|---|
 | Capacity | Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.) |
| Count | Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.) |
| Item |
Return a sprite instance from the collection given its 0-based index.
|
RemarksInstances of this class are used both to represent the entire collection
of sprites contained within a layer m_Sprites as well
as sub-collections of these sprites divided into individual categories, exposed by
m_SpriteCategories. Sprite collections can contain static
and dynamic sprites. For more information about this distinction, see remarks in
staticSize.
See Also