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

DotMatrix
Derived from MonoBehaviour


Main class of DotMatrix. This script is attached to all DotMatrix prefabs (3D, sprite based and UI).


Inspector fields

Following public fields are typically set using Unity Editor inspector window after creating new DotMatrix gameobject from prefab to the scene.


public bool initOnStartDefines whatever DotMatrix should be initialized immediately when this script's Start function is called by Unity engine.

Methods

public Controller GetController ()Gets the DotMatrix Controller.
public Display GetDisplay ()Gets the DotMatrix Display.
public DisplayModel GetDisplayModel ()Gets the DotMatrix DisplayModel.
public void Init ()Initializes this DotMatrix display.
public void Reset ()Resets the DotMatrix.

Inspector fields

Following public fields are typically set using Unity Editor inspector window after creating new DotMatrix gameobject from prefab to the scene.


public bool initOnStart

Defines whatever DotMatrix should be initialized immediately when this script's Start function is called by Unity engine. Set false if you wish to have more control when DotMatrix display (dots) is created or you need to change some of the values (like width and height) during runtime before creating the display.


Methods

public Controller GetController ()

Gets the DotMatrix Controller. This will also cause this DotMatrix to initialize if it haven't done yet.

ReturnsThe controller that can be used to send commands to DotMatrix display.


public Display GetDisplay ()

Gets the DotMatrix Display. This will not cause DotMatrix to initialize. If this DotMatrix object was created from prefab on runtime, you can use this method to get the display and change display parameters and then call Init() method in this class to create the display dots.

ReturnsReference to display that is attached to this game object. You can cast resulting Display object to Display_Sprite, Display_UI or Display_3D depending of the type of attached display.


public DisplayModel GetDisplayModel ()

Gets the DotMatrix DisplayModel. This will also cause this DotMatrix to initialize if it haven't done yet.

ReturnsThe display model that can be used to access display directly without using Controller.


public void Init ()

Initializes this DotMatrix display. This will create the actual visible display and create Controller and DisplayModel. This method does nothing if this instance is already initialized. After initialization, many parameters can't be changed any more (like width and height of display) and changing some parameters may cause undesired or delayed effects. Generally it is not recommended to change any parameters after initialization.


public void Reset ()

Resets the DotMatrix. This will stop executing any commands, clear the Controller command queue and clear the display. This instance will return to same state where it was after Init() was done.