C# Class SadConsole.Consoles.LayeredTextSurface

Inheritance: TextSurface

Show file Open project: Thraka/SadConsole Class Usage Examples

Private Properties

Property	Type	Description
AfterDeserialized	void
AfterSerialized	void
BeforeSerialized	void

Public Methods

Method	Description
Add ( ) : Layer	Adds a new layer.
Add ( ITextSurface surface ) : Layer	Creates and adds a new layer based on an existing surface.
GetLayer ( int index ) : Layer	Gets a specific layer.
GetLayers ( ) : Layer[]	Gets all of the layers.
IndexOf ( Layer layer ) : int	Gets the index of a layer.
LayeredTextSurface ( int width, int height, Font font, int layers ) : System	Creates a new layer text surface with the specified font.
LayeredTextSurface ( int width, int height, int layers ) : System	Creates a new layer text surface with the default Font.
Load ( string file ) : LayeredTextSurface	Loads a LayeredTextSurface from a file.
Move ( Layer layer, int index ) : void	Moves a layer to the specified index.
MoveToBottom ( Layer layer ) : void	Moves a layer to the bottom.
MoveToTop ( Layer layer ) : void	Moves a layer to the top.
Remove ( Layer layer ) : void	Removes a layer.
Remove ( int index ) : void	Removes a layer.
Save ( string file ) : void	Saves the LayeredTextSurface to a file.
SetActiveLayer ( Layer layer ) : void	Changes the active layer, which sets the current cell data for ITextSurfaceRendered.
SetActiveLayer ( int index ) : void	Changes the active layer, which sets the current cell data for ITextSurfaceRendered.

Protected Methods

Method	Description
InitializeCells ( ) : void	Sets up all the cells of a layer for the first time.
InitializeLayer ( Layer layer ) : void	Initializes a layers cells.
ResetArea ( ) : void	Resets all layer areas.
ResetAreaLayer ( Layer layer ) : void	Sets up the layers render cells.
SyncLayerIndex ( ) : void	Sets the Layer.Index of each layer to the index it appears in the layers.

Private Methods

Method	Description
AfterDeserialized ( StreamingContext context ) : void
AfterSerialized ( StreamingContext context ) : void
BeforeSerialized ( StreamingContext context ) : void

Method Details

Add() public method

Adds a new layer.

public Add ( ) : Layer
return	Layer

Add() public method

Creates and adds a new layer based on an existing surface.

public Add ( ITextSurface surface ) : Layer
surface	ITextSurface	The surface. Must be the same width/height of this
return	Layer

GetLayer() public method

Gets a specific layer.

public GetLayer ( int index ) : Layer
index	int	The zero-based layer to get.
return	Layer

GetLayers() public method

Gets all of the layers.

public GetLayers ( ) : Layer[]
return	Layer[]

IndexOf() public method

Gets the index of a layer.

public IndexOf ( Layer layer ) : int
layer	Layer	The layer to check.
return	int

InitializeCells() protected method

Sets up all the cells of a layer for the first time.

protected InitializeCells ( ) : void
return	void

InitializeLayer() protected method

Initializes a layers cells.

protected InitializeLayer ( Layer layer ) : void
layer	Layer	The layer to setup.
return	void

LayeredTextSurface() public method

Creates a new layer text surface with the specified font.

public LayeredTextSurface ( int width, int height, Font font, int layers ) : System
width	int	Width of the layers.
height	int	Height of the layers.
font	Font	The font.
layers	int	The count of layers.
return	System

LayeredTextSurface() public method

Creates a new layer text surface with the default Font.

public LayeredTextSurface ( int width, int height, int layers ) : System
width	int	Width of the layers.
height	int	Height of the layers.
layers	int	The count of layers.
return	System

Load() public static method

Loads a LayeredTextSurface from a file.

public static Load ( string file ) : LayeredTextSurface
file	string	The source file.
return	LayeredTextSurface

Move() public method

Moves a layer to the specified index.

public Move ( Layer layer, int index ) : void
layer	Layer	The layer to check.
index	int	The new index of the layer.
return	void

MoveToBottom() public method

Moves a layer to the bottom.

public MoveToBottom ( Layer layer ) : void
layer	Layer	The layer to check.
return	void

MoveToTop() public method

Moves a layer to the top.

public MoveToTop ( Layer layer ) : void
layer	Layer	The layer to check.
return	void

Remove() public method

Removes a layer.

public Remove ( Layer layer ) : void
layer	Layer	The layer to remove.
return	void

Remove() public method

Removes a layer.

public Remove ( int index ) : void
index	int	The layer index to remove.
return	void

ResetArea() protected method

Resets all layer areas.

protected ResetArea ( ) : void
return	void

ResetAreaLayer() protected method

Sets up the layers render cells.

protected ResetAreaLayer ( Layer layer ) : void
layer	Layer
return	void

Save() public method

Saves the LayeredTextSurface to a file.

public Save ( string file ) : void
file	string	The destination file.
return	void

SetActiveLayer() public method

Changes the active layer, which sets the current cell data for ITextSurfaceRendered.

public SetActiveLayer ( Layer layer ) : void
layer	Layer	The layer to set active.
return	void

SetActiveLayer() public method

Changes the active layer, which sets the current cell data for ITextSurfaceRendered.

public SetActiveLayer ( int index ) : void
index	int	The zero-based index of the layer.
return	void

SyncLayerIndex() protected method

Sets the Layer.Index of each layer to the index it appears in the layers.

protected SyncLayerIndex ( ) : void
return	void