Skip to content

gui_patch

Jump to bottom
pierre drezet edited this page Aug 20, 2025 · 1 revision
Gui Patch class="toc_span_items"> Misc ↓ <span

class="toc_span_items"> Params ↓ Ports ↓

This component is used to create a widget to display a rectangular patch in the GUI. The position, dimensions, colour and transparency of the widget are specified in the widget properties in the GUI Builder, LGB. In addition the data inputs [In]off.x and [In]off.y can be used to change the position of the widget by specifying the offset from its original position in the x and y axis respectively. The data inputs href="#[In]off.wid"> [In]off.wid and [In]off.ht can be used to specify an offset in the width and the height of the widget from the original dimensions and [In]alpha can be used to change the alpha value of the transparency of the widget. Note that if the property Maintain Aspect Ratio is set to TRUE then changes to the widget width using the data input [In]off.wid also change the height to maintain the aspect ratio and changes to height using the data input [In]off.ht are ignored.

The input event [In]create will allocate the memory for the patch and [In]destroy will deallocate the memory. When the input event href="#[In]create"> [In]create is triggered, data is presented to outputs [Out]abs x , [Out]abs y , [Out]wid and [Out]ht , describing the absolute position and dimensions of the patch as created.

The input events [In]show and [In]hide will show and hide the patch. The state of the patch as shown or hidden is persistent, so that if href="#[In]show"> [In]show is asserted before [In]create , the patch will be shown when [In]create is asserted.

When the input event [In]update is asserted, the values presented to the inputs [In]off.x , [In]off.y , [In]off.wid , [In]off.ht and [In]alpha will be used to update the widget properties. Data is presented to outputs [Out]abs x , [Out]abs y , [Out]wid and [Out]ht , describing the updated absolute position and dimensions of the patch. It should be noted that the data inputs [In]off.x and [In]off.y specify the offset in the x and y axis from its original position and the data outputs [Out]abs x and [Out]abs y refer to the absolute x and y coordinates of the widget in reference to the viewport. This allows the data output to be used to detect if widgets are overlapping in the GUI.

name type default min. max. description
Widget Tag String None widget widget tag Name of the widget as displayed in the GUI builder.
Widget-Group Selectable None default widget group Group that the widget belongs to in the GUI builder.
Maintain Aspect Ratio Boolean 0 - - Maintains aspect ratio of widget when width is changed and ignores changes in height if TRUE, allows width and height to be altered independently if FALSE.
Register Click Disregarding Z-Order Boolean 0 - - Allows a widget to register a mouse click event when it is hidden behind another widget if TRUE, the widget only registers mouse clicks if the widget is visible at the coords that the mouse click occurs at if FALSE.
Ports Top ↑ Misc ↓ class="toc_span_items"> Params ↑
In Ev.
create

Input event, allocates memory for the patch.

destroy

Input event, deallocates memory for the patch.

show

Input event, shows the patch in the GUI.

hide

Input event, hides the patch in the GUI.

update

Input event, updates the properties of the widget.

Data In
off.x

Data input, specifies the offset in the x axis of the widget from its initial position when the update event is asserted.

off.y

Data input, specifies the offset in the y axis of the widget from its initial position when the update event is asserted.

off.wid

Data input, specifies the offset in width of the widget from its original dimensions when the update event is asserted..

off.ht

Data input, specifies the offset in height of the widget from its original dimensions when the update event is asserted..

alpha

Data input, specifies the alpha transparency of the patch when the update event is asserted..

Data Out
abs x

Data output, the x coordinate of the widget relative to the viewport origin presented when the create or update events are triggered.

abs y

Data output, the y coordinate of the widget relative to the viewport origin presented when the create or update events are triggered.

wid

Data output, the width of the widget presented when the create or update events are triggered.

ht

Data output, the height of the widget presented when the create or update events are triggered.

Out Ev.

Output event, triggered when the input event [In]create is asserted.

Output event, triggered when the input event [In]destroy is asserted.

Output event, triggered when the input event [In]show is asserted.

Output event, triggered when the input event [In]hide is asserted.

Output event, triggered when the input event [In]update is asserted.

click

Output event, triggered when the user clicks on the patch in the GUI.

mouse down

Output event, triggered when the user presses the mouse button and the pointer is over the patch.

Misc Top ↑ Ports ↑ class="toc_span_items"> Params ↑
State Machine Stateless.
Toolbox GUI. Version v2.1.
Licence Type MPL2.0 Component Supplier inx ltd.
Minumum DCC A0000 Profiles All.

copyright inx limited, UK, 2025 - join the inxware community @appland

Core Components

Events & Triggers

State Management

  • STATE - Represents a State in Lucid
  • state_condition - Event driven state condition --> transition and actions
  • state_debug - To debug state machines this function block is required.
  • state_manager - Each state machine is defined by a State Manager

Array & Data Structures

Buffers & Queues

Primitive Data Constants

Data Converters

Boolean Logic

Mathematics

Alebraic Evaluation

Mathematical Operators

Inequalities

Trigonometry

Other Functions

Data Selection

  • indexed_mux_int - Indexed Mux Int
  • indexed_mux_str - Indexed Mux String
  • map_int - Map Int
  • mux_1b - mux_1b
  • mux_1i - mux_1i
  • mux_1r - mux_1r
  • mux_1s - mux_1s
  • mux_2b - MultiplexTwo Input Bool
  • mux_2i - MultiplexTwo Input Int
  • mux_2r - MultiplexTwo Input Real
  • mux_2s - MultiplexTwo Input String
  • mux_3b - MultiplexThree Input Bool
  • mux_3i - MultiplexThree Input Int
  • mux_3r - MultiplexThree Input Real
  • mux_3s - MultiplexThree Input String
  • mux_4b - MultiplexFour Input Bool
  • mux_4i - MultiplexFour Input Int
  • mux_4r - MultiplexFour Input Real
  • mux_4s - MultiplexFour Input String
  • mux_8b - 8-Input Indexed Boolean Multiplexer Function Block
  • mux_8i - 8-Input Indexed Integer Multiplexer Function Block
  • mux_8r - 8-Input Real Number Multiplexer Function Block
  • mux_8s - Number Multiplexer Function Block
  • num_mux - Numeric Multiplexer Function Block

Data Processing & Parsers

Database & Storage

Demultiplexers

String Functions

File Operations

Basic IO Components

GPIO & Hardware I/O

Graphics and UI Components

GUI & User Interface

User Input

  • keypress - Reads key presses & control keys

Unity & Web Integration

  • inx-unity - Provides media and animation widget interface
  • unity2 - Unity 3D
  • webkit - JavaScript/WebKit Interface (Obsolete)

Language & Localization

Media Components

Audio & Media

Digital TV & Media Control

Communications Components

TCPIP Network & Communication

Wireless & LPWAN Networks

Fieldbus Comms

Digital Signal Processing

  • ADC Polled Analogue to Digital converter.
  • ADC_continuous Advanced ADC supporting clocked ISR modes and advanced signal averaging.
  • FFT8 Fast Fourier Transform of 8 bit binary input data
  • FIR8 Finite Impulse Response filter for 8 bit binary data.
  • IIR8 Infinite Impulse Response filter for 8 bit binary data.
  • [calibrate](ADC calibrate) - Calibrates the ADCs

Control Systems Components

PID Controllers

Machine Learning & Machine Vision

  • mv_camera - Provides access to camera input data image streams
  • mv_idsplay - Renders camera image streams.
  • mv_resize - Resizes an image using given interpolation method
  • mv_crop - Crops and image width and height at a give offset
  • mv_apriltag_reader Plain Old Prgramming AprilTag Reader
  • ml_tflite_inference Machine learning model inference.
  • ml_osvm Online iterative machine learning (training& inference).

Platform Components

System Utilities

  • reboot - Reboot the device
  • rtc - RealTimeClock - provdes date/time from RTC device or OS.
  • rtinfo - RuntimeInfo (e.g. MAC/IP address, memory,... )
  • scheduler - Weekly Scheduler
  • system_exec - Executes linux shell commands
  • rng - Random Number Generator (may use hardware RNG)

Time Components

Application Management

Over the Air Update (OTA)

  • ota - OTA Function Block for updating firmware
  • ota_data_parser - Assembles OTA data files from Devman.

Non-functional Components

Some function blocks that can be used Lucid app are for visual/organisation purposes only and do not translate into any executable ert-components.

Sub System Input/Output Ports

-Note this file is autogenerated from ert-config help files and may not currently be complete or properly categorised!

Clone this wiki locally