0024793: Documentation of methods using BRepFill_TypeOfContact has to be updated...
authorjgv <jgv@opencascade.com>
Thu, 17 Apr 2014 09:44:16 +0000 (13:44 +0400)
committerabv <abv@opencascade.com>
Mon, 21 Apr 2014 15:58:51 +0000 (19:58 +0400)
src/BRepFill/BRepFill_PipeShell.cdl
src/BRepOffsetAPI/BRepOffsetAPI_MakePipeShell.cdl

index 2701666..d477c57 100644 (file)
@@ -100,9 +100,18 @@ is
         --   than P split  <Spline>. 
         -- Else  the  plan  define  by  P  and  the  tangent  to  the  <Spine> 
         --       intersect <AuxiliarySpine> in Q.
-        -- If <KeepContact> the  Normal  is  defined to  assume like  the  sweeped 
-        --                  section is  in  contact to  the  <AuxiliarySpine>
-        -- Else  the  Normal  is  defined  by the vector  PQ. 
+        -- If <KeepContact> equals BRepFill_NoContact: The Normal is defined
+        -- by the vector PQ.
+        -- If <KeepContact> equals BRepFill_Contact: The Normal is defined to
+        -- achieve that the sweeped section is in contact to the
+        -- auxiliarySpine. The width of section is constant all along the path.
+        -- In other words, the auxiliary spine lies on the swept surface,
+        -- but not necessarily is a boundary of this surface. However,
+        -- the auxiliary spine has to be close enough to the main spine
+        -- to provide intersection with any section all along the path.
+        -- If <KeepContact> equals BRepFill_ContactOnBorder: The auxiliary spine
+        -- becomes a boundary of the swept surface and the width of section varies
+        -- along the path.
 
         ---Level: Public
 
index c203338..3e94234 100644 (file)
@@ -103,9 +103,18 @@ is
         --   than P split  <Spline>. 
         -- Else  the  plan  define  by  P  and  the  tangent  to  the  <Spine> 
         --       intersect <AuxiliarySpine> in Q.
-        -- If <KeepContact> the  Normal  is  defined to  assume like  the  sweeped 
-        --                  section is  in  contact to  the  <AuxiliarySpine>
-        -- Else  the  Normal  is  defined  by the vector  PQ. 
+        -- If <KeepContact> equals BRepFill_NoContact: The Normal is defined
+        -- by the vector PQ.
+        -- If <KeepContact> equals BRepFill_Contact: The Normal is defined to
+        -- achieve that the sweeped section is in contact to the
+        -- auxiliarySpine. The width of section is constant all along the path.
+        -- In other words, the auxiliary spine lies on the swept surface,
+        -- but not necessarily is a boundary of this surface. However,
+        -- the auxiliary spine has to be close enough to the main spine
+        -- to provide intersection with any section all along the path.
+        -- If <KeepContact> equals BRepFill_ContactOnBorder: The auxiliary spine
+        -- becomes a boundary of the swept surface and the width of section varies
+        -- along the path.
 
         ---Level: Public