Class Container

Container for all the renderables

Inheritance

object

Container

Namespace

Terminaux.Writer.CyclicWriters.Renderer @ Terminaux.dll

Syntax

public class Container

Methods

AddRenderable(string, CyclicWriter)

Adds a renderable to the list

Declaration

public void AddRenderable(string name, CyclicWriter renderable)

Parameters

Name	Type	Description
name	string	Renderable name
renderable	CyclicWriter	Renderable instance

Exceptions

Type	Condition
TerminauxException

GetRenderable(string)

Gets a renderable

Returns

CyclicWriter

Renderable instance

Declaration

public CyclicWriter GetRenderable(string name)

Parameters

Name	Type	Description
name	string	Renderable name

Exceptions

Type	Condition
TerminauxException

GetRenderableNames()

Gets the renderable names

Returns

string[]

Declaration

public string[] GetRenderableNames()

GetRenderablePosition(string)

Gets the position of a renderable

Returns

Coordinate

Coordinates of a renderable

Declaration

public Coordinate GetRenderablePosition(string name)

Parameters

Name	Type	Description
name	string	Renderable name

Exceptions

Type	Condition
TerminauxException

GetRenderableSize(string)

Gets the size of a renderable

Returns

Size

Size of a renderable

Declaration

public Size GetRenderableSize(string name)

Parameters

Name	Type	Description
name	string	Renderable name

Exceptions

Type	Condition
TerminauxException

IsRegistered(string)

Whether this renderable is registered or not

Returns

bool

True if registered; false otherwise

Declaration

public bool IsRegistered(string name)

Parameters

Name	Type	Description
name	string	Name of the renderable

RemoveRenderable(string)

Removes a renderable from the list

Declaration

public void RemoveRenderable(string name)

Parameters

Name	Type	Description
name	string	Renderable name

Exceptions

Type	Condition
TerminauxException

RemoveRenderables()

Removes all renderables from the list

Declaration

public void RemoveRenderables()

SetRenderablePosition(string, Coordinate)

Sets the position of a renderable

Declaration

public void SetRenderablePosition(string name, Coordinate position)

Parameters

Name	Type	Description
name	string	Renderable name
position	Coordinate	Position to set

Exceptions

Type	Condition
TerminauxException

SetRenderableSize(string, Size)

Sets the size of a renderable

Declaration

public void SetRenderableSize(string name, Size size)

Parameters

Name	Type	Description
name	string	Renderable name
size	Size	Size to set

Exceptions

Type	Condition
TerminauxException