C# Class WaveEngine.Components.Graphics2D.SpriteAtlas

A collection of images.

Inheritance: Component, IDisposable

显示文件 Open project: WaveEngine/Components Class Usage Examples

Public Properties

Property	Type	Description
SourceRectangle	Rectangle

Protected Properties

Property	Type	Description
disposed	bool

Private Properties

Property	Type	Description
RefreshAtlasTexture	void
RefreshTextureIndex	void

Public Methods

Method	Description
Dispose ( ) : void	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
SpriteAtlas ( ) : System	Initializes a new instance of the SpriteAtlas class.
SpriteAtlas ( string atlasPath ) : System	Initializes a new instance of the SpriteAtlas class.
SpriteAtlas ( string atlasPath, string textureName ) : System	Initializes a new instance of the SpriteAtlas class.

Protected Methods

Method	Description
DefaultValues ( ) : void	Sets default values
Dispose ( bool disposing ) : void	Releases unmanaged and - optionally - managed resources
Initialize ( ) : void	Performs further custom initialization for this instance.
RefreshSourceRectangle ( ) : void	Refresh the source rectangle of the sprite transform 2D.

Private Methods

Method	Description
RefreshAtlasTexture ( ) : void	Refresh the atlas texture
RefreshTextureIndex ( ) : void	Refresh texture index from its name

Method Details

DefaultValues() protected method

Sets default values

protected DefaultValues ( ) : void
return	void

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public Dispose ( ) : void
return	void

Dispose() protected method

Releases unmanaged and - optionally - managed resources

protected Dispose ( bool disposing ) : void
disposing	bool	/// true to release both managed and unmanaged resources; false to release only unmanaged resources. ///
return	void

Initialize() protected method

Performs further custom initialization for this instance.

protected Initialize ( ) : void
return	void

RefreshSourceRectangle() protected method

Refresh the source rectangle of the sprite transform 2D.

SpriteAtlas has been disposed.

protected RefreshSourceRectangle ( ) : void
return	void

SpriteAtlas() public method

Initializes a new instance of the SpriteAtlas class.

public SpriteAtlas ( ) : System
return	System

SpriteAtlas() public method

Initializes a new instance of the SpriteAtlas class.

TexturePath can not be null.

public SpriteAtlas ( string atlasPath ) : System
atlasPath	string	The path to the atlas.
return	System

SpriteAtlas() public method

Initializes a new instance of the SpriteAtlas class.

TexturePath can not be null.

public SpriteAtlas ( string atlasPath, string textureName ) : System
atlasPath	string	The path to the atlas.
textureName	string	Name of the texture from where this atlas is loaded.
return	System

Property Details

SourceRectangle public_oe property

Rectangle for the Image of the atlas that will be rendered.

public Rectangle SourceRectangle
return	Rectangle

disposed protected_oe property

The disposed.

protected bool disposed
return	bool