Base: apply clang format

2023-11-10 18:27:44 +01:00
parent bb333d9a74
commit 985def3416
154 changed files with 11874 additions and 9872 deletions
--- a/src/Base/BoundBoxPy.xml
+++ b/src/Base/BoundBoxPy.xml
@@ -1,20 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
-  <PythonExport 
-      Father="PyObjectBase" 
-      Name="BoundBoxPy" 
-      Twin="BoundBox" 
-      TwinPointer="BoundBox3d" 
-      Include="Base/BoundBox.h" 
-      FatherInclude="Base/PyObjectBase.h" 
-      Namespace="Base" 
+  <PythonExport
+      Father="PyObjectBase"
+      Name="BoundBoxPy"
+      Twin="BoundBox"
+      TwinPointer="BoundBox3d"
+      Include="Base/BoundBox.h"
+      FatherInclude="Base/PyObjectBase.h"
+      Namespace="Base"
      Constructor="true"
-      Delete="true" 
+      Delete="true"
      FatherNamespace="Base">
    <Documentation>
      <Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
      <DeveloperDocu>This is the BoundBox export class</DeveloperDocu>
-      <UserDocu>Base.BoundBox class.
+      <UserDocu>Base.BoundBox class.

 This class represents a bounding box.
 A bounding box is a rectangular cuboid which is a way to describe outer
@@ -23,50 +23,50 @@ It is often used to check if a 3D entity lies in the range of another object.
 Checking for bounding interference first can save a lot of computing time!
 An invalid BoundBox is represented by inconsistent values at each direction:
 The maximum float value of the system at the minimum coordinates, and the
-opposite value at the maximum coordinates.
+opposite value at the maximum coordinates.

-The following constructors are supported:
+The following constructors are supported:

 BoundBox()
-Empty constructor. Returns an invalid BoundBox.
+Empty constructor. Returns an invalid BoundBox.

 BoundBox(boundBox)
 Copy constructor.
-boundBox : Base.BoundBox
+boundBox : Base.BoundBox

 BoundBox(xMin, yMin=0, zMin=0, xMax=0, yMax=0, zMax=0)
 Define from the minimum and maximum values at each direction.
-xMin : float
+xMin : float
    Minimum value at x-coordinate.
-yMin : float
+yMin : float
    Minimum value at y-coordinate.
-zMin : float
+zMin : float
    Minimum value at z-coordinate.
-xMax : float
+xMax : float
    Maximum value at x-coordinate.
-yMax : float
+yMax : float
    Maximum value at y-coordinate.
-zMax : float
-    Maximum value at z-coordinate.
+zMax : float
+    Maximum value at z-coordinate.

 App.BoundBox(min, max)
 Define from two containers representing the minimum and maximum values of the
 coordinates in each direction.
-min : Base.Vector, tuple
+min : Base.Vector, tuple
    Minimum values of the coordinates.
-max : Base.Vector, tuple
+max : Base.Vector, tuple
    Maximum values of the coordinates.</UserDocu>
    </Documentation>
    <Methode Name="setVoid">
      <Documentation>
-        <UserDocu>setVoid() -> None
+        <UserDocu>setVoid() -> None

 Invalidate the bounding box.</UserDocu>
      </Documentation>
    </Methode>
    <Methode Name="isValid">
      <Documentation>
-        <UserDocu>isValid() -> bool
+        <UserDocu>isValid() -> bool

 Checks if the bounding box is valid.</UserDocu>
      </Documentation>
@@ -74,38 +74,38 @@ Checks if the bounding box is valid.</UserDocu>
    <Methode Name="add">
      <Documentation>
        <UserDocu>add(minMax) -> None
-add(x, y, z) -> None
+add(x, y, z) -> None

 Increase the maximum values or decrease the minimum values of this BoundBox by
 replacing the current values with the given values, so the bounding box can grow
-but not shrink.
+but not shrink.

-minMax : Base.Vector, tuple
+minMax : Base.Vector, tuple
    Values to enlarge at each direction.
-x : float
+x : float
    Value to enlarge at x-direction.
-y : float
+y : float
    Value to enlarge at y-direction.
-z : float
+z : float
    Value to enlarge at z-direction.</UserDocu>
      </Documentation>
    </Methode>
    <Methode Name="getPoint">
      <Documentation>
-        <UserDocu>getPoint(index) ->Base.Vector
+        <UserDocu>getPoint(index) ->Base.Vector

 Get the point of the given index.
-The index must be in the range of [0, 7].
+The index must be in the range of [0, 7].

 index : int</UserDocu>
      </Documentation>
    </Methode>
    <Methode Name="getEdge">
      <Documentation>
-        <UserDocu>getEdge(index) -> tuple of Base.Vector
+        <UserDocu>getEdge(index) -> tuple of Base.Vector

 Get the edge points of the given index.
-The index must be in the range of [0, 11].
+The index must be in the range of [0, 11].

 index : int</UserDocu>
      </Documentation>
@@ -113,27 +113,27 @@ index : int</UserDocu>
    <Methode Name="closestPoint">
      <Documentation>
        <UserDocu>closestPoint(point) -> Base.Vector
-closestPoint(x, y, z) -> Base.Vector
+closestPoint(x, y, z) -> Base.Vector

-Get the closest point of the bounding box to the given point.
+Get the closest point of the bounding box to the given point.

-point : Base.Vector, tuple
+point : Base.Vector, tuple
    Coordinates of the given point.
-x : float
+x : float
    X-coordinate of the given point.
-y : float
+y : float
    Y-coordinate of the given point.
-z : float
+z : float
    Z-coordinate of the given point.</UserDocu>
      </Documentation>
    </Methode>
    <Methode Name="intersect">
      <Documentation>
        <UserDocu>intersect(boundBox2) -> bool
-intersect(base, dir) -> bool
+intersect(base, dir) -> bool

 Checks if the given object intersects with this bounding box. That can be
-another bounding box or a line specified by base and direction.
+another bounding box or a line specified by base and direction.

 boundBox2 : Base.BoundBox
 base : Base.Vector, tuple
@@ -142,28 +142,28 @@ dir : Base.Vector, tuple</UserDocu>
    </Methode>
    <Methode Name="intersected">
      <Documentation>
-        <UserDocu>intersected(boundBox2) -> Base.BoundBox
+        <UserDocu>intersected(boundBox2) -> Base.BoundBox

-Returns the intersection of this and the given bounding box.
+Returns the intersection of this and the given bounding box.

 boundBox2 : Base.BoundBox</UserDocu>
      </Documentation>
    </Methode>
    <Methode Name="united">
      <Documentation>
-        <UserDocu>united(boundBox2) -> Base.BoundBox
+        <UserDocu>united(boundBox2) -> Base.BoundBox

-Returns the union of this and the given bounding box.
+Returns the union of this and the given bounding box.

 boundBox2 : Base.BoundBox</UserDocu>
      </Documentation>
    </Methode>
    <Methode Name="enlarge">
        <Documentation>
-            <UserDocu>enlarge(variation) -> None
+            <UserDocu>enlarge(variation) -> None

 Decrease the minimum values and increase the maximum values by the given value.
-A negative value shrinks the bounding box.
+A negative value shrinks the bounding box.

 variation : float</UserDocu>
        </Documentation>
@@ -171,70 +171,70 @@ variation : float</UserDocu>

      <Methode Name="getIntersectionPoint">
          <Documentation>
-              <UserDocu>getIntersectionPoint(base, dir, epsilon=0.0001) -> Base.Vector
+              <UserDocu>getIntersectionPoint(base, dir, epsilon=0.0001) -> Base.Vector

 Calculate the intersection point of a line with the bounding box.
-The base point must lie inside the bounding box, if not an exception is thrown.
+The base point must lie inside the bounding box, if not an exception is thrown.

-base : Base.Vector
+base : Base.Vector
    Base point of the line.
-dir : Base.Vector
+dir : Base.Vector
    Direction of the line.
-epsilon : float
+epsilon : float
    Bounding box size tolerance.</UserDocu>
          </Documentation>
      </Methode>
      <Methode Name="move">
          <Documentation>
              <UserDocu>move(displacement) -> None
-move(x, y, z) -> None
+move(x, y, z) -> None

-Move the bounding box by the given values.
+Move the bounding box by the given values.

-displacement : Base.Vector, tuple
+displacement : Base.Vector, tuple
    Displacement at each direction.
-x : float
+x : float
    Displacement at x-direction.
-y : float
+y : float
    Displacement at y-direction.
-z : float
+z : float
    Displacement at z-direction.</UserDocu>
          </Documentation>
      </Methode>
      <Methode Name="scale">
          <Documentation>
              <UserDocu>scale(factor) -> None
-scale(x, y, z) -> None
+scale(x, y, z) -> None

-Scale the bounding box by the given values.
+Scale the bounding box by the given values.

-factor : Base.Vector, tuple
+factor : Base.Vector, tuple
    Factor scale at each direction.
-x : float
+x : float
    Scale at x-direction.
-y : float
+y : float
    Scale at y-direction.
-z : float
+z : float
    Scale at z-direction.</UserDocu>
          </Documentation>
      </Methode>
      <Methode Name="transformed">
          <Documentation>
-              <UserDocu>transformed(matrix) -> Base.BoundBox
+              <UserDocu>transformed(matrix) -> Base.BoundBox

 Returns a new BoundBox containing the transformed rectangular cuboid
-represented by this BoundBox.
+represented by this BoundBox.

-matrix : Base.Matrix
+matrix : Base.Matrix
    Transformation matrix.</UserDocu>
          </Documentation>
      </Methode>
      <Methode Name="isCutPlane">
      <Documentation>
-        <UserDocu>isCutPlane(base, normal) -> bool
+        <UserDocu>isCutPlane(base, normal) -> bool

 Check if the plane specified by base and normal intersects (cuts) this bounding
-box.
+box.

 base : Base.Vector
 normal : Base.Vector</UserDocu>
@@ -243,17 +243,17 @@ normal : Base.Vector</UserDocu>
        <Methode Name="isInside">
            <Documentation>
                <UserDocu>isInside(object) -> bool
-isInside(x, y, z) -> bool
+isInside(x, y, z) -> bool

-Check if a point or a bounding box is inside this bounding box.
+Check if a point or a bounding box is inside this bounding box.

-object : Base.Vector, Base.BoundBox
+object : Base.Vector, Base.BoundBox
    Object to check if it is inside this bounding box.
-x : float
+x : float
    X-coordinate of the point to check.
-y : float
+y : float
    Y-coordinate of the point to check.
-z : float
+z : float
    Z-coordinate of the point to check.</UserDocu>
            </Documentation>
        </Methode>