@aryacode/dsh-engineering 0.5.0 → 0.6.0

package/vendor/optix/netlogic/pages/accessing-project-nodes.md

@@ -0,0 +1,113 @@
+# Accessing project nodes
+
+Before reading this page, please make sure to have the concept of [InformationModel and Session](./information-model.md).
+
+## Navigating to a node
+
+### The `Node.Get` syntax
+
+The `Get` method is used to fetch nodes from the current project, it can retrieve both session and global objects (nodes), this method also accepts a type that will be passed to the variable type
+- Example:
+    - `var myButton = … .Get<Button>("path/to/button");` -> Will create a _myButton_ variable of Type `FTOptix.UI.Button` pointing to the desired element
+- After the object has been casted to the proper path, you can access its properties using IntelliSense
+    - Example:
+        - `myButton.Text = Hello;`
+
+### Accessing global objects
+
+In order to manipulate any project element, you first need to access it, this can be either done by getting its NodeId or its node object
+
+- Examples:
+    - `var myNodeId = Project.Current.Get( [path/to/node] ).NodeId;`
+    - `var myObject = Project.Current.Get( [path/to/node] );`
+
+    - Where `path/to/node` can be obtained by right clicking any element of the IDE and then clicking `Copy path to node`, here you need to remember to remove the project name from the pasted element
+        - Example:
+            - `NewHMIProject25/Model/MyCustomMotor` --> `Model/MyCustomMotor`
+
+### Accessing session-based objects
+
+Now that we know how session works, it's easy to understand the benefits of placing a NetLogic in a session-based object (such as the page you want to access or manipulate) and then use the relative addressing to retrieve the right element
+    - Example:
+        - `var ButtonText = Owner.Get("MotorButton/Text");`
+
+### The `Node.Find` syntax
+
+You can also search for a specific object by knowing its `BrowseName` by using the `Find` method, this can be useful but it is not recommended as it is very slow to perform (it will recursively browse the whole project until it gets to the first element with such node)
+- Example:
+    - `var myObj = Project.Current.Find("ObjectName");`
+
+## Casting vs Type passing
+
+### Passing the object type
+
+Type parameter can be used with "generic methods" that allows using different types. A generic method can be called either without an argument (anything that applies to any node such as `BrowseName` or `NodeId`) or by specifying the type of argument within angle brackets
+- Example:
+    - `var myfolder = Project.Current.Get<Folder>("Model\MyFolder");`
+
+Using this type passing option, the returned node is `null` if:
+- Node does not exist
+- The node does not match the specified type (e.g: `MyFolder` is an `Object` and not a `Folder`)
+
+### Casting from IUANode
+
+A cast is an explicit conversion, to perform a cast, specify the type that you are casting to in parentheses in front of the value or variable to be converted.
+    - Example:
+        - `var myfolder = (Folder)Project.Current.Get("Model\MyFolder");`
+
+Using this casting option, the node is returned as null only if completely missing, if the object type cannot be casted, an exception is thrown.
+
+### Summary
+
+Result is very similar, as best practice we suggest to use the type passing approach unless casting is a specific requirement to achieve the result
+
+## Accessing an object by NodeId (pointer)
+
+```csharp
+/// <summary>
+/// Access an object by passing a NodeId pointer to a NetLogic variable. This keeps references valid even if the object is moved in the project tree.
+/// </summary>
+// Example: assume a NodeId variable named "ObjectPointer" exists and contains the NodeId of the target object
+var myObjectNodeId = LogicObject.GetVariable("ObjectPointer").Value;
+var myRectangle = InformationModel.Get<Rectangle>(myObjectNodeId);
+// Now use myRectangle as the referenced object
+```
+
+## Use ChildrenRemoteRead to inspect an aliased object structure
+
+```csharp
+/// <summary>
+/// When an object is aliased (for example via an Alias pointer), `ChildrenRemoteRead` lets you fetch a lightweight view
+/// of the aliased object's children without creating full session objects. This is handy to read a structure's values.
+/// </summary>
+// Example: assume `LightPointer` is an alias variable pointing to a UI object.
+var refLight = LogicObject.GetAlias("LightPointer");
+if (refLight != null)
+{
+    var structure = refLight.ChildrenRemoteRead();
+    Log.Info("IntermittentMode value: " + structure.SingleOrDefault(item => item.RelativePath == "IntermittentMode").Value);
+}
+```
+
+## Count nodes under a specific page/object
+
+```csharp
+/// <summary>
+/// Count the number of nodes under a given NodeId and log the result.
+/// Input: NodeId of the starting node.
+/// Output: Logs the count to Info.
+/// </summary>
+[ExportMethod]
+public static int GetNodesNumber(NodeId nodeId) => InformationModel.Get(nodeId).FindNodesByType<IUANode>().Count();
+
+[ExportMethod]
+public void CounNodes()
+{
+    // Example: log node counts for two screens
+    var unit02 = Project.Current.Get("UI/Screens/Pages/Un02/Em02_Pref/Unit02Em02");
+    var unit00 = Project.Current.Get("UI/Screens/Pages/Un00/Unit00");
+
+    Log.Info("Unit02Em02: " + GetNodesNumber(unit02.NodeId).ToString());
+    Log.Info("Unit00: " + GetNodesNumber(unit00.NodeId).ToString());
+}
+```

package/vendor/optix/netlogic/pages/advanced-svg.md

@@ -0,0 +1,124 @@
+# Advanced SVG image
+
+## SetImageContent
+
+The AdvancedSVGImage container, supports direct manipulation of the image buffer, allowing for fast and direct access to the content, this allows runtime editing that can efficiently manipulate the path or properties of an SVG image without impacting the InformationModel
+
+> [!NOTE]
+> This feature was introduced in FT Optix 1.4.x
+
+> [!NOTE]
+> The `SetImageContent` writes in the image buffer, so it does not trigger a change in the InformationModel, and it will not work at DesignTime, it is meant to be used at Runtime for animation or dynamic image manipulation.
+
+> [!NOTE]
+> As the `SetImageContent` method writes directly in the image buffer, if the page is reloaded or if the image source is changed, the changes will be lost, and the original SVG will be loaded again.
+
+### Sample image
+
+This is the sample image (containing a "star" shape) that we used in the examples below to be animated
+
+```svg
+<?xml version="1.0" encoding="iso-8859-1"?>
+<svg version="1.1" id="Overall" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" viewBox="0 0 300 300">
+  <g id="MyPaths" opacity="1.0">
+	  <path style="fill:#3C4660;" d="M 0 67.2262 L 72.1921 67.2262 L 94.5 0 L 116.8079 67.2262 L 189 67.2262 L 130.5954 108.7738 L 152.9045 176 L 94.5 134.4513 L 36.0954 176 L 58.4045 108.7738 L 0 67.2262 Z" transform="rotate(0, 150, 219)"/>
+  </g>
+  <g id="Box1">
+    <polygon style="fill:#CB8252;" points="25,270 75,270 75,220 25,220" transform="rotate(0, 20, 20)"/>
+  </g>
+</svg>
+```
+
+### Making the image disappear
+
+```csharp
+[ExportMethod]
+public void replaceSVG()
+{
+    // LogicObject.Owner is the button, so LogicObject.Owner is the MainWindow
+    AdvancedSVGImage svgImage = LogicObject.Owner.Get<AdvancedSVGImage>("AdvancedSVGImage1");
+
+    string myXML = "<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\r\n<svg version=\"1.1\" id=\"Overall\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xml:space=\"preserve\" viewBox=\"0 0 300 300\">\r\n  <g id=\"Box1\">\r\n    <polygon style=\"fill:#CB8252;\" points=\"25,270 75,270 75,220 25,220\" transform=\"rotate(0, 20, 20)\"/>\r\n  </g>\r\n</svg>\r\n";
+
+    //Update the SVG
+    svgImage.SetImageContent(myXML);
+}
+```
+
+### Rotate the image
+
+```csharp
+#region Using directives
+using FTOptix.NetLogic;
+using FTOptix.UI;
+using System.Xml.Linq;
+using System.Linq;
+using UAManagedCore;
+using System.Threading;
+#endregion
+
+public class RuntimeNetLogic1 : BaseNetLogic
+{
+    public override void Start()
+    {
+        // LogicObject.Owner is the button, so LogicObject.Owner is the MainWindow
+        svgImage = LogicObject.Owner.Get<AdvancedSVGImage>("AdvancedSVGImage1");
+        // Retrieve the Path to the SVG
+        var imageAbsolutePath = svgImage.Path.Uri;
+        // Load the SVG into an XDocument
+        xDocument = XDocument.Load(imageAbsolutePath);
+        // Find the first path element
+        var pathNode = xDocument.Descendants().Where(x => x.Name.LocalName == "path").FirstOrDefault();
+        // Find the first polygon element
+        var polyNode = xDocument.Descendants().Where(x => x.Name.LocalName == "polygon").FirstOrDefault();
+        // Get the polygon transform attribute
+        polyTransformAttribute = polyNode.Attribute("transform");
+        // Get the polygon transform attribute
+        pathTransformAttribute = pathNode.Attribute("transform");
+    }
+
+    public override void Stop()
+    {
+        keepGoing = false;
+        if (myLRT != null)
+            myLRT.Dispose();
+    }
+
+    private void doRotate()
+    {
+        int degrees = 3;
+        while (keepGoing)
+        {
+            Thread.Sleep(50);
+            degrees += 3;
+            if (degrees > 360)
+                degrees = 0;
+            string newTransformPoly = new string("rotate(" + degrees + ", 50, 250)");
+            polyTransformAttribute.SetValue(newTransformPoly);
+            string newTransformPath = new string("rotate(" + degrees + ", 96, 97)");
+            pathTransformAttribute.SetValue(newTransformPath);
+            //Update the SVG
+            svgImage.SetImageContent(xDocument.ToString());
+        }
+    }
+
+    [ExportMethod]
+    public void rotateSVG()
+    {
+        keepGoing = false;
+        if (myLRT != null)
+            myLRT.Dispose();
+        keepGoing = true;
+        myLRT = new LongRunningTask(doRotate, LogicObject);
+        myLRT.Start();
+    }
+
+    private XDocument xDocument;
+    private AdvancedSVGImage svgImage;
+    private XAttribute polyTransformAttribute;
+    private XAttribute pathTransformAttribute;
+    private LongRunningTask myLRT;
+    private bool keepGoing = true;
+}
+```
+