realvirtual.UIMessage Class Reference

Modal UI Message box which can be opened by a PLC signal. Can be used for example for displaying warnings. More...

Inheritance diagram for realvirtual.UIMessage:

Public Member Functions
void	OKPressed ()
	Close the message.
void	enableMessage (bool enable)
	Enable the message or disable the message.
Public Member Functions inherited from realvirtual.realvirtualUI
void	SetColor (GameObject obj, Color color)
void	ResetColor (GameObject obj)
Public Member Functions inherited from realvirtual.BehaviorInterface
new List< BehaviorInterfaceConnection >	GetConnections ()
	Returns a list of behavior interface connections for this component.
new List< Signal >	GetSignals ()
	Returns a list of connected signals for this component.
Public Member Functions inherited from realvirtual.realvirtualBehavior
void	PreStartSim ()
	Is called by the realvirtualController before the component is started.
void	StartSim ()
	Is called by the realvirtualController to start or stop the component.
void	StopSim ()
Vector3	DirectionToVector (DIRECTION direction)
	Transfers the direction enumeration to a vector.
DIRECTION	VectorToDirection (bool torotatoin, Vector3 vector)
	Transfers a vector to the direction enumeration.
float	GetLocalScale (Transform thetransform, DIRECTION direction)
List< BehaviorInterfaceConnection >	UpdateConnectionInfo ()
List< Signal >	GetConnectedSignals ()
void	SetVisibility (bool visibility)
	Sets the visibility of this object including all subobjects.
List< BehaviorInterfaceConnection >	GetConnections ()
List< Signal >	GetSignals ()
GameObject	GetChildByName (string name)
	Gets a child by name.
List< GameObject >	GetChildsByName (string name)
	Gets all child by name.
GameObject	GetChildByNameAlsoHidden (string name)
List< GameObject >	GetAllMeshesWithGroup (string group)
List< GameObject >	GetAllWithGroup (string group)
List< GameObject >	GetAllWithGroups (List< string > groups)
List< GameObject >	GetAllMeshesWithGroups (List< string > groups)
List< string >	GetMyGroups ()
List< GameObject >	GetMeshesWithSameGroups ()
List< GameObject >	GetAllWithSameGroups ()
MeshRenderer	GetMeshRenderer ()
	Gets the mesh renderers in the childrens.
void	SetCollider (bool enabled)
	sets the collider in all child objects
void	ErrorMessage (string message)
	Displays an error message.
void	ChangeConnectionMode (bool isconnected)
void	Log (string message)
	Logs a message.
void	Log (string message, object obj)
	Logs a message with a relation to an object.
void	Warning (string message, object obj)
	Logs a warinng with a relation to an object.
void	Error (string message, object obj)
	Logs an error with a relation to an object.
void	Error (string message)
	Logs an error.
GameObject	DebugPosition (string debugname, Vector3 position, Quaternion quaternation, float scale)
	Displays a gizmo for debugging positions.
void	SetFreezePosition (bool enabled)
	Freezes all child components to the current poosition.
void	SetRbConstraints (RigidbodyConstraints constraints)
virtual void	AwakeAlsoDeactivated ()

Public Attributes
string	Header
	The Header text of the message.
string	Message
	The message itself.
float	AutoCloseAfterSeconds
	Close the message after the defined time in seconds. If seconds is 0 the message is not automatically closed.
GameObject[]	HightlightObjects
	A collection of objects which should be highlighed during the message.
float	HighLightRedCol
	The highlight color in RGB - red.
float	HighLightGreenCol
	The highlight color in RGB - green.
float	HighLightBlueCol
	The highlight color in RGB - blue.
float	FlashDuration
	The duration of the highlight flash.
bool	Display
	Displays the message.
PLCOutputBool	DisplayMessage
	The PLCOutput signal which is connected to the message.
Public Attributes inherited from realvirtual.BehaviorInterface
List< BehaviorInterfaceConnection >	ConnectionInfo
Public Attributes inherited from realvirtual.realvirtualBehavior
string	Name
	The name of the component if it should be different from the GameObject name.
ActiveOnly	Active
GameObject	FromTemplate
realvirtualController	realvirtualController
bool	HideNonG44Components
bool	SceneIsAdditive
bool	ForceStop

Additional Inherited Members
Public Types inherited from realvirtual.realvirtualBehavior
enum	ActiveOnly {   Always , Connected , Disconnected , Never ,   DontChange }
Static Public Member Functions inherited from realvirtual.realvirtualBehavior
static bool	DirectionIsLinear (DIRECTION direction)
	Gets back if the direction is linear or a rotation.
Protected Member Functions inherited from realvirtual.realvirtualBehavior
bool	hidename ()
bool	hideactiveonly ()
virtual void	OnStopSim ()
virtual void	OnPreStartSim ()
virtual void	OnStartSim ()
MU	GetTopOfMu (GameObject obj)
	Gets the top of an MU component (the first MU script going up in the hierarchy)
void	InitGame4Automation ()
	Initialiates the components and gets the reference to the realvirtualController in the scene.
virtual void	AfterAwake ()
void	Awake ()
Properties inherited from realvirtual.ISignalInterface
GameObject	gameObject [get]

Detailed Description

Modal UI Message box which can be opened by a PLC signal. Can be used for example for displaying warnings.

Member Function Documentation

enableMessage()

void realvirtual.UIMessage.enableMessage

(

bool

enable

)

Enable the message or disable the message.

OKPressed()

void realvirtual.UIMessage.OKPressed

(

)

Close the message.

Member Data Documentation

AutoCloseAfterSeconds

float realvirtual.UIMessage.AutoCloseAfterSeconds

Close the message after the defined time in seconds. If seconds is 0 the message is not automatically closed.

Display

bool realvirtual.UIMessage.Display

Displays the message.

DisplayMessage

PLCOutputBool realvirtual.UIMessage.DisplayMessage

The PLCOutput signal which is connected to the message.

FlashDuration

float realvirtual.UIMessage.FlashDuration

The duration of the highlight flash.

Header

string realvirtual.UIMessage.Header

The Header text of the message.

HighLightBlueCol

float realvirtual.UIMessage.HighLightBlueCol

The highlight color in RGB - blue.

HighLightGreenCol

float realvirtual.UIMessage.HighLightGreenCol

The highlight color in RGB - green.

HighLightRedCol

float realvirtual.UIMessage.HighLightRedCol

The highlight color in RGB - red.

HightlightObjects

GameObject [] realvirtual.UIMessage.HightlightObjects

A collection of objects which should be highlighed during the message.

Message

string realvirtual.UIMessage.Message

The message itself.