Class Container
Container for all the renderables
Inheritance
object
Container
Namespace: Terminaux.Writer.CyclicWriters.Renderer
Assembly: Terminaux.dll
Syntax
public class Container
Methods
| Edit this page View SourceAddRenderable(string, CyclicWriter)
Adds a renderable to the list
Declaration
public void AddRenderable(string name, CyclicWriter renderable)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Renderable name |
| CyclicWriter | renderable | Renderable instance |
Exceptions
| Type | Condition |
|---|---|
| TerminauxException |
GetRenderable(string)
Gets a renderable
Declaration
public CyclicWriter GetRenderable(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Renderable name |
Returns
| Type | Description |
|---|---|
| CyclicWriter | Renderable instance |
Exceptions
| Type | Condition |
|---|---|
| TerminauxException |
GetRenderableNames()
Gets the renderable names
Declaration
public string[] GetRenderableNames()
Returns
| Type | Description |
|---|---|
| string[] |
GetRenderablePosition(string)
Gets the position of a renderable
Declaration
public Coordinate GetRenderablePosition(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Renderable name |
Returns
| Type | Description |
|---|---|
| Coordinate | Coordinates of a renderable |
Exceptions
| Type | Condition |
|---|---|
| TerminauxException |
GetRenderableSize(string)
Gets the size of a renderable
Declaration
public Size GetRenderableSize(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Renderable name |
Returns
| Type | Description |
|---|---|
| Size | Size of a renderable |
Exceptions
| Type | Condition |
|---|---|
| TerminauxException |
IsRegistered(string)
Whether this renderable is registered or not
Declaration
public bool IsRegistered(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the renderable |
Returns
| Type | Description |
|---|---|
| bool | True if registered; false otherwise |
RemoveRenderable(string)
Removes a renderable from the list
Declaration
public void RemoveRenderable(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Renderable name |
Exceptions
| Type | Condition |
|---|---|
| TerminauxException |
SetRenderablePosition(string, Coordinate)
Sets the position of a renderable
Declaration
public void SetRenderablePosition(string name, Coordinate position)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Renderable name |
| Coordinate | position | 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
| Type | Name | Description |
|---|---|---|
| string | name | Renderable name |
| Size | size | Size to set |
Exceptions
| Type | Condition |
|---|---|
| TerminauxException |