Public classes

Controller
DisplayModel
DotMatrix
TextToContent

Commands/

   AbsCmd
   AbsCmdPosition
   AbsCmdSpeed
   CallbackCommand
   ClearCommand
   ContentCommand
   PauseCommand
   TextCommand

Displays/

   Display
   Display_3D
   Display_Sprite
   Display_UI


Introduction page

Controller


Class that runs given commands which then change content of the DotMatrix display. Commands sent to controller are executed one by one in queue.

This class doesn't have public constructor. Instance of this class is automatically created when DotMatrix initializes. After that reference to this class can be get from DotMatrix using GetController() method.

If you need to access display dots directly, use DisplayModel instead.


Properties

public float DefaultSpeedDotsPerSecondSets or gets the default speed in dots per second.
public TextCommand.Fonts DefaultTextFontSets or gets the default text font.

Methods

public void AddCommand (AbsCmd command)Add new command to controller queue.
public void ClearCommands ()Clear the controller commmand queue.
public void ClearCommandsAndStop ()Clear the controller commmand queue and stop any possible currently executing command.
public bool IsIdle ()Check whatever controller is idle.
public bool RemoveCommand (AbsCmd command)Remove command from controller queue.
public bool ReplaceCommand (AbsCmd oldCommand, AbsCmd newCommand)Replace command in controller queue.

Properties

public float DefaultSpeedDotsPerSecond

Sets or gets the default speed in dots per second. Default speed is used in all moving content such as scrolling texts unless command have its own speed set.

ValueDefault speed in dots per second.


public TextCommand.Fonts DefaultTextFont

Sets or gets the default text font. Default font is used in TextCommands unless command have its own font defined.

ValueDefault text font, one of the values from enum TextCommand.Fonts


Methods

public void AddCommand (AbsCmd command)

Add new command to controller queue. If queue is empty, instantly start executing this command.

ParameterscommandCommand to add to queue.


public void ClearCommands ()

Clear the controller commmand queue. Command that is currently being executed (if any) will finish normally but it will not repeat even if Repeat flag is set. So after finishing current command, controller will be idle unless new commands are added.


public void ClearCommandsAndStop ()

Clear the controller commmand queue and stop any possible currently executing command. Controller will be idle immediately after this. Display is not cleared so whatever is on display when callign this will remain there.


public bool IsIdle ()

Check whatever controller is idle.

ReturnsTrue if controller isn't currently executing any command and there is nothing in queue. False otherwise.


public bool RemoveCommand (AbsCmd command)

Remove command from controller queue. If this command is currently being executed it will finish normally.

ParameterscommandCommand to remove from queue.

ReturnsTrue if command was found and removed, false otherwise.


public bool ReplaceCommand (AbsCmd oldCommand, AbsCmd newCommand)

Replace command in controller queue. If command that is replaced is currently being executed it will finish normally. If command to replace doesn't found, this method changes nothing.

ParametersoldCommandCommand to remove from queue.
 newCommandCommand to be added to queue to the same index where old command was.

ReturnsTrue if command was replaced, false otherwise.