cust. data blocks -> properties; bump to ver -3

Author: fferri

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.12)
-project(configUi-2)
+project(configUi-3)
 
 if(NOT COPPELIASIM_INCLUDE_DIR)
     if(DEFINED ENV{COPPELIASIM_ROOT_DIR})
@@ -11,5 +11,5 @@ endif()
 list(APPEND CMAKE_MODULE_PATH ${COPPELIASIM_INCLUDE_DIR}/cmake)
 find_package(CoppeliaSim 4.5.1.7 REQUIRED)
 
-coppeliasim_add_lua("lua/configUi-2.lua")
+coppeliasim_add_lua("lua/configUi-3.lua")
 coppeliasim_add_resource_directory(qml)

README.md

@@ -1,4 +1,4 @@
-# ConfigUI 2
+# ConfigUI 3
 
 A library for CoppeliaSim models' configuration.
 
@@ -8,8 +8,8 @@ A library for CoppeliaSim models' configuration.
 2. Checkout, compile and install into CoppeliaSim:
 ```sh
 $ cd path/to/CoppeliaSim/programming
-$ git clone https://github.com/CoppeliaRobotics/configUi-2.git
-$ cd configUi-2
+$ git clone https://github.com/CoppeliaRobotics/configUi.git
+$ cd configUi
 $ git checkout coppeliasim-v4.5.0-rev0
 $ mkdir -p build && cd build
 $ cmake -DCMAKE_BUILD_TYPE=Release ..
@@ -69,20 +69,20 @@ The valid fields of an element schema are:
 Here's a complete example:
 
 ```lua
-require'configUi-2'
-
-schema={
-    a={
-        type='int',
-        name='A',
-        minimum=0,
-        maximum=10,
-        ui={order=1,control='spinbox',},
+require 'configUi-3'
+
+schema = {
+    a = {
+        type = 'int',
+        name = 'A',
+        minimum = 0,
+        maximum = 10,
+        ui = {order = 1, control = 'spinbox', },
     },
-    b={
-        type='string',
-        name='B',
-        ui={order=2,},
+    b = {
+        type = 'string',
+        name = 'B',
+        ui = {order = 2, },
     }
 }
 
@@ -91,5 +91,11 @@ function gen(cfg)
     print(cfg)
 end
 
-configUi=ConfigUI('myModelType',schema,gen)
+configUi = ConfigUI('myModelType', schema, gen)
 ```
+
+### Changelog
+
+1) initial version
+2) switch to QML-based UI
+3) switch to using properties instead of custom data blocks

lua/configUi-2.lua lua/configUi-3.lua

@@ -99,27 +99,13 @@ function ConfigUI:getObjectName()
     return sim.getObjectAlias(self:getObject(), 1)
 end
 
-function ConfigUI:readInfo()
-    self.info = {}
-    local info = sim.readCustomTableData(self:getObject(), self.dataBlockName.info)
-    for k, v in pairs(info) do
-        self.info[k] = v
-    end
-end
-
-function ConfigUI:writeInfo()
-    sim.writeCustomTableData(self:getObject(), self.dataBlockName.info, self.info)
-end
-
 function ConfigUI:readSchema()
-    local schema = sim.readCustomTableData(self:getObject(), self.dataBlockName.schema)
+    local schema = sim.getTableProperty(self:getObject(), 'customData.' .. self.propertyName.schema, {noError=true}) or {}
     if next(schema) ~= nil then
         self.schema = {}
-        for k, v in pairs(schema) do
-            self.schema[k] = v
-        end
+        for k, v in pairs(schema) do self.schema[k] = v end
     elseif self.schema == nil then
-        error('schema not provided, and not found in the custom data block ' .. self.dataBlockName.schema)
+        error('schema not provided, and not found in the custom data block ' ..  self.propertyName.schema)
     end
 end
 
@@ -129,25 +115,32 @@ function ConfigUI:defaultConfig()
     return ret
 end
 
-function ConfigUI:readConfig()
-    if self.schema == nil then error('readConfig() requires schema') end
-    self.config = self:defaultConfig()
-    local config = sim.readCustomTableData(self:getObject(), self.dataBlockName.config)
-    for k, v in pairs(config) do
-        if self.schema[k] then self.config[k] = v end
-    end
+function ConfigUI:getConfigProperty(k)
+    local nsConfig = self.propertyNamespace.config or ''
+    if nsConfig ~= '' then nsConfig = nsConfig .. '.' end
+    return 'customData.' .. nsConfig .. k
 end
 
-function ConfigUI:writeConfig()
-    sim.writeCustomTableData(self:getObject(), self.dataBlockName.config, self.config)
+function ConfigUI:readConfigConst()
+    if self.schema == nil then error('readConfig() requires schema') end
+    local config = self:defaultConfig()
+    for k, v in pairs(self.schema) do
+        local pv = sim.getProperty(self:getObject(), self:getConfigProperty(k), {noError=true})
+        if pv ~= nil then config[k] = pv end
+    end
+    return config
 end
 
-function ConfigUI:readUiState()
-    return sim.readCustomTableData(self:getObject(), self.dataBlockName.uiState .. '@tmp')
+function ConfigUI:readConfig()
+    self.config = self:readConfigConst()
 end
 
-function ConfigUI:writeUiState(uiState)
-    sim.writeCustomTableData(self:getObject(), self.dataBlockName.uiState .. '@tmp', uiState)
+function ConfigUI:writeConfig()
+    for k, v in pairs(self.schema) do
+        if self.config[k] ~= nil then
+            sim.setProperty(self:getObject(), self:getConfigProperty(k), self.config[k])
+        end
+    end
 end
 
 function ConfigUI:showUi()
@@ -168,7 +161,7 @@ function ConfigUI:createUi()
         schema = self.schema,
         objectName = sim.getObjectAlias(self:getObject(), 1),
     })
-    simQML.sendEvent(self.uiHandle, 'setUiState', self:readUiState())
+    simQML.sendEvent(self.uiHandle, 'setUiState', self.uiState)
 end
 
 function ConfigUI_uiChanged(c)
@@ -179,7 +172,7 @@ end
 
 function ConfigUI_uiState(info)
     if ConfigUI.instance then
-        ConfigUI.instance:uiState(info)
+        ConfigUI.instance:uiStateChanged(info)
     end
 end
 
@@ -197,8 +190,10 @@ function ConfigUI:uiChanged(c)
     self:writeConfig()
 end
 
-function ConfigUI:uiState(uiState)
-    self:writeUiState(uiState)
+function ConfigUI:uiStateChanged(uiState)
+    for k, v in pairs(uiState) do
+        self.uiState[k] = v
+    end
 
     if self.uiHandle and not uiState.opened then
         -- UI is closing
@@ -210,19 +205,26 @@ end
 function ConfigUI:sysCall_init()
     self:readSchema()
     self:validateSchema()
-    self:readInfo()
-    self.info.modelType = self.modelType
-    self:writeInfo()
     self:readConfig() -- reads existing or creates default
     self:writeConfig()
 
-    local uiState = self:readUiState()
-    if uiState.opened then
+    self.uiState = self.uiState or {}
+    local uiState = sim.getTableProperty(self:getObject(), 'signal.configUi.uistate', {noError=true})
+    if uiState then
+        sim.removeProperty(self:getObject(), 'signal.configUi.uistate')
+        for k, v in pairs(uiState) do
+            self.uiState[k] = v
+        end
+    end
+    if self.uiState.opened then
         self:showUi()
     end
 end
 
 function ConfigUI:sysCall_cleanup()
+    -- save uistate here so it can persist a script restart:
+    sim.setTableProperty(self:getObject(), 'signal.configUi.uistate', self.uiState)
+
     if self.uiHandle then
         simQML.destroyEngine(self.uiHandle)
         self.uiHandle = nil
@@ -236,12 +238,15 @@ function ConfigUI:sysCall_userConfig()
 end
 
 function ConfigUI:sysCall_data(changedNames)
-    if changedNames[self.dataBlockName.config] then
-        self:readConfig()
-        if self.uiHandle then
-            simQML.sendEvent(self.uiHandle, 'setConfig', self.config)
+    for changedName, g in pairs(changedNames) do
+        local typ, name = changedName:match("&(.-)&%.(.*)")
+        if self.schema[name] and g then
+            self:readConfig()
+            if self.uiHandle then
+                simQML.sendEvent(self.uiHandle, 'setConfig', self.config)
+            end
+            self:generateNow()
         end
-        self:generateNow()
     end
 end
 
@@ -295,11 +300,11 @@ setmetatable(ConfigUI, {__call = function(meta, modelType, schema, genCb)
         error('multiple instances of ConfigUI not supported')
     end
     local self = setmetatable({
-        dataBlockName = {
-            config = '__config__',
-            info = '__info__',
+        propertyNamespace = {
+            config = '',
+        },
+        propertyName = {
             schema = '__schema__',
-            uiState = '__uiState__',
         },
         modelType = modelType,
         schema = schema,