realvirtual.HMI_Message Class Reference
HMI element to display messages. More...
Inheritance diagram for realvirtual.HMI_Message:
Public Member Functions | |
| void | Modify () |
| void | ClickQuitButtonReference () |
| void | ClickCancelButtonReference () |
| void | ShowMessage (bool state) |
 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 | |
| MessageTypes | MsgType |
| Type of message. | |
| bool | UseUserDefinedColor |
| if true, use user defined color of the message background | |
| Color | BackgroundColor |
| user defined color of the message background | |
| bool | UseUserDefinedIcon |
| if true, use user defined icon | |
| Sprite | MessageIcon |
| user defined icon | |
| string | Text |
| text of the message | |
| int | SizeText |
| size of the text | |
| Color | FontColor |
| color of the text and icons | |
| bool | ShowTimeStamp |
| if true, show time stamp | |
| bool | Modal |
| if true, the message is modal | |
| int | MessageCheckTime |
| time in seconds to check if the message is still valid after canceling | |
| bool | CancelButton |
| if true, show cancel button | |
| bool | AcknowledgeButton |
| if true, show acknowledge button | |
| bool | ShowButton |
| if true, show information button | |
| bool | ForceAcknowledge |
| if true, the message has to be acknowledged by the user | |
| GameObject | MessageTriggeredObject |
| object which is activated when the message is shown | |
| GameObject | InformationTriggeredObject |
| object which is activated when the information button is pressed | |
| bool | Highlighting |
| if true, the defined objects is highlighted | |
| List< MeshRenderer > | HightlightedObjects |
| list of objects which are highlighted | |
| Material | HighlightMaterial |
| material for highlighting | |
| bool | FlickerEffectMaterial |
| if true, the highlighting material is flickering | |
| Material | FlickerMaterial |
| material for flickering | |
| float | FlickerTime |
| time for flickering | |
| PLCOutputBool | SignalMessage |
| PLC output for message. | |
| PLCInputBool | SignalAcknowledge |
| PLC input for acknowledge. | |
| PLCInputBool | SignalCancel |
| PLC input for cancel. | |
| Image | IconReference |
| TextMeshProUGUI | TextReference |
| Button | AcknowledgeButtonReference |
| Button | CancelButtonReference |
| Button | ShowButtonReference |
| DateTime | timeStamp |
| string | currentType |
| HMI_Tab | parentTab |
| Image | bgImg |
| 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
HMI element to display messages.
Member Data Documentation
◆ AcknowledgeButton
| bool realvirtual.HMI_Message.AcknowledgeButton |
if true, show acknowledge button
◆ BackgroundColor
| Color realvirtual.HMI_Message.BackgroundColor |
user defined color of the message background
◆ CancelButton
| bool realvirtual.HMI_Message.CancelButton |
if true, show cancel button
◆ FlickerEffectMaterial
| bool realvirtual.HMI_Message.FlickerEffectMaterial |
if true, the highlighting material is flickering
◆ FlickerMaterial
| Material realvirtual.HMI_Message.FlickerMaterial |
material for flickering
◆ FlickerTime
| float realvirtual.HMI_Message.FlickerTime |
time for flickering
◆ FontColor
| Color realvirtual.HMI_Message.FontColor |
color of the text and icons
◆ ForceAcknowledge
| bool realvirtual.HMI_Message.ForceAcknowledge |
if true, the message has to be acknowledged by the user
◆ Highlighting
| bool realvirtual.HMI_Message.Highlighting |
if true, the defined objects is highlighted
◆ HighlightMaterial
| Material realvirtual.HMI_Message.HighlightMaterial |
material for highlighting
◆ HightlightedObjects
| List<MeshRenderer> realvirtual.HMI_Message.HightlightedObjects |
list of objects which are highlighted
◆ InformationTriggeredObject
| GameObject realvirtual.HMI_Message.InformationTriggeredObject |
object which is activated when the information button is pressed
◆ MessageCheckTime
| int realvirtual.HMI_Message.MessageCheckTime |
time in seconds to check if the message is still valid after canceling
◆ MessageIcon
| Sprite realvirtual.HMI_Message.MessageIcon |
user defined icon
◆ MessageTriggeredObject
| GameObject realvirtual.HMI_Message.MessageTriggeredObject |
object which is activated when the message is shown
◆ Modal
| bool realvirtual.HMI_Message.Modal |
if true, the message is modal
◆ MsgType
| MessageTypes realvirtual.HMI_Message.MsgType |
Type of message.
◆ ShowButton
| bool realvirtual.HMI_Message.ShowButton |
if true, show information button
◆ ShowTimeStamp
| bool realvirtual.HMI_Message.ShowTimeStamp |
if true, show time stamp
◆ SignalAcknowledge
| PLCInputBool realvirtual.HMI_Message.SignalAcknowledge |
PLC input for acknowledge.
◆ SignalCancel
| PLCInputBool realvirtual.HMI_Message.SignalCancel |
PLC input for cancel.
◆ SignalMessage
| PLCOutputBool realvirtual.HMI_Message.SignalMessage |
PLC output for message.
◆ SizeText
| int realvirtual.HMI_Message.SizeText |
size of the text
◆ Text
| string realvirtual.HMI_Message.Text |
text of the message
◆ UseUserDefinedColor
| bool realvirtual.HMI_Message.UseUserDefinedColor |
if true, use user defined color of the message background
◆ UseUserDefinedIcon
| bool realvirtual.HMI_Message.UseUserDefinedIcon |
if true, use user defined icon