feat(graphics): add getframe, movie functions and double buffering

CHANGELOG.md

@@ -5,6 +5,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.13.0 (UNRELEASED)
+
+### Added
+
+- Double Buffering for Plots:
+
+  - Implementation of a double buffering mechanism to improve the smoothness and responsiveness of graphical plots.
+  - Significant reduction in flickering during graphic refresh.
+
+- `getframe`: Capture axes or figure as movie frame.
+- `movie`: Play recorded movie frames.
+- `DevicePixelRatio`: property for figure.
+
+- Example to connect ollama with Nelson
+  `edit([modulepath('webtools'), '/examples/ollama/readme.md'])`
+
+### Changed
+
+- `plot`: speed optimization: `tic();plot(rand(300,300), rand(300,300));toc()`
+
 ## 1.12.0 (2025-02-16)
 
 ### Added

CMake/C17Config.cmake

@@ -10,6 +10,9 @@ include(Clang-cxx-dev-tools)
 # ==============================================================================
 include(CheckCXXCompilerFlag)
 # ==============================================================================
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+# ==============================================================================
 if("${CMAKE_CXX_COMPILE_FEATURES}" MATCHES "cxx_std_17")
   set(CMAKE_CXX_STANDARD 17)
 else()

modules/graphics/builtin/c/nlsGraphics_builtin.vcxproj

@@ -187,6 +187,7 @@
     <ClCompile Include="..\cpp\axesBuiltin.cpp" />
     <ClCompile Include="..\cpp\closeBuiltin.cpp" />
     <ClCompile Include="..\cpp\drawnowBuiltin.cpp" />
+    <ClCompile Include="..\cpp\__getframe__Builtin.cpp" />
     <ClCompile Include="..\cpp\GOConstructorHelpers.cpp" />
     <ClCompile Include="..\cpp\copygraphicsBuiltin.cpp" />
     <ClCompile Include="..\cpp\dllMain.cpp" />
@@ -270,6 +271,7 @@
     <ClInclude Include="..\include\figureBuiltin.hpp" />
     <ClInclude Include="..\include\gcaBuiltin.hpp" />
     <ClInclude Include="..\include\gcfBuiltin.hpp" />
+    <ClInclude Include="..\include\__getframe__Builtin.hpp" />
     <ClInclude Include="..\include\graphics_object_deleteBuiltin.hpp" />
     <ClInclude Include="..\include\graphics_object_displayBuiltin.hpp" />
     <ClInclude Include="..\include\graphics_object_eqBuiltin.hpp" />

modules/graphics/builtin/c/nlsGraphics_builtin.vcxproj.filters

@@ -124,6 +124,9 @@
     <ClCompile Include="..\cpp\waitforBuiltin.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="..\cpp\__getframe__Builtin.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="..\include\__image__Builtin.hpp">
@@ -246,6 +249,9 @@
     <ClInclude Include="..\include\waitforBuiltin.hpp">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="..\include\__getframe__Builtin.hpp">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <None Include="..\..\etc\finish.m" />

modules/graphics/builtin/cpp/GOConstructorHelpers.cpp

@@ -51,7 +51,10 @@ GOCommonConstructorHelper(GraphicsObject* fp, const ArrayOfVector& arg)
     }
 
     finalizeConstruction(fp);
-
+    GOFigure* fig = getCurrentGOFigure();
+    if (fig && !fig->isRenderingStateInvalid()) {
+        fig->setRenderingStateInvalid(true);
+    }
     return thisHandle;
 }
 //=============================================================================

modules/graphics/builtin/cpp/Gateway.cpp

@@ -20,6 +20,7 @@
 #include "__zoom__Builtin.hpp"
 #include "__pan__Builtin.hpp"
 #include "__rotate3d__Builtin.hpp"
+#include "__getframe__Builtin.hpp"
 #include "uicontrolBuiltin.hpp"
 #include "figureBuiltin.hpp"
 #include "graphics_object_displayBuiltin.hpp"
@@ -53,19 +54,31 @@ using namespace Nelson;
 //=============================================================================
 const std::wstring gatewayName = L"graphics";
 //=============================================================================
-static const nlsGateway gateway[] = {
-    { "__line__", (ptrBuiltin)Nelson::GraphicsGateway::__line__Builtin, -1, 1, CPP_BUILTIN },
-    { "__text__", (ptrBuiltin)Nelson::GraphicsGateway::__text__Builtin, -1, 1, CPP_BUILTIN },
-    { "__surf__", (ptrBuiltin)Nelson::GraphicsGateway::__surf__Builtin, -1, 1, CPP_BUILTIN },
-    { "__image__", (ptrBuiltin)Nelson::GraphicsGateway::__image__Builtin, -1, 1, CPP_BUILTIN },
-    { "__patch__", (ptrBuiltin)Nelson::GraphicsGateway::__patch__Builtin, -1, 1, CPP_BUILTIN },
-    { "__contour__", (ptrBuiltin)Nelson::GraphicsGateway::__contour__Builtin, -1, 1, CPP_BUILTIN },
-    { "__hggroup__", (ptrBuiltin)Nelson::GraphicsGateway::__hggroup__Builtin, -1, 1, CPP_BUILTIN },
-    { "__view__", (ptrBuiltin)Nelson::GraphicsGateway::__view__Builtin, -1, 4, CPP_BUILTIN },
-    { "__zoom__", (ptrBuiltin)Nelson::GraphicsGateway::__zoom__Builtin, -1, 2, CPP_BUILTIN },
-    { "__pan__", (ptrBuiltin)Nelson::GraphicsGateway::__pan__Builtin, -1, 2, CPP_BUILTIN },
-    { "__rotate3d__", (ptrBuiltin)Nelson::GraphicsGateway::__rotate3d__Builtin, -1, 2,
-        CPP_BUILTIN },
+static const nlsGateway gateway[] = { { "__line__",
+                                          (ptrBuiltin)Nelson::GraphicsGateway::__line__Builtin, -1,
+                                          1, CPP_BUILTIN, NLS_OVERLOAD_AUTO_OFF },
+    { "__text__", (ptrBuiltin)Nelson::GraphicsGateway::__text__Builtin, -1, 1, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
+    { "__surf__", (ptrBuiltin)Nelson::GraphicsGateway::__surf__Builtin, -1, 1, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
+    { "__image__", (ptrBuiltin)Nelson::GraphicsGateway::__image__Builtin, -1, 1, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
+    { "__patch__", (ptrBuiltin)Nelson::GraphicsGateway::__patch__Builtin, -1, 1, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
+    { "__contour__", (ptrBuiltin)Nelson::GraphicsGateway::__contour__Builtin, -1, 1, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
+    { "__hggroup__", (ptrBuiltin)Nelson::GraphicsGateway::__hggroup__Builtin, -1, 1, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
+    { "__view__", (ptrBuiltin)Nelson::GraphicsGateway::__view__Builtin, -1, 4, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
+    { "__zoom__", (ptrBuiltin)Nelson::GraphicsGateway::__zoom__Builtin, -1, 2, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
+    { "__pan__", (ptrBuiltin)Nelson::GraphicsGateway::__pan__Builtin, -1, 2, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
+    { "__rotate3d__", (ptrBuiltin)Nelson::GraphicsGateway::__rotate3d__Builtin, -1, 2, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
+    { "__getframe__", (ptrBuiltin)Nelson::GraphicsGateway::__getframe__Builtin, -1, 2, CPP_BUILTIN,
+        NLS_OVERLOAD_AUTO_OFF },
     //=============================================================================
     { OVERLOAD_FUNCTION_NAME(NLS_GO_HANDLE_STR, "display"),
         (ptrBuiltin)Nelson::GraphicsGateway::graphics_object_displayBuiltin, 0, 2,
@@ -123,8 +136,7 @@ static const nlsGateway gateway[] = {
     { "waitforbuttonpress", (ptrBuiltin)Nelson::GraphicsGateway::waitforbuttonpressBuiltin, -1, 0,
         CPP_BUILTIN },
     { "waitfor", (ptrBuiltin)Nelson::GraphicsGateway::waitforBuiltin, 0, 3,
-        CPP_BUILTIN_WITH_EVALUATOR }
-};
+        CPP_BUILTIN_WITH_EVALUATOR } };
 //=============================================================================
 static bool
 initializeGraphicsModule(Nelson::Evaluator* eval)

modules/graphics/builtin/cpp/__getframe__Builtin.cpp

@@ -0,0 +1,47 @@
+//=============================================================================
+// Copyright (c) 2016-present Allan CORNET (Nelson)
+//=============================================================================
+// This file is part of the Nelson.
+//=============================================================================
+// LICENCE_BLOCK_BEGIN
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// LICENCE_BLOCK_END
+//=============================================================================
+#include "__getframe__Builtin.hpp"
+#include "GOWindow.hpp"
+#include "GOHelpers.hpp"
+#include "GOFiguresManager.hpp"
+#include "Error.hpp"
+#include "i18n.hpp"
+#include "GetFrame.hpp"
+#include "InputOutputArgumentsCheckers.hpp"
+//=============================================================================
+using namespace Nelson;
+//=============================================================================
+namespace Nelson::GraphicsGateway {
+//=============================================================================
+ArrayOfVector
+__getframe__Builtin(int nLhs, const ArrayOfVector& argIn)
+{
+    nargincheck(argIn, 1, 2);
+    nargoutcheck(nLhs, 0, 1);
+
+    if (!argIn[0].isGraphicsObject()) {
+        Error(_W("Expected graphics object."));
+    }
+    nelson_handle* gobject = (nelson_handle*)(argIn[0].getDataPointer());
+    if (isDeletedGraphicsObject(gobject[0])) {
+        Error(_W("Valid graphics object expected."));
+    }
+
+    if (gobject[0] == HANDLE_ROOT_OBJECT || gobject[0] >= HANDLE_OFFSET_OBJECT) {
+        Error("figure object expected.");
+    }
+    GOWindow* goWindow = getFigure(gobject[0]);
+    ArrayOfVector retval;
+    retval << GetFrame(goWindow);
+    return retval;
+}
+//=============================================================================
+}
+//=============================================================================

modules/graphics/builtin/cpp/__view__Builtin.cpp

@@ -119,6 +119,7 @@ __view__Builtin(int nLhs, const ArrayOfVector& argIn)
     GOAxis* axis = (GOAxis*)fp;
     if (argIn.size() >= 2) {
         axis->setView(azimuth, elevation);
+        axis->getParentFigure()->setRenderingStateInvalid(true);
         axis->updateState();
     }
 

modules/graphics/builtin/cpp/axesBuiltin.cpp

@@ -77,6 +77,7 @@ axesBuiltin(int nLhs, const ArrayOfVector& argIn)
                 GO_Z_LIM_MODE_PROPERTY_NAME_STR, GO_PROPERTY_VALUE_AUTO_STR);
         }
         ArrayOfVector retval;
+        fig->setRenderingStateInvalid(true);
         retval << ArrayOf::graphicsObjectConstructor(handle);
         return retval;
     }
@@ -99,6 +100,7 @@ axesBuiltin(int nLhs, const ArrayOfVector& argIn)
     }
     children.insert(children.begin(), 1, handle);
     cp->data(children);
+    fig->setRenderingStateInvalid(true);
     fig->repaint();
     return ArrayOfVector();
 }

modules/graphics/builtin/cpp/copygraphicsBuiltin.cpp

@@ -29,6 +29,7 @@ copygraphicsBuiltin(int nLhs, const ArrayOfVector& argIn)
     if (!f) {
         Error(_W("Invalid handle."));
     }
+    f->getGOFigure()->setRenderingStateInvalid(true);
     QClipboard* cb = QApplication::clipboard();
     cb->setPixmap(f->getMainQWigdet()->grab());
     return retval;

modules/graphics/builtin/cpp/figureBuiltin.cpp

@@ -88,7 +88,7 @@ figureBuiltin(int nLhs, const ArrayOfVector& argIn)
     if (goCallback) {
         goCallback->executeNow(fig);
     }
-
+    fig->setRenderingStateInvalid(true);
     return retval;
 }
 //=============================================================================

modules/graphics/builtin/cpp/gcaBuiltin.cpp

@@ -31,6 +31,7 @@ gcaBuiltin(int nLhs, const ArrayOfVector& argIn)
         ArrayOfVector arg2;
         axesBuiltin(0, arg2);
         current = fig->findGoProperty(GO_CURRENT_AXES_PROPERTY_NAME_STR);
+        fig->setRenderingStateInvalid(true);
     }
     retval << ArrayOf::graphicsObjectConstructor(current);
     return retval;

modules/graphics/builtin/cpp/gcfBuiltin.cpp

@@ -10,6 +10,7 @@
 #include "gcfBuiltin.hpp"
 #include "GOFiguresManager.hpp"
 #include "InputOutputArgumentsCheckers.hpp"
+#include "GOHelpers.hpp"
 //=============================================================================
 namespace Nelson::GraphicsGateway {
 //=============================================================================
@@ -28,6 +29,10 @@ gcfBuiltin(int nLhs, const ArrayOfVector& argIn)
             currentFigureID = figs.back();
         }
     }
+    GOFigure* fig = findGOFigure(currentFigureID);
+    if (fig) {
+        fig->setRenderingStateInvalid(true);
+    }
     retval << ArrayOf::graphicsObjectConstructor(currentFigureID);
     return retval;
 }

modules/graphics/builtin/cpp/graphics_object_setBuiltin.cpp

@@ -19,6 +19,7 @@
 #include "GOHelpers.hpp"
 #include "GORoot.hpp"
 #include "InputOutputArgumentsCheckers.hpp"
+#include "GOFiguresManager.hpp"
 //=============================================================================
 namespace Nelson::GraphicsGateway {
 //=============================================================================
@@ -77,10 +78,12 @@ graphics_object_setBuiltin(int nLhs, const ArrayOfVector& argIn)
             && !fp->isType(GO_PROPERTY_VALUE_UICONTROL_STR)) {
             GOFigure* fig = fp->getParentFigure();
             if (fig) {
+                fig->setRenderingStateInvalid(true);
                 fig->repaint();
             }
         }
     }
+
     return ArrayOfVector();
 }
 //=============================================================================

modules/graphics/builtin/include/__getframe__Builtin.hpp

@@ -0,0 +1,20 @@
+//=============================================================================
+// Copyright (c) 2016-present Allan CORNET (Nelson)
+//=============================================================================
+// This file is part of the Nelson.
+//=============================================================================
+// LICENCE_BLOCK_BEGIN
+// SPDX-License-Identifier: LGPL-3.0-or-later
+// LICENCE_BLOCK_END
+//=============================================================================
+#pragma once
+//=============================================================================
+#include "ArrayOf.hpp"
+//=============================================================================
+namespace Nelson::GraphicsGateway {
+//=============================================================================
+ArrayOfVector
+__getframe__Builtin(int nLhs, const ArrayOfVector& argIn);
+//=============================================================================
+}
+//=============================================================================

modules/graphics/examples/movie/demo_movie.m

@@ -0,0 +1,37 @@
+%=============================================================================
+% Copyright (c) 2016-present Allan CORNET (Nelson)
+%=============================================================================
+% This file is part of the Nelson.
+%=============================================================================
+% LICENCE_BLOCK_BEGIN
+% SPDX-License-Identifier: LGPL-3.0-or-later
+% LICENCE_BLOCK_END
+%=============================================================================
+clear('M');
+movie_directory = fileparts(mfilename('fullpathext'));
+figure('Position', [0   50   806   530]);
+
+% Define sequences and number of frames
+sequences = {'dance', 8; 'leap', 9; 'run', 8};
+nb_frames = sum([sequences{:,2}]);
+
+% Initialize the structure M
+M(nb_frames) = struct('cdata', [], 'colormap', []);
+
+L = 1;
+for s = 1:size(sequences, 1)
+    action = sequences{s, 1};
+    nb_frames_action = sequences{s, 2};
+
+    for i = 1:nb_frames_action
+        % Construct the filename for the current frame
+        filename = fullfile(movie_directory, sprintf('%s_%d.png', action, i));
+
+        % Read the image and store it in the movie structure
+        M(L).cdata = imread(filename);
+        L = L + 1;
+    end
+end
+
+% Play the movie 5 times
+movie(M, 5);

modules/graphics/examples/movie/readme.md

@@ -0,0 +1,4 @@
+images from https://furiirakun.com/
+https://furiirakun.com/aboutlicense
+
+Free to use, Free to share.

modules/graphics/functions/frame2im.m

@@ -0,0 +1,32 @@
+%=============================================================================
+% Copyright (c) 2016-present Allan CORNET (Nelson)
+%=============================================================================
+% This file is part of the Nelson.
+%=============================================================================
+% LICENCE_BLOCK_BEGIN
+% SPDX-License-Identifier: LGPL-3.0-or-later
+% LICENCE_BLOCK_END
+%=============================================================================
+function varargout = frame2im(varargin)
+  % RGB = frame2im(F)
+  % [X, map] = frame2im(F)
+  narginchk(1, 1);
+  nargoutchk(0, 2);
+  F = varargin{1};
+  mustBeA(varargin{1}, 'struct');
+  if (~isequal(fieldnames(F), {'cdata';'colormap'}))
+    error('Nelson:frame2im:invalidInput', _('Invalid structure fields.'));
+  end
+  n = numel(F);
+  X = [];
+  map = [];
+  if (n > 0)
+    x = [F.cdata];
+    map(1) = F(1).colormap;
+  end
+  varargout{1} = x;
+  if nargout > 1
+    varargout{2} = map;
+  end
+end
+%=============================================================================