bos #29469: Advanced geometry features: Detect type of shape

[modules/geom.git] / src / GEOM_SWIG / canonicalrecognition.py

diff --git a/src/GEOM_SWIG/canonicalrecognition.py b/src/GEOM_SWIG/canonicalrecognition.py
new file mode 100644 (file)
index 0000000..69aaa18
--- /dev/null
+++ b/src/GEOM_SWIG/canonicalrecognition.py
@@ -0,0 +1,90 @@
+#  -*- coding: iso-8859-1 -*-
+# Copyright (C) 2007-2022  CEA/DEN, EDF R&D, OPEN CASCADE
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+#  File   : GEOM_CanonicalRecognition.py
+#  Author : Vitaly SMETANNIKOV, Open CASCADE S.A.S.
+#  Module : GEOM_SWIG
+
+def setVectorSize(theVec):
+    "We have to set the vector size because we need to have output values in this vector"
+    if len(theVec) != 3:
+        theVec = [0,0,0]
+    return theVec
+
+class CanonicalRecognition:
+    "The class provides recognition of canonical shapes"
+
+    def __init__(self, geompyD):
+        self.CR = geompyD.GetICanonicalRecognition()
+        
+    def isPlane(self, shape, tolerance, normal = [], origin = []):
+        """
+        Check if shape is planar
+        Usage:
+        > CR.isPlane(shape, tolerance, normal, origin)
+        """
+        return self.CR.isPlane(shape, tolerance, setVectorSize(normal), setVectorSize(origin))
+
+    def isSphere(self, shape, tolerance, origin = [], radius = 0.0):
+        """
+        Check if shape is spherical
+        Usage:
+        > CR.isSphere(shape, tolerance, origin, radius)
+        """
+        return self.CR.isSphere(shape, tolerance, setVectorSize(origin), radius)
+
+    def isCone(self, shape, tolerance, axis = [], apex = [], halfAngle = 0.0):
+        """
+        Check if shape is conical
+        Usage:
+        > CR.isCone(shape, tolerance, axis, apex, halfAngle)
+        """
+        return self.CR.isCone(shape, tolerance, setVectorSize(axis), setVectorSize(apex), halfAngle)
+
+    def isCylinder(self, shape, tolerance, axis = [], origin = [], radius = 0.0):
+        """
+        Check if shape is cylinder
+        Usage:
+        > CR.isCylinder(shape, tolerance, axis, origin, radius)
+        """
+        return self.CR.isCylinder(shape, tolerance, setVectorSize(axis), setVectorSize(origin), radius)
+
+    def isLine(self, edge, tolerance, direction = [], origin = []):
+        """
+        Check if edge/wire is line
+        Usage:
+        > CR.isLine(edge, tolerance, direction, origin)
+        """
+        return self.CR.isLine(edge, tolerance, setVectorSize(direction), setVectorSize(origin))
+
+    def isCircle(self, edge, tolerance, normal = [], origin = [], radius = 0.0):
+        """
+        Check if edge/wire is circle
+        Usage:
+        > CR.isCircle(edge, tolerance, normal, origin, radius)
+        """
+        return self.CR.isCircle(edge, tolerance, setVectorSize(normal), setVectorSize(origin), radius)
+
+    def isEllipse(self, edge, tolerance, normal = [], dirX = [], origin = [], majorRadius = 0.0, minorRadius = 0.0):
+        """
+        Check if edge/wire is ellipse
+        Usage:
+        > CR.isEllipse(edge, tolerance, normal, dirX, origin, majorRadius, minorRadius)
+        """
+        return self.CR.isEllipse(edge, tolerance, setVectorSize(normal), setVectorSize(dirX), setVectorSize(origin), majorRadius, minorRadius)