realvirtual.HMI_Pushbutton Class Reference
Industrial pushbutton HMI component with PLC signal integration and multi-state visual feedback. More...
Inheritance diagram for realvirtual.HMI_Pushbutton:
Public Member Functions | |
| delegate void | OnClickDelegate () |
| new void | Awake () |
| override void | Init () |
| void | OnClick () |
| void | OnPointerExit (PointerEventData eventData) |
| void | OnPointerEnter (PointerEventData eventData) |
| void | Update () |
| void | OnPointerDown (PointerEventData eventData) |
| void | OnPointerUp (PointerEventData eventData) |
 Public Member Functions inherited from realvirtual.HMI | |
| TextMeshProUGUI | GetText (string objName) |
| Image | GetImage (string objName) |
| virtual void | CloseExtendedArea (Vector3 pos) |
| void | OnValueChanged () |
| Canvas | GetCanvas (GameObject HMIelement, ref RectTransform rectTransform) |
| void | OnTransformParentChanged () |
| void | UpdateUISkinParameter (RealvirtualUISkin skin) |
| 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 | |
| float | MinHighTime |
| < Signal that is set high when the button is pushed | |
| string | ButtonText |
| Text of the button. | |
| int | TextSize |
| Color | FontColor |
| Text size of the button. | |
| Signal | SignalButtonPushed |
| PLCOutputBool | Color1Signal |
| Signal that set the color of the button. | |
| Color | Color1 |
| Color of the button when signal 1 is high. | |
| PLCOutputBool | Color2Signal |
| Signal that set the color of the button. | |
| Color | Color2 |
| Color of the button when signal 2 is high. | |
| PLCOutputBool | Color3Signal |
| Signal that set the color of the button. | |
| Color | Color3 |
| Color of the button when signal 3 is high. | |
| Public Attributes inherited from realvirtual.HMI | |
| Color | Color |
| Color of the HMI element. | |
| Color | ColorMouseOver |
| Color of the HMI element when the mouse is over it. | |
| RealVirtualHMIEvent | EventOnValueChanged |
| Event that is triggered when the value of the HMI element changes. | |
| 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 |
Events | |
| OnClickDelegate | ClickEvent |
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
Industrial pushbutton HMI component with PLC signal integration and multi-state visual feedback.
This professional interface element simulates industrial control panel pushbuttons with configurable minimum activation time, multiple color states based on PLC signals, and realistic button behavior. Essential for operator panels, machine start/stop controls, and safety acknowledgments in virtual commissioning. Supports both momentary and latched operation modes with full signal connectivity.
Member Function Documentation
◆ Init()
|
virtual |
Reimplemented from realvirtual.HMI.
Member Data Documentation
◆ ButtonText
| string realvirtual.HMI_Pushbutton.ButtonText |
Text of the button.
◆ Color1
| Color realvirtual.HMI_Pushbutton.Color1 |
Color of the button when signal 1 is high.
◆ Color1Signal
| PLCOutputBool realvirtual.HMI_Pushbutton.Color1Signal |
Signal that set the color of the button.
◆ Color2
| Color realvirtual.HMI_Pushbutton.Color2 |
Color of the button when signal 2 is high.
◆ Color2Signal
| PLCOutputBool realvirtual.HMI_Pushbutton.Color2Signal |
Signal that set the color of the button.
◆ Color3
| Color realvirtual.HMI_Pushbutton.Color3 |
Color of the button when signal 3 is high.
◆ Color3Signal
| PLCOutputBool realvirtual.HMI_Pushbutton.Color3Signal |
Signal that set the color of the button.
◆ FontColor
| Color realvirtual.HMI_Pushbutton.FontColor |
Text size of the button.
◆ MinHighTime
| float realvirtual.HMI_Pushbutton.MinHighTime |
< Signal that is set high when the button is pushed
Minimum time the signal is high