Generic receiver
This element is a data receiver used to receive information from a Generic emitter when the receiver and the emitter are in contact. It can be useful to send a flow when some elements overlap or when an element has reached a destination. Data can be transmitted by the emitter to the receiver and then carried by the flow, but the emitter/receiver pair can also be used as a simple trigger with no information exchange.
Is an equipment | ✔️ |
Can have equipment | ❌ |
This element must be used with 2D scene context.
Icon
2D Representations
Generic receiver in Edit Mode | Generic receiver in Run Mode |
3D Representation
No reprensation available on 3D.
External parameters
Show/Hide all parameters
parameter | editable via "Parameter" tab | updatable via a mapping | description | unit | type |
---|---|---|---|---|---|
X-axis relative position | ✔️ | ❌ | Relative position of the element, from its attached element, on the X-axis. | meter | Decimal number |
Y-axis relative position | ✔️ | ❌ | Relative position of the element, from its attached element, on the Y-axis. | meter | Decimal number |
Z-axis relative position | ✔️ | ❌ | Relative position of the element, from its attached element, on the Z-axis. | meter | Decimal number |
Z-axis relative angle | ✔️ | ✔️ | Relative angle of the element, from its attached element. | degree | Decimal number |
Radius | ✔️ | ✔️ | Radius of the receiver, used to calculate an overlap with the emitter. It can be seen as a detection radius. | meter | Decimal number |
Channel | ✔️ | ❌ | Signal broadcast channel. The receiver will detect the emitter only if they have the same channel. | - | Text |
Color | ✔️ | ✔️ | Color of the receiver. This parameter can be edited. | - | Hexadecimal |
iconX | ✔️ | ❌ | Relative position of the icon, from the receiver, on the X-axis. | meter | Decimal number |
iconY | ✔️ | ❌ | Relative position of the icon, from the receiver, on the Y-axis. | meter | Decimal number |
Visibility | ✔️ | ✔️ | This parameter allows you to choose if you want the element to be visible or not on the scene during the execution of the scenario. If the item is part of a group, it can inherit the value of that group. | - | Enumeration (visible, hidden, inherit) |
Trigger mode enable | ❌ | ❌ | When the trigger mode enable is ✔️, the generic receiver flows are sent at each clock event only if the emitter flow is received. When trigger mode enable is ❌, the flow is sent at each clock event. If no emitter flow is received, it will send the default value or the last value received. | - | Enumeration (True, False) |
Threshold zoom out | ✔️ | ❌ | Zoom level from which its representation on the scene is no longer modified. | % | Decimal number |
X-axis position | ✔️ | ✔️ | Position of the element on the X-axis. | meter | Decimal number |
Y-axis position | ✔️ | ✔️ | Position of the element on the Y-axis. | meter | Decimal number |
SizeX | ❌ | ❌ | Size of the element on the X-axis. | meter | Decimal number |
SizeY | ❌ | ❌ | Size of the element on the Y-axis. | meter | Decimal number |
Z-axis angle | ❌ | ❌ | Angle of rotation of the element compared to its initial position. | degree | Decimal number |
Z-axis position | ❌ | ❌ | Position of the element on the Z-axis. | meter | Decimal number |
Height Z | ❌ | ❌ | Height of the element. | meter | Decimal number |
X-axis angle | ❌ | ❌ | Angle of the element on the X-axis. | degree | Decimal number |
Y-axis angle | ❌ | ❌ | Angle of the element on the Y-axis. | degree | Decimal number |
longitude coordinate | ❌ | ❌ | Automatically calculated longitude value, based on the origin defined for the context and the position of the element. | degree | Decimal number |
latitude coordinate | ❌ | ❌ | Automatically calculated latitude value, based on the origin defined for the context and the position of the element. | degree | Decimal number |
Triggered behaviours
See Triggered behaviours and events page for more explanation: Triggered behaviours and events.
Show/Hide all triggered behaviours
Destroy
At the reception of the flow, the element is destroy.
No parameters for this triggered behaviour.
Events
See Triggered behaviours and events page for more explanation: Triggered behaviours and events.
Show/Hide all events
event | description |
---|---|
On Parameter Value Changed | The element can send information to the model when the value of the selected parameter has changed |
In presence of one emitter | When the generic receiver and a generic emitter with the same Channel overlap, the generic receiver can send information to the model continuously |
At initialization | The generic receiver can send information to the model once at initialization |
Continually | The generic receiver can send information to the model continuously |