Referencia de la Clase StateMessageControl

Diagrama de herencias de StateMessageControl

Métodos públicos
void	WriteMessage (string text, bool success)
void	UpdateMessageLog ()
void	UpdatePositionLog ()
void	NewBlock ()

Métodos privados
void	Awake ()
void	UpdateCountData (int nSync, int nTotal)
void	AdjustContent (GameObject textMesh, GameObject content)
float	CalculateHeight (GameObject textMesh)
float	CalculatePosY (GameObject content, float height)

Atributos privados
TargetControl	targetControl
TextMeshProUGUI	stateOutput
Animator	stateOutputPanel
TextMeshProUGUI	messageLog
GameObject	contentLog
List< string >	messages
int	indexBlock = 0
bool	newBlock = false
const int	MAX_MASSAGES = 100
const float	LINE_HEIGHT = 28.9f
TextMeshProUGUI	positionLog
TextMeshProUGUI	positionSyncLog
GameObject	contentPositionLog
TextMeshProUGUI	positionCountLog

Descripción detallada

La función principal de este componente es comunicar el resultado de una acción mediante un mensaje en el "Estado actual" de la interfaz gráfica. También se encarga de mantener el registro de estos mensajes como un historial "Log".

Autor

Oscar Catari Gutiérrez - E-mail: oscar.nosp@m.cata.nosp@m.ri@ou.nosp@m.tloo.nosp@m.k.es - Universidad de La Laguna

Versión

1.0

Desde

02-05-2019

Documentación de las funciones miembro

AdjustContent()

void StateMessageControl.AdjustContent ( GameObject  textMesh, GameObject  content  )

inlineprivate

Redimensiona el contenedor del texto para que se ajuste a ese texto.

Parámetros

textMesh	Texto
content	Contenedor del texto

Devuelve

void

CalculateHeight()

float StateMessageControl.CalculateHeight ( GameObject  textMesh )

inlineprivate

Calcula al altura que debería tener un contenedor para mostrar el texto.

Parámetros

textMesh

Texto

Devuelve

float Altura

CalculatePosY()

float StateMessageControl.CalculatePosY ( GameObject  content, float  height  )

inlineprivate

Calcula la posición y que debería tener un contenedor para mostrar el texto.

Parámetros

textMesh	Texto
height	Altura del contenedor del texto

Devuelve

float Posición y

NewBlock()

void StateMessageControl.NewBlock ( )

inline

Genera el siguiente mensaje en un bloque nuevo.

Devuelve

void

UpdateCountData()

void StateMessageControl.UpdateCountData ( int  nSync, int  nTotal  )

inlineprivate

Actualiza la información sobre el número de posiciones y su sincronización. Ventana "Positions(0/0)"

Parámetros

nSync	Número de posiciones sincronizadas
nTotal	Número de posiciones totales

Devuelve

void

UpdateMessageLog()

void StateMessageControl.UpdateMessageLog ( )

inline

Actualiza la información de la ventana "Log".

Devuelve

void

UpdatePositionLog()

void StateMessageControl.UpdatePositionLog ( )

inline

Actualiza la información de la ventana "Positions(0/0)".

Devuelve

void

WriteMessage()

void StateMessageControl.WriteMessage ( string  text, bool  success  )

inline

Escribe un nuevo mensaje en el "Estado actual" de la interfaz gráfica. Cambia su color a rojo (error). También se actualiza la ventana "Log". o verde (éxito).

Parámetros

text	Mensaje
success	Éxito o error

Devuelve

void

---

La documentación para esta clase fue generada a partir del siguiente fichero:

• Controllers/StateMessageControl.cs