Merge pull request #1007 from ess-dmsc/ECDC-3038_enable_offsets_in_tr…

…ansforms

 ECDC-3038: Adding offset to transformations

nexus_constructor/common_attrs.py

@@ -10,6 +10,7 @@ class CommonAttrs:
     VECTOR = "vector"
     UNITS = "units"
     VERTICES = "vertices"
+    OFFSET = "offset"
 
 
 class CommonKeys:

nexus_constructor/json/transformation_reader.py

@@ -30,7 +30,7 @@
     create_fw_module_object,
 )
 from nexus_constructor.model.transformation import Transformation
-from nexus_constructor.model.value_type import VALUE_TYPE_TO_NP
+from nexus_constructor.model.value_type import VALUE_TYPE_TO_NP, ValueTypes
 from nexus_constructor.transformations_list import TransformationsList
 
 TRANSFORMATION_MAP = {
@@ -176,7 +176,7 @@ def _find_attribute_in_list(
         :return: The value of the attribute if is is found in the list, otherwise the failure value is returned.
         """
         attribute = _find_attribute_from_list_or_dict(attribute_name, attributes_list)
-        if not attribute:
+        if not attribute and attribute_name not in [CommonAttrs.OFFSET]:
             self.warnings.append(
                 TransformDependencyMissing(
                     f"Unable to find {attribute_name} attribute in transformation"
@@ -330,6 +330,11 @@ def _create_transformations(self, json_transformations: list):
                 depends_on=temp_depends_on,
                 values=values,
             )
+            offset = self._find_attribute_in_list(CommonAttrs.OFFSET, name, attributes)
+            if offset:
+                transform.attributes.set_attribute_value(
+                    CommonAttrs.OFFSET, offset, ValueTypes.FLOAT
+                )
             if depends_on not in DEPENDS_ON_IGNORE:
                 depends_on_id = TransformId(
                     *get_component_and_transform_name(depends_on)

nexus_constructor/model/transformation.py

@@ -107,14 +107,19 @@ def qmatrix(self) -> QMatrix4x4:
         """
         transform = Qt3DCore.QTransform()
         transform.matrix()
+        offset = self.attributes.get_attribute_value(CommonAttrs.OFFSET)
+        if not offset:
+            offset = 0.0
         if self.transform_type == TransformationType.ROTATION:
             quaternion = transform.fromAxisAndAngle(
-                self.vector, self.ui_value * self._ui_scale_factor
+                self.vector, (self.ui_value + offset) * self._ui_scale_factor
             )
             transform.setRotation(quaternion)
         elif self.transform_type == TransformationType.TRANSLATION:
             transform.setTranslation(
-                self.vector.normalized() * self.ui_value * self._ui_scale_factor
+                self.vector.normalized()
+                * (self.ui_value + offset)
+                * self._ui_scale_factor
             )
         else:
             raise (

nexus_constructor/transformation_view.py

@@ -3,7 +3,7 @@
 from PySide6.QtGui import QVector3D
 from PySide6.QtWidgets import QFrame, QGroupBox, QWidget
 
-from nexus_constructor.common_attrs import TransformationType
+from nexus_constructor.common_attrs import CommonAttrs, TransformationType
 from nexus_constructor.component_tree_model import LinkTransformation
 from nexus_constructor.field_utils import find_field_type
 from nexus_constructor.model.component import Component
@@ -60,6 +60,9 @@ def _fill_in_existing_fields(self, current_vector):
                 self.transformation.values, self.transformation_frame.magnitude_widget
             )
         self.transformation_frame.magnitude_widget.units = self.transformation.units
+        offset = self.transformation.attributes.get_attribute_value(CommonAttrs.OFFSET)
+        if offset:
+            self.transformation_frame.offset_box.setValue(offset)
         self.update_depends_on_ui()
 
     def disable(self):
@@ -106,9 +109,17 @@ def save_transformation_name(self):
             self.transformation.name = self.transformation_frame.name_line_edit.text()
             self.model.signals.transformation_changed.emit()
 
+    def save_offset(self):
+        offset_value = self.transformation_frame.offset_box.value()
+        if offset_value:
+            self.transformation.attributes.set_attribute_value(
+                CommonAttrs.OFFSET, offset_value
+            )
+
     def save_all_changes(self):
         self.save_transformation_name()
         self.save_transformation_vector()
+        self.save_offset()
         self.save_magnitude()
 
 
@@ -120,6 +131,7 @@ def __init__(self, parent: QWidget, transformation: Transformation, model: Model
         )
         self.transformation_frame.vector_label.setText("Direction")
         self.transformation_frame.value_label.setText("Distance (m)")
+        self.transformation_frame.offset_label.setText("Offset (m)")
         self.setTitle(TransformationType.TRANSLATION)
 
 
@@ -131,6 +143,7 @@ def __init__(self, parent: QWidget, transformation: Transformation, model: Model
         )
         self.transformation_frame.vector_label.setText("Rotation Axis")
         self.transformation_frame.value_label.setText("Angle (°)")
+        self.transformation_frame.offset_label.setText("Offset (°)")
         self.setTitle(TransformationType.ROTATION)
 
 

nx-class-documentation/html/applying-nexus.html

@@ -793,7 +793,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/authorgroup.html

@@ -155,7 +155,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXarchive.html

@@ -454,7 +454,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXarpes.html

@@ -373,7 +373,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXcanSAS.html

@@ -1539,7 +1539,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXdirecttof.html

@@ -256,7 +256,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXfluo.html

@@ -313,7 +313,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXindirecttof.html

@@ -242,7 +242,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXiqproc.html

@@ -338,7 +338,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXlauetof.html

@@ -341,7 +341,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXmonopd.html

@@ -344,7 +344,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXmx.html

@@ -1039,7 +1039,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXrefscan.html

@@ -330,7 +330,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXreftof.html

@@ -346,7 +346,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXsas.html

@@ -451,7 +451,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXsastof.html

@@ -427,7 +427,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXscan.html

@@ -288,7 +288,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXspe.html

@@ -311,7 +311,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXsqom.html

@@ -336,7 +336,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXstxm.html

@@ -421,7 +421,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXtas.html

@@ -397,7 +397,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXtofnpd.html

@@ -340,7 +340,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXtofraw.html

@@ -359,7 +359,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXtofsingle.html

@@ -345,7 +345,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXtomo.html

@@ -360,7 +360,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXtomophase.html

@@ -362,7 +362,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXtomoproc.html

@@ -338,7 +338,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>

nx-class-documentation/html/classes/applications/NXxas.html

@@ -332,7 +332,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; <a href="../../copyright.html">Copyright</a> 1996-2022, NIAC, https://www.nexusformat.org.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.3.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>
 </html>