Marks a GameObject as a 3D visual sensor indicator for realvirtual WEB 3D-HMI. More...
Public Attributes | |
| PLCOutputBool | SignalBool |
| Binary input: false=Low, true=High. Use for 2-state sensors. | |
| PLCOutputInt | SignalInt |
| Integer input: value mapped to state via IntStateMap. Use for 4+ state sensors. | |
| string | IntStateMap |
| Maps integer values to sensor states. | |
| string | Label |
| Optional label shown in WebViewer tooltip and sensor list. | |
 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 |
| bool | IsNetworkOwner |
| True when this component owns its simulation (local authority). Set to false by MultiplayerWEB on remote clients. | |
Additional Inherited Members | |
| Public Types inherited from realvirtual.realvirtualBehavior | |
| enum | ActiveOnly { Always , Connected , Disconnected , Never , DontChange } |
| Public Member Functions inherited from realvirtual.realvirtualBehavior | |
| virtual void | OnOwnershipChanged (bool isOwner) |
| Called when network ownership changes. | |
| void | SetNetworkOwner (bool isOwner) |
| Sets IsNetworkOwner and triggers OnOwnershipChanged callback. | |
| 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, bool includeTriggers=true) |
| 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 warning 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 () |
| 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 () |
Detailed Description
Marks a GameObject as a 3D visual sensor indicator for realvirtual WEB 3D-HMI.
UI-only marker for realvirtual WEB 3D-HMI. No Unity runtime function.
The WebSensor exposes four visual states — Low, High, Warning, Error — driven by up to one optional PLC signal. In the browser-based WebViewer the node (and all its mesh descendants) is rendered with a configurable gizmo overlay that switches color / opacity / blink-rate per state. All visual parameters are hardcoded in the WebViewer TypeScript layer — this component only provides the signal binding and an optional label.
Signal binding: use EITHER SignalBool (2-state: false=Low, true=High) OR SignalInt with IntStateMap for N-state mapping (default: 0=Low, 1=High, 2=Warning, 3=Error). If both are assigned, SignalInt wins.
Key Features:
- Four-state visual indicator (Low / High / Warning / Error) + Unbound fallback
- Bool or integer signal input with flexible int-to-state mapping
- ISA-101 aligned colors: grey / blue / amber (1 Hz blink) / red (2 Hz blink)
- Automatic export to GLB via rv_extras for WebViewer consumption
- Multi-mesh subtree handling: all child meshes render as one unit
- Optional label shown in WebViewer tooltip and sensor list panel
Common Applications:
- Status indicators on machines (on / running / warning / fault)
- Position sensors (end-of-travel, presence detection) visualization
- Alarm indicators on equipment with color + blink feedback
- Conveyor / line station status display in 3D HMI
For detailed documentation see: https://doc.realvirtual.io/components-and-scripts/webhmi/web-sensor
Member Data Documentation
◆ IntStateMap
| string realvirtual.WebSensor.IntStateMap |
Maps integer values to sensor states.
Leave empty for default (0=Low, 1=High, 2=Warning, 3=Error). Format: comma-separated "value:state" pairs, e.g. "0:low,1:high,5:warning,99:error". Values not listed map to 'Low' (with a one-time warning in the WebViewer console). Ignored when SignalBool is used.
◆ Label
| string realvirtual.WebSensor.Label |
Optional label shown in WebViewer tooltip and sensor list.
◆ SignalBool
| PLCOutputBool realvirtual.WebSensor.SignalBool |
Binary input: false=Low, true=High. Use for 2-state sensors.
◆ SignalInt
| PLCOutputInt realvirtual.WebSensor.SignalInt |
Integer input: value mapped to state via IntStateMap. Use for 4+ state sensors.