Display_3D - C# API Docs

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_3D
Derived from DisplayObj

Display where dots are based on actual 3D objects which rotates when turning on and off.

Enums

public enum StateChangeStyles

Different selections how dots are changed when their state changes.

Properties

public Vector3 DotSize	Size of single dot.
public int MaterialCount	Gets or sets the count of materials this display's dots can have.
public Vector3 OffRotation	Rotation of single dot object when it is turned to off-state.
public Vector3 OnRotation	Rotation of single dot object when it is turned to on-state.
public int RotationCount	Gets or sets the count of rotations this display's dots can have.
public StateChangeStyles StateChangeStyle	Set or get selection how dots change when their state changes.

Methods

public Material GetMaterial (int state)	Gets material used in dot objects when dot state is set to 'state'.
public Vector3 GetRotation (int state)	Gets rotation used in dot objects when dot state is set to 'state'.
public void SetMaterial (int state, Material material)	Sets material used in dot objects when dot state is set to 'state'.
public void SetRotation (int state, Vector3 rotation)	Sets rotation used in dot objects when dot state is set to 'state'.

Enums

public enum StateChangeStyles

Different selections how dots are changed when their state changes.

Items	RotateDot	Rotate dot object to different rotation.
	ChangeDotMaterial	Change dot object material.

Properties

public Vector3 DotSize

Size of single dot.

Value

Size of single dot as Vector3

public int MaterialCount

Gets or sets the count of materials this display's dots can have. Default and minimum is two materials.

This setting have no effect if StateChangeStyle is set to StateChangeStyles.RotateDot

Value

Amount of different possible material states.

public Vector3 OffRotation

Rotation of single dot object when it is turned to off-state. This have same effect than using SetRotation(0,Vector3) or GetRotation(0,Vector3) methods and is here for backward compatibility.

This setting have no effect if StateChangeStyle is set to StateChangeStyles.ChangeDotMaterial

Value

Dot rotation when in off-state.

public Vector3 OnRotation

Rotation of single dot object when it is turned to on-state. This have same effect than using SetRotation(1,Vector3) or GetRotation(1,Vector3) methods and is here for backward compatibility.

This setting have no effect if StateChangeStyle is set to StateChangeStyles.ChangeDotMaterial

Value

Dot rotation when in on-state.

public int RotationCount

Gets or sets the count of rotations this display's dots can have. Default and minimum is two rotations.

This setting have no effect if StateChangeStyle is set to StateChangeStyles.ChangeDotMaterial

Value

Amount of different possible rotation states.

public StateChangeStyles StateChangeStyle

Set or get selection how dots change when their state changes.

By default this is StateChangeStyles.RotateDot which means that dots rotate to different rotation when their state changes between on, off or different additional states. When setting this to StateChangeStyles.ChangeDotMaterial, dot material is changed when its state changes.

Value

One of the choices from enum StateChangeStyles

Methods

public Material GetMaterial (int state)

Gets material used in dot objects when dot state is set to 'state'.

This setting have no effect if StateChangeStyle is set to StateChangeStyles.RotateDot

Parameters

state

0 is dot 'off' state, 1 is default 'on' state, 2 and above are additional 'on' states.

Returns

Material used.

public Vector3 GetRotation (int state)

Gets rotation used in dot objects when dot state is set to 'state'.

This setting have no effect if StateChangeStyle is set to StateChangeStyles.ChangeDotMaterial

Parameters

state

0 is dot 'off' state, 1 is default 'on' state, 2 and above are additional 'on' state rotations.

Returns

Rotation used.

public void SetMaterial (int state, Material material)

Sets material used in dot objects when dot state is set to 'state'.

This setting have no effect if StateChangeStyle is set to StateChangeStyles.RotateDot

Parameters	state	0 is dot 'off' state, 1 is default 'on' state, 2 and above are additional 'on' states.
	material	Material to use.

public void SetRotation (int state, Vector3 rotation)

Sets rotation used in dot objects when dot state is set to 'state'.

This setting have no effect if StateChangeStyle is set to StateChangeStyles.ChangeDotMaterial

Parameters	state	0 is dot 'off' state, 1 is default 'on' state, 2 and above are additional 'on' state rotations.
	rotation	Rotation to use.