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

DisplayObj
Derived from Display


Extended abstract base class for all the display types that uses separate dot objects (3D, sprite based and UI).


Enums

public enum DotLayersDifferent selections how dots' layers are set.

Properties

public Vector2 DotGroupRelativeSpacingSet or get relative spacing between dot groups.
public int DotGroupSizeHorizontalSet or get how many dots are in each group horizontally.
public int DotGroupSizeVerticalSet or get how many dots are in each group vertically.
public bool DotGroupingEnabledSet or get the setting whatever dots are grouped, ie there is extra space after certain amount of dots.
public DotLayers DotLayerSet or get selection how each dot layer is set when they are created runtime or in editor.
public GameObject DotPrefabPrefab for a single dot in display.
public Vector2 DotSpacingSpacing between dots.

Enums

public enum DotLayers

Different selections how dots' layers are set.

ItemsKeepDotPrefabLayerKeep dots layer same as prefab layer.
 CopyDotMatrixDisplayLayerSet dots layer same as DotMatrix display layer.


Properties

public Vector2 DotGroupRelativeSpacing

Set or get relative spacing between dot groups. 1.0 means space is equal to one dot. 0.0 means no space at all which equals to not having dot grouping enabled at all.

This setting have no effect if 'DotGroupingEnabled' is false.

ValueRelative spacing between dot groups.


public int DotGroupSizeHorizontal

Set or get how many dots are in each group horizontally.

This setting have no effect if 'DotGroupingEnabled' is false.

ValueNumber of dots in each group horizontally.


public int DotGroupSizeVertical

Set or get how many dots are in each group vertically.

This setting have no effect if 'DotGroupingEnabled' is false.

ValueNumber of dots in each group vertically.


public bool DotGroupingEnabled

Set or get the setting whatever dots are grouped, ie there is extra space after certain amount of dots. Typically this is used to create visual effect that display is actually made of multiple smaller displays, for example each letter in is in its own dot group.

This is special mode of display, there are several things to note when using this:
- When adding text to display and you want each letter to be in its own dot group, make sure font size matches the dot group size and character/line spacing in TextCommand is set to 0.
- Scrolling text may look broken since scrolling still happens dot by dot.

ValueDot grouping enabled setting.


public DotLayers DotLayer

Set or get selection how each dot layer is set when they are created runtime or in editor.

By default this is DotLayers.KeepPrefabLayer which means that dots' layers are not changed after they are created from dot prefab. When setting this to DotLayers.CopyDotMatrixLayer, each dot layer is set same as actual DotMatrix gameobject layer.

ValueOne of the choices from enum DotLayers


public GameObject DotPrefab

Prefab for a single dot in display.

ValuePrefab object.


public Vector2 DotSpacing

Spacing between dots. 0 means no spacing. Negative values will cause dots to overlap each other but may result undesired visual glitches.

ValueSpacing between dots as Vector2