Merge pull request #274 from stride3d/master

Initiating deployment of latest docs updates to staging
stride3d · Apr 24, 2024 · 71f3183 · 71f3183
2 parents 846ae4b + aeea5b5
commit 71f3183
Show file tree

Hide file tree

Showing 2,005 changed files with 29,160 additions and 1,367 deletions.
diff --git a/en/contributors/engine/ndepend.md b/en/contributors/engine/ndepend.md
diff --git a/en/contributors/engine/ndepend/NDependReport.html b/en/contributors/engine/ndepend/NDependReport.html
diff --git a/en/contributors/engine/ndepend/NDependReportFiles/AbstractnessVSInstability.png b/en/contributors/engine/ndepend/NDependReportFiles/AbstractnessVSInstability.png
diff --git a/en/contributors/engine/ndepend/NDependReportFiles/ComponentDependenciesDiagram.png b/en/contributors/engine/ndepend/NDependReportFiles/ComponentDependenciesDiagram.png
diff --git a/en/contributors/engine/ndepend/NDependReportFiles/ComponentDependenciesMatrix.png b/en/contributors/engine/ndepend/NDependReportFiles/ComponentDependenciesMatrix.png
diff --git a/...ontributors/engine/ndepend/NDependReportFiles/TinyAbstractnessVSInstability.png b/...ontributors/engine/ndepend/NDependReportFiles/TinyAbstractnessVSInstability.png
diff --git a/...ributors/engine/ndepend/NDependReportFiles/TinyComponentDependenciesDiagram.png b/...ributors/engine/ndepend/NDependReportFiles/TinyComponentDependenciesDiagram.png
diff --git a/...tributors/engine/ndepend/NDependReportFiles/TinyComponentDependenciesMatrix.png b/...tributors/engine/ndepend/NDependReportFiles/TinyComponentDependenciesMatrix.png
diff --git a/en/contributors/engine/ndepend/NDependReportFiles/TinyVisualNDependView.png b/en/contributors/engine/ndepend/NDependReportFiles/TinyVisualNDependView.png
diff --git a/en/contributors/engine/ndepend/NDependReportFiles/VisualNDependView.png b/en/contributors/engine/ndepend/NDependReportFiles/VisualNDependView.png
diff --git a/en/contributors/engine/ndepend/NDependReportFiles/src/AbsoluteId.cs.html b/en/contributors/engine/ndepend/NDependReportFiles/src/AbsoluteId.cs.html
@@ -0,0 +1,14 @@
+<meta charset="UTF-8">
+<html>
+  <head>
+    <link rel="stylesheet" href="src.css"/>
+	 <script src="src.js"></script>
+    <script src="CommonIssuesData.js"></script>
+    <script>
+var issues='{"fileName":"AbsoluteId.cs","relativePath":"../../../../stride/sources/core/Stride.Core.Design/AbsoluteId.cs","absolutePath":"D:/Projects/GitHub/stride/sources/core/Stride.Core.Design/AbsoluteId.cs","projectName":"Stride.Core.Design","line":"77","statement":"12","debt":"2h  2min","cov":"N/A","issues":[{"line":"6","ruleId":"ND1401","debt":"2h  0min","severity":"2","expl":"The <i>2 namespaces Stride.Core.IO and Stride.Core</i> form a <b>dependency cycle</b>: they all depend on each other. This cycle prevents <b>clean layered architecture</b> and reduces maintainability. To fix it, first address all issues stemming from the rule <i>Avoid mutually dependent namespaces</i>. Then read this rule documentation that explains how to use the <i>Dependency Inversion Principle</i> to fix cycles involving 3 or more namespaces."},{"line":"12","ruleId":"ND1914","debt":"2min  0s","severity":"1","expl":"The <i>structure AbsoluteId</i> should be declared as <i>readonly</i>. This way not only the intent is clearly expressed and some optimizations can be performed by the compiler and the runtime."}]}';
+ </script>
+</head>
+<body>
+    <span id="source" fid="1"  style="display:none">H4sIAAAAAAAEAK1W22rbQBB9N/gfJqYEqYTVQx5KE9sQEjc1tCnUeSstrKWRtam1q+6u6rrB/97R6mLJiZ2URATkzOXMmasdBHCpsrUWi8SCF/rAbia38EHlMuJWKAlcRmQhrRbz3CptwEuszcxZEETKSrRxY8qUXgRwDLXekE+EpxEjK9/hzMRShIQ5s3kkFMHqjG3xVqsVM6WFcQYsVOwu8/u9IIArYUoKGAEFRA02Qfg8vQVyQGmQwQzRCT9NLyc3swlLI4jFEkFIJ860usPQglbKQqw0pEoXSvqYlvz7vdwIuYDZ2lhMz5t/XR6M2CK7MAatIVW/J3mKJuMhtg36vft+D+gJiPPQ5GnK9Xq8FX3FTKNBaY3jxOdGLSknIH9pRSwoLxVTrRoBn1MGau6Yi6IbwAsKrBUl6Ib5dsUtdx3jofUGF1WIaTTwv5cWWT6nogEVNCfUrQGcwXTyKyd3CjrcyivgKrM92dXiqRRW8KX4iwY4SFwRbWO5pDpRZkNDTQo1xqM2sWDMdrCDx8GHGdc8haL0o4ErBHmPh4ETH7ItK3jAGP+EmLmBr9jpRZ5SCya1nDydI2l34gdjN9y76iYk6UMuJU3dXNkE5giYZnbNhkETtMWmas62Ot5FGQeqeCdwnYsIanh/69pqUPGIGLzKB0YjqGDYpAgOx8cNQqEsIEuN3wUpHptotXKtfFAV783gvkhXxXUof+OqUUsbmpvHizDw3TK1w9X5juqMz7v6Lw3vJoWWxaYNd2BOb5PdrSsWkm6P5UIWa9/es0NzWTesYl2/72GB9vyFdLaL767F/zFyY9IU6zE+zSGg+xdSY9QSVIaa052nofBal2GJsT1pnwr3hbF/9jTaXEvnxoqTsjRe6bGvU4eoHL0GlaPnc3F1FTJBLWykQgge1tYRrMBaVGi0UT9JpdnE0t85sUroF5tZN61rUUtfwlv9Rl18WXUSqKaMXk9SJxsQpl19mjFiXCGJ1yEnpIVrtB+5SS5VhN5+WrkMEwx/YtQV71i1EqivKevgw1s4ff/Ohx/b0nf0Oxdo87wcD6VY/JqhI3OrZu7DgRQr4nRoK+qb4L5muRl0y1296O8fQuZ/G9gJ$822$</span>
+  </body>
+</html>
diff --git a/en/contributors/engine/ndepend/NDependReportFiles/src/AbstractObjectInstantiator.cs.html b/en/contributors/engine/ndepend/NDependReportFiles/src/AbstractObjectInstantiator.cs.html
@@ -0,0 +1,14 @@
+<meta charset="UTF-8">
+<html>
+  <head>
+    <link rel="stylesheet" href="src.css"/>
+	 <script src="src.js"></script>
+    <script src="CommonIssuesData.js"></script>
+    <script>
+var issues='{"fileName":"AbstractObjectInstantiator.cs","relativePath":"../../../../stride/sources/assets/Stride.Core.Assets/Reflection/AbstractObjectInstantiator.cs","absolutePath":"D:/Projects/GitHub/stride/sources/assets/Stride.Core.Assets/Reflection/AbstractObjectInstantiator.cs","projectName":"Stride.Core.Assets","line":"176","statement":"81","debt":"49min","cov":"N/A","issues":[{"line":"62","ruleId":"ND1003","debt":"39min","severity":"1","expl":"The <i>method InitializeTypeBuilderFromType(…)</i> has a high <i>cyclomatic complexity</i> score of 19 and should be refactored into a set of smaller methods."},{"line":"10","ruleId":"ND2103","debt":"3min  0s","severity":"1","expl":"The source file containing the declaration of the <i>namespace Stride.Core.Reflection</i> is located in the directory <i>D:/Projects/GitHub/stride/sources/assets/Stride.Core.Assets.Yaml/Reflection</i> that does not align with the namespace name."},{"line":"10","ruleId":"ND2105","debt":"7min","severity":"2","expl":"The <i>namespace Stride.Core.Reflection</i> declarations are present in source files spread across multiple directories. <i>class OverridePostfixes</i> is declared in source files out of <i>D:/Projects/GitHub/stride/sources/assets/Stride.Core.Assets/Reflection</i>."}]}';
+ </script>
+</head>
+<body>
+    <span id="source" fid="4"  style="display:none">H4sIAAAAAAAEALUZW2/btvo9QP4Dlw2ZjCby2r3ltuM4aWcgTYskZy9FcSBLVMxVEj2SiuuT5vz2fR8vulCSnfasQhDbJL/7nRqPyZQv14LdLxQJ4hEJry/vyGteFkmkGC9IVCRwolCCzUvFhSTBQqmlPBqPE64KqtLqaMjF/ZjsE7cvASahvyYhnBppPLcsYzHgvFVlwjigFcuwxrdarUJpTkh9IIx5+OdytLszHpMLJg0LNCFAkAqiFpS8nd0RAKCFpCG5pVQvXs2ml9e3l2GekJRllLBCLy8F/5PGigjOFUm5IDkXuAlfc8P/7k4pWXFPbtdS0fy4/TOc8iwDeDgowze0oILF/pErVvzlr93Q1IIN74SXOVP1ttYb0BM0nBQFV5o7Cfu7O0WUU7mMYto6VWPa3Xnc3SHwLMs5KIZIBI5JnEVSkskcdBjF6t0cFTEDLUeFYhFY1cBYUA0u2EOkqIMXNEp4ka3BDJpMJNYnd+slPSD4/wwdBFCXMVgHFyQ5JQVdDZwORloUR2oM1j2RZZ7DsbP28hToKsAWFWAn5Bbk5imJiAI8hOXLjOYURACloYXlksYsZeAhJ8tIRLmgKUGFne7NI0mR9t74LPQoj/tJGww++NnJWK/7hwUFFJ+ktzxLNzFCGAiWoWbXIBE4fSwoaFyLFoDVUerIWsysFuC0WhWKihR84EBLnVO14AmYSJWi6OhqIwNK0iztKKRfmBNL4GzyTxoDqRm0vkNQGmWSE1BKero3AT96QEcNjUvMLAMB4hkBohr6wzVX12WWfWw4cysWuPZ+61tTq/YKYQWufZU4Xkc1tkaU4MNSErhT5BT8HoBHoAHBVzoGJuK+RL0g0svPMV1iRASoCZ5WgKN2SDi8P7j9cCZd8JL9fdJcnzlvGLXh8TG6JYPaq8h3qGtp4nZUH7ePZDz+RAI/8j0uHrtMacF8sPBOrN9Q9UeUlTVbB4SXyudi1CNnDxV8HiKIF5lfg65tQppISfN5tsal4Kc9Z32TEP/z+KZkSXhNV/gZjI6un/a6mnFPlZ6AhEFKAqg0OYWysu7hscHQeckyrGCnFT92JbygKSvoxRrcg8VuM7AyHPjHJ3FMpQxvymJ0PEww50mZ0ZpmzUCb3Ft9Lthr/dysAAOvE8Awfdytqbe4sQygWcEaj87uTzNIJntDMs0KBkUrY//VZy2m14LnGk2D2gEZ9u+uFYeF8BwQhGgQsSGFGzNoJYIhrjsOP0mShqP7Tt7L8FN7yfu5Ldh7SDQwPase16qXOsf7mb2hF6wvpp2xvdcDdCv/eGFuEjy7W9jqObfepjhUKsdxOFC6++s84sJfBiGUOeWQx6UQkM4h3E0bWqkV+7gujXbteeAs2eLA7QLkAqfl1t9Uo1ph+JVlqgE78h38e9U/7W4L6LIVoZ+hl8DGv7LIMAtbKmIzciECq6Mz177oXrtVGJvgNJM9SaKJ9Jaq9xE6yIbiCqLp4zC6SIXOZdrzBaMiEvECCkkK3kASSpfGi+OMS1B9GwvmVuuMNi05isfdg66RPLdHXId+BRyc1F15E2y1wOEpaJL4wZp3a43vkNPproGqL022hWn8Cs/7BfMSYJfoDX2gQtKg1wTTBYUGRi0i6LSzrO6qoYUWjX6WJl1tVmff6t67pUyzhLWgq1IYNWkUL0iASP5VYcEJtfJf6IIqr5SB3+309VMeM6jqm6i4p0FNAbHa7eCcFQnk5ddZdC/D9yY9fSGtVVczOsH+tNWVq4nFjCVy2BX/H91Z53CWRgV2rL9dcy2UdowCTB7yr9TdNS+2KfXZDSwmtsAwFk6Uvf+QZJ8Yfuql0E0HI4zRXwbazwEq1o5OgUckSkAPaviwZ0Ed24bLoe7nqX8Z0+lXCPkHE6qMMiMjzkHPA4OG/jbjoJrTb1UNhzSCty1HJNZJA1iGsuRWIWFAg0MfGC8ltAWwEANpKFdeLAyTwNuowCSWhH6GiPjl2H496Sh7ystC2e0XLwbE2SISPt1QxNmgTeyDpvJxwKjuQQO2AUMzcp1awc1PsNeU59Af2UR1y+6LCFpW6gEfWKi+OPkK+fAB0+mbTDBQHql4cUAyqn6W0CrnYDy0oS60LnfZFAAFV9Aq/2+n4lvoRmOfqEBrbygkms8c8tCnLecGQmjDVidZuwfUcmM1UJUgm66rG6nB+tdA8j3DYlNIdCres2Jig7/01HSg6JPZHg06lXlgfbGwxSNAtdDyQgkBbTaahFaLugXFly8EBmqflQsKnaaAioR17bfwNfRyyM5T2Dmpl/c8trcE5IYI99A/J8S3hPf3D+2Ol7Xj+vBwU2QPh+SWpb4OC8Y9iLGZIpLSXJqWdfojcfej5oqcvBccxgW1Hl8+gGw6gHR34+LxGOZihYpJOJXFzwYbaiSNWAbdPi0MMjez62l3xRRgwJv/gheHVeTeUwXKGUv9QQ4PCXCyooAZ8Qoa2ysVM/kbruhDR+M44jlb6B58c/M40K51C2QRR8p3OfmMThr4+fcy0er0mwitTqfJwcSla2oNUwVPjafHZRoA+6fkf4Ot3TeA2s5nM+SX027L9DtIeb6G+O29h0IxnS6qbNkcgs21ntkKGgnkoEHX5YBwCpYHnwOzoYdAaqt2bvSNlrkgs0tv9HgNqMC4MB3BuI0vvgIoEGfkc1ht6REzvOMTIaJ10Blj+oWYXYEY7SU9jV3pt314pdYzSFq/uXt38e4IMpJwDs9QwkRHxSoqdMSQR3dHl9A0KjMV3I2OyRPEIW496bcqUHt/6yVgngkkPB3YqCoggJ06gtqsh18V5z0YfEnDO7ygqe9j0Ho8DSDTzOrCX233zYGNr897l2cqg7k4XDpDabeR+oJtxfVbH/vGpx4Fv/Fq0DjMy8FXdt2zrza83jPvqE7iMyVKejKOz7DW90miixFkTErma/w4JhyOiRWT4MQAn0LW1gh6X315r13nnGdDJbW+BKxVZaPkZfOKsLP7avieEGOiEki+rBLYSz/uem6YarhXFdyrHrju1V2DYnhFi3uoODDgNfDZ1eEXXFqpHdx1C2nbR2gdu7SOyYsX7HlvrRrAH9jHdrbxWO7sD3Q6ngDNrU4nYM+iB7bv7u0H/P0NApvGEs4h$2325$</span>
+  </body>
+</html>
diff --git a/en/contributors/engine/ndepend/NDependReportFiles/src/AccelerometerSensor.cs.html b/en/contributors/engine/ndepend/NDependReportFiles/src/AccelerometerSensor.cs.html
@@ -0,0 +1,14 @@
+<meta charset="UTF-8">
+<html>
+  <head>
+    <link rel="stylesheet" href="src.css"/>
+	 <script src="src.js"></script>
+    <script src="CommonIssuesData.js"></script>
+    <script>
+var issues='{"fileName":"AccelerometerSensor.cs","relativePath":"../../../../stride/sources/engine/Stride.Input/AccelerometerSensor.cs","absolutePath":"D:/Projects/GitHub/stride/sources/engine/Stride.Input/AccelerometerSensor.cs","projectName":"Stride.Input","line":"19","statement":"3","debt":"4h  22min","cov":"N/A","issues":[{"line":"8","ruleId":"ND1203","debt":"0min  30s","severity":"1","expl":"No class derives from the <i>class AccelerometerSensor</i> and it is not publicly visible. It can be marked as <i>sealed</i>."},{"line":"8","ruleId":"ND1700","debt":"15min","severity":"1","expl":"The <i>class AccelerometerSensor</i> is not used within the context of analyzed code and may be a candidate for removal."},{"line":"15","ruleId":"ND1701","debt":"10min","severity":"1","expl":"The <i>constructor of AccelerometerSensor</i> is not invoked within the context of analyzed code and may be a candidate for removal."},{"line":"6","ruleId":"ND2105","debt":"3h  57min","severity":"2","expl":"The <i>namespace Stride.Input</i> declarations are present in source files spread across multiple directories. <i>10 types GamePadLayout, GamePadLayout+MappedAxis, GamePadLayoutDS4, GamePadLayouts, GamePadLayoutXInput, GestureConfig, GestureConfigComposite, GestureConfigDrag, GestureConfigFlick and GestureConfigLongPress and 37 other types</i> are declared in source files out of <i>D:/Projects/GitHub/stride/sources/engine/Stride.Input</i>."}]}';
+ </script>
+</head>
+<body>
+    <span id="source" fid="1"  style="display:none">H4sIAAAAAAAEAG1RwW7bMAy9G/A/EDkMMRBIh97arsDQZYCBNRcXuysynaiwRUOkEWRF/n203STrFl8kk4/vPT5ZC8/UH1PY7QWWvgCzWb/CDxpi7SRQBBdrRURJYTsIJYblXqTne2trkojSXKCG0s7CFzj3WWdqvKuNooqJpwpt8MpZyVAHUtrUmyvf4XAwPCN4AhhP5q0v8sxa+B54toA1qCAmkD3CS/kKOoCR0UCFOBV/ls/rTbU2XQ1NaBFCnMp9ojf0AolIoKEEHaWxqddu9p9neTZwiDs1OFo3ahDNi9PpEeH5YURE1yH3zuMZVcZ+kDx7zzPQL0TBFF0LvnXM8M17bDFRh1qu1KgK38N8WUF5oz3TfLCNXz9sdUf4peYp3Z0Z59d5hx3Kw1WUx7/TaPM8bTW8Rx66zqXj0+dyGYME14bfyOAg4kF5WFzU1aiZMntkzdQnbL4ubjhd2Kd5S/OPnP1f72OJGyzLcgqwoiGpME/HCsbX1ofgIwt2G4280Ni2jnF5QVxaK/jsblFcdf/K8TRf9Tj9AekKn1v2Ag==$94$</span>
+  </body>
+</html>
diff --git a/en/contributors/engine/ndepend/NDependReportFiles/src/AccessorMetadata.cs.html b/en/contributors/engine/ndepend/NDependReportFiles/src/AccessorMetadata.cs.html
@@ -0,0 +1,14 @@
+<meta charset="UTF-8">
+<html>
+  <head>
+    <link rel="stylesheet" href="src.css"/>
+	 <script src="src.js"></script>
+    <script src="CommonIssuesData.js"></script>
+    <script>
+var issues='{"fileName":"AccessorMetadata.cs","relativePath":"../../../../stride/sources/core/Stride.Core/AccessorMetadata.cs","absolutePath":"D:/Projects/GitHub/stride/sources/core/Stride.Core/AccessorMetadata.cs","projectName":"Stride.Core","line":"60","statement":"5","debt":"2h  23min","cov":"N/A","issues":[{"line":"9","ruleId":"ND1207","debt":"2min  0s","severity":"1","expl":"The <i>class AccessorMetadata</i> is not instantiated in the context of the analyzed code. Should it be declared as a <i>static class</i> or is it a potential candidate for removal?"},{"line":"16","ruleId":"ND1306","debt":"2min  0s","severity":"1","expl":"The <i>nested delegate AccessorMetadata+SetterDelegate</i> is declared as <i>public</i> and is accessed outside its parent type by the <i>no element</i>. Typically, types are nested to encapsulate private implementation details. Consider making it <i>private</i> or non-nested."},{"line":"23","ruleId":"ND1306","debt":"2min  0s","severity":"1","expl":"The <i>nested delegate AccessorMetadata+GetterDelegate</i> is declared as <i>public</i> and is accessed outside its parent type by the <i>no element</i>. Typically, types are nested to encapsulate private implementation details. Consider making it <i>private</i> or non-nested."},{"line":"4","ruleId":"ND1401","debt":"2h  0min","severity":"2","expl":"The <i>10 namespaces Stride.Core.Storage, Stride.Core.Settings, Stride.Core.Reflection, Stride.Core.ReferenceCounting, Stride.Core.Extensions, Stride.Core.Diagnostics, Stride.Core.Collections, Stride.Core.Annotations, Stride.Core.Serialization and Stride.Core.Serialization.Serializers and 1 other namespace</i> form a <b>dependency cycle</b>: they all depend on each other. This cycle prevents <b>clean layered architecture</b> and reduces maintainability. To fix it, first address all issues stemming from the rule <i>Avoid mutually dependent namespaces</i>. Then read this rule documentation that explains how to use the <i>Dependency Inversion Principle</i> to fix cycles involving 3 or more namespaces."},{"line":"1","ruleId":"ND1407","debt":"10min","severity":"0","expl":"The <i>assembly Stride.Core</i> has a <i>Normalized Distance from the Main Sequence</i> metric equals to 0.83. To understand this metric, its implications, and the necessary corrective actions, please read this rule description."},{"line":"4","ruleId":"ND2105","debt":"7min","severity":"2","expl":"The <i>namespace Stride.Core</i> declarations are present in source files spread across multiple directories. <i>class NativeLibraryHelper</i> is declared in source files out of <i>D:/Projects/GitHub/stride/sources/core/Stride.Core</i>."}]}';
+ </script>
+</head>
+<body>
+    <span id="source" fid="1"  style="display:none">H4sIAAAAAAAEAM1VUW/aMBB+R+I/nHiYQKrsh721FGlqu6raWk2j6rubHOAqsSPbAbFp/31nOyEQCCD2MoSU6HJ3/u67+86cw50u1kbOFw6GyQjYy8MrfNWlSoWTWoFQKXkoZ+R76bSxMFw4V9hrzlPtFLrZxpVpM+fwCervlmJS/Jwy8hqFPFOZyYRyTl2ZSk1pTcGafKvVitnoYYMDSzT7KEb9HudwL22EgCnQgWjALRCen16BAlBZZDBFDMbvT3cPL9MHlqcwkxmCVMFcGP2BiQOjtYOZNpBr4z/Sax7x93v9nhI52kIkSCA9fEYgsd/73e8B/TghGdsyz4VZTxrTMzpBHAgoLcHzuemwpUylmoNwTiQLMs/ROTTchgc4DYJSEeTE4Ox28MPoAo1bf8P1gE/Y1nF897yifKeKIcmEtfAlSdBabTYArmErUW2NgVUJHWXU5mmEl2KGc+GQtYL44ahxIYzIwZN3OygqBH5qhFRoBpPXyH8wQ1LbYaGzwJFvz1JkJbIxD5mOpQ+OMWV49VQSqfuRFVN1KbDUMq3qu69sQ+J+w9gGL+xVcAX6PQxPOHF04yflDDIfd8n8P7g06Eqj7ORnfDYBY15/6uawouHxIhZ3eSuMXPqUBkWqVbZutQaiUG6OBOyiqAR2bm+elHRSZPIXWlKiwhWtAuuEIuXrWSBlS51tnZFEowIv0UfEOZi0puOc2bdVaFulncPfBj48yNnVYe5HTbqt5eF/biEti7Fw2xC/52Jrl71m/jlfQlsjCjOj88OLs1EI9YY6oxMp/GVB28FDqUBe0i+a+cHEHVTdKY01S8rS3YkpO6KxRlpvPqJDVOTV3ZaYuyo1JPDuF7A+bbFON9pp0uPWuZTgw2vtHy6EblHUF8EJnltLv5N1u0P3VXNHbLFePej/F8cfbjxxCQ==$685$</span>
+  </body>
+</html>