Public classes

Controller
DisplayModel
DotMatrix
ImageToContent
TextToContent

Commands/

   AbsCmd
   AbsCmdPosition
   AbsCmdSpeed
   CallbackCommand
   ClearCommand
   ContentCommand
   PauseCommand
   TextCommand

Displays/

   Display
   DisplayObj
   Display_3D
   Display_Sprite
   Display_Texture
   Display_UI


Introduction page

Display
Derived from MonoBehaviour


Abstract base class for all the display types. Display script is attached to DotMatrix prefabs and is defining how actual, visible display looks like.

Note that many fields in this class are public so they can be changed in Unity Editor inspector. Changing values on runtime may case errors or unexpected or delayed results.


Enums

public enum ContentsInEditorDifferent types of content to display when showing dots in Unity Editor.

Properties

public int BorderDotsEasy and quick way to add borders around display.
public int BrokenAlwaysOffDotsSet some of the dots on display to be broken in the way that they are always off.
public int BrokenAlwaysOnDotsSet some of the dots on display to be broken in the way that they are always on.
public float ChangeDelaySecondsSet or get delay (in seconds) when dot is changing state from on one state to another on state.
public ContentsInEditor ContentInEditorSet or get what kind of content is shown in display in Unity Editor.
public bool CreateDotsInEditorSet whatever display dots should be created and shown also in edit mode in Unity Editor.
public int HeightInDotsHeight of the display in dots.
public float OffDelaySecondsSet or get delay (in seconds) when dot is turning from any on-state to off-state.
public float OnDelaySecondsSet or get delay (in seconds) when dot is turning from off-state to any on-state.
public TextCommand.Fonts TextInEditorFontSet or get font that is used when showing text in display in Unity Editor.
public string TextInEditorTextSet or get text that is shown in display in Unity Editor.
public int WidthInDotsWidth of the display in dots.

Enums

public enum ContentsInEditor

Different types of content to display when showing dots in Unity Editor.

ItemsEmptyTotally empty display.
 FilledDisplay with all dots in on state.
 BordersEmpty display with borders.
 RulerDisplay with borders and ruler.
 TextShow any wanted text in display.


Properties

public int BorderDots

Easy and quick way to add borders around display. Border dots go around the display, they are always off and can't be accessed in any way. Set 0 for no borders.

ValueAmount of dots that act as border around the active display area.


public int BrokenAlwaysOffDots

Set some of the dots on display to be broken in the way that they are always off.

ValueAmount of dots that always remain off.


public int BrokenAlwaysOnDots

Set some of the dots on display to be broken in the way that they are always on.

ValueAmount of dots that always remain on.


public float ChangeDelaySeconds

Set or get delay (in seconds) when dot is changing state from on one state to another on state. This have effect only in displays that are using more than 2 colors. Note that 'enableDelays' have to be set true already before DotMatrix initializes.

ValueSeconds how long it takes to dot to turn from one on state to another.


public ContentsInEditor ContentInEditor

Set or get what kind of content is shown in display in Unity Editor.

This setting is normally used only through Unity Inspector window and have no effect when application is playing.

ValueOne of the choices from enum ContentsInEditor


public bool CreateDotsInEditor

Set whatever display dots should be created and shown also in edit mode in Unity Editor.

This setting is normally used only through Unity Inspector window and have no effect when application is playing.

ValueBoolean value, true to show display dots in editor, false to not.


public int HeightInDots

Height of the display in dots. Usually set through inspector in Unity editor or by another script if this DotMatrix was created from prefab during runtime.

ValueDisplay height in dots.


public float OffDelaySeconds

Set or get delay (in seconds) when dot is turning from any on-state to off-state. Especially in 3D-object based display (where each dot rotates when turning off) this adds realism but can be also used to simulate lagging display.

ValueSeconds how long it takes to dot to turn off.


public float OnDelaySeconds

Set or get delay (in seconds) when dot is turning from off-state to any on-state. Especially in 3D-object based display (where each dot rotates when turning on) this adds realism but can be also used to simulate lagging display.

ValueSeconds how long it takes to dot to turn on.


public TextCommand.Fonts TextInEditorFont

Set or get font that is used when showing text in display in Unity Editor.

This setting is normally used only through Unity Inspector window and have no effect when application is playing.

ValueOne of the choices from enum TextCommand.Fonts


public string TextInEditorText

Set or get text that is shown in display in Unity Editor.

This setting is normally used only through Unity Inspector window and have no effect when application is playing.

ValueText to be shown in display when in editor.


public int WidthInDots

Width of the display in dots. Usually set through inspector in Unity editor or by another script if this DotMatrix was created from prefab during runtime.

ValueDisplay width in dots.