From df59c53e790f27df7b07fff9d2727a41e6ea7a28 Mon Sep 17 00:00:00 2001 From: luzpaz Date: Thu, 13 Nov 2025 04:30:53 -0500 Subject: [PATCH] Documentation - Fix whitespaces and typos (#821) MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit - Removed excessive whitespace between words in comments - Removed
syntax - Fixed spelling errors ("hilight" → "highlights", "texte" → "text") - Improved comment formatting and structure --- src/Draw/TKXSDRAW/XSDRAW/XSDRAW.hxx | 4 +- .../TKMath/CSLib/CSLib_Class2d.hxx | 2 +- .../Convert_SphereToBSplineSurface.hxx | 4 +- .../TKMath/ElSLib/ElSLib.hxx | 4 +- .../TKernel/OSD/OSD_Path.hxx | 2 +- .../TKernel/OSD/OSD_Protection.hxx | 10 +- .../TKBO/BOPAlgo/BOPAlgo_Algo.hxx | 2 +- .../TKBO/BOPAlgo/BOPAlgo_BOP.hxx | 24 ++--- .../TKBO/BOPAlgo/BOPAlgo_Builder.hxx | 10 +- .../TKBO/BOPAlgo/BOPAlgo_CellsBuilder.hxx | 32 +++--- .../TKBO/BOPAlgo/BOPAlgo_CheckerSI.hxx | 22 ++--- .../TKBO/BOPAlgo/BOPAlgo_GlueEnum.hxx | 28 +++--- .../TKBO/BOPAlgo/BOPAlgo_PaveFiller.hxx | 46 ++++----- .../TKBO/BOPAlgo/BOPAlgo_Splitter.hxx | 16 +-- .../TKBO/BOPAlgo/BOPAlgo_Tools.hxx | 44 ++++----- .../TKBO/BOPDS/BOPDS_CommonBlock.hxx | 6 +- .../TKBO/BOPDS/BOPDS_DS.hxx | 2 +- .../TKBO/BOPTools/BOPTools_AlgoTools.hxx | 2 +- .../TKBO/BOPTools/BOPTools_AlgoTools2D.hxx | 4 +- .../BRepAlgoAPI_BooleanOperation.hxx | 4 +- .../BRepAlgoAPI/BRepAlgoAPI_BuilderAlgo.hxx | 14 +-- .../TKBO/BRepAlgoAPI/BRepAlgoAPI_Splitter.hxx | 22 ++--- .../TKBO/IntTools/IntTools_Context.hxx | 12 +-- .../TKBO/IntTools/IntTools_Curve.hxx | 14 +-- .../TKBO/IntTools/IntTools_FaceFace.hxx | 2 +- .../TKBO/IntTools/IntTools_Tools.hxx | 2 +- .../GeomAPI/GeomAPI_ProjectPointOnSurf.hxx | 4 +- .../TKGeomAlgo/IntPolyh/IntPolyh_Couple.hxx | 2 +- .../TKGeomAlgo/IntPolyh/IntPolyh_Edge.hxx | 2 +- .../LocalAnalysis_CurveContinuity.hxx | 4 +- .../TKHLR/HLRBRep/HLRBRep_EdgeBuilder.hxx | 18 ++-- .../TKHLR/HLRBRep/HLRBRep_Surface.hxx | 26 ++--- .../HLRTopoBRep/HLRTopoBRep_FaceData.hxx | 4 +- .../TKMesh/BRepMesh/BRepMesh_CircleTool.hxx | 2 +- .../BRepMesh/BRepMesh_DiscretFactory.hxx | 20 ++-- .../TKMesh/BRepMesh/BRepMesh_VertexTool.hxx | 2 +- .../IMeshTools/IMeshTools_Parameters.hxx | 2 +- .../TKOffset/BRepOffset/BRepOffset_Tool.hxx | 34 +++---- .../BRepOffsetAPI_MakeThickSolid.hxx | 10 +- .../BRepOffsetAPI_NormalProjection.hxx | 14 +-- .../BRepOffsetAPI_ThruSections.hxx | 10 +- .../TKPrim/BRepPrim/BRepPrim_Builder.hxx | 44 ++++----- .../TKPrim/BRepPrim/BRepPrim_Cone.hxx | 10 +- .../TKPrim/BRepPrim/BRepPrim_Cylinder.hxx | 6 +- .../TKPrim/BRepPrim/BRepPrim_FaceBuilder.hxx | 4 +- .../TKPrim/BRepPrim/BRepPrim_GWedge.hxx | 6 +- .../TKPrim/BRepPrim/BRepPrim_Revolution.hxx | 18 ++-- .../TKPrim/BRepPrim/BRepPrim_Sphere.hxx | 6 +- .../BRepPrimAPI/BRepPrimAPI_MakeRevol.hxx | 18 ++-- .../BRepSweep_NumLinearRegularSweep.hxx | 98 +++++++++---------- .../TKPrim/BRepSweep/BRepSweep_Prism.hxx | 20 ++-- .../TKPrim/BRepSweep/BRepSweep_Revol.hxx | 16 +-- .../TKPrim/BRepSweep/BRepSweep_Rotation.hxx | 66 ++++++------- .../TKPrim/BRepSweep/BRepSweep_Tool.hxx | 6 +- .../ShapeAnalysis/ShapeAnalysis_Surface.hxx | 2 +- .../ShapeCustom_ConvertToRevolution.hxx | 48 ++++----- .../ShapeCustom_DirectModification.hxx | 48 ++++----- .../ShapeCustom_SweptToElementary.hxx | 48 ++++----- .../ShapeUpgrade_UnifySameDomain.hxx | 6 +- ...RepApprox_TheComputeLineBezierOfApprox.hxx | 2 +- .../BRepApprox_TheComputeLineOfApprox.hxx | 2 +- .../BRepApprox_TheMultiLineOfApprox.hxx | 4 +- .../BRepBuilderAPI/BRepBuilderAPI.hxx | 36 +++---- .../BRepBuilderAPI_EdgeError.hxx | 6 +- .../BRepBuilderAPI_FaceError.hxx | 2 +- .../BRepBuilderAPI_GTransform.hxx | 2 +- .../BRepBuilderAPI_MakeEdge.hxx | 22 ++--- .../BRepBuilderAPI_MakeEdge2d.hxx | 22 ++--- .../BRepBuilderAPI_MakeFace.hxx | 4 +- .../BRepBuilderAPI_MakePolygon.hxx | 4 +- .../BRepBuilderAPI_MakeShape.hxx | 12 +-- .../BRepBuilderAPI_ModifyShape.hxx | 24 ++--- .../BRepBuilderAPI_NurbsConvert.hxx | 2 +- .../BRepBuilderAPI/BRepBuilderAPI_Sewing.hxx | 2 +- .../BRepBuilderAPI_Transform.hxx | 10 +- .../BRepBuilderAPI_TransitionMode.hxx | 2 +- .../TKTopAlgo/BRepCheck/BRepCheck.hxx | 2 +- .../BRepCheck/BRepCheck_Analyzer.hxx | 40 ++++---- .../TKTopAlgo/BRepCheck/BRepCheck_Shell.hxx | 12 +-- .../TKTopAlgo/BRepCheck/BRepCheck_Solid.hxx | 2 +- .../TKTopAlgo/BRepCheck/BRepCheck_Wire.hxx | 44 ++++----- .../TKTopAlgo/BRepClass/BRepClass_Edge.hxx | 4 +- .../BRepClass_FClass2dOfFClassifier.hxx | 16 +-- .../BRepClass/BRepClass_FClassifier.hxx | 16 +-- .../BRepClass/BRepClass_FaceClassifier.hxx | 10 +- .../BRepClass/BRepClass_FaceExplorer.hxx | 28 +++--- .../BRepClass_FacePassiveClassifier.hxx | 16 +-- .../BRepClass/BRepClass_Intersector.hxx | 6 +- .../BRepClass3d/BRepClass3d_SolidExplorer.hxx | 18 ++-- .../BRepClass3d_SolidPassiveClassifier.hxx | 10 +- .../BRepExtrema_DistShapeShape.hxx | 90 ++++++++--------- .../BRepExtrema/BRepExtrema_ExtCC.hxx | 28 +++--- .../BRepExtrema/BRepExtrema_ExtCF.hxx | 22 ++--- .../BRepExtrema/BRepExtrema_ExtFF.hxx | 22 ++--- .../BRepExtrema/BRepExtrema_ExtPC.hxx | 26 ++--- .../BRepExtrema/BRepExtrema_ExtPF.hxx | 16 +-- .../TKTopAlgo/BRepGProp/BRepGProp_Cinert.hxx | 2 +- .../BRepGProp/BRepGProp_EdgeTool.hxx | 14 +-- .../BRepGProp/BRepGProp_MeshCinert.hxx | 8 +- .../TKTopAlgo/BRepGProp/BRepGProp_Sinert.hxx | 2 +- .../BRepGProp/BRepGProp_TFunction.hxx | 4 +- .../TKTopAlgo/BRepGProp/BRepGProp_Vinert.hxx | 16 +-- .../BRepIntCurveSurface_Inter.hxx | 2 +- .../TKTopAlgo/BRepLib/BRepLib.hxx | 76 +++++++------- .../TKTopAlgo/BRepLib/BRepLib_MakeFace.hxx | 6 +- .../TKTopAlgo/BRepLib/BRepLib_MakePolygon.hxx | 6 +- .../TKTopAlgo/BRepLib/BRepLib_MakeShape.hxx | 8 +- .../TKTopAlgo/BRepLib/BRepLib_MakeShell.hxx | 2 +- .../TKTopAlgo/BRepLib/BRepLib_MakeSolid.hxx | 2 +- .../TKTopAlgo/Bisector/Bisector_Bisec.hxx | 16 +-- .../TKTopAlgo/Bisector/Bisector_BisecAna.hxx | 20 ++-- .../TKTopAlgo/Bisector/Bisector_BisecCC.hxx | 18 ++-- .../TKTopAlgo/Bisector/Bisector_BisecPC.hxx | 16 +-- .../TKTopAlgo/Bisector/Bisector_Curve.hxx | 8 +- .../TKTopAlgo/Bisector/Bisector_FunctionH.hxx | 2 +- .../Bisector/Bisector_FunctionInter.hxx | 2 +- .../TKBRep/BRepTools/BRepTools.hxx | 2 +- .../TKBRep/BRepTools/BRepTools_ReShape.hxx | 4 +- .../TKBRep/TopTools/TopTools_ShapeSet.hxx | 2 +- .../TKGeomBase/GC/GC_MakeHyperbola.hxx | 2 +- .../TKGeomBase/GC/GC_MakePlane.hxx | 2 +- .../TKGeomBase/GCE2d/GCE2d_MakeEllipse.hxx | 4 +- .../TKGeomBase/GCE2d/GCE2d_MakeHyperbola.hxx | 4 +- .../TKGeomBase/GCE2d/GCE2d_MakeParabola.hxx | 4 +- .../GCPnts/GCPnts_AbscissaPoint.cxx | 2 +- .../Geom2dConvert_ApproxCurve.hxx | 12 +-- .../TKGeomBase/gce/gce_MakeCone.hxx | 2 +- .../TKGeomBase/gce/gce_MakeElips2d.hxx | 6 +- .../TKGeomBase/gce/gce_MakeHypr.hxx | 2 +- .../TKGeomBase/gce/gce_MakeParab.hxx | 2 +- .../TKGeomBase/gce/gce_MakeParab2d.hxx | 2 +- .../TKGeomBase/gce/gce_MakePln.hxx | 4 +- .../Aspect/Aspect_DisplayConnection.hxx | 9 +- .../Aspect/Aspect_TypeOfDeflection.hxx | 2 +- .../Aspect/Aspect_TypeOfStyleText.hxx | 6 +- .../TKService/Font/Font_TextFormatter.hxx | 24 ++--- .../TKService/Graphic3d/Graphic3d_Camera.hxx | 6 +- .../TKV3d/AIS/AIS_InteractiveContext.hxx | 2 +- .../TKV3d/AIS/AIS_Manipulator.hxx | 6 +- .../TKV3d/AIS/AIS_PlaneTrihedron.hxx | 2 +- .../TKV3d/AIS/AIS_Triangulation.hxx | 2 +- src/Visualization/TKV3d/AIS/AIS_Trihedron.hxx | 8 +- .../TKV3d/AIS/AIS_TypeFilter.hxx | 4 +- .../TKV3d/AIS/AIS_ViewController.hxx | 2 +- .../TKV3d/DsgPrs/DsgPrs_AnglePresentation.hxx | 18 ++-- src/Visualization/TKV3d/PrsDim/PrsDim.hxx | 32 +++--- .../PrsDim/PrsDim_MaxRadiusDimension.hxx | 14 +-- .../PrsDim/PrsDim_MinRadiusDimension.hxx | 14 +-- .../TKV3d/PrsMgr/PrsMgr_PresentableObject.hxx | 2 +- .../SelectMgr/SelectMgr_SelectableObject.hxx | 2 +- .../TKV3d/SelectMgr/SelectMgr_Selection.hxx | 4 +- .../SelectMgr/SelectMgr_SelectionManager.hxx | 2 +- .../SelectMgr/SelectMgr_StateOfSelection.hxx | 2 +- .../SelectMgr/SelectMgr_ViewerSelector.hxx | 4 +- .../TKV3d/StdPrs/StdPrs_PoleCurve.hxx | 2 +- .../StdPrs/StdPrs_ToolTriangulatedShape.hxx | 4 +- .../StdPrs_WFDeflectionRestrictedFace.hxx | 8 +- .../StdSelect/StdSelect_BRepSelectionTool.hxx | 6 +- src/Visualization/TKV3d/V3d/V3d_View.hxx | 12 +-- 159 files changed, 1017 insertions(+), 1012 deletions(-) diff --git a/src/Draw/TKXSDRAW/XSDRAW/XSDRAW.hxx b/src/Draw/TKXSDRAW/XSDRAW/XSDRAW.hxx index 7d696880e7..984afd98e0 100644 --- a/src/Draw/TKXSDRAW/XSDRAW/XSDRAW.hxx +++ b/src/Draw/TKXSDRAW/XSDRAW/XSDRAW.hxx @@ -154,8 +154,8 @@ public: //! Returns the FinderProcess, detained by the TransferWriter Standard_EXPORT static Handle(Transfer_FinderProcess) FinderProcess(); - //! Initialises a TransferReader, according to mode : - //! 0 nullifies it, 1 clears it (not nullify) + //! Initialises a TransferReader, according to mode: + //! 0 nullifies it, 1 clears it (not nullify) //! 2 sets it with TransientProcess & Model //! 3 idem plus roots of TransientProcess //! Remark : called with 0 at least at each SetModel/NewModel diff --git a/src/FoundationClasses/TKMath/CSLib/CSLib_Class2d.hxx b/src/FoundationClasses/TKMath/CSLib/CSLib_Class2d.hxx index c97f11d01b..8162b6c5ba 100644 --- a/src/FoundationClasses/TKMath/CSLib/CSLib_Class2d.hxx +++ b/src/FoundationClasses/TKMath/CSLib/CSLib_Class2d.hxx @@ -28,7 +28,7 @@ class gp_Pnt2d; -//! *** Class2d : Low level algorithm for 2d classification +//! Class2d: Low level algorithm for 2d classification //! this class was moved from package BRepTopAdaptor class CSLib_Class2d { diff --git a/src/FoundationClasses/TKMath/Convert/Convert_SphereToBSplineSurface.hxx b/src/FoundationClasses/TKMath/Convert/Convert_SphereToBSplineSurface.hxx index 6a4f9aee41..2283a8bcfc 100644 --- a/src/FoundationClasses/TKMath/Convert/Convert_SphereToBSplineSurface.hxx +++ b/src/FoundationClasses/TKMath/Convert/Convert_SphereToBSplineSurface.hxx @@ -27,8 +27,8 @@ class gp_Sphere; //! This algorithm converts a bounded Sphere into a rational //! B-spline surface. The sphere is a Sphere from package gp. -//! The parametrization of the sphere is -//! P (U, V) = Loc + Radius * Sin(V) * Zdir + +//! The parametrization of the sphere is: +//! P (U, V) = Loc + Radius * Sin(V) * Zdir + //! Radius * Cos(V) * (Cos(U)*Xdir + Sin(U)*Ydir) //! where Loc is the center of the sphere Xdir, Ydir and Zdir are the //! normalized directions of the local cartesian coordinate system of diff --git a/src/FoundationClasses/TKMath/ElSLib/ElSLib.hxx b/src/FoundationClasses/TKMath/ElSLib/ElSLib.hxx index 994dadd20f..e1d514e923 100644 --- a/src/FoundationClasses/TKMath/ElSLib/ElSLib.hxx +++ b/src/FoundationClasses/TKMath/ElSLib/ElSLib.hxx @@ -533,7 +533,7 @@ public: static void Parameters(const gp_Cylinder& C, const gp_Pnt& P, Standard_Real& U, Standard_Real& V); //! parametrization - //! P (U, V) = Location + V * ZDirection + + //! P (U, V) = Location + V * ZDirection + //! (Radius + V * Tan (SemiAngle)) * //! (Cos(U) * XDirection + Sin(U) * YDirection) static void Parameters(const gp_Cone& C, const gp_Pnt& P, Standard_Real& U, Standard_Real& V); @@ -569,7 +569,7 @@ public: Standard_Real& V); //! parametrization - //! P (U, V) = Location + V * ZDirection + + //! P (U, V) = Location + V * ZDirection + //! (Radius + V * Tan (SemiAngle)) * //! (Cos(U) * XDirection + Sin(U) * YDirection) Standard_EXPORT static void ConeParameters(const gp_Ax3& Pos, diff --git a/src/FoundationClasses/TKernel/OSD/OSD_Path.hxx b/src/FoundationClasses/TKernel/OSD/OSD_Path.hxx index 276f925eb3..0e8fae5381 100644 --- a/src/FoundationClasses/TKernel/OSD/OSD_Path.hxx +++ b/src/FoundationClasses/TKernel/OSD/OSD_Path.hxx @@ -211,7 +211,7 @@ public: public: //! Returns the relative file path between the absolute directory - //! path and the absolute file path . + //! path and the absolute file path . //! If starts with "/", paths are handled as //! on Unix, if it starts with a letter followed by ":", as on //! WNT. In particular on WNT directory names are not key sensitive. diff --git a/src/FoundationClasses/TKernel/OSD/OSD_Protection.hxx b/src/FoundationClasses/TKernel/OSD/OSD_Protection.hxx index c30af7d650..6816d4ada8 100644 --- a/src/FoundationClasses/TKernel/OSD/OSD_Protection.hxx +++ b/src/FoundationClasses/TKernel/OSD/OSD_Protection.hxx @@ -23,10 +23,10 @@ #include -//! This class provides data to manage file protection -//! Example:These rights are treated in a system dependent manner : +//! This class provides data to manage file protection +//! Example:These rights are treated in a system dependent manner: //! On UNIX you have User,Group and Other rights -//! On VMS you have Owner,Group,World and System rights +//! On VMS you have Owner,Group,World and System rights //! An automatic conversion is done between OSD and UNIX/VMS. //! //! OSD VMS UNIX @@ -99,12 +99,12 @@ public: //! Add a right to a single protection. //! ex: aProt = RWD - //! me.Add(aProt,X) -> aProt = RWXD + //! me.Add(aProt,X) -> aProt = RWXD Standard_EXPORT void Add(OSD_SingleProtection& aProt, const OSD_SingleProtection aRight); //! Subtract a right to a single protection. //! ex: aProt = RWD - //! me.Sub(aProt,RW) -> aProt = D + //! me.Sub(aProt,RW) -> aProt = D //! But me.Sub(aProt,RWX) is also valid and gives same result. Standard_EXPORT void Sub(OSD_SingleProtection& aProt, const OSD_SingleProtection aRight); diff --git a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Algo.hxx b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Algo.hxx index b77ae5c9b0..894459c4c0 100644 --- a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Algo.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Algo.hxx @@ -28,7 +28,7 @@ class BOPAlgo_PISteps; -//! The class provides the root interface for the algorithms in Boolean Component.
+//! The class provides the root interface for the algorithms in Boolean Component. class BOPAlgo_Algo : public BOPAlgo_Options { public: diff --git a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_BOP.hxx b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_BOP.hxx index f0f9f617f6..1811905c63 100644 --- a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_BOP.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_BOP.hxx @@ -28,25 +28,25 @@ class BOPAlgo_PaveFiller; //! //! The class represents the Building part of the Boolean Operations -//! algorithm.
+//! algorithm. //! The arguments of the algorithms are divided in two groups - *Objects* -//! and *Tools*.
+//! and *Tools*. //! The algorithm builds the splits of the given arguments using the intersection -//! results and combines the result of Boolean Operation of given type:
-//! - *FUSE* - union of two groups of objects;
-//! - *COMMON* - intersection of two groups of objects;
-//! - *CUT* - subtraction of one group from the other.
+//! results and combines the result of Boolean Operation of given type: +//! - *FUSE* - union of two groups of objects; +//! - *COMMON* - intersection of two groups of objects; +//! - *CUT* - subtraction of one group from the other. //! -//! The rules for the arguments and type of the operation are the following:
-//! - For Boolean operation *FUSE* all arguments should have equal dimensions;
+//! The rules for the arguments and type of the operation are the following: +//! - For Boolean operation *FUSE* all arguments should have equal dimensions; //! - For Boolean operation *CUT* the minimal dimension of *Tools* should not be -//! less than the maximal dimension of *Objects*;
-//! - For Boolean operation *COMMON* the arguments can have any dimension.
+//! less than the maximal dimension of *Objects*; +//! - For Boolean operation *COMMON* the arguments can have any dimension. //! //! The class is a General Fuse based algorithm. Thus, all options //! of the General Fuse algorithm such as Fuzzy mode, safe processing mode, //! parallel processing mode, gluing mode and history support are also -//! available in this algorithm.
+//! available in this algorithm. //! //! Additionally to the Warnings of the parent class the algorithm returns //! the following warnings: @@ -98,7 +98,7 @@ protected: Standard_EXPORT void BuildSolid(const Message_ProgressRange& theRange); - //! Treatment of the cases with empty shapes.
+ //! Treatment of the cases with empty shapes. //! It returns TRUE if there is nothing to do, i.e. //! all shapes in one of the groups are empty shapes. Standard_EXPORT Standard_Boolean TreatEmptyShape(); diff --git a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Builder.hxx b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Builder.hxx index 1bec334a7f..60c0b0bbf5 100644 --- a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Builder.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Builder.hxx @@ -42,16 +42,16 @@ class TopoDS_Shape; //! The class is a General Fuse algorithm - base algorithm for the //! algorithms in the Boolean Component. Its main purpose is to build //! the split parts of the argument shapes from which the result of -//! the operations is combined.
+//! the operations is combined. //! The result of the General Fuse algorithm itself is a compound -//! containing all split parts of the arguments.
+//! containing all split parts of the arguments. //! //! Additionally to the options of the base classes, the algorithm has -//! the following options:
+//! the following options: //! - *Safe processing mode* - allows to avoid modification of the input -//! shapes during the operation (by default it is off);
+//! shapes during the operation (by default it is off); //! - *Gluing options* - allows to speed up the calculation of the intersections -//! on the special cases, in which some sub-shapes are coinciding.
+//! on the special cases, in which some sub-shapes are coinciding. //! - *Disabling the check for inverted solids* - Disables/Enables the check of the input solids //! for inverted status (holes in the space). The default value is TRUE, //! i.e. the check is performed. Setting this flag to FALSE for inverted diff --git a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_CellsBuilder.hxx b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_CellsBuilder.hxx index d706b496cd..9f9533bd61 100644 --- a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_CellsBuilder.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_CellsBuilder.hxx @@ -178,33 +178,33 @@ public: //! Redefined method Clear - clears the contents. Standard_EXPORT virtual void Clear() Standard_OVERRIDE; - //! Adding the parts to result.
- //! The parts are defined by two lists of shapes:
- //! defines the arguments which parts should be taken into result;
- //! defines the arguments which parts should not be taken into result;
+ //! Adding the parts to result. + //! The parts are defined by two lists of shapes: + //! defines the arguments which parts should be taken into result; + //! defines the arguments which parts should not be taken into result; //! To be taken into result the part must be IN for all shapes from the list - //! and must be OUT of all shapes from the list .
+ //! and must be OUT of all shapes from the list . //! //! To remove internal boundaries between any cells in the result //! variable should be used. The boundaries between - //! cells with the same material will be removed. Default value is 0.
- //! Thus, to remove any boundary the value of this variable should not be equal to 0.
+ //! cells with the same material will be removed. Default value is 0. + //! Thus, to remove any boundary the value of this variable should not be equal to 0. //! parameter defines whether to remove boundaries now or not. Standard_EXPORT void AddToResult(const TopTools_ListOfShape& theLSToTake, const TopTools_ListOfShape& theLSToAvoid, const Standard_Integer theMaterial = 0, const Standard_Boolean theUpdate = Standard_False); - //! Add all split parts to result.
- //! defines the removal of internal boundaries;
+ //! Add all split parts to result. + //! defines the removal of internal boundaries; //! parameter defines whether to remove boundaries now or not. Standard_EXPORT void AddAllToResult(const Standard_Integer theMaterial = 0, const Standard_Boolean theUpdate = Standard_False); - //! Removing the parts from result.
- //! The parts are defined by two lists of shapes:
- //! defines the arguments which parts should be removed from result;
- //! defines the arguments which parts should not be removed from result.
+ //! Removing the parts from result. + //! The parts are defined by two lists of shapes: + //! defines the arguments which parts should be removed from result; + //! defines the arguments which parts should not be removed from result. //! To be removed from the result the part must be IN for all shapes from the list //! and must be OUT of all shapes from the list . Standard_EXPORT void RemoveFromResult(const TopTools_ListOfShape& theLSToTake, @@ -213,9 +213,9 @@ public: //! Remove all parts from result. Standard_EXPORT void RemoveAllFromResult(); - //! Removes internal boundaries between cells with the same material.
+ //! Removes internal boundaries between cells with the same material. //! If the result contains the cells with same material but of different dimension - //! the removal of internal boundaries between these cells will not be performed.
+ //! the removal of internal boundaries between these cells will not be performed. //! In case of some errors during the removal the method will set the appropriate warning //! status - use GetReport() to access them. Standard_EXPORT void RemoveInternalBoundaries(); @@ -246,7 +246,7 @@ protected: const TopTools_ListOfShape& theLSToAvoid, TopTools_ListOfShape& theParts); - //! Removes internal boundaries between cells with the same material.
+ //! Removes internal boundaries between cells with the same material. //! Returns TRUE if any internal boundaries have been removed. Standard_EXPORT Standard_Boolean RemoveInternals(const TopTools_ListOfShape& theLS, diff --git a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_CheckerSI.hxx b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_CheckerSI.hxx index 97becc041f..aa628b9656 100644 --- a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_CheckerSI.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_CheckerSI.hxx @@ -44,17 +44,17 @@ public: Standard_EXPORT virtual void Perform( const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE; - //! Sets the level of checking shape on self-interference.
- //! It defines which interferences will be checked:
- //! 0 - only V/V;
- //! 1 - V/V and V/E;
- //! 2 - V/V, V/E and E/E;
- //! 3 - V/V, V/E, E/E and V/F;
- //! 4 - V/V, V/E, E/E, V/F and E/F;
- //! 5 - V/V, V/E, E/E, V/F, E/F and F/F;
- //! 6 - V/V, V/E, E/E, V/F, E/F, F/F and V/S;
- //! 7 - V/V, V/E, E/E, V/F, E/F, F/F, V/S and E/S;
- //! 8 - V/V, V/E, E/E, V/F, E/F, F/F, V/S, E/S and F/S;
+ //! Sets the level of checking shape on self-interference. + //! It defines which interferences will be checked: + //! 0 - only V/V; + //! 1 - V/V and V/E; + //! 2 - V/V, V/E and E/E; + //! 3 - V/V, V/E, E/E and V/F; + //! 4 - V/V, V/E, E/E, V/F and E/F; + //! 5 - V/V, V/E, E/E, V/F, E/F and F/F; + //! 6 - V/V, V/E, E/E, V/F, E/F, F/F and V/S; + //! 7 - V/V, V/E, E/E, V/F, E/F, F/F, V/S and E/S; + //! 8 - V/V, V/E, E/E, V/F, E/F, F/F, V/S, E/S and F/S; //! 9 - V/V, V/E, E/E, V/F, E/F, F/F, V/S, E/S, F/S and S/S - all interferences (Default value) Standard_EXPORT void SetLevelOfCheck(const Standard_Integer theLevel); diff --git a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_GlueEnum.hxx b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_GlueEnum.hxx index b9b2019bba..72a288d0e8 100644 --- a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_GlueEnum.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_GlueEnum.hxx @@ -17,41 +17,41 @@ //! The Enumeration describes an additional option for the algorithms //! in the Boolean Component such as General Fuse, Boolean operations, -//! Section, Maker Volume, Splitter and Cells Builder algorithms.
+//! Section, Maker Volume, Splitter and Cells Builder algorithms. //! //! The Gluing options have been designed to speed up the computation //! of the interference among arguments of the operations on special cases, //! in which the arguments may be overlapping but do not have real intersections -//! between their sub-shapes.
+//! between their sub-shapes. //! //! This option cannot be used on the shapes having real intersections, //! like intersection vertex between edges, or intersection vertex between -//! edge and a face or intersection line between faces.
+//! edge and a face or intersection line between faces. //! -//! There are two possibilities of overlapping shapes:
+//! There are two possibilities of overlapping shapes: //! 1. The shapes can be partially coinciding - the faces do not have //! intersection curves, but overlapping. The faces of such arguments will -//! be split during the operation;
+//! be split during the operation; //! 2. The shapes can be fully coinciding - there should be no partial //! overlapping of the faces, thus no intersection of type EDGE/FACE at all. -//! In such cases the faces will not be split during the operation.
+//! In such cases the faces will not be split during the operation. //! //! Even though there are no real intersections on such cases without Gluing options the algorithm -//! will still intersect the sub-shapes of the arguments with interfering bounding boxes.
+//! will still intersect the sub-shapes of the arguments with interfering bounding boxes. //! //! The performance improvement in gluing mode is achieved by excluding -//! the most time consuming computations according to the given Gluing parameter:
-//! 1. Computation of FACE/FACE intersections for partial coincidence;
+//! the most time consuming computations according to the given Gluing parameter: +//! 1. Computation of FACE/FACE intersections for partial coincidence; //! 2. And computation of VERTEX/FACE, EDGE/FACE and FACE/FACE intersections for full -//! coincidence.
+//! coincidence. //! //! By setting the Gluing option for the operation user should guarantee //! that the arguments are really coinciding. The algorithms do not check this itself. -//! Setting inappropriate option for the operation is likely to lead to incorrect result.
+//! Setting inappropriate option for the operation is likely to lead to incorrect result. //! -//! There are following items in the enumeration:
-//! **BOPAlgo_GlueOff** - default value for the algorithms, Gluing is switched off;
-//! **BOPAlgo_GlueShift** - Glue option for shapes with partial coincidence;
+//! There are following items in the enumeration: +//! **BOPAlgo_GlueOff** - default value for the algorithms, Gluing is switched off; +//! **BOPAlgo_GlueShift** - Glue option for shapes with partial coincidence; //! **BOPAlgo_GlueFull** - Glue option for shapes with full coincidence. //! enum BOPAlgo_GlueEnum diff --git a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_PaveFiller.hxx b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_PaveFiller.hxx index e2590cc195..3bee938dc5 100644 --- a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_PaveFiller.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_PaveFiller.hxx @@ -61,27 +61,27 @@ class TopoDS_Face; //! //! The class represents the Intersection phase of the -//! Boolean Operations algorithm.
+//! Boolean Operations algorithm. //! It performs the pairwise intersection of the sub-shapes of -//! the arguments in the following order:
-//! 1. Vertex/Vertex;
-//! 2. Vertex/Edge;
-//! 3. Edge/Edge;
-//! 4. Vertex/Face;
-//! 5. Edge/Face;
-//! 6. Face/Face.
+//! the arguments in the following order: +//! 1. Vertex/Vertex; +//! 2. Vertex/Edge; +//! 3. Edge/Edge; +//! 4. Vertex/Face; +//! 5. Edge/Face; +//! 6. Face/Face. //! //! The results of intersection are stored into the Data Structure -//! of the algorithm.
+//! of the algorithm. //! //! Additionally to the options provided by the parent class, -//! the algorithm has the following options:
+//! the algorithm has the following options: //! - *Section attributes* - allows to customize the intersection of the faces -//! (avoid approximation or building 2d curves);
+//! (avoid approximation or building 2d curves); //! - *Safe processing mode* - allows to avoid modification of the input -//! shapes during the operation (by default it is off);
+//! shapes during the operation (by default it is off); //! - *Gluing options* - allows to speed up the calculation on the special -//! cases, in which some sub-shapes are coincide.
+//! cases, in which some sub-shapes are coincide. //! //! The algorithm returns the following Warning statuses: //! - *BOPAlgo_AlertSelfInterferingShape* - in case some of the argument shapes are self-interfering @@ -101,9 +101,9 @@ class TopoDS_Face; //! //! The algorithm returns the following Error alerts: //! - *BOPAlgo_AlertTooFewArguments* - in case there are no enough arguments to -//! perform the operation;
-//! - *BOPAlgo_AlertIntersectionFailed* - in case some unexpected error occurred;
-//! - *BOPAlgo_AlertNullInputShapes* - in case some of the arguments are null shapes.
+//! perform the operation; +//! - *BOPAlgo_AlertIntersectionFailed* - in case some unexpected error occurred; +//! - *BOPAlgo_AlertNullInputShapes* - in case some of the arguments are null shapes. //! class BOPAlgo_PaveFiller : public BOPAlgo_Algo { @@ -194,12 +194,12 @@ protected: const Message_ProgressRange& theRange, const Standard_Boolean bAddInterfs = Standard_True); - //! Splits the Pave Blocks of the given edges with the extra paves.
+ //! Splits the Pave Blocks of the given edges with the extra paves. //! The method also builds the shrunk data for the new pave blocks and //! in case there is no valid range on the pave block, the vertices of - //! this pave block will be united making SD vertex.
+ //! this pave block will be united making SD vertex. //! Parameter defines whether this interference will be added - //! into common table of interferences or not.
+ //! into common table of interferences or not. //! If some of the Pave Blocks are forming the Common Blocks, the splits //! of the Pave Blocks will also form a Common Block. Standard_EXPORT void SplitPaveBlocks(const TColStd_MapOfInteger& theMEdges, @@ -539,12 +539,12 @@ protected: Standard_EXPORT void PutSEInOtherFaces(const Message_ProgressRange& theRange); //! Analyzes the results of interferences of sub-shapes of the shapes - //! looking for self-interfering entities by the following rules:
- //! 1. The Faces of the same shape considered interfering in case they:
- //! - Interfere with the other shapes in the same place (in the same vertex) or;
+ //! looking for self-interfering entities by the following rules: + //! 1. The Faces of the same shape considered interfering in case they: + //! - Interfere with the other shapes in the same place (in the same vertex) or; //! - Included in the same common block. //! 2. The Faces of the same shape considered interfering in case they - //! share the IN or SECTION edges.
+ //! share the IN or SECTION edges. //! In case self-interference is found the warning is added. Standard_EXPORT void CheckSelfInterference(); diff --git a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Splitter.hxx b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Splitter.hxx index 418ad5781c..9b6701f5a4 100644 --- a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Splitter.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Splitter.hxx @@ -22,27 +22,27 @@ #include //! The **Splitter algorithm** is the algorithm for splitting a group of -//! arbitrary shapes by the other group of arbitrary shapes.
-//! The arguments of the operation are divided on two groups:
-//! *Objects* - shapes that will be split;
-//! *Tools* - shapes by which the *Objects* will be split.
+//! arbitrary shapes by the other group of arbitrary shapes. +//! The arguments of the operation are divided on two groups: +//! *Objects* - shapes that will be split; +//! *Tools* - shapes by which the *Objects* will be split. //! The result of the operation contains only the split parts -//! of the shapes from the group of *Objects*.
+//! of the shapes from the group of *Objects*. //! The split parts of the shapes from the group of *Tools* are excluded -//! from the result.
+//! from the result. //! The shapes can be split by the other shapes from the same group //! (in case these shapes are interfering). //! //! The class is a General Fuse based algorithm. Thus, all options //! of the General Fuse algorithm such as Fuzzy mode, safe processing mode, //! parallel processing mode, gluing mode and history support are also -//! available in this algorithm.
+//! available in this algorithm. //! There is no requirement on the existence of the *Tools* shapes. //! And if there are no *Tools* shapes, the result of the splitting //! operation will be equivalent to the General Fuse result. //! //! The implementation of the algorithm is minimal - only the methods -//! CheckData() and Perform() have been overridden.
+//! CheckData() and Perform() have been overridden. //! The method BOPAlgo_Builder::BuildResult(), which adds the split parts of the arguments //! into result, does not have to be overridden, because its native implementation //! performs the necessary actions for the Splitter algorithm - it adds diff --git a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Tools.hxx b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Tools.hxx index 5cbb14a6cb..ba77a9850b 100644 --- a/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Tools.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPAlgo/BOPAlgo_Tools.hxx @@ -126,45 +126,45 @@ public: const BOPDS_PDS theDS, const Handle(IntTools_Context)& theContext); - //! Creates planar wires from the given edges.
+ //! Creates planar wires from the given edges. //! The input edges are expected to be planar. And for the performance - //! sake the method does not check if the edges are really planar.
- //! Thus, the result wires will also be not planar if the input edges are not planar.
+ //! sake the method does not check if the edges are really planar. + //! Thus, the result wires will also be not planar if the input edges are not planar. //! The edges may be not shared, but the resulting wires will be sharing the - //! coinciding parts and intersecting parts.
- //! The output wires may be non-manifold and contain free and multi-connected vertices.
+ //! coinciding parts and intersecting parts. + //! The output wires may be non-manifold and contain free and multi-connected vertices. //! Parameters: - //! - input edges;
- //! - output wires;
+ //! - input edges; + //! - output wires; //! - boolean flag which defines whether the input edges are already - //! shared or have to be intersected;
+ //! shared or have to be intersected; //! - the angular tolerance which will be used for distinguishing //! the planes in which the edges are located. Default value is - //! 1.e-8 which is used for intersection of planes in IntTools_FaceFace.
- //! Method returns the following error statuses:
- //! 0 - in case of success (at least one wire has been built);
- //! 1 - in case there are no edges in the given shape;
- //! 2 - sharing of the edges has failed.
+ //! 1.e-8 which is used for intersection of planes in IntTools_FaceFace. + //! Method returns the following error statuses: + //! 0 - in case of success (at least one wire has been built); + //! 1 - in case there are no edges in the given shape; + //! 2 - sharing of the edges has failed. Standard_EXPORT static Standard_Integer EdgesToWires( const TopoDS_Shape& theEdges, TopoDS_Shape& theWires, const Standard_Boolean theShared = Standard_False, const Standard_Real theAngTol = 1.e-8); - //! Creates planar faces from given planar wires.
- //! The method does not check if the wires are really planar.
- //! The input wires may be non-manifold but should be shared.
+ //! Creates planar faces from given planar wires. + //! The method does not check if the wires are really planar. + //! The input wires may be non-manifold but should be shared. //! The wires located in the same planes and included into other wires will create - //! holes in the faces built from outer wires.
+ //! holes in the faces built from outer wires. //! The tolerance values of the input shapes may be modified during the operation - //! due to projection of the edges on the planes for creation of 2D curves.
+ //! due to projection of the edges on the planes for creation of 2D curves. //! Parameters: - //! - the given wires;
- //! - the output faces;
+ //! - the given wires; + //! - the output faces; //! - the angular tolerance for distinguishing the planes in which //! the wires are located. Default value is 1.e-8 which is used - //! for intersection of planes in IntTools_FaceFace.
- //! Method returns TRUE in case of success, i.e. at least one face has been built.
+ //! for intersection of planes in IntTools_FaceFace. + //! Method returns TRUE in case of success, i.e. at least one face has been built. Standard_EXPORT static Standard_Boolean WiresToFaces(const TopoDS_Shape& theWires, TopoDS_Shape& theFaces, const Standard_Real theAngTol = 1.e-8); diff --git a/src/ModelingAlgorithms/TKBO/BOPDS/BOPDS_CommonBlock.hxx b/src/ModelingAlgorithms/TKBO/BOPDS/BOPDS_CommonBlock.hxx index aec0e8b646..afd4d44690 100644 --- a/src/ModelingAlgorithms/TKBO/BOPDS/BOPDS_CommonBlock.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPDS/BOPDS_CommonBlock.hxx @@ -30,9 +30,9 @@ DEFINE_STANDARD_HANDLE(BOPDS_CommonBlock, Standard_Transient) //! The class BOPDS_CommonBlock is to store the information //! about pave blocks that have geometrical coincidence -//! (in terms of a tolerance) with:
-//! a) other pave block(s);
-//! b) face(s).
+//! (in terms of a tolerance) with: +//! a) other pave block(s); +//! b) face(s). //! First pave block in the common block (real pave block) //! is always a pave block with the minimal index of the original edge. class BOPDS_CommonBlock : public Standard_Transient diff --git a/src/ModelingAlgorithms/TKBO/BOPDS/BOPDS_DS.hxx b/src/ModelingAlgorithms/TKBO/BOPDS/BOPDS_DS.hxx index b68f0fa19c..30fb5fa8de 100644 --- a/src/ModelingAlgorithms/TKBO/BOPDS/BOPDS_DS.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPDS/BOPDS_DS.hxx @@ -413,7 +413,7 @@ public: //! Clears information about PaveBlocks for the untouched edges Standard_EXPORT void ReleasePaveBlocks(); - //! Checks if the existing shrunk data of the pave block is still valid.
+ //! Checks if the existing shrunk data of the pave block is still valid. //! The shrunk data may become invalid if e.g. the vertices of the pave block //! have been replaced with the new one with bigger tolerances, or the tolerances //! of the existing vertices have been increased. diff --git a/src/ModelingAlgorithms/TKBO/BOPTools/BOPTools_AlgoTools.hxx b/src/ModelingAlgorithms/TKBO/BOPTools/BOPTools_AlgoTools.hxx index 94d0d7cb3a..52c06868de 100644 --- a/src/ModelingAlgorithms/TKBO/BOPTools/BOPTools_AlgoTools.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPTools/BOPTools_AlgoTools.hxx @@ -273,7 +273,7 @@ public: //! @name Face classification relatively solid const Handle(IntTools_Context)& theContext); public: //! @name PCurve construction - //! Makes 2d curve of the edge on the faces and .
+ //! Makes 2d curve of the edge on the faces and . //! - storage for caching the geometrical tools Standard_EXPORT static void MakePCurve( const TopoDS_Edge& theE, diff --git a/src/ModelingAlgorithms/TKBO/BOPTools/BOPTools_AlgoTools2D.hxx b/src/ModelingAlgorithms/TKBO/BOPTools/BOPTools_AlgoTools2D.hxx index 9657543bbd..5992e3e4d6 100644 --- a/src/ModelingAlgorithms/TKBO/BOPTools/BOPTools_AlgoTools2D.hxx +++ b/src/ModelingAlgorithms/TKBO/BOPTools/BOPTools_AlgoTools2D.hxx @@ -79,7 +79,7 @@ public: //! Get P-Curve for the edge on surface . //! If the P-Curve does not exist, build it using Make2D(). - //! [aFirst, aLast] - range of the P-Curve
+ //! [aFirst, aLast] - range of the P-Curve //! [aToler] - reached tolerance //! Raises exception Standard_ConstructionError if algorithm Make2D() fails. //! - storage for caching the geometrical tools @@ -131,7 +131,7 @@ public: const Handle(IntTools_Context)& theContext = Handle(IntTools_Context)()); //! Adjust P-Curve (3D-curve ) on surface . - //! [aT1, aT2] - range to adjust + //! [aT1, aT2] - range to adjust Standard_EXPORT static void AdjustPCurveOnSurf(const BRepAdaptor_Surface& aF, const Standard_Real aT1, const Standard_Real aT2, diff --git a/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_BooleanOperation.hxx b/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_BooleanOperation.hxx index b40170fc2b..d8bebf317e 100644 --- a/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_BooleanOperation.hxx +++ b/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_BooleanOperation.hxx @@ -46,8 +46,8 @@ class TopoDS_Shape; //! - For Boolean operation *SECTION* the arguments can be of any type. //! //! Additionally to the errors of the base class the algorithm returns -//! the following Errors:
-//! - *BOPAlgo_AlertBOPNotSet* - in case the type of Boolean Operation is not set.
+//! the following Errors: +//! - *BOPAlgo_AlertBOPNotSet* - in case the type of Boolean Operation is not set. class BRepAlgoAPI_BooleanOperation : public BRepAlgoAPI_BuilderAlgo { public: diff --git a/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_BuilderAlgo.hxx b/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_BuilderAlgo.hxx index 2c6def1cc5..fa4ac1ce14 100644 --- a/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_BuilderAlgo.hxx +++ b/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_BuilderAlgo.hxx @@ -28,10 +28,10 @@ #include #include -//! The class contains API level of the General Fuse algorithm.
+//! The class contains API level of the General Fuse algorithm. //! //! Additionally to the options defined in the base class, the algorithm has -//! the following options:
+//! the following options: //! - *Safe processing mode* - allows to avoid modification of the input //! shapes during the operation (by default it is off); //! - *Gluing options* - allows to speed up the calculation of the intersections @@ -43,12 +43,12 @@ //! - *Disabling history collection* - allows disabling the collection of the history //! of shapes modifications during the operation. //! -//! It returns the following Error statuses:
-//! - 0 - in case of success;
+//! It returns the following Error statuses: +//! - 0 - in case of success; //! - *BOPAlgo_AlertTooFewArguments* - in case there are no enough arguments to perform the -//! operation;
-//! - *BOPAlgo_AlertIntersectionFailed* - in case the intersection of the arguments has failed;
-//! - *BOPAlgo_AlertBuilderFailed* - in case building of the result shape has failed.
+//! operation; +//! - *BOPAlgo_AlertIntersectionFailed* - in case the intersection of the arguments has failed; +//! - *BOPAlgo_AlertBuilderFailed* - in case building of the result shape has failed. //! //! Warnings statuses from underlying DS Filler and Builder algorithms //! are collected in the report. diff --git a/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_Splitter.hxx b/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_Splitter.hxx index dfb5c28a93..89ee2f5787 100644 --- a/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_Splitter.hxx +++ b/src/ModelingAlgorithms/TKBO/BRepAlgoAPI/BRepAlgoAPI_Splitter.hxx @@ -23,30 +23,30 @@ //! The class contains API level of the **Splitter** algorithm, //! which allows splitting a group of arbitrary shapes by the -//! other group of arbitrary shapes.
-//! The arguments of the operation are divided on two groups:
-//! *Objects* - shapes that will be split;
-//! *Tools* - shapes by which the *Objects* will be split.
+//! other group of arbitrary shapes. +//! The arguments of the operation are divided on two groups: +//! *Objects* - shapes that will be split; +//! *Tools* - shapes by which the *Objects* will be split. //! The result of the operation contains only the split parts -//! of the shapes from the group of *Objects*.
+//! of the shapes from the group of *Objects*. //! The split parts of the shapes from the group of *Tools* are excluded -//! from the result.
+//! from the result. //! The shapes can be split by the other shapes from the same group //! (in case these shapes are interfering). //! //! The class is a General Fuse based algorithm. Thus, all options //! of the General Fuse algorithm such as Fuzzy mode, safe processing mode, //! parallel processing mode, gluing mode and history support are also -//! available in this algorithm.
+//! available in this algorithm. //! There is no requirement on the existence of the *Tools* shapes. //! And if there are no *Tools* shapes, the result of the splitting //! operation will be equivalent to the General Fuse result. //! -//! The algorithm returns the following Error statuses:
-//! - 0 - in case of success;
+//! The algorithm returns the following Error statuses: +//! - 0 - in case of success; //! - *BOPAlgo_AlertTooFewArguments* - in case there is no enough arguments for the -//! operation;
-//! - *BOPAlgo_AlertIntersectionFailed* - in case the Intersection of the arguments has failed;
+//! operation; +//! - *BOPAlgo_AlertIntersectionFailed* - in case the Intersection of the arguments has failed; //! - *BOPAlgo_AlertBuilderFailed* - in case the Building of the result has failed. class BRepAlgoAPI_Splitter : public BRepAlgoAPI_BuilderAlgo { diff --git a/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Context.hxx b/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Context.hxx index 8f94b8d09e..92046ff958 100644 --- a/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Context.hxx +++ b/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Context.hxx @@ -119,9 +119,9 @@ public: //! Returns zero if the distance between vertex //! and edge is less than sum of tolerances and the fuzzy value, //! otherwise and for following conditions returns - //! negative value:
- //! 1. the edge is degenerated (-1)
- //! 2. the edge does not contain 3d curve and pcurves (-2)
+ //! negative value: + //! 1. the edge is degenerated (-1) + //! 2. the edge does not contain 3d curve and pcurves (-2) //! 3. projection algorithm failed (-3) Standard_EXPORT Standard_Integer ComputeVE(const TopoDS_Vertex& theV, const TopoDS_Edge& theE, @@ -134,9 +134,9 @@ public: //! Returns zero if the distance between vertex and face is //! less than or equal the sum of tolerances and the fuzzy value //! and the projection point lays inside boundaries of the face. - //! For following conditions returns negative value
- //! 1. projection algorithm failed (-1)
- //! 2. distance is more than sum of tolerances (-2)
+ //! For following conditions returns negative value + //! 1. projection algorithm failed (-1) + //! 2. distance is more than sum of tolerances (-2) //! 3. projection point out or on the boundaries of face (-3) Standard_EXPORT Standard_Integer ComputeVF(const TopoDS_Vertex& theVertex, const TopoDS_Face& theFace, diff --git a/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Curve.hxx b/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Curve.hxx index fd5c5f177a..7f2e5330af 100644 --- a/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Curve.hxx +++ b/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Curve.hxx @@ -27,14 +27,14 @@ class Geom_Curve; class Geom2d_Curve; class gp_Pnt; -//! The class is a container of one 3D curve, two 2D curves and two Tolerance values.
+//! The class is a container of one 3D curve, two 2D curves and two Tolerance values. //! It is used in the Face/Face intersection algorithm to store the results -//! of intersection. In this context:
-//! **the 3D curve** is the intersection curve;
-//! **the 2D curves** are the PCurves of the 3D curve on the intersecting faces;
+//! of intersection. In this context: +//! **the 3D curve** is the intersection curve; +//! **the 2D curves** are the PCurves of the 3D curve on the intersecting faces; //! **the tolerance** is the valid tolerance for 3D curve computed as //! maximal deviation between 3D curve and 2D curves (or surfaces in case there are no 2D -//! curves);
+//! curves); //! **the tangential tolerance** is the maximal distance from 3D curve to the //! end of the tangential zone between faces in terms of their tolerance values. class IntTools_Curve @@ -100,7 +100,7 @@ public: //! If the 3d curve is bounded curve the method will return TRUE //! and modify the output parameters with boundary parameters of - //! the curve and corresponded 3d points.
+ //! the curve and corresponded 3d points. //! If the curve does not have bounds, the method will return false //! and the output parameters will stay untouched. Standard_EXPORT Standard_Boolean Bounds(Standard_Real& theFirst, @@ -110,7 +110,7 @@ public: //! Computes 3d point corresponded to the given parameter if this //! parameter is inside the boundaries of the curve. - //! Returns TRUE in this case.
+ //! Returns TRUE in this case. //! Otherwise, the point will not be computed and the method will return FALSE. Standard_EXPORT Standard_Boolean D0(const Standard_Real& thePar, gp_Pnt& thePnt) const; diff --git a/src/ModelingAlgorithms/TKBO/IntTools/IntTools_FaceFace.hxx b/src/ModelingAlgorithms/TKBO/IntTools/IntTools_FaceFace.hxx index 5843f620b1..674beece4f 100644 --- a/src/ModelingAlgorithms/TKBO/IntTools/IntTools_FaceFace.hxx +++ b/src/ModelingAlgorithms/TKBO/IntTools/IntTools_FaceFace.hxx @@ -95,7 +95,7 @@ protected: const Standard_Real theToler); //! Computes the valid tolerance for the intersection curves - //! as a maximal deviation between 3D curve and 2D curves on faces.
+ //! as a maximal deviation between 3D curve and 2D curves on faces. //! If there are no 2D curves the maximal deviation between 3D curves //! and surfaces is computed. Standard_EXPORT void ComputeTolReached3d(const Standard_Boolean theToRunParallel); diff --git a/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Tools.hxx b/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Tools.hxx index ad800d5725..2cbe35272e 100644 --- a/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Tools.hxx +++ b/src/ModelingAlgorithms/TKBO/IntTools/IntTools_Tools.hxx @@ -136,7 +136,7 @@ public: Standard_EXPORT static Standard_Real CurveTolerance(const Handle(Geom_Curve)& aC, const Standard_Real aTolBase); - //! Checks if the curve is not covered by the default tolerance (confusion).
+ //! Checks if the curve is not covered by the default tolerance (confusion). //! Builds bounding box for the curve and stores it into . Standard_EXPORT static Standard_Boolean CheckCurve(const IntTools_Curve& theCurve, Bnd_Box& theBox); diff --git a/src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_ProjectPointOnSurf.hxx b/src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_ProjectPointOnSurf.hxx index 6b0f618abe..ed6b6a9355 100644 --- a/src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_ProjectPointOnSurf.hxx +++ b/src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_ProjectPointOnSurf.hxx @@ -122,11 +122,11 @@ public: const Standard_Real Vsup, const Extrema_ExtAlgo Algo = Extrema_ExtAlgo_Grad); - //! Sets the Extrema search algorithm - Grad or Tree.
+ //! Sets the Extrema search algorithm - Grad or Tree. //! By default the Extrema is initialized with Grad algorithm. void SetExtremaAlgo(const Extrema_ExtAlgo theAlgo) { myExtPS.SetAlgo(theAlgo); } - //! Sets the Extrema search flag - MIN or MAX or MINMAX.
+ //! Sets the Extrema search flag - MIN or MAX or MINMAX. //! By default the Extrema is set to search the MinMax solutions. void SetExtremaFlag(const Extrema_ExtFlag theExtFlag) { myExtPS.SetFlag(theExtFlag); } diff --git a/src/ModelingAlgorithms/TKGeomAlgo/IntPolyh/IntPolyh_Couple.hxx b/src/ModelingAlgorithms/TKGeomAlgo/IntPolyh/IntPolyh_Couple.hxx index f30471e04e..9b49c2f0dc 100644 --- a/src/ModelingAlgorithms/TKGeomAlgo/IntPolyh/IntPolyh_Couple.hxx +++ b/src/ModelingAlgorithms/TKGeomAlgo/IntPolyh/IntPolyh_Couple.hxx @@ -26,7 +26,7 @@ #include //! The class represents the couple of indices with additional -//! characteristics such as analyzed flag and an angle.
+//! characteristics such as analyzed flag and an angle. //! In IntPolyh_MaillageAffinage algorithm the class is used as a //! couple of interfering triangles with the intersection angle. class IntPolyh_Couple diff --git a/src/ModelingAlgorithms/TKGeomAlgo/IntPolyh/IntPolyh_Edge.hxx b/src/ModelingAlgorithms/TKGeomAlgo/IntPolyh/IntPolyh_Edge.hxx index 3c6e1caae2..c4928d8d3e 100644 --- a/src/ModelingAlgorithms/TKGeomAlgo/IntPolyh/IntPolyh_Edge.hxx +++ b/src/ModelingAlgorithms/TKGeomAlgo/IntPolyh/IntPolyh_Edge.hxx @@ -21,7 +21,7 @@ #include #include -//! The class represents the edge built between the two IntPolyh points.
+//! The class represents the edge built between the two IntPolyh points. //! It is linked to two IntPolyh triangles. class IntPolyh_Edge { diff --git a/src/ModelingAlgorithms/TKGeomAlgo/LocalAnalysis/LocalAnalysis_CurveContinuity.hxx b/src/ModelingAlgorithms/TKGeomAlgo/LocalAnalysis/LocalAnalysis_CurveContinuity.hxx index 56beb3cd9b..9760e08f98 100644 --- a/src/ModelingAlgorithms/TKGeomAlgo/LocalAnalysis/LocalAnalysis_CurveContinuity.hxx +++ b/src/ModelingAlgorithms/TKGeomAlgo/LocalAnalysis/LocalAnalysis_CurveContinuity.hxx @@ -71,14 +71,14 @@ public: //! necessary to check the continuity in the following cases: //! //! case C0 - //! -------- + //! ------- //! - the distance between P1 and P2 with P1=Curv1 (u1) and //! P2=Curv2(u2) //! //! case C1 //! ------- //! - //! - the angle between the first derivatives + //! - the angle between the first derivatives //! dCurv1(u1) dCurv2(u2) //! -------- and --------- //! du du diff --git a/src/ModelingAlgorithms/TKHLR/HLRBRep/HLRBRep_EdgeBuilder.hxx b/src/ModelingAlgorithms/TKHLR/HLRBRep/HLRBRep_EdgeBuilder.hxx index ec61a7cf5e..eb0c8e9843 100644 --- a/src/ModelingAlgorithms/TKHLR/HLRBRep/HLRBRep_EdgeBuilder.hxx +++ b/src/ModelingAlgorithms/TKHLR/HLRBRep/HLRBRep_EdgeBuilder.hxx @@ -33,9 +33,9 @@ class HLRBRep_EdgeBuilder public: DEFINE_STANDARD_ALLOC - //! Creates an EdgeBuilder algorithm. - //! describes the edge and the interferences. - //! AreaLimits are created from the vertices. + //! Creates an EdgeBuilder algorithm. + //! describes the edge and the interferences. + //! AreaLimits are created from the vertices. //! Builds(IN) is automatically called. Standard_EXPORT HLRBRep_EdgeBuilder(HLRBRep_VertexList& VList); @@ -57,17 +57,17 @@ public: //! Returns the edge state of the current area. Standard_EXPORT TopAbs_State AreaEdgeState() const; - //! Returns the AreaLimit beginning the current area. + //! Returns the AreaLimit beginning the current area. //! This is a NULL handle when the area is infinite on //! the left. Standard_EXPORT Handle(HLRBRep_AreaLimit) LeftLimit() const; - //! Returns the AreaLimit ending the current area. + //! Returns the AreaLimit ending the current area. //! This is a NULL handle when the area is infinite on //! the right. Standard_EXPORT Handle(HLRBRep_AreaLimit) RightLimit() const; - //! Reinitialize the results iteration to the parts + //! Reinitialize the results iteration to the parts //! with State . If this method is not called //! after construction the default is = IN. Standard_EXPORT void Builds(const TopAbs_State ToBuild); @@ -75,7 +75,7 @@ public: //! Returns True if there are more new edges to build. Standard_EXPORT Standard_Boolean MoreEdges() const; - //! Proceeds to the next edge to build. Skip all + //! Proceeds to the next edge to build. Skip all //! remaining vertices on the current edge. Standard_EXPORT void NextEdge(); @@ -89,11 +89,11 @@ public: //! Returns the current vertex of the current edge. Standard_EXPORT const HLRAlgo_Intersection& Current() const; - //! Returns True if the current vertex comes from the + //! Returns True if the current vertex comes from the //! boundary of the edge. Standard_EXPORT Standard_Boolean IsBoundary() const; - //! Returns True if the current vertex was an + //! Returns True if the current vertex was an //! interference. Standard_EXPORT Standard_Boolean IsInterference() const; diff --git a/src/ModelingAlgorithms/TKHLR/HLRBRep/HLRBRep_Surface.hxx b/src/ModelingAlgorithms/TKHLR/HLRBRep/HLRBRep_Surface.hxx index a234b1583a..fdd35b798b 100644 --- a/src/ModelingAlgorithms/TKHLR/HLRBRep/HLRBRep_Surface.hxx +++ b/src/ModelingAlgorithms/TKHLR/HLRBRep/HLRBRep_Surface.hxx @@ -74,12 +74,12 @@ public: GeomAbs_Shape VContinuity() const; //! If necessary, breaks the surface in U intervals of - //! continuity . And returns the number of + //! continuity . And returns the number of //! intervals. Standard_Integer NbUIntervals(const GeomAbs_Shape S); //! If necessary, breaks the surface in V intervals of - //! continuity . And returns the number of + //! continuity . And returns the number of //! intervals. Standard_Integer NbVIntervals(const GeomAbs_Shape S); @@ -105,15 +105,15 @@ public: //! Computes the point of parameters U,V on the surface. void D0(const Standard_Real U, const Standard_Real V, gp_Pnt& P) const; - //! Computes the point and the first derivatives on + //! Computes the point and the first derivatives on //! the surface. - //! Raised if the continuity of the current + //! Raised if the continuity of the current //! intervals is not C1. void D1(const Standard_Real U, const Standard_Real V, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V) const; - //! Computes the point, the first and second + //! Computes the point, the first and second //! derivatives on the surface. - //! Raised if the continuity of the current + //! Raised if the continuity of the current //! intervals is not C2. void D2(const Standard_Real U, const Standard_Real V, @@ -124,9 +124,9 @@ public: gp_Vec& D2V, gp_Vec& D2UV) const; - //! Computes the point, the first, second and third + //! Computes the point, the first, second and third //! derivatives on the surface. - //! Raised if the continuity of the current + //! Raised if the continuity of the current //! intervals is not C3. void D3(const Standard_Real U, const Standard_Real V, @@ -141,10 +141,10 @@ public: gp_Vec& D3UUV, gp_Vec& D3UVV) const; - //! Computes the derivative of order Nu in the - //! direction U and Nv in the direction V at the point P(U, + //! Computes the derivative of order Nu in the + //! direction U and Nv in the direction V at the point P(U, //! V). - //! Raised if the current U interval is not not CNu + //! Raised if the current U interval is not not CNu //! and the current V interval is not CNv. //! Raised if Nu + Nv < 1 or Nu < 0 or Nv < 0. gp_Vec DN(const Standard_Real U, @@ -153,8 +153,8 @@ public: const Standard_Integer Nv) const; //! Returns the type of the surface : Plane, Cylinder, - //! Cone, Sphere, Torus, BezierSurface, - //! BSplineSurface, SurfaceOfRevolution, + //! Cone, Sphere, Torus, BezierSurface, + //! BSplineSurface, SurfaceOfRevolution, //! SurfaceOfExtrusion, OtherSurface GeomAbs_SurfaceType GetType() const; diff --git a/src/ModelingAlgorithms/TKHLR/HLRTopoBRep/HLRTopoBRep_FaceData.hxx b/src/ModelingAlgorithms/TKHLR/HLRTopoBRep/HLRTopoBRep_FaceData.hxx index 748ebf3cba..513d4f967f 100644 --- a/src/ModelingAlgorithms/TKHLR/HLRTopoBRep/HLRTopoBRep_FaceData.hxx +++ b/src/ModelingAlgorithms/TKHLR/HLRTopoBRep/HLRTopoBRep_FaceData.hxx @@ -23,8 +23,8 @@ #include -//! Contains the 3 ListOfShape of a Face ( Internal -//! OutLines, OutLines on restriction and IsoLines ). +//! Contains the 3 ListOfShape of a Face +//! (Internal OutLines, OutLines on restriction and IsoLines). class HLRTopoBRep_FaceData { public: diff --git a/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_CircleTool.hxx b/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_CircleTool.hxx index d604797b81..a0b9ee2947 100644 --- a/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_CircleTool.hxx +++ b/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_CircleTool.hxx @@ -28,7 +28,7 @@ class gp_Circ2d; -//! Create sort and destroy the circles used in triangulation.
+//! Create sort and destroy the circles used in triangulation. class BRepMesh_CircleTool { public: diff --git a/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_DiscretFactory.hxx b/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_DiscretFactory.hxx index d27dbf90d5..7c8556d81f 100644 --- a/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_DiscretFactory.hxx +++ b/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_DiscretFactory.hxx @@ -26,9 +26,9 @@ class TopoDS_Shape; -//! This class intended to setup / retrieve default triangulation algorithm.
-//! Use BRepMesh_DiscretFactory::Get() static method to retrieve global Factory instance.
-//! Use BRepMesh_DiscretFactory::Discret() method to retrieve meshing tool.
+//! This class intended to setup / retrieve default triangulation algorithm. +//! Use BRepMesh_DiscretFactory::Get() static method to retrieve global Factory instance. +//! Use BRepMesh_DiscretFactory::Discret() method to retrieve meshing tool. class BRepMesh_DiscretFactory { public: @@ -40,8 +40,8 @@ public: //! Returns the list of registered meshing algorithms. const TColStd_MapOfAsciiString& Names() const { return myNames; } - //! Setup meshing algorithm by name.
- //! Returns TRUE if requested tool is available.
+ //! Setup meshing algorithm by name. + //! Returns TRUE if requested tool is available. //! On fail Factory will continue to use previous algo. Standard_Boolean SetDefaultName(const TCollection_AsciiString& theName) { @@ -51,8 +51,8 @@ public: //! Returns name for current meshing algorithm. const TCollection_AsciiString& DefaultName() const { return myDefaultName; } - //! Advanced function. Changes function name to retrieve from plugin.
- //! Returns TRUE if requested tool is available.
+ //! Advanced function. Changes function name to retrieve from plugin. + //! Returns TRUE if requested tool is available. //! On fail Factory will continue to use previous algo. Standard_Boolean SetFunctionName(const TCollection_AsciiString& theFuncName) { @@ -65,9 +65,9 @@ public: //! Returns error status for last meshing algorithm switch. BRepMesh_FactoryError ErrorStatus() const { return myErrorStatus; } - //! Setup meshing algorithm that should be created by this Factory.
- //! Returns TRUE if requested tool is available.
- //! On fail Factory will continue to use previous algo.
+ //! Setup meshing algorithm that should be created by this Factory. + //! Returns TRUE if requested tool is available. + //! On fail Factory will continue to use previous algo. //! Call ::ErrorStatus() method to retrieve fault reason. Standard_EXPORT Standard_Boolean SetDefault(const TCollection_AsciiString& theName, diff --git a/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_VertexTool.hxx b/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_VertexTool.hxx index 4c8a05805f..301218df07 100644 --- a/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_VertexTool.hxx +++ b/src/ModelingAlgorithms/TKMesh/BRepMesh/BRepMesh_VertexTool.hxx @@ -112,7 +112,7 @@ public: //! Returns a number of vertices. Standard_Integer Extent() const { return mySelector.NbVertices(); } - //! Returns True when the map contains no keys.
+ //! Returns True when the map contains no keys. Standard_Boolean IsEmpty() const { return (Extent() == 0); } //! Substitutes vertex with the given by the given vertex with attributes. diff --git a/src/ModelingAlgorithms/TKMesh/IMeshTools/IMeshTools_Parameters.hxx b/src/ModelingAlgorithms/TKMesh/IMeshTools/IMeshTools_Parameters.hxx index a5cf5069a6..67be4a8095 100644 --- a/src/ModelingAlgorithms/TKMesh/IMeshTools/IMeshTools_Parameters.hxx +++ b/src/ModelingAlgorithms/TKMesh/IMeshTools/IMeshTools_Parameters.hxx @@ -69,7 +69,7 @@ struct IMeshTools_Parameters //! Switches on/off multi-thread computation Standard_Boolean InParallel; - //! Switches on/off relative computation of edge tolerance
+ //! Switches on/off relative computation of edge tolerance //! If true, deflection used for the polygonalisation of each edge will be //! * Size of Edge. The deflection used for the faces will be the //! maximum deflection of their edges. diff --git a/src/ModelingAlgorithms/TKOffset/BRepOffset/BRepOffset_Tool.hxx b/src/ModelingAlgorithms/TKOffset/BRepOffset/BRepOffset_Tool.hxx index 6d923fec37..b7aa44bfa6 100644 --- a/src/ModelingAlgorithms/TKOffset/BRepOffset/BRepOffset_Tool.hxx +++ b/src/ModelingAlgorithms/TKOffset/BRepOffset/BRepOffset_Tool.hxx @@ -50,7 +50,7 @@ public: TopoDS_Vertex& V1, TopoDS_Vertex& V2); - //! is a section between and . Computes + //! is a section between and . Computes //! the orientation of in influenced by . //! idem for . Standard_EXPORT static void OrientSection(const TopoDS_Edge& E, @@ -59,25 +59,25 @@ public: TopAbs_Orientation& O1, TopAbs_Orientation& O2); - //! Looks for the common Vertices and Edges between faces and .
- //! Returns TRUE if common shapes have been found.
- //! will contain the found common edges;
+ //! Looks for the common Vertices and Edges between faces and . + //! Returns TRUE if common shapes have been found. + //! will contain the found common edges; //! will contain the found common vertices. Standard_EXPORT static Standard_Boolean FindCommonShapes(const TopoDS_Face& theF1, const TopoDS_Face& theF2, TopTools_ListOfShape& theLE, TopTools_ListOfShape& theLV); - //! Looks for the common shapes of type between shapes and .
- //! Returns TRUE if common shapes have been found.
+ //! Looks for the common shapes of type between shapes and . + //! Returns TRUE if common shapes have been found. //! will contain the found common shapes. Standard_EXPORT static Standard_Boolean FindCommonShapes(const TopoDS_Shape& theS1, const TopoDS_Shape& theS2, const TopAbs_ShapeEnum theType, TopTools_ListOfShape& theLSC); - //! Computes the Section between and the - //! edges solution are stored in with the + //! Computes the Section between and the + //! edges solution are stored in with the //! orientation on , the sames edges are stored in //! with the orientation on . Standard_EXPORT static void Inter3D(const TopoDS_Face& F1, @@ -125,11 +125,11 @@ public: Standard_Boolean& enlargeVfirst, Standard_Boolean& enlargeVlast); - //! Returns True if The Surface of has changed. - //! if is TRUE , the surface can be + //! Returns True if The Surface of has changed. + //! if is TRUE the surface can be //! changed . - //! if is TRUE, update the pcurves of the - //! edges of on the new surface if the surface has been changed. + //! if is TRUE, update the pcurves of the + //! edges of on the new surface if the surface has been changed. //! , , allow or forbid //! enlargement in U and V directions correspondingly. //! is a mode of extension of the surface of the face: @@ -172,16 +172,16 @@ public: TopTools_DataMapOfShapeShape& NOnV1, TopTools_DataMapOfShapeShape& NOnV2); - //! Store in MVE for a vertex in the incident + //! Store in MVE for a vertex in the incident //! edges in . //! An Edge is Store only one Time for a vertex. Standard_EXPORT static void MapVertexEdges(const TopoDS_Shape& S, TopTools_DataMapOfShapeListOfShape& MVE); - //! Remove the non valid part of an offsetshape - //! 1 - Remove all the free boundary and the faces + //! Remove the non valid part of an offsetshape + //! 1 - Remove all the free boundary and the faces //! connex to such edges. - //! 2 - Remove all the shapes not valid in the result + //! 2 - Remove all the shapes not valid in the result //! (according to the side of offsetting) //! in this version only the first point is implemented. Standard_EXPORT static TopoDS_Shape Deboucle3D(const TopoDS_Shape& S, @@ -196,7 +196,7 @@ public: Standard_EXPORT static Standard_Real Gabarit(const Handle(Geom_Curve)& aCurve); //! Compares the normal directions of the planar faces and returns - //! TRUE if the directions are the same with the given precision.
+ //! TRUE if the directions are the same with the given precision. Standard_EXPORT static Standard_Boolean CheckPlanesNormals(const TopoDS_Face& theFace1, const TopoDS_Face& theFace2, const Standard_Real theTolAng = 1.e-8); diff --git a/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_MakeThickSolid.hxx b/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_MakeThickSolid.hxx index 518f225d61..4381b9af64 100644 --- a/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_MakeThickSolid.hxx +++ b/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_MakeThickSolid.hxx @@ -34,10 +34,10 @@ class TopoDS_Shape; //! remaining faces of the solid become the walls of the //! hollowed solid, their thickness defined at the time of construction. //! the solid is built from an initial -//! solid and a set of faces {Fi} from , -//! builds a solid composed by two shells closed by -//! the {Fi}. First shell is composed by all -//! the faces of expected {Fi}. Second shell is +//! solid and a set of faces {Fi} from , +//! builds a solid composed by two shells closed by +//! the {Fi}. First shell is composed by all +//! the faces of expected {Fi}. Second shell is //! the offset shell of . //! A MakeThickSolid object provides a framework for: //! - defining the cross-section of a hollowed solid, @@ -115,7 +115,7 @@ public: Standard_EXPORT virtual void Build( const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE; - //! Returns the list of shapes modified from the shape + //! Returns the list of shapes modified from the shape //! . Standard_EXPORT virtual const TopTools_ListOfShape& Modified(const TopoDS_Shape& S) Standard_OVERRIDE; diff --git a/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_NormalProjection.hxx b/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_NormalProjection.hxx index c20a9902fa..b5375e5a4f 100644 --- a/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_NormalProjection.hxx +++ b/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_NormalProjection.hxx @@ -58,11 +58,11 @@ public: //! Standard_ConstructionError if ToProj is not added. Standard_EXPORT void Add(const TopoDS_Shape& ToProj); - //! Sets the parameters used for computation - //! Tol3 is the required tolerance between the 3d projected - //! curve and its 2d representation - //! InternalContinuity is the order of constraints - //! used for approximation + //! Sets the parameters used for computation + //! Tol3 is the required tolerance between the 3d projected + //! curve and its 2d representation + //! InternalContinuity is the order of constraints + //! used for approximation //! MaxDeg and MaxSeg are the maximum degree and the maximum //! number of segment for BSpline resulting of an approximation. Standard_EXPORT void SetParams(const Standard_Real Tol3D, @@ -77,7 +77,7 @@ public: //! if MaxDist < 0 then this method does not affect the algorithm Standard_EXPORT void SetMaxDistance(const Standard_Real MaxDist); - //! Manage limitation of projected edges. + //! Manage limitation of projected edges. Standard_EXPORT void SetLimit(const Standard_Boolean FaceBoundaries = Standard_True); //! Returns true if a 3D curve is computed. If not, false is @@ -111,7 +111,7 @@ public: //! E has already been found. Standard_EXPORT const TopoDS_Shape& Couple(const TopoDS_Edge& E) const; - //! Returns the list of shapes generated from the + //! Returns the list of shapes generated from the //! shape . Standard_EXPORT virtual const TopTools_ListOfShape& Generated(const TopoDS_Shape& S) Standard_OVERRIDE; diff --git a/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_ThruSections.hxx b/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_ThruSections.hxx index 13f64fc155..41ae77c8b0 100644 --- a/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_ThruSections.hxx +++ b/src/ModelingAlgorithms/TKOffset/BRepOffsetAPI/BRepOffsetAPI_ThruSections.hxx @@ -101,14 +101,14 @@ public: //! Define the approximation algorithm Standard_EXPORT void SetSmoothing(const Standard_Boolean UseSmoothing); - //! Define the type of parametrization used in the approximation + //! Define the type of parametrization used in the approximation Standard_EXPORT void SetParType(const Approx_ParametrizationType ParType); //! Define the Continuity used in the approximation Standard_EXPORT void SetContinuity(const GeomAbs_Shape C); - //! define the Weights associed to the criterium used in - //! the optimization. + //! define the Weights associed to the criterium used in + //! the optimization. //! //! if Wi <= 0 Standard_EXPORT void SetCriteriumWeight(const Standard_Real W1, @@ -130,8 +130,8 @@ public: //! Define the approximation algorithm Standard_EXPORT Standard_Boolean UseSmoothing() const; - //! returns the Weights associed to the criterium used in - //! the optimization. + //! returns the Weights associed to the criterium used in + //! the optimization. Standard_EXPORT void CriteriumWeight(Standard_Real& W1, Standard_Real& W2, Standard_Real& W3) const; diff --git a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Builder.hxx b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Builder.hxx index 6fa28e5845..966422f5bf 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Builder.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Builder.hxx @@ -39,7 +39,7 @@ class BRepPrim_Builder public: DEFINE_STANDARD_ALLOC - //! Creates an empty, useless Builder. Necesseray for + //! Creates an empty, useless Builder. Necesseray for //! compilation. Standard_EXPORT BRepPrim_Builder(); @@ -51,7 +51,7 @@ public: //! Make a empty Shell. Standard_EXPORT void MakeShell(TopoDS_Shell& S) const; - //! Returns in a Face built with the plane + //! Returns in a Face built with the plane //! equation

. Used by all primitives. Standard_EXPORT void MakeFace(TopoDS_Face& F, const gp_Pln& P) const; @@ -61,12 +61,12 @@ public: //! Returns in a degenerated edge. Standard_EXPORT void MakeDegeneratedEdge(TopoDS_Edge& E) const; - //! Returns in an Edge built with the line - //! equation . + //! Returns in an Edge built with the line + //! equation . Standard_EXPORT void MakeEdge(TopoDS_Edge& E, const gp_Lin& L) const; - //! Returns in an Edge built with the circle - //! equation . + //! Returns in an Edge built with the circle + //! equation . Standard_EXPORT void MakeEdge(TopoDS_Edge& E, const gp_Circ& C) const; //! Sets the line to be the curve representing the @@ -74,16 +74,16 @@ public: //! . Standard_EXPORT void SetPCurve(TopoDS_Edge& E, const TopoDS_Face& F, const gp_Lin2d& L) const; - //! Sets the lines to be the curves - //! representing the edge in the parametric space + //! Sets the lines to be the curves + //! representing the edge in the parametric space //! of the closed surface of . Standard_EXPORT void SetPCurve(TopoDS_Edge& E, const TopoDS_Face& F, const gp_Lin2d& L1, const gp_Lin2d& L2) const; - //! Sets the circle to be the curve representing - //! the edge in the parametric space of the + //! Sets the circle to be the curve representing + //! the edge in the parametric space of the //! surface of . Standard_EXPORT void SetPCurve(TopoDS_Edge& E, const TopoDS_Face& F, const gp_Circ2d& C) const; @@ -93,54 +93,54 @@ public: //! Reverses the Face . Standard_EXPORT void ReverseFace(TopoDS_Face& F) const; - //! Adds the Vertex in the Edge .

is the - //! parameter of the vertex on the edge. If direct + //! Adds the Vertex in the Edge .

is the + //! parameter of the vertex on the edge. If direct //! is False the Vertex is reversed. Standard_EXPORT void AddEdgeVertex(TopoDS_Edge& E, const TopoDS_Vertex& V, const Standard_Real P, const Standard_Boolean direct) const; - //! Adds the Vertex in the Edge . - //! are the parameters of the vertex on the closed + //! Adds the Vertex in the Edge . + //! are the parameters of the vertex on the closed //! edge. Standard_EXPORT void AddEdgeVertex(TopoDS_Edge& E, const TopoDS_Vertex& V, const Standard_Real P1, const Standard_Real P2) const; - //! are the parameters of the vertex on the - //! edge. The edge is a closed curve. + //! are the parameters of the vertex on the + //! edge. The edge is a closed curve. Standard_EXPORT void SetParameters(TopoDS_Edge& E, const TopoDS_Vertex& V, const Standard_Real P1, const Standard_Real P2) const; - //! Adds the Edge in the Wire , if direct is + //! Adds the Edge in the Wire , if direct is //! False the Edge is reversed. Standard_EXPORT void AddWireEdge(TopoDS_Wire& W, const TopoDS_Edge& E, const Standard_Boolean direct) const; - //! Adds the Wire in the Face . + //! Adds the Wire in the Face . Standard_EXPORT void AddFaceWire(TopoDS_Face& F, const TopoDS_Wire& W) const; - //! Adds the Face in the Shell . + //! Adds the Face in the Shell . Standard_EXPORT void AddShellFace(TopoDS_Shell& Sh, const TopoDS_Face& F) const; //! This is called once an edge is completed. It gives //! the opportunity to perform any post treatment. Standard_EXPORT void CompleteEdge(TopoDS_Edge& E) const; - //! This is called once a wire is completed. It gives + //! This is called once a wire is completed. It gives //! the opportunity to perform any post treatment. Standard_EXPORT void CompleteWire(TopoDS_Wire& W) const; - //! This is called once a face is completed. It gives + //! This is called once a face is completed. It gives //! the opportunity to perform any post treatment. Standard_EXPORT void CompleteFace(TopoDS_Face& F) const; - //! This is called once a shell is completed. It gives + //! This is called once a shell is completed. It gives //! the opportunity to perform any post treatment. Standard_EXPORT void CompleteShell(TopoDS_Shell& S) const; diff --git a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Cone.hxx b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Cone.hxx index 81bab0a3bb..d4cb2025e6 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Cone.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Cone.hxx @@ -57,12 +57,12 @@ public: //! infinite cone with Axes Standard_EXPORT BRepPrim_Cone(const Standard_Real Angle, const gp_Ax2& Axes); - //! create a Cone at origin on Z axis, of height H, - //! radius R1 at Z = 0, R2 at Z = H, X is the origin - //! of angles. If R1 or R2 is 0 there is an apex. + //! create a Cone at origin on Z axis, of height H, + //! radius R1 at Z = 0, R2 at Z = H, X is the origin + //! of angles. If R1 or R2 is 0 there is an apex. //! Otherwise, it is a truncated cone. //! - //! Error : R1 and R2 < Resolution + //! Error : R1 and R2 < Resolution //! R1 or R2 negative //! Abs(R1-R2) < Resolution //! H < Resolution @@ -83,7 +83,7 @@ public: const Standard_Real R2, const Standard_Real H); - //! The surface normal should be directed towards the + //! The surface normal should be directed towards the //! outside. Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const Standard_OVERRIDE; diff --git a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Cylinder.hxx b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Cylinder.hxx index e8c83ac8b5..c82e0c5f98 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Cylinder.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Cylinder.hxx @@ -53,9 +53,9 @@ public: //! infinite Cylinder at Axes on Z negative Standard_EXPORT BRepPrim_Cylinder(const gp_Ax2& Axes, const Standard_Real Radius); - //! create a Cylinder at origin on Z axis, of + //! create a Cylinder at origin on Z axis, of //! height H and radius R - //! Error : Radius < Resolution + //! Error : Radius < Resolution //! H < Resolution //! H negative Standard_EXPORT BRepPrim_Cylinder(const Standard_Real R, const Standard_Real H); @@ -65,7 +65,7 @@ public: const Standard_Real R, const Standard_Real H); - //! The surface normal should be directed towards the + //! The surface normal should be directed towards the //! outside. Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const Standard_OVERRIDE; diff --git a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_FaceBuilder.hxx b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_FaceBuilder.hxx index 817362710b..feabcd1b98 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_FaceBuilder.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_FaceBuilder.hxx @@ -28,10 +28,10 @@ class BRep_Builder; class Geom_Surface; -//! The FaceBuilder is an algorithm to build a BRep +//! The FaceBuilder is an algorithm to build a BRep //! Face from a Geom Surface. //! -//! The face covers the whole surface or the area +//! The face covers the whole surface or the area //! delimited by UMin, UMax, VMin, VMax class BRepPrim_FaceBuilder { diff --git a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_GWedge.hxx b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_GWedge.hxx index 855a7a411d..228d349a15 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_GWedge.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_GWedge.hxx @@ -38,14 +38,14 @@ class gp_Pnt; //! //! Axes: an Axis2 (coordinate system) //! -//! YMin, YMax the coordinates of the ymin and ymax +//! YMin, YMax the coordinates of the ymin and ymax //! rectangular faces parallel to the ZX plane (of the //! coordinate systems) //! -//! ZMin,ZMax,XMin,XMax the rectangular +//! ZMin, ZMax, XMin, XMax the rectangular //! left (YMin) face parallel to the Z and X axes. //! -//! Z2Min,Z2Max,X2Min,X2Max the rectangular +//! Z2Min, Z2Max, X2Min, X2Max the rectangular //! right (YMax) face parallel to the Z and X axes. //! //! For a box Z2Min = ZMin, Z2Max = ZMax, diff --git a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Revolution.hxx b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Revolution.hxx index af96e85e9a..8052fc6371 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Revolution.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Revolution.hxx @@ -30,15 +30,15 @@ class TopoDS_Face; class TopoDS_Edge; class gp_Pnt2d; -//! Implement the OneAxis algorithm for a revolution +//! Implement the OneAxis algorithm for a revolution //! surface. class BRepPrim_Revolution : public BRepPrim_OneAxis { public: DEFINE_STANDARD_ALLOC - //! Create a revolution body is the meridian nd - //! must be in the XZ plane of . is the + //! Create a revolution body is the meridian nd + //! must be in the XZ plane of . is the //! meridian in the XZ plane. Standard_EXPORT BRepPrim_Revolution(const gp_Ax2& A, const Standard_Real VMin, @@ -46,12 +46,12 @@ public: const Handle(Geom_Curve)& M, const Handle(Geom2d_Curve)& PM); - //! The surface normal should be directed towards the + //! The surface normal should be directed towards the //! outside. Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const; - //! Returns an edge with a 3D curve made from the - //! meridian in the XZ plane rotated by around + //! Returns an edge with a 3D curve made from the + //! meridian in the XZ plane rotated by around //! the Z-axis. Ang may be 0 or myAngle. Standard_EXPORT virtual TopoDS_Edge MakeEmptyMeridianEdge(const Standard_Real Ang) const; @@ -59,13 +59,13 @@ public: //! plane XZ. Standard_EXPORT virtual gp_Pnt2d MeridianValue(const Standard_Real V) const; - //! Sets the parametric urve of the edge in the - //! face to be the 2d representation of the + //! Sets the parametric urve of the edge in the + //! face to be the 2d representation of the //! meridian. Standard_EXPORT virtual void SetMeridianPCurve(TopoDS_Edge& E, const TopoDS_Face& F) const; protected: - //! Create a revolution body. The meridian is set + //! Create a revolution body. The meridian is set //! later. Reserved for derivated classes. Standard_EXPORT BRepPrim_Revolution(const gp_Ax2& A, const Standard_Real VMin, diff --git a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Sphere.hxx b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Sphere.hxx index 70fee647df..a7f8a506f2 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Sphere.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepPrim/BRepPrim_Sphere.hxx @@ -32,8 +32,8 @@ class BRepPrim_Sphere : public BRepPrim_Revolution public: DEFINE_STANDARD_ALLOC - //! Creates a Sphere at origin with Radius. The axes - //! of the sphere are the reference axes. An error is + //! Creates a Sphere at origin with Radius. The axes + //! of the sphere are the reference axes. An error is //! raised if the radius is < Resolution. Standard_EXPORT BRepPrim_Sphere(const Standard_Real Radius); @@ -45,7 +45,7 @@ public: //! Creates a sphere with given axes system. Standard_EXPORT BRepPrim_Sphere(const gp_Ax2& Axes, const Standard_Real Radius); - //! The surface normal should be directed towards the + //! The surface normal should be directed towards the //! outside. Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const Standard_OVERRIDE; diff --git a/src/ModelingAlgorithms/TKPrim/BRepPrimAPI/BRepPrimAPI_MakeRevol.hxx b/src/ModelingAlgorithms/TKPrim/BRepPrimAPI/BRepPrimAPI_MakeRevol.hxx index d3d62687d1..d2c1e7e468 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepPrimAPI/BRepPrimAPI_MakeRevol.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepPrimAPI/BRepPrimAPI_MakeRevol.hxx @@ -34,10 +34,10 @@ class gp_Ax1; //! //! * A basis topology which is swept. //! -//! The basis topology must not contain solids +//! The basis topology must not contain solids //! (neither composite solids.). //! -//! The basis topology may be copied or shared in +//! The basis topology may be copied or shared in //! the result. //! //! * A rotation axis and angle : @@ -56,22 +56,22 @@ class gp_Ax1; //! - Face -> Solid. //! - Shell -> CompSolid. //! -//! Sweeping a Compound sweeps the elements of the -//! compound and creates a compound with the +//! Sweeping a Compound sweeps the elements of the +//! compound and creates a compound with the //! results. class BRepPrimAPI_MakeRevol : public BRepPrimAPI_MakeSweep { public: DEFINE_STANDARD_ALLOC - //! Builds the Revol of base S, axis A and angle D. If C + //! Builds the Revol of base S, axis A and angle D. If C //! is true, S is copied. Standard_EXPORT BRepPrimAPI_MakeRevol(const TopoDS_Shape& S, const gp_Ax1& A, const Standard_Real D, const Standard_Boolean Copy = Standard_False); - //! Builds the Revol of base S, axis A and angle 2*Pi. If + //! Builds the Revol of base S, axis A and angle 2*Pi. If //! C is true, S is copied. Standard_EXPORT BRepPrimAPI_MakeRevol(const TopoDS_Shape& S, const gp_Ax1& A, @@ -84,7 +84,7 @@ public: Standard_EXPORT virtual void Build( const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE; - //! Returns the first shape of the revol (coinciding with + //! Returns the first shape of the revol (coinciding with //! the generating shape). Standard_EXPORT TopoDS_Shape FirstShape() Standard_OVERRIDE; @@ -101,11 +101,11 @@ public: Standard_EXPORT virtual Standard_Boolean IsDeleted(const TopoDS_Shape& S) Standard_OVERRIDE; //! Returns the TopoDS Shape of the beginning of the revolution, - //! generated with theShape (subShape of the generating shape). + //! generated with theShape (subShape of the generating shape). Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& theShape); //! Returns the TopoDS Shape of the end of the revolution, - //! generated with theShape (subShape of the generating shape). + //! generated with theShape (subShape of the generating shape). Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& theShape); //! Check if there are degenerated edges in the result. diff --git a/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_NumLinearRegularSweep.hxx b/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_NumLinearRegularSweep.hxx index d256ec13ac..41fe7a94c1 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_NumLinearRegularSweep.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_NumLinearRegularSweep.hxx @@ -28,8 +28,8 @@ #include #include -//! This a generic class is used to build Sweept -//! primitives with a generating "shape" and a +//! This a generic class is used to build Sweept +//! primitives with a generating "shape" and a //! directing "line". //! //! The indexation and type analysis services required @@ -41,13 +41,13 @@ //! The iteration services required for the generatrix //! are given by . //! -//! The iteration services required for the directrix +//! The iteration services required for the directrix //! are given by . //! -//! The topology is like a grid of shapes. Each shape -//! of the grid must be addressable without confusion -//! by one or two objects from the generating or -//! directing shapes. Here are examples of correct +//! The topology is like a grid of shapes. Each shape +//! of the grid must be addressable without confusion +//! by one or two objects from the generating or +//! directing shapes. Here are examples of correct //! associations to address: //! //! - a vertex : GenVertex - DirVertex @@ -63,7 +63,7 @@ //! types. //! //! The method Has... is given because in some special -//! cases, a vertex, an edge or a face may be +//! cases, a vertex, an edge or a face may be //! geometricaly nonexistent or not useful. class BRepSweep_NumLinearRegularSweep { @@ -86,8 +86,8 @@ public: Standard_EXPORT virtual TopoDS_Shape MakeEmptyGeneratingEdge(const TopoDS_Shape& aGenE, const Sweep_NumShape& aDirV) = 0; - //! Sets the parameters of the new vertex on the new - //! face. The new face and new vertex where generated + //! Sets the parameters of the new vertex on the new + //! face. The new face and new vertex where generated //! from aGenF, aGenV and aDirV . Standard_EXPORT virtual void SetParameters(const TopoDS_Shape& aNewFace, TopoDS_Shape& aNewVertex, @@ -95,8 +95,8 @@ public: const TopoDS_Shape& aGenV, const Sweep_NumShape& aDirV) = 0; - //! Sets the parameter of the new vertex on the new - //! edge. The new edge and new vertex where generated + //! Sets the parameter of the new vertex on the new + //! edge. The new edge and new vertex where generated //! from aGenV aDirE, and aDirV. Standard_EXPORT virtual void SetDirectingParameter(const TopoDS_Shape& aNewEdge, TopoDS_Shape& aNewVertex, @@ -104,8 +104,8 @@ public: const Sweep_NumShape& aDirE, const Sweep_NumShape& aDirV) = 0; - //! Sets the parameter of the new vertex on the new - //! edge. The new edge and new vertex where generated + //! Sets the parameter of the new vertex on the new + //! edge. The new edge and new vertex where generated //! from aGenE, aGenV and aDirV . Standard_EXPORT virtual void SetGeneratingParameter(const TopoDS_Shape& aNewEdge, TopoDS_Shape& aNewVertex, @@ -113,16 +113,16 @@ public: const TopoDS_Shape& aGenV, const Sweep_NumShape& aDirV) = 0; - //! Builds the face addressed by [aGenS,aDirS], with + //! Builds the face addressed by [aGenS,aDirS], with //! its geometric part, but without subcomponents. The - //! couple aGenS, aDirS can be a "generating face and - //! a directing vertex" or "a generating edge and a - //! directing edge". + //! couple aGenS, aDirS can be a "generating face and + //! a directing vertex" or "a generating edge and a + //! directing edge". Standard_EXPORT virtual TopoDS_Shape MakeEmptyFace(const TopoDS_Shape& aGenS, const Sweep_NumShape& aDirS) = 0; //! Sets the PCurve for a new edge on a new face. The - //! new edge and the new face were generated using + //! new edge and the new face were generated using //! aGenF, aGenE and aDirV. Standard_EXPORT virtual void SetPCurve(const TopoDS_Shape& aNewFace, TopoDS_Shape& aNewEdge, @@ -132,7 +132,7 @@ public: const TopAbs_Orientation orien) = 0; //! Sets the PCurve for a new edge on a new face. The - //! new edge and the new face were generated using + //! new edge and the new face were generated using //! aGenE, aDirE and aDirV. Standard_EXPORT virtual void SetGeneratingPCurve(const TopoDS_Shape& aNewFace, TopoDS_Shape& aNewEdge, @@ -142,7 +142,7 @@ public: const TopAbs_Orientation orien) = 0; //! Sets the PCurve for a new edge on a new face. The - //! new edge and the new face were generated using + //! new edge and the new face were generated using //! aGenE, aDirE and aGenV. Standard_EXPORT virtual void SetDirectingPCurve(const TopoDS_Shape& aNewFace, TopoDS_Shape& aNewEdge, @@ -151,15 +151,15 @@ public: const Sweep_NumShape& aDirE, const TopAbs_Orientation orien) = 0; - //! Returns the Orientation of the shell in the solid - //! generated by the face aGenS with the edge aDirS. - //! It is REVERSED if the surface is swept in the + //! Returns the Orientation of the shell in the solid + //! generated by the face aGenS with the edge aDirS. + //! It is REVERSED if the surface is swept in the //! direction of the normal. Standard_EXPORT virtual TopAbs_Orientation DirectSolid(const TopoDS_Shape& aGenS, const Sweep_NumShape& aDirS) = 0; - //! Returns true if aNewSubShape (addressed by - //! aSubGenS and aDirS) must be added in aNewShape + //! Returns true if aNewSubShape (addressed by + //! aSubGenS and aDirS) must be added in aNewShape //! (addressed by aGenS and aDirS). Standard_EXPORT virtual Standard_Boolean GGDShapeIsToAdd(const TopoDS_Shape& aNewShape, const TopoDS_Shape& aNewSubShape, @@ -167,8 +167,8 @@ public: const TopoDS_Shape& aSubGenS, const Sweep_NumShape& aDirS) const = 0; - //! Returns true if aNewSubShape (addressed by - //! aGenS and aSubDirS) must be added in aNewShape + //! Returns true if aNewSubShape (addressed by + //! aGenS and aSubDirS) must be added in aNewShape //! (addressed by aGenS and aDirS). Standard_EXPORT virtual Standard_Boolean GDDShapeIsToAdd( const TopoDS_Shape& aNewShape, @@ -177,9 +177,9 @@ public: const Sweep_NumShape& aDirS, const Sweep_NumShape& aSubDirS) const = 0; - //! In some particular cases the topology of a - //! generated face must be composed of independent - //! closed wires, in this case this function returns + //! In some particular cases the topology of a + //! generated face must be composed of independent + //! closed wires, in this case this function returns //! true. Standard_EXPORT virtual Standard_Boolean SeparatedWires(const TopoDS_Shape& aNewShape, const TopoDS_Shape& aNewSubShape, @@ -187,21 +187,21 @@ public: const TopoDS_Shape& aSubGenS, const Sweep_NumShape& aDirS) const = 0; - //! In some particular cases the topology of a - //! generated Shell must be composed of independent - //! closed Shells, in this case this function returns + //! In some particular cases the topology of a + //! generated Shell must be composed of independent + //! closed Shells, in this case this function returns //! a Compound of independent Shells. Standard_EXPORT virtual TopoDS_Shape SplitShell(const TopoDS_Shape& aNewShape) const; - //! Called to propagate the continuity of every vertex - //! between two edges of the generating wire aGenS on + //! Called to propagate the continuity of every vertex + //! between two edges of the generating wire aGenS on //! the generated edge and faces. Standard_EXPORT virtual void SetContinuity(const TopoDS_Shape& aGenS, const Sweep_NumShape& aDirS) = 0; - //! Returns true if aDirS and aGenS addresses a - //! resulting Shape. In some specific cases the shape - //! can be geometrically inexsistant, then this + //! Returns true if aDirS and aGenS addresses a + //! resulting Shape. In some specific cases the shape + //! can be geometrically inexsistant, then this //! function returns false. Standard_EXPORT virtual Standard_Boolean HasShape(const TopoDS_Shape& aGenS, const Sweep_NumShape& aDirS) const = 0; @@ -209,11 +209,11 @@ public: //! Returns true if aGenS cannot be transformed. Standard_EXPORT virtual Standard_Boolean IsInvariant(const TopoDS_Shape& aGenS) const = 0; - //! Returns the resulting Shape indexed by aDirS and + //! Returns the resulting Shape indexed by aDirS and //! aGenS. Standard_EXPORT TopoDS_Shape Shape(const TopoDS_Shape& aGenS, const Sweep_NumShape& aDirS); - //! Returns the resulting Shape indexed by myDirWire + //! Returns the resulting Shape indexed by myDirWire //! and aGenS. Standard_EXPORT TopoDS_Shape Shape(const TopoDS_Shape& aGenS); @@ -225,30 +225,30 @@ public: //! is used in result shape Standard_EXPORT Standard_Boolean GenIsUsed(const TopoDS_Shape& theS) const; - //! Returns the resulting Shape indexed by myDirWire + //! Returns the resulting Shape indexed by myDirWire //! and myGenShape. Standard_EXPORT TopoDS_Shape Shape(); - //! Returns the resulting Shape indexed by the first - //! Vertex of myDirWire and myGenShape. + //! Returns the resulting Shape indexed by the first + //! Vertex of myDirWire and myGenShape. Standard_EXPORT TopoDS_Shape FirstShape(); - //! Returns the resulting Shape indexed by the last + //! Returns the resulting Shape indexed by the last //! Vertex of myDirWire and myGenShape. Standard_EXPORT TopoDS_Shape LastShape(); - //! Returns the resulting Shape indexed by the first - //! Vertex of myDirWire and aGenS. + //! Returns the resulting Shape indexed by the first + //! Vertex of myDirWire and aGenS. Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& aGenS); - //! Returns the resulting Shape indexed by the last + //! Returns the resulting Shape indexed by the last //! Vertex of myDirWire and aGenS. Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& aGenS); Standard_EXPORT Standard_Boolean Closed() const; protected: - //! Creates a NumLinearRegularSweep. gives + //! Creates a NumLinearRegularSweep. gives //! basic topological services. Standard_EXPORT BRepSweep_NumLinearRegularSweep(const BRepSweep_Builder& aBuilder, const TopoDS_Shape& aGenShape, diff --git a/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Prism.hxx b/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Prism.hxx index 4bcf81fe5b..033fc01d8d 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Prism.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Prism.hxx @@ -45,8 +45,8 @@ public: const Standard_Boolean Canonize = Standard_True); //! Builds a semi-infinite or an infinite prism of base S. - //! If Copy is true S is copied. If Inf is true the prism - //! is infinite, if Inf is false the prism is infinite in + //! If Copy is true S is copied. If Inf is true the prism + //! is infinite, if Inf is false the prism is infinite in //! the direction D. If Canonize is true then generated surfaces //! are attempted to be canonized in simple types Standard_EXPORT BRepSweep_Prism(const TopoDS_Shape& S, @@ -58,27 +58,27 @@ public: //! Returns the TopoDS Shape attached to the prism. Standard_EXPORT TopoDS_Shape Shape(); - //! Returns the TopoDS Shape generated with aGenS - //! (subShape of the generating shape). + //! Returns the TopoDS Shape generated with aGenS + //! (subShape of the generating shape). Standard_EXPORT TopoDS_Shape Shape(const TopoDS_Shape& aGenS); - //! Returns the TopoDS Shape of the bottom of the prism. + //! Returns the TopoDS Shape of the bottom of the prism. Standard_EXPORT TopoDS_Shape FirstShape(); - //! Returns the TopoDS Shape of the bottom of the prism. - //! generated with aGenS (subShape of the generating + //! Returns the TopoDS Shape of the bottom of the prism. + //! generated with aGenS (subShape of the generating //! shape). Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& aGenS); //! Returns the TopoDS Shape of the top of the prism. Standard_EXPORT TopoDS_Shape LastShape(); - //! Returns the TopoDS Shape of the top of the prism. - //! generated with aGenS (subShape of the generating + //! Returns the TopoDS Shape of the top of the prism. + //! generated with aGenS (subShape of the generating //! shape). Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& aGenS); - //! Returns the Vector of the Prism, if it is an infinite + //! Returns the Vector of the Prism, if it is an infinite //! prism the Vec is unitar. Standard_EXPORT gp_Vec Vec() const; diff --git a/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Revol.hxx b/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Revol.hxx index 71113cf99b..2c45f0fc6b 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Revol.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Revol.hxx @@ -35,14 +35,14 @@ class BRepSweep_Revol public: DEFINE_STANDARD_ALLOC - //! Builds the Revol of meridian S axis A and angle D. If + //! Builds the Revol of meridian S axis A and angle D. If //! C is true S is copied. Standard_EXPORT BRepSweep_Revol(const TopoDS_Shape& S, const gp_Ax1& A, const Standard_Real D, const Standard_Boolean C = Standard_False); - //! Builds the Revol of meridian S axis A and angle 2*Pi. + //! Builds the Revol of meridian S axis A and angle 2*Pi. //! If C is true S is copied. Standard_EXPORT BRepSweep_Revol(const TopoDS_Shape& S, const gp_Ax1& A, @@ -51,23 +51,23 @@ public: //! Returns the TopoDS Shape attached to the Revol. Standard_EXPORT TopoDS_Shape Shape(); - //! Returns the TopoDS Shape generated with aGenS - //! (subShape of the generating shape). + //! Returns the TopoDS Shape generated with aGenS + //! (subShape of the generating shape). Standard_EXPORT TopoDS_Shape Shape(const TopoDS_Shape& aGenS); - //! Returns the first shape of the revol (coinciding with + //! Returns the first shape of the revol (coinciding with //! the generating shape). Standard_EXPORT TopoDS_Shape FirstShape(); - //! Returns the first shape of the revol (coinciding with + //! Returns the first shape of the revol (coinciding with //! the generating shape). Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& aGenS); //! Returns the TopoDS Shape of the top of the prism. Standard_EXPORT TopoDS_Shape LastShape(); - //! Returns the TopoDS Shape of the top of the prism. - //! generated with aGenS (subShape of the generating + //! Returns the TopoDS Shape of the top of the prism. + //! generated with aGenS (subShape of the generating //! shape). Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& aGenS); diff --git a/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Rotation.hxx b/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Rotation.hxx index 8bfb4f27d4..ca67b5c763 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Rotation.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Rotation.hxx @@ -29,14 +29,14 @@ class TopoDS_Shape; class Sweep_NumShape; class TopLoc_Location; -//! Provides an algorithm to build object by +//! Provides an algorithm to build object by //! Rotation sweep. class BRepSweep_Rotation : public BRepSweep_Trsf { public: DEFINE_STANDARD_ALLOC - //! Creates a topology by rotating around A with the + //! Creates a topology by rotating around A with the //! angle D. Standard_EXPORT BRepSweep_Rotation(const TopoDS_Shape& S, const Sweep_NumShape& N, @@ -62,8 +62,8 @@ public: const Sweep_NumShape& aDirV) Standard_OVERRIDE; - //! Sets the parameters of the new vertex on the new - //! face. The new face and new vertex where generated + //! Sets the parameters of the new vertex on the new + //! face. The new face and new vertex where generated //! from aGenF, aGenV and aDirV . Standard_EXPORT void SetParameters(const TopoDS_Shape& aNewFace, TopoDS_Shape& aNewVertex, @@ -71,8 +71,8 @@ public: const TopoDS_Shape& aGenV, const Sweep_NumShape& aDirV) Standard_OVERRIDE; - //! Sets the parameter of the new vertex on the new - //! edge. The new edge and new vertex where generated + //! Sets the parameter of the new vertex on the new + //! edge. The new edge and new vertex where generated //! from aGenV aDirE, and aDirV. Standard_EXPORT void SetDirectingParameter(const TopoDS_Shape& aNewEdge, TopoDS_Shape& aNewVertex, @@ -80,8 +80,8 @@ public: const Sweep_NumShape& aDirE, const Sweep_NumShape& aDirV) Standard_OVERRIDE; - //! Sets the parameter of the new vertex on the new - //! edge. The new edge and new vertex where generated + //! Sets the parameter of the new vertex on the new + //! edge. The new edge and new vertex where generated //! from aGenE, aGenV and aDirV . Standard_EXPORT void SetGeneratingParameter(const TopoDS_Shape& aNewEdge, TopoDS_Shape& aNewVertex, @@ -89,16 +89,16 @@ public: const TopoDS_Shape& aGenV, const Sweep_NumShape& aDirV) Standard_OVERRIDE; - //! Builds the face addressed by [aGenS,aDirS], with + //! Builds the face addressed by [aGenS,aDirS], with //! its geometric part, but without subcomponents. The - //! couple aGenS, aDirS can be a "generating face and - //! a directing vertex" or "a generating edge and a + //! couple aGenS, aDirS can be a "generating face and + //! a directing vertex" or "a generating edge and a //! directing edge". Standard_EXPORT TopoDS_Shape MakeEmptyFace(const TopoDS_Shape& aGenS, const Sweep_NumShape& aDirS) Standard_OVERRIDE; //! Sets the PCurve for a new edge on a new face. The - //! new edge and the new face were generated using + //! new edge and the new face were generated using //! aGenF, aGenE and aDirV. Standard_EXPORT void SetPCurve(const TopoDS_Shape& aNewFace, TopoDS_Shape& aNewEdge, @@ -108,7 +108,7 @@ public: const TopAbs_Orientation orien) Standard_OVERRIDE; //! Sets the PCurve for a new edge on a new face. The - //! new edge and the new face were generated using + //! new edge and the new face were generated using //! aGenE, aDirE and aDirV. Standard_EXPORT void SetGeneratingPCurve(const TopoDS_Shape& aNewFace, TopoDS_Shape& aNewEdge, @@ -118,7 +118,7 @@ public: const TopAbs_Orientation orien) Standard_OVERRIDE; //! Sets the PCurve for a new edge on a new face. The - //! new edge and the new face were generated using + //! new edge and the new face were generated using //! aGenE, aDirE and aGenV. Standard_EXPORT void SetDirectingPCurve(const TopoDS_Shape& aNewFace, TopoDS_Shape& aNewEdge, @@ -127,15 +127,15 @@ public: const Sweep_NumShape& aDirE, const TopAbs_Orientation orien) Standard_OVERRIDE; - //! Returns the Orientation of the shell in the solid - //! generated by the face aGenS with the edge aDirS. - //! It is REVERSED if the surface is swept in the + //! Returns the Orientation of the shell in the solid + //! generated by the face aGenS with the edge aDirS. + //! It is REVERSED if the surface is swept in the //! direction of the normal. Standard_EXPORT TopAbs_Orientation DirectSolid(const TopoDS_Shape& aGenS, const Sweep_NumShape& aDirS) Standard_OVERRIDE; - //! Returns true if aNewSubShape (addressed by - //! aSubGenS and aDirS) must be added in aNewShape + //! Returns true if aNewSubShape (addressed by + //! aSubGenS and aDirS) must be added in aNewShape //! (addressed by aGenS and aDirS). Standard_EXPORT Standard_Boolean GGDShapeIsToAdd(const TopoDS_Shape& aNewShape, @@ -144,8 +144,8 @@ public: const TopoDS_Shape& aSubGenS, const Sweep_NumShape& aDirS) const Standard_OVERRIDE; - //! Returns true if aNewSubShape (addressed by - //! aGenS and aSubDirS) must be added in aNewShape + //! Returns true if aNewSubShape (addressed by + //! aGenS and aSubDirS) must be added in aNewShape //! (addressed by aGenS and aDirS). Standard_EXPORT Standard_Boolean GDDShapeIsToAdd(const TopoDS_Shape& aNewShape, @@ -154,10 +154,10 @@ public: const Sweep_NumShape& aDirS, const Sweep_NumShape& aSubDirS) const Standard_OVERRIDE; - //! In some particular cases the topology of a - //! generated face must be composed of independent - //! closed wires, in this case this function returns - //! true. The only case in which the function may + //! In some particular cases the topology of a + //! generated face must be composed of independent + //! closed wires, in this case this function returns + //! true. The only case in which the function may //! return true is a planar face in a closed revol. Standard_EXPORT Standard_Boolean SeparatedWires(const TopoDS_Shape& aNewShape, @@ -166,22 +166,22 @@ public: const TopoDS_Shape& aSubGenS, const Sweep_NumShape& aDirS) const Standard_OVERRIDE; - //! In some particular cases the topology of a - //! generated Shell must be composed of independent - //! closed Shells, in this case this function returns + //! In some particular cases the topology of a + //! generated Shell must be composed of independent + //! closed Shells, in this case this function returns //! a Compound of independent Shells. Standard_EXPORT virtual TopoDS_Shape SplitShell(const TopoDS_Shape& aNewShape) const Standard_OVERRIDE; - //! Returns true if aDirS and aGenS addresses a - //! resulting Shape. In some specific cases the shape - //! can be geometrically inexsistant, then this + //! Returns true if aDirS and aGenS addresses a + //! resulting Shape. In some specific cases the shape + //! can be geometrically inexsistant, then this //! function returns false. Standard_EXPORT Standard_Boolean HasShape(const TopoDS_Shape& aGenS, const Sweep_NumShape& aDirS) const Standard_OVERRIDE; - //! Returns true when the geometry of aGenS is not - //! modified by the rotation. + //! Returns true when the geometry of aGenS is not + //! modified by the rotation. Standard_EXPORT Standard_Boolean IsInvariant(const TopoDS_Shape& aGenS) const Standard_OVERRIDE; //! returns the axis diff --git a/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Tool.hxx b/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Tool.hxx index 8e1d89cecd..e8315c0601 100644 --- a/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Tool.hxx +++ b/src/ModelingAlgorithms/TKPrim/BRepSweep/BRepSweep_Tool.hxx @@ -26,15 +26,15 @@ #include class TopoDS_Shape; -//! Provides the indexation and type analysis services +//! Provides the indexation and type analysis services //! required by the TopoDS generating Shape of BRepSweep. class BRepSweep_Tool { public: DEFINE_STANDARD_ALLOC - //! Initialize the tool with . The IndexTool - //! must prepare an indexation for all the subshapes + //! Initialize the tool with . The IndexTool + //! must prepare an indexation for all the subshapes //! of this shape. Standard_EXPORT BRepSweep_Tool(const TopoDS_Shape& aShape); diff --git a/src/ModelingAlgorithms/TKShHealing/ShapeAnalysis/ShapeAnalysis_Surface.hxx b/src/ModelingAlgorithms/TKShHealing/ShapeAnalysis/ShapeAnalysis_Surface.hxx index e7603d95fb..d63d1279c7 100644 --- a/src/ModelingAlgorithms/TKShHealing/ShapeAnalysis/ShapeAnalysis_Surface.hxx +++ b/src/ModelingAlgorithms/TKShHealing/ShapeAnalysis/ShapeAnalysis_Surface.hxx @@ -349,7 +349,7 @@ private: //! //! The singularities and corresponding precisions are the //! following: - //! - ConicalSurface - one degenerated point (apex of the cone), + //! - ConicalSurface - one degenerated point (apex of the cone), //! precision is 0., //! - ToroidalSurface - two degenerated points, precision is //! Max (0, majorR-minorR), diff --git a/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_ConvertToRevolution.hxx b/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_ConvertToRevolution.hxx index 2cd84a2623..6b751f3490 100644 --- a/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_ConvertToRevolution.hxx +++ b/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_ConvertToRevolution.hxx @@ -43,11 +43,11 @@ class ShapeCustom_ConvertToRevolution : public ShapeCustom_Modification public: Standard_EXPORT ShapeCustom_ConvertToRevolution(); - //! Returns Standard_True if the face has been + //! Returns Standard_True if the face has been //! modified. In this case, is the new geometric - //! support of the face, the new location, - //! the new tolerance. Otherwise, returns - //! Standard_False, and , , are not + //! support of the face, the new location, + //! the new tolerance. Otherwise, returns + //! Standard_False, and , , are not //! significant. Standard_EXPORT Standard_Boolean NewSurface(const TopoDS_Face& F, Handle(Geom_Surface)& S, @@ -56,35 +56,35 @@ public: Standard_Boolean& RevWires, Standard_Boolean& RevFace) Standard_OVERRIDE; - //! Returns Standard_True if the edge has been - //! modified. In this case, is the new geometric - //! support of the edge, the new location, - //! the new tolerance. Otherwise, returns - //! Standard_False, and , , are not + //! Returns Standard_True if the edge has been + //! modified. In this case, is the new geometric + //! support of the edge, the new location, + //! the new tolerance. Otherwise, returns + //! Standard_False, and , , are not //! significant. Standard_EXPORT Standard_Boolean NewCurve(const TopoDS_Edge& E, Handle(Geom_Curve)& C, TopLoc_Location& L, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns Standard_True if the vertex has been - //! modified. In this case,

is the new geometric - //! support of the vertex, the new tolerance. - //! Otherwise, returns Standard_False, and

, + //! Returns Standard_True if the vertex has been + //! modified. In this case,

is the new geometric + //! support of the vertex, the new tolerance. + //! Otherwise, returns Standard_False, and

, //! are not significant. Standard_EXPORT Standard_Boolean NewPoint(const TopoDS_Vertex& V, gp_Pnt& P, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns Standard_True if the edge has a new + //! Returns Standard_True if the edge has a new //! curve on surface on the face .In this case, - //! is the new geometric support of the edge, the + //! is the new geometric support of the edge, the //! new location, the new tolerance. //! - //! Otherwise, returns Standard_False, and , , + //! Otherwise, returns Standard_False, and , , //! are not significant. //! - //! is the new edge created from . + //! is the new edge created from . //! is the new face created from . They may be useful. Standard_EXPORT Standard_Boolean NewCurve2d(const TopoDS_Edge& E, const TopoDS_Face& F, @@ -93,21 +93,21 @@ public: Handle(Geom2d_Curve)& C, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns Standard_True if the Vertex has a new - //! parameter on the edge . In this case,

is - //! the parameter, the new tolerance. - //! Otherwise, returns Standard_False, and

, + //! Returns Standard_True if the Vertex has a new + //! parameter on the edge . In this case,

is + //! the parameter, the new tolerance. + //! Otherwise, returns Standard_False, and

, //! are not significant. Standard_EXPORT Standard_Boolean NewParameter(const TopoDS_Vertex& V, const TopoDS_Edge& E, Standard_Real& P, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns the continuity of between + //! Returns the continuity of between //! and . //! - //! is the new edge created from . - //! (resp. ) is the new face created from + //! is the new edge created from . + //! (resp. ) is the new face created from //! (resp. ). Standard_EXPORT GeomAbs_Shape Continuity(const TopoDS_Edge& E, const TopoDS_Face& F1, diff --git a/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_DirectModification.hxx b/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_DirectModification.hxx index 5457251a92..2fd6067494 100644 --- a/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_DirectModification.hxx +++ b/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_DirectModification.hxx @@ -43,11 +43,11 @@ class ShapeCustom_DirectModification : public ShapeCustom_Modification public: Standard_EXPORT ShapeCustom_DirectModification(); - //! Returns Standard_True if the face has been + //! Returns Standard_True if the face has been //! modified. In this case, is the new geometric - //! support of the face, the new location, - //! the new tolerance. Otherwise, returns - //! Standard_False, and , , are not + //! support of the face, the new location, + //! the new tolerance. Otherwise, returns + //! Standard_False, and , , are not //! significant. Standard_EXPORT Standard_Boolean NewSurface(const TopoDS_Face& F, Handle(Geom_Surface)& S, @@ -56,35 +56,35 @@ public: Standard_Boolean& RevWires, Standard_Boolean& RevFace) Standard_OVERRIDE; - //! Returns Standard_True if the edge has been - //! modified. In this case, is the new geometric - //! support of the edge, the new location, - //! the new tolerance. Otherwise, returns - //! Standard_False, and , , are not + //! Returns Standard_True if the edge has been + //! modified. In this case, is the new geometric + //! support of the edge, the new location, + //! the new tolerance. Otherwise, returns + //! Standard_False, and , , are not //! significant. Standard_EXPORT Standard_Boolean NewCurve(const TopoDS_Edge& E, Handle(Geom_Curve)& C, TopLoc_Location& L, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns Standard_True if the vertex has been - //! modified. In this case,

is the new geometric - //! support of the vertex, the new tolerance. - //! Otherwise, returns Standard_False, and

, + //! Returns Standard_True if the vertex has been + //! modified. In this case,

is the new geometric + //! support of the vertex, the new tolerance. + //! Otherwise, returns Standard_False, and

, //! are not significant. Standard_EXPORT Standard_Boolean NewPoint(const TopoDS_Vertex& V, gp_Pnt& P, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns Standard_True if the edge has a new + //! Returns Standard_True if the edge has a new //! curve on surface on the face .In this case, - //! is the new geometric support of the edge, the + //! is the new geometric support of the edge, the //! new location, the new tolerance. //! - //! Otherwise, returns Standard_False, and , , + //! Otherwise, returns Standard_False, and , , //! are not significant. //! - //! is the new edge created from . + //! is the new edge created from . //! is the new face created from . They may be useful. Standard_EXPORT Standard_Boolean NewCurve2d(const TopoDS_Edge& E, const TopoDS_Face& F, @@ -93,21 +93,21 @@ public: Handle(Geom2d_Curve)& C, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns Standard_True if the Vertex has a new - //! parameter on the edge . In this case,

is - //! the parameter, the new tolerance. - //! Otherwise, returns Standard_False, and

, + //! Returns Standard_True if the Vertex has a new + //! parameter on the edge . In this case,

is + //! the parameter, the new tolerance. + //! Otherwise, returns Standard_False, and

, //! are not significant. Standard_EXPORT Standard_Boolean NewParameter(const TopoDS_Vertex& V, const TopoDS_Edge& E, Standard_Real& P, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns the continuity of between + //! Returns the continuity of between //! and . //! - //! is the new edge created from . - //! (resp. ) is the new face created from + //! is the new edge created from . + //! (resp. ) is the new face created from //! (resp. ). Standard_EXPORT GeomAbs_Shape Continuity(const TopoDS_Edge& E, const TopoDS_Face& F1, diff --git a/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_SweptToElementary.hxx b/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_SweptToElementary.hxx index 9b84d58711..8105476e56 100644 --- a/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_SweptToElementary.hxx +++ b/src/ModelingAlgorithms/TKShHealing/ShapeCustom/ShapeCustom_SweptToElementary.hxx @@ -42,11 +42,11 @@ class ShapeCustom_SweptToElementary : public ShapeCustom_Modification public: Standard_EXPORT ShapeCustom_SweptToElementary(); - //! Returns Standard_True if the face has been + //! Returns Standard_True if the face has been //! modified. In this case, is the new geometric - //! support of the face, the new location, - //! the new tolerance. Otherwise, returns - //! Standard_False, and , , are not + //! support of the face, the new location, + //! the new tolerance. Otherwise, returns + //! Standard_False, and , , are not //! significant. Standard_EXPORT Standard_Boolean NewSurface(const TopoDS_Face& F, Handle(Geom_Surface)& S, @@ -55,35 +55,35 @@ public: Standard_Boolean& RevWires, Standard_Boolean& RevFace) Standard_OVERRIDE; - //! Returns Standard_True if the edge has been - //! modified. In this case, is the new geometric - //! support of the edge, the new location, - //! the new tolerance. Otherwise, returns - //! Standard_False, and , , are not + //! Returns Standard_True if the edge has been + //! modified. In this case, is the new geometric + //! support of the edge, the new location, + //! the new tolerance. Otherwise, returns + //! Standard_False, and , , are not //! significant. Standard_EXPORT Standard_Boolean NewCurve(const TopoDS_Edge& E, Handle(Geom_Curve)& C, TopLoc_Location& L, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns Standard_True if the vertex has been - //! modified. In this case,

is the new geometric - //! support of the vertex, the new tolerance. - //! Otherwise, returns Standard_False, and

, + //! Returns Standard_True if the vertex has been + //! modified. In this case,

is the new geometric + //! support of the vertex, the new tolerance. + //! Otherwise, returns Standard_False, and

, //! are not significant. Standard_EXPORT Standard_Boolean NewPoint(const TopoDS_Vertex& V, gp_Pnt& P, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns Standard_True if the edge has a new + //! Returns Standard_True if the edge has a new //! curve on surface on the face .In this case, - //! is the new geometric support of the edge, the + //! is the new geometric support of the edge, the //! new location, the new tolerance. //! - //! Otherwise, returns Standard_False, and , , + //! Otherwise, returns Standard_False, and , , //! are not significant. //! - //! is the new edge created from . + //! is the new edge created from . //! is the new face created from . They may be useful. Standard_EXPORT Standard_Boolean NewCurve2d(const TopoDS_Edge& E, const TopoDS_Face& F, @@ -92,21 +92,21 @@ public: Handle(Geom2d_Curve)& C, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns Standard_True if the Vertex has a new - //! parameter on the edge . In this case,

is - //! the parameter, the new tolerance. - //! Otherwise, returns Standard_False, and

, + //! Returns Standard_True if the Vertex has a new + //! parameter on the edge . In this case,

is + //! the parameter, the new tolerance. + //! Otherwise, returns Standard_False, and

, //! are not significant. Standard_EXPORT Standard_Boolean NewParameter(const TopoDS_Vertex& V, const TopoDS_Edge& E, Standard_Real& P, Standard_Real& Tol) Standard_OVERRIDE; - //! Returns the continuity of between + //! Returns the continuity of between //! and . //! - //! is the new edge created from . - //! (resp. ) is the new face created from + //! is the new edge created from . + //! (resp. ) is the new face created from //! (resp. ). Standard_EXPORT GeomAbs_Shape Continuity(const TopoDS_Edge& E, const TopoDS_Face& F1, diff --git a/src/ModelingAlgorithms/TKShHealing/ShapeUpgrade/ShapeUpgrade_UnifySameDomain.hxx b/src/ModelingAlgorithms/TKShHealing/ShapeUpgrade/ShapeUpgrade_UnifySameDomain.hxx index 5a4d3d02e1..02c9bfa699 100644 --- a/src/ModelingAlgorithms/TKShHealing/ShapeUpgrade/ShapeUpgrade_UnifySameDomain.hxx +++ b/src/ModelingAlgorithms/TKShHealing/ShapeUpgrade/ShapeUpgrade_UnifySameDomain.hxx @@ -56,10 +56,10 @@ DEFINE_STANDARD_HANDLE(ShapeUpgrade_UnifySameDomain, Standard_Transient) //! The output result of the tool is the unified shape. //! //! All the modifications of initial shape are recorded during unifying. -//! Methods History are intended to:
+//! Methods History are intended to: //! - set a place holder for the history of modifications of sub-shapes of -//! the initial shape;
-//! - get the collected history.
+//! the initial shape; +//! - get the collected history. //! The algorithm provides a place holder for the history and collects the //! history by default. //! To avoid collecting of the history the place holder should be set to null handle. diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheComputeLineBezierOfApprox.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheComputeLineBezierOfApprox.hxx index 5bb169746c..8b601d4fc0 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheComputeLineBezierOfApprox.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheComputeLineBezierOfApprox.hxx @@ -155,7 +155,7 @@ public: //! returns the result of the approximation. Standard_EXPORT const AppParCurves_MultiBSpCurve& SplineValue(); - //! returns the type of parametrization + //! returns the type of parametrization Standard_EXPORT Approx_ParametrizationType Parametrization() const; //! returns the new parameters of the approximation diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheComputeLineOfApprox.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheComputeLineOfApprox.hxx index f26f38f059..37cea6acc5 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheComputeLineOfApprox.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheComputeLineOfApprox.hxx @@ -127,7 +127,7 @@ public: Standard_EXPORT void Perform(const BRepApprox_TheMultiLineOfApprox& Line); //! The approximation will begin with the - //! set of parameters . + //! set of parameters . Standard_EXPORT void SetParameters(const math_Vector& ThePar); //! The approximation will be done with the diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheMultiLineOfApprox.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheMultiLineOfApprox.hxx index c1d10ecbdd..520c2c17dd 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheMultiLineOfApprox.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepApprox/BRepApprox_TheMultiLineOfApprox.hxx @@ -41,9 +41,9 @@ public: //! The class SvSurfaces is used when the approximation algorithm //! needs some extra points on the line . - //! A New line is then created which shares the same surfaces and functions. + //! A New line is then created which shares the same surfaces and functions. //! SvSurfaces is a deferred class which allows several implementations of - //! this algorithm with different surfaces (bi-parametric ones, or + //! this algorithm with different surfaces (bi-parametric ones, or //! implicit and biparametric ones) Standard_EXPORT BRepApprox_TheMultiLineOfApprox(const Handle(BRepApprox_ApproxLine)& line, const Standard_Address PtrSvSurfaces, diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI.hxx index b018455ec4..75891cbb83 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI.hxx @@ -24,22 +24,22 @@ #include class Geom_Plane; -//! The BRepBuilderAPI package provides an Application -//! Programming Interface for the BRep topology data +//! The BRepBuilderAPI package provides an Application +//! Programming Interface for the BRep topology data //! structure. //! -//! The API is a set of classes aiming to provide : +//! The API is a set of classes aiming to provide: //! -//! * High level and simple calls for the most common +//! * High level and simple calls for the most common //! operations. //! -//! * Keeping an access on the low-level +//! * Keeping an access on the low-level //! implementation of high-level calls. //! -//! * Examples of programming of high-level operations +//! * Examples of programming of high-level operations //! from low-level operations. //! -//! * A complete coverage of modelling : +//! * A complete coverage of modelling: //! //! - Creating vertices ,edges, faces, solids. //! @@ -49,20 +49,20 @@ class Geom_Plane; //! //! - Global properties computation. //! -//! The API provides classes to build objects: +//! The API provides classes to build objects: //! -//! * The constructors of the classes provides the +//! * The constructors of the classes provides the //! different constructions methods. //! -//! * The class keeps as fields the different tools +//! * The class keeps as fields the different tools //! used to build the object. //! -//! * The class provides a casting method to get -//! automatically the result with a function-like +//! * The class provides a casting method to get +//! automatically the result with a function-like //! call. //! -//! For example to make a vertex from a point

-//! one can writes : +//! For example to make a vertex from a point

+//! one can write: //! //! V = BRepBuilderAPI_MakeVertex(P); //! @@ -71,8 +71,8 @@ class Geom_Plane; //! BRepBuilderAPI_MakeVertex MV(P); //! V = MV.Vertex(); //! -//! For tolerances a default precision is used which -//! can be changed by the packahe method +//! For tolerances a default precision is used which +//! can be changed by the packahe method //! BRepBuilderAPI::Precision. //! //! For error handling the BRepBuilderAPI commands raise only @@ -87,13 +87,13 @@ class BRepBuilderAPI public: DEFINE_STANDARD_ALLOC - //! Sets the current plane. + //! Sets the current plane. Standard_EXPORT static void Plane(const Handle(Geom_Plane)& P); //! Returns the current plane. Standard_EXPORT static const Handle(Geom_Plane)& Plane(); - //! Sets the default precision. The current Precision + //! Sets the default precision. The current Precision //! is returned. Standard_EXPORT static void Precision(const Standard_Real P); diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_EdgeError.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_EdgeError.hxx index 77dc41cac8..517be8349b 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_EdgeError.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_EdgeError.hxx @@ -20,7 +20,7 @@ //! Indicates the outcome of the //! construction of an edge, i.e. whether it has been successful or //! not, as explained below: -//! - BRepBuilderAPI_EdgeDone No error occurred; The edge is +//! - BRepBuilderAPI_EdgeDone No error occurred; The edge is //! correctly built. //! - BRepBuilderAPI_PointProjectionFailed No parameters were given but //! the projection of the 3D points on the curve failed. This @@ -34,13 +34,13 @@ //! curve but have different locations. //! - BRepBuilderAPI_PointWithInfiniteParameter //! A finite coordinate point was associated with an infinite -//! parameter (see the Precision package for a definition of infinite values). +//! parameter (see the Precision package for a definition of infinite values). //! - BRepBuilderAPI_DifferentsPointAndParameter //! The distance between the 3D point and the point evaluated //! on the curve with the parameter is greater than the precision. //! - BRepBuilderAPI_LineThroughIdenticPoints //! Two identical points were given to define a line (construction -//! of an edge without curve); gp::Resolution is used for the confusion test. +//! of an edge without curve); gp::Resolution is used for the confusion test. enum BRepBuilderAPI_EdgeError { BRepBuilderAPI_EdgeDone, diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_FaceError.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_FaceError.hxx index 709699a20d..571ceee628 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_FaceError.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_FaceError.hxx @@ -29,7 +29,7 @@ //! - BRepBuilderAPI_CurveProjectionFailed //! Not used so far. //! - BRepBuilderAPI_ParametersOutOfRange -//! The parameters given to limit the surface are out of its bounds. +//! The parameters given to limit the surface are out of its bounds. enum BRepBuilderAPI_FaceError { BRepBuilderAPI_FaceDone, diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_GTransform.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_GTransform.hxx index 1634632230..2e38f83d54 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_GTransform.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_GTransform.hxx @@ -89,7 +89,7 @@ public: //! them by calling the function Perform again. Standard_EXPORT void Perform(const TopoDS_Shape& S, const Standard_Boolean Copy = Standard_False); - //! Returns the list of shapes modified from the shape + //! Returns the list of shapes modified from the shape //! . Standard_EXPORT virtual const TopTools_ListOfShape& Modified(const TopoDS_Shape& S) Standard_OVERRIDE; diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeEdge.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeEdge.hxx index 8c943ecb0b..f53dae8b41 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeEdge.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeEdge.hxx @@ -39,34 +39,34 @@ class TopoDS_Edge; //! Provides methods to build edges. //! -//! The methods have the following syntax, where +//! The methods have the following syntax, where //! TheCurve is one of Lin, Circ, ... //! //! Create(C : TheCurve) //! -//! Makes an edge on the whole curve. Add vertices +//! Makes an edge on the whole curve. Add vertices //! on finite curves. //! //! Create(C : TheCurve; p1,p2 : Real) //! -//! Make an edge on the curve between parameters p1 +//! Make an edge on the curve between parameters p1 //! and p2. if p2 < p1 the edge will be REVERSED. If -//! p1 or p2 is infinite the curve will be open in -//! that direction. Vertices are created for finite +//! p1 or p2 is infinite the curve will be open in +//! that direction. Vertices are created for finite //! values of p1 and p2. //! //! Create(C : TheCurve; P1, P2 : Pnt from gp) //! -//! Make an edge on the curve between the points P1 -//! and P2. The points are projected on the curve -//! and the previous method is used. An error is +//! Make an edge on the curve between the points P1 +//! and P2. The points are projected on the curve +//! and the previous method is used. An error is //! raised if the points are not on the curve. //! //! Create(C : TheCurve; V1, V2 : Vertex from TopoDS) //! -//! Make an edge on the curve between the vertices -//! V1 and V2. Same as the previous but no vertices -//! are created. If a vertex is Null the curve will +//! Make an edge on the curve between the vertices +//! V1 and V2. Same as the previous but no vertices +//! are created. If a vertex is Null the curve will //! be open in this direction. class BRepBuilderAPI_MakeEdge : public BRepBuilderAPI_MakeShape { diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeEdge2d.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeEdge2d.hxx index ead036ad36..28ef05acf3 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeEdge2d.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeEdge2d.hxx @@ -37,34 +37,34 @@ class TopoDS_Edge; //! Provides methods to build edges. //! -//! The methods have the following syntax, where +//! The methods have the following syntax, where //! TheCurve is one of Lin2d, Circ2d, ... //! //! Create(C : TheCurve) //! -//! Makes an edge on the whole curve. Add vertices +//! Makes an edge on the whole curve. Add vertices //! on finite curves. //! //! Create(C : TheCurve; p1,p2 : Real) //! -//! Make an edge on the curve between parameters p1 +//! Make an edge on the curve between parameters p1 //! and p2. if p2 < p1 the edge will be REVERSED. If -//! p1 or p2 is infinite the curve will be open in -//! that direction. Vertices are created for finite +//! p1 or p2 is infinite the curve will be open in +//! that direction. Vertices are created for finite //! values of p1 and p2. //! //! Create(C : TheCurve; P1, P2 : Pnt2d from gp) //! -//! Make an edge on the curve between the points P1 -//! and P2. The points are projected on the curve -//! and the previous method is used. An error is +//! Make an edge on the curve between the points P1 +//! and P2. The points are projected on the curve +//! and the previous method is used. An error is //! raised if the points are not on the curve. //! //! Create(C : TheCurve; V1, V2 : Vertex from TopoDS) //! -//! Make an edge on the curve between the vertices -//! V1 and V2. Same as the previous but no vertices -//! are created. If a vertex is Null the curve will +//! Make an edge on the curve between the vertices +//! V1 and V2. Same as the previous but no vertices +//! are created. If a vertex is Null the curve will //! be open in this direction. class BRepBuilderAPI_MakeEdge2d : public BRepBuilderAPI_MakeShape { diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeFace.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeFace.hxx index 7eb199ff00..3e9e27d0fa 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeFace.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeFace.hxx @@ -36,7 +36,7 @@ class TopoDS_Wire; //! Provides methods to build faces. //! -//! A face may be built : +//! A face may be built: //! //! * From a surface. //! @@ -53,7 +53,7 @@ class TopoDS_Wire; //! * From a surface and a wire. //! //! - A flag Inside is given, when this flag is True -//! the wire is oriented to bound a finite area on +//! the wire is oriented to bound a finite area on //! the surface. //! //! * From a face and a wire. diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakePolygon.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakePolygon.hxx index 76186ac8de..ff4bb7e2f6 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakePolygon.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakePolygon.hxx @@ -32,8 +32,8 @@ class TopoDS_Wire; //! polygonal wire can be built from any number of points //! or vertices, and consists of a sequence of connected //! rectilinear edges. -//! When a point or vertex is added to the polygon if -//! it is identic to the previous point no edge is +//! When a point or vertex is added to the polygon if +//! it is identic to the previous point no edge is //! built. The method added can be used to test it. //! Construction of a Polygonal Wire //! You can construct: diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeShape.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeShape.hxx index ba3a84be2b..1d32552b96 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeShape.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_MakeShape.hxx @@ -26,17 +26,17 @@ #include #include -//! This is the root class for all shape -//! constructions. It stores the result. +//! This is the root class for all shape +//! constructions. It stores the result. //! -//! It provides deferred methods to trace the history +//! It provides deferred methods to trace the history //! of sub-shapes. class BRepBuilderAPI_MakeShape : public BRepBuilderAPI_Command { public: DEFINE_STANDARD_ALLOC - //! This is called by Shape(). It does nothing but + //! This is called by Shape(). It does nothing but //! may be redefined. Standard_EXPORT virtual void Build( const Message_ProgressRange& theRange = Message_ProgressRange()); @@ -46,11 +46,11 @@ public: Standard_EXPORT virtual const TopoDS_Shape& Shape(); Standard_EXPORT operator TopoDS_Shape(); - //! Returns the list of shapes generated from the + //! Returns the list of shapes generated from the //! shape . Standard_EXPORT virtual const TopTools_ListOfShape& Generated(const TopoDS_Shape& S); - //! Returns the list of shapes modified from the shape + //! Returns the list of shapes modified from the shape //! . Standard_EXPORT virtual const TopTools_ListOfShape& Modified(const TopoDS_Shape& S); diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_ModifyShape.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_ModifyShape.hxx index 4f95bd99ad..11516ef3ce 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_ModifyShape.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_ModifyShape.hxx @@ -27,11 +27,11 @@ #include class BRepTools_Modification; -//! Implements the methods of MakeShape for the -//! constant topology modifications. The methods are -//! implemented when the modification uses a Modifier -//! from BRepTools. Some of them have to be redefined -//! if the modification is implemented with another +//! Implements the methods of MakeShape for the +//! constant topology modifications. The methods are +//! implemented when the modification uses a Modifier +//! from BRepTools. Some of them have to be redefined +//! if the modification is implemented with another //! tool (see Transform from BRepBuilderAPI for example). //! The BRepBuilderAPI package provides the following //! frameworks to perform modifications of this sort: @@ -47,7 +47,7 @@ class BRepBuilderAPI_ModifyShape : public BRepBuilderAPI_MakeShape public: DEFINE_STANDARD_ALLOC - //! Returns the list of shapes modified from the shape + //! Returns the list of shapes modified from the shape //! . Standard_EXPORT virtual const TopTools_ListOfShape& Modified(const TopoDS_Shape& S) Standard_OVERRIDE; @@ -66,29 +66,29 @@ protected: //! Empty constructor. Standard_EXPORT BRepBuilderAPI_ModifyShape(); - //! Initializes the modifier with the Shape , and + //! Initializes the modifier with the Shape , and //! set the field to . Standard_EXPORT BRepBuilderAPI_ModifyShape(const TopoDS_Shape& S); //! Set the field with . Standard_EXPORT BRepBuilderAPI_ModifyShape(const Handle(BRepTools_Modification)& M); - //! Initializes the modifier with the Shape , and + //! Initializes the modifier with the Shape , and //! set the field to , and set the - //! field with , the performs the + //! field with , the performs the //! modification. Standard_EXPORT BRepBuilderAPI_ModifyShape(const TopoDS_Shape& S, const Handle(BRepTools_Modification)& M); - //! Performs the previously given modification on the + //! Performs the previously given modification on the //! shape . Standard_EXPORT void DoModif(const TopoDS_Shape& S); - //! Performs the modification on a previously + //! Performs the modification on a previously //! given shape. Standard_EXPORT void DoModif(const Handle(BRepTools_Modification)& M); - //! Performs the modification on the shape . + //! Performs the modification on the shape . Standard_EXPORT void DoModif(const TopoDS_Shape& S, const Handle(BRepTools_Modification)& M); BRepTools_Modifier myModifier; diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_NurbsConvert.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_NurbsConvert.hxx index c34c26ed2a..9ed62ebbf4 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_NurbsConvert.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_NurbsConvert.hxx @@ -64,7 +64,7 @@ public: //! shapes: you specify them by calling the function Perform again. Standard_EXPORT void Perform(const TopoDS_Shape& S, const Standard_Boolean Copy = Standard_False); - //! Returns the list of shapes modified from the shape + //! Returns the list of shapes modified from the shape //! . Standard_EXPORT virtual const TopTools_ListOfShape& Modified(const TopoDS_Shape& S); diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_Sewing.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_Sewing.hxx index dffd77cb36..3d30b3634c 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_Sewing.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_Sewing.hxx @@ -145,7 +145,7 @@ public: Standard_EXPORT Standard_Boolean IsSectionBound(const TopoDS_Edge& section) const; //! Gives the original edge (free boundary) which becomes the - //! the section. Remember that sections constitute common edges. + //! the section. Remember that sections constitute common edges. //! This information is important for control because with //! original edge we can find the surface to which the section //! is attached. diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_Transform.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_Transform.hxx index 6249c2faae..ddf2c09861 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_Transform.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_Transform.hxx @@ -49,10 +49,10 @@ public: //! Creates a transformation from the gp_Trsf , and //! applies it to the shape . If the transformation - //! is direct and isometric (determinant = 1) and - //! = Standard_False, the resulting shape is - //! on which a new location has been set. - //! Otherwise, the transformation is applied on a + //! is direct and isometric (determinant = 1) and + //! = Standard_False, the resulting shape is + //! on which a new location has been set. + //! Otherwise, the transformation is applied on a //! duplication of . //! If is true, the triangulation will be copied, //! and the copy will be assigned to the result shape. @@ -82,7 +82,7 @@ public: //! Returns the modified shape corresponding to . Standard_EXPORT virtual TopoDS_Shape ModifiedShape(const TopoDS_Shape& S) const Standard_OVERRIDE; - //! Returns the list of shapes modified from the shape + //! Returns the list of shapes modified from the shape //! . Standard_EXPORT virtual const TopTools_ListOfShape& Modified(const TopoDS_Shape& S) Standard_OVERRIDE; diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_TransitionMode.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_TransitionMode.hxx index 44fb2a0346..fff3ed88c6 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_TransitionMode.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepBuilderAPI/BRepBuilderAPI_TransitionMode.hxx @@ -17,7 +17,7 @@ #ifndef _BRepBuilderAPI_TransitionMode_HeaderFile #define _BRepBuilderAPI_TransitionMode_HeaderFile -//! Option to manage discontinuities in Sweep +//! Option to manage discontinuities in Sweep enum BRepBuilderAPI_TransitionMode { BRepBuilderAPI_Transformed, diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck.hxx index 5fe2d5c74d..4a25ecc2c7 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck.hxx @@ -27,7 +27,7 @@ class TopoDS_Face; class TopoDS_Edge; class Adaptor3d_Curve; -//! This package provides tools to check the validity +//! This package provides tools to check the validity //! of the BRep. class BRepCheck { diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Analyzer.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Analyzer.hxx index 31fb8b12b1..bea8a03dbf 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Analyzer.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Analyzer.hxx @@ -39,21 +39,21 @@ public: DEFINE_STANDARD_ALLOC //! Constructs a shape validation object defined by the shape S. - //! is the shape to control. If - //! False only topological informaions are checked. + //! is the shape to control. If + //! False only topological informaions are checked. //! The geometricals controls are - //! For a Vertex : - //! BRepCheck_InvalidToleranceValue NYI - //! For an Edge : + //! For a Vertex: + //! BRepCheck_InvalidToleranceValue NYI + //! For an Edge: //! BRepCheck_InvalidCurveOnClosedSurface, //! BRepCheck_InvalidCurveOnSurface, //! BRepCheck_InvalidSameParameterFlag, - //! BRepCheck_InvalidToleranceValue NYI - //! For a face : + //! BRepCheck_InvalidToleranceValue NYI + //! For a face: //! BRepCheck_UnorientableShape, //! BRepCheck_IntersectingWires, - //! BRepCheck_InvalidToleranceValue NYI - //! For a wire : + //! BRepCheck_InvalidToleranceValue NYI + //! For a wire: //! BRepCheck_SelfIntersectingWire BRepCheck_Analyzer(const TopoDS_Shape& S, const Standard_Boolean GeomControls = Standard_True, @@ -65,21 +65,21 @@ public: Init(S, GeomControls); } - //! is the shape to control. If - //! False only topological informaions are checked. + //! is the shape to control. If + //! False only topological informaions are checked. //! The geometricals controls are - //! For a Vertex : - //! BRepCheck_InvalidTolerance NYI - //! For an Edge : + //! For a Vertex: + //! BRepCheck_InvalidTolerance NYI + //! For an Edge: //! BRepCheck_InvalidCurveOnClosedSurface, //! BRepCheck_InvalidCurveOnSurface, //! BRepCheck_InvalidSameParameterFlag, - //! BRepCheck_InvalidTolerance NYI - //! For a face : + //! BRepCheck_InvalidTolerance NYI + //! For a face: //! BRepCheck_UnorientableShape, //! BRepCheck_IntersectingWires, - //! BRepCheck_InvalidTolerance NYI - //! For a wire : + //! BRepCheck_InvalidTolerance NYI + //! For a wire: //! BRepCheck_SelfIntersectingWire Standard_EXPORT void Init(const TopoDS_Shape& S, const Standard_Boolean GeomControls = Standard_True); @@ -100,7 +100,7 @@ public: //! Returns true if parallel flag is set Standard_Boolean IsParallel() { return myIsParallel; } - //! is a subshape of the original shape. Returns + //! is a subshape of the original shape. Returns //! if no default has been detected on //! and any of its subshape. Standard_EXPORT Standard_Boolean IsValid(const TopoDS_Shape& S) const; @@ -128,7 +128,7 @@ public: //! the edge?s contextual situation. //! - if the edge is either single, or it is in the context //! of a wire or a compound, its parameterization is defined by - //! the parameterization of its 3D curve and is considered as valid. + //! the parameterization of its 3D curve and is considered as valid. //! - If the edge is in the context of a face, it should //! have SameParameter and SameRange flags set to Standard_True. To //! check these flags, you should call the function diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Shell.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Shell.hxx index e10fb86b36..d926ba626a 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Shell.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Shell.hxx @@ -41,15 +41,15 @@ public: Standard_EXPORT void Blind() Standard_OVERRIDE; - //! Checks if the oriented faces of the shell give a - //! closed shell. If the wire is closed, returns - //! BRepCheck_NoError.If is set to + //! Checks if the oriented faces of the shell give a + //! closed shell. If the wire is closed, returns + //! BRepCheck_NoError. If is set to //! Standard_True, registers the status in the list. Standard_EXPORT BRepCheck_Status Closed(const Standard_Boolean Update = Standard_False); - //! Checks if the oriented faces of the shell are - //! correctly oriented. An internal call is made to - //! the method Closed. If is set to + //! Checks if the oriented faces of the shell are + //! correctly oriented. An internal call is made to + //! the method Closed. If is set to //! Standard_True, registers the status in the list. Standard_EXPORT BRepCheck_Status Orientation(const Standard_Boolean Update = Standard_False); diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Solid.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Solid.hxx index d07877088e..1d2fd0a940 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Solid.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Solid.hxx @@ -49,7 +49,7 @@ public: //! Status: BRepCheck_BadOrientationOfSubshape //! //! 3. For closed, non-internal shells: - //! 3.1 Shells containing entities of the solid that + //! 3.1 Shells containing entities of the solid that //! are outside towards the shells //! Status: BRepCheck_SubshapeNotInShape //! diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Wire.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Wire.hxx index 500acde92f..5238027f49 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Wire.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepCheck/BRepCheck_Wire.hxx @@ -37,46 +37,46 @@ class BRepCheck_Wire : public BRepCheck_Result public: Standard_EXPORT BRepCheck_Wire(const TopoDS_Wire& W); - //! if is a face, consequently checks - //! SelfIntersect(), Closed(), Orientation() and + //! if is a face, consequently checks + //! SelfIntersect(), Closed(), Orientation() and //! Closed2d until faulty is found Standard_EXPORT void InContext(const TopoDS_Shape& ContextShape) Standard_OVERRIDE; - //! checks that the wire is not empty and "connex". + //! checks that the wire is not empty and "connex". //! Called by constructor Standard_EXPORT void Minimum() Standard_OVERRIDE; //! Does nothing Standard_EXPORT void Blind() Standard_OVERRIDE; - //! Checks if the oriented edges of the wire give a - //! closed wire. If the wire is closed, returns - //! BRepCheck_NoError. Warning : if the first and - //! last edge are infinite, the wire will be - //! considered as a closed one. If is set to + //! Checks if the oriented edges of the wire give a + //! closed wire. If the wire is closed, returns + //! BRepCheck_NoError. Warning: if the first and + //! last edge are infinite, the wire will be + //! considered as a closed one. If is set to //! Standard_True, registers the status in the list. //! May return (and registers): - //! **BRepCheck_NotConnected, if wire is not + //! **BRepCheck_NotConnected, if wire is not //! topologically closed - //! **BRepCheck_RedundantEdge, if an edge is in wire - //! more than 3 times or in case of 2 occurrences if + //! **BRepCheck_RedundantEdge, if an edge is in wire + //! more than 3 times or in case of 2 occurrences if //! not with FORWARD and REVERSED orientation. //! **BRepCheck_NoError Standard_EXPORT BRepCheck_Status Closed(const Standard_Boolean Update = Standard_False); - //! Checks if edges of the wire give a wire closed in + //! Checks if edges of the wire give a wire closed in //! 2d space. - //! Returns BRepCheck_NoError, or BRepCheck_NotClosed + //! Returns BRepCheck_NoError, or BRepCheck_NotClosed //! If is set to Standard_True, registers the //! status in the list. Standard_EXPORT BRepCheck_Status Closed2d(const TopoDS_Face& F, const Standard_Boolean Update = Standard_False); - //! Checks if the oriented edges of the wire are - //! correctly oriented. An internal call is made to - //! the method Closed. If no face exists, call the - //! method with a null face (TopoDS_face()). If - //! is set to Standard_True, registers the + //! Checks if the oriented edges of the wire are + //! correctly oriented. An internal call is made to + //! the method Closed. If no face exists, call the + //! method with a null face (TopoDS_face()). If + //! is set to Standard_True, registers the //! status in the list. //! May return (and registers): //! BRepCheck_InvalidDegeneratedFlag, @@ -86,11 +86,11 @@ public: Standard_EXPORT BRepCheck_Status Orientation(const TopoDS_Face& F, const Standard_Boolean Update = Standard_False); - //! Checks if the wire intersect itself on the face - //! . and are the first intersecting - //! edges found. may be a null edge when a + //! Checks if the wire intersect itself on the face + //! . and are the first intersecting + //! edges found. may be a null edge when a //! self-intersecting edge is found.If is set - //! to Standard_True, registers the status in the + //! to Standard_True, registers the status in the //! list. //! May return (and register): //! BRepCheck_EmptyWire, diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_Edge.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_Edge.hxx index 4da864cea0..0a211df6de 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_Edge.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_Edge.hxx @@ -25,8 +25,8 @@ #include #include -//! This class is used to send the description of an -//! Edge to the classifier. It contains an Edge and a +//! This class is used to send the description of an +//! Edge to the classifier. It contains an Edge and a //! Face. So the PCurve of the Edge can be found. class BRepClass_Edge { diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FClass2dOfFClassifier.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FClass2dOfFClassifier.hxx index 3a0a7d6ef3..619ec0ae3f 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FClass2dOfFClassifier.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FClass2dOfFClassifier.hxx @@ -38,14 +38,14 @@ public: //! Creates an undefined classifier. Standard_EXPORT BRepClass_FClass2dOfFClassifier(); - //! Starts a classification process. The point to - //! classify is the origin of the line .

is - //! the original length of the segment on used to - //! compute intersections. is the tolerance + //! Starts a classification process. The point to + //! classify is the origin of the line .

is + //! the original length of the segment on used to + //! compute intersections. is the tolerance //! attached to the line segment in intersections. Standard_EXPORT void Reset(const gp_Lin2d& L, const Standard_Real P, const Standard_Real Tol); - //! Updates the classification process with the edge + //! Updates the classification process with the edge //! from the boundary. Standard_EXPORT void Compare(const BRepClass_Edge& E, const TopAbs_Orientation Or); @@ -55,9 +55,9 @@ public: //! Returns the intersecting algorithm. BRepClass_Intersector& Intersector(); - //! Returns 0 if the last compared edge had no - //! relevant intersection. Else returns the index of - //! this intersection in the last intersection + //! Returns 0 if the last compared edge had no + //! relevant intersection. Else returns the index of + //! this intersection in the last intersection //! algorithm. Standard_Integer ClosestIntersection() const; diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FClassifier.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FClassifier.hxx index 9f54671987..9d5c1564ed 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FClassifier.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FClassifier.hxx @@ -39,13 +39,13 @@ public: //! Empty constructor, undefined algorithm. Standard_EXPORT BRepClass_FClassifier(); - //! Creates an algorithm to classify the Point P with + //! Creates an algorithm to classify the Point P with //! Tolerance on the face described by . Standard_EXPORT BRepClass_FClassifier(BRepClass_FaceExplorer& F, const gp_Pnt2d& P, const Standard_Real Tol); - //! Classify the Point P with Tolerance on the + //! Classify the Point P with Tolerance on the //! face described by . Standard_EXPORT void Perform(BRepClass_FaceExplorer& F, const gp_Pnt2d& P, @@ -54,24 +54,24 @@ public: //! Returns the result of the classification. Standard_EXPORT TopAbs_State State() const; - //! Returns True when the state was computed by a + //! Returns True when the state was computed by a //! rejection. The state is OUT. Standard_Boolean Rejected() const; - //! Returns True if the face contains no wire. The + //! Returns True if the face contains no wire. The //! state is IN. Standard_Boolean NoWires() const; - //! Returns the Edge used to determine the - //! classification. When the State is ON this is the + //! Returns the Edge used to determine the + //! classification. When the State is ON this is the //! Edge containing the point. Standard_EXPORT const BRepClass_Edge& Edge() const; - //! Returns the parameter on Edge() used to determine the + //! Returns the parameter on Edge() used to determine the //! classification. Standard_EXPORT Standard_Real EdgeParameter() const; - //! Returns the position of the point on the edge + //! Returns the position of the point on the edge //! returned by Edge. IntRes2d_Position Position() const; diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FaceClassifier.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FaceClassifier.hxx index 443ed08867..584332b710 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FaceClassifier.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FaceClassifier.hxx @@ -36,13 +36,13 @@ public: //! Empty constructor, undefined algorithm. Standard_EXPORT BRepClass_FaceClassifier(); - //! Creates an algorithm to classify the Point P with + //! Creates an algorithm to classify the Point P with //! Tolerance on the face described by . Standard_EXPORT BRepClass_FaceClassifier(BRepClass_FaceExplorer& F, const gp_Pnt2d& P, const Standard_Real Tol); - //! Creates an algorithm to classify the Point P with + //! Creates an algorithm to classify the Point P with //! Tolerance on the face . //! Recommended to use Bnd_Box if the number of edges > 10 //! and the geometry is mostly spline @@ -52,7 +52,7 @@ public: const Standard_Boolean theUseBndBox = Standard_False, const Standard_Real theGapCheckTol = 0.1); - //! Classify the Point P with Tolerance on the + //! Classify the Point P with Tolerance on the //! face described by . //! Recommended to use Bnd_Box if the number of edges > 10 //! and the geometry is mostly spline @@ -62,7 +62,7 @@ public: const Standard_Boolean theUseBndBox = Standard_False, const Standard_Real theGapCheckTol = 0.1); - //! Creates an algorithm to classify the Point P with + //! Creates an algorithm to classify the Point P with //! Tolerance on the face . //! Recommended to use Bnd_Box if the number of edges > 10 //! and the geometry is mostly spline @@ -72,7 +72,7 @@ public: const Standard_Boolean theUseBndBox = Standard_False, const Standard_Real theGapCheckTol = 0.1); - //! Classify the Point P with Tolerance on the + //! Classify the Point P with Tolerance on the //! face described by . //! Recommended to use Bnd_Box if the number of edges > 10 //! and the geometry is mostly spline diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FaceExplorer.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FaceExplorer.hxx index 4866d7eb31..93fac8e452 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FaceExplorer.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FaceExplorer.hxx @@ -29,7 +29,7 @@ class gp_Pnt2d; class gp_Lin2d; class BRepClass_Edge; -//! Provide an exploration of a BRep Face for the +//! Provide an exploration of a BRep Face for the //! classification. Return UV edges. class BRepClass_FaceExplorer { @@ -44,44 +44,44 @@ public: //! bounding box. Returns True if point was not changed. Standard_EXPORT Standard_Boolean CheckPoint(gp_Pnt2d& thePoint); - //! Should return True if the point is outside a + //! Should return True if the point is outside a //! bounding volume of the face. Standard_EXPORT Standard_Boolean Reject(const gp_Pnt2d& P) const; - //! Returns in , a segment having at least - //! one intersection with the face boundary to - //! compute intersections. + //! Returns in , a segment having at least + //! one intersection with the face boundary to + //! compute intersections. Standard_EXPORT Standard_Boolean Segment(const gp_Pnt2d& P, gp_Lin2d& L, Standard_Real& Par); - //! Returns in , a segment having at least - //! one intersection with the face boundary to - //! compute intersections. Each call gives another segment. + //! Returns in , a segment having at least + //! one intersection with the face boundary to + //! compute intersections. Each call gives another segment. Standard_EXPORT Standard_Boolean OtherSegment(const gp_Pnt2d& P, gp_Lin2d& L, Standard_Real& Par); //! Starts an exploration of the wires. Standard_EXPORT void InitWires(); - //! Returns True if there is a current wire. + //! Returns True if there is a current wire. Standard_Boolean MoreWires() const; - //! Sets the explorer to the next wire. + //! Sets the explorer to the next wire. void NextWire(); - //! Returns True if the wire bounding volume does not + //! Returns True if the wire bounding volume does not //! intersect the segment. Standard_EXPORT Standard_Boolean RejectWire(const gp_Lin2d& L, const Standard_Real Par) const; - //! Starts an exploration of the edges of the current + //! Starts an exploration of the edges of the current //! wire. Standard_EXPORT void InitEdges(); //! Returns True if there is a current edge. Standard_Boolean MoreEdges() const; - //! Sets the explorer to the next edge. + //! Sets the explorer to the next edge. void NextEdge(); - //! Returns True if the edge bounding volume does not + //! Returns True if the edge bounding volume does not //! intersect the segment. Standard_EXPORT Standard_Boolean RejectEdge(const gp_Lin2d& L, const Standard_Real Par) const; diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FacePassiveClassifier.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FacePassiveClassifier.hxx index d428433ac8..830fabddc5 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FacePassiveClassifier.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_FacePassiveClassifier.hxx @@ -39,14 +39,14 @@ public: //! Creates an undefined classifier. Standard_EXPORT BRepClass_FacePassiveClassifier(); - //! Starts a classification process. The point to - //! classify is the origin of the line .

is - //! the original length of the segment on used to - //! compute intersections. is the tolerance + //! Starts a classification process. The point to + //! classify is the origin of the line .

is + //! the original length of the segment on used to + //! compute intersections. is the tolerance //! attached to the line segment in intersections. Standard_EXPORT void Reset(const gp_Lin2d& L, const Standard_Real P, const Standard_Real Tol); - //! Updates the classification process with the edge + //! Updates the classification process with the edge //! from the boundary. Standard_EXPORT void Compare(const BRepClass_Edge& E, const TopAbs_Orientation Or); @@ -56,9 +56,9 @@ public: //! Returns the intersecting algorithm. BRepClass_Intersector& Intersector(); - //! Returns 0 if the last compared edge had no - //! relevant intersection. Else returns the index of - //! this intersection in the last intersection + //! Returns 0 if the last compared edge had no + //! relevant intersection. Else returns the index of + //! this intersection in the last intersection //! algorithm. Standard_Integer ClosestIntersection() const; diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_Intersector.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_Intersector.hxx index e923101332..2827eddf8d 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_Intersector.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepClass/BRepClass_Intersector.hxx @@ -25,7 +25,7 @@ class gp_Lin2d; class BRepClass_Edge; class gp_Dir2d; -//! Intersect an Edge with a segment. +//! Intersect an Edge with a segment. //! Implement the Intersector2d required by the classifier. class BRepClass_Intersector : public Geom2dInt_IntConicCurveOfGInter { @@ -40,8 +40,8 @@ public: const Standard_Real Tol, const BRepClass_Edge& E); - //! Returns in , and the tangent, normal - //! and curvature of the edge at parameter value + //! Returns in , and the tangent, normal + //! and curvature of the edge at parameter value //! . Standard_EXPORT void LocalGeometry(const BRepClass_Edge& E, const Standard_Real U, diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepClass3d/BRepClass3d_SolidExplorer.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepClass3d/BRepClass3d_SolidExplorer.hxx index d47510a6e3..9263ce0218 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepClass3d/BRepClass3d_SolidExplorer.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepClass3d/BRepClass3d_SolidExplorer.hxx @@ -51,8 +51,8 @@ public: //! Should return True if P outside of bounding vol. of the shape Standard_EXPORT virtual Standard_Boolean Reject(const gp_Pnt& P) const; - //! compute a point P in the face F. Param is a Real in - //! ]0,1[ and is used to initialise the algorithm. For + //! compute a point P in the face F. Param is a Real in + //! ]0,1[ and is used to initialise the algorithm. For //! different values , different points are returned. Standard_EXPORT static Standard_Boolean FindAPointInTheFace(const TopoDS_Face& F, gp_Pnt& P, @@ -102,7 +102,7 @@ public: const Standard_Real u2, const Standard_Real v2) const; - //! gives point index to search from and returns + //! gives point index to search from and returns //! point index of succeseful search Standard_EXPORT Standard_Boolean PointInTheFace(const TopoDS_Face& F, gp_Pnt& P, @@ -148,14 +148,14 @@ public: //! returns True if the face is rejected. Standard_EXPORT virtual Standard_Boolean RejectFace(const gp_Lin& L) const; - //! Returns in , a segment having at least - //! one intersection with the shape boundary to - //! compute intersections. + //! Returns in , a segment having at least + //! one intersection with the shape boundary to + //! compute intersections. Standard_EXPORT Standard_Integer Segment(const gp_Pnt& P, gp_Lin& L, Standard_Real& Par); - //! Returns in , a segment having at least - //! one intersection with the shape boundary to - //! compute intersections. + //! Returns in , a segment having at least + //! one intersection with the shape boundary to + //! compute intersections. //! //! The First Call to this method returns a line which //! point to a point of the first face of the shape. diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepClass3d/BRepClass3d_SolidPassiveClassifier.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepClass3d/BRepClass3d_SolidPassiveClassifier.hxx index 0698c411f8..0554c1e317 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepClass3d/BRepClass3d_SolidPassiveClassifier.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepClass3d/BRepClass3d_SolidPassiveClassifier.hxx @@ -38,14 +38,14 @@ public: //! Creates an undefined classifier. Standard_EXPORT BRepClass3d_SolidPassiveClassifier(); - //! Starts a classification process. The point to - //! classify is the origin of the line .

is - //! the original length of the segment on used to - //! compute intersections. is the tolerance + //! Starts a classification process. The point to + //! classify is the origin of the line .

is + //! the original length of the segment on used to + //! compute intersections. is the tolerance //! attached to the intersections. Standard_EXPORT void Reset(const gp_Lin& L, const Standard_Real P, const Standard_Real Tol); - //! Updates the classification process with the face + //! Updates the classification process with the face //! from the boundary. Standard_EXPORT void Compare(const TopoDS_Face& F, const TopAbs_Orientation Or); diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_DistShapeShape.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_DistShapeShape.hxx index 7afb9d8675..31c74acfe7 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_DistShapeShape.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_DistShapeShape.hxx @@ -26,7 +26,7 @@ #include #include -//! This class provides tools to compute minimum distance +//! This class provides tools to compute minimum distance //! between two Shapes (Compound,CompSolid, Solid, Shell, Face, Wire, Edge, Vertex). class BRepExtrema_DistShapeShape { @@ -37,8 +37,8 @@ public: Standard_EXPORT BRepExtrema_DistShapeShape(); //! create tool and computation of the minimum distance (value and pair of points) - //! using default deflection in single thread mode.
- //! Default deflection value is Precision::Confusion().
+ //! using default deflection in single thread mode. + //! Default deflection value is Precision::Confusion(). //! @param Shape1 - the first shape for distance computation //! @param Shape2 - the second shape for distance computation //! @param F and @param A are not used in computation and are obsolete. @@ -50,8 +50,8 @@ public: const Extrema_ExtAlgo A = Extrema_ExtAlgo_Grad, const Message_ProgressRange& theRange = Message_ProgressRange()); //! create tool and computation of the minimum distance - //! (value and pair of points) in single thread mode.
- //! Default deflection value is Precision::Confusion().
+ //! (value and pair of points) in single thread mode. + //! Default deflection value is Precision::Confusion(). //! @param Shape1 - the first shape for distance computation //! @param Shape2 - the second shape for distance computation //! @param theDeflection - the presition of distance computation @@ -65,98 +65,98 @@ public: const Extrema_ExtAlgo A = Extrema_ExtAlgo_Grad, const Message_ProgressRange& theRange = Message_ProgressRange()); - //! Sets deflection to computation of the minimum distance
+ //! Sets deflection to computation of the minimum distance void SetDeflection(const Standard_Real theDeflection) { myEps = theDeflection; } - //! load first shape into extrema
+ //! load first shape into extrema Standard_EXPORT void LoadS1(const TopoDS_Shape& Shape1); - //! load second shape into extrema
+ //! load second shape into extrema Standard_EXPORT void LoadS2(const TopoDS_Shape& Shape1); - //! computation of the minimum distance (value and
- //! couple of points). Parameter theDeflection is used
- //! to specify a maximum deviation of extreme distances
- //! from the minimum one.
- //! Returns IsDone status.
+ //! computation of the minimum distance (value and + //! couple of points). Parameter theDeflection is used + //! to specify a maximum deviation of extreme distances + //! from the minimum one. + //! Returns IsDone status. //! theRange - the progress indicator of algorithm Standard_EXPORT Standard_Boolean Perform(const Message_ProgressRange& theRange = Message_ProgressRange()); - //! True if the minimum distance is found.
+ //! True if the minimum distance is found. Standard_Boolean IsDone() const { return myIsDone; } - //! Returns the number of solutions satisfying the minimum distance.
+ //! Returns the number of solutions satisfying the minimum distance. Standard_Integer NbSolution() const { return mySolutionsShape1.Length(); } - //! Returns the value of the minimum distance.
+ //! Returns the value of the minimum distance. Standard_EXPORT Standard_Real Value() const; - //! True if one of the shapes is a solid and the other shape
- //! is completely or partially inside the solid.
+ //! True if one of the shapes is a solid and the other shape + //! is completely or partially inside the solid. Standard_Boolean InnerSolution() const { return myInnerSol; } - //! Returns the Point corresponding to the th solution on the first Shape
+ //! Returns the Point corresponding to the th solution on the first Shape const gp_Pnt& PointOnShape1(const Standard_Integer N) const { return mySolutionsShape1.Value(N).Point(); } - //! Returns the Point corresponding to the th solution on the second Shape
+ //! Returns the Point corresponding to the th solution on the second Shape const gp_Pnt& PointOnShape2(const Standard_Integer N) const { return mySolutionsShape2.Value(N).Point(); } - //! gives the type of the support where the Nth solution on the first shape is situated:
- //! IsVertex => the Nth solution on the first shape is a Vertex
- //! IsOnEdge => the Nth soluion on the first shape is on a Edge
- //! IsInFace => the Nth solution on the first shape is inside a face
- //! the corresponding support is obtained by the method SupportOnShape1
+ //! gives the type of the support where the Nth solution on the first shape is situated: + //! IsVertex => the Nth solution on the first shape is a Vertex + //! IsOnEdge => the Nth soluion on the first shape is on a Edge + //! IsInFace => the Nth solution on the first shape is inside a face + //! the corresponding support is obtained by the method SupportOnShape1 BRepExtrema_SupportType SupportTypeShape1(const Standard_Integer N) const { return mySolutionsShape1.Value(N).SupportKind(); } - //! gives the type of the support where the Nth solution on the second shape is situated:
- //! IsVertex => the Nth solution on the second shape is a Vertex
- //! IsOnEdge => the Nth soluion on the secondt shape is on a Edge
- //! IsInFace => the Nth solution on the second shape is inside a face
- //! the corresponding support is obtained by the method SupportOnShape2
+ //! gives the type of the support where the Nth solution on the second shape is situated: + //! IsVertex => the Nth solution on the second shape is a Vertex + //! IsOnEdge => the Nth soluion on the secondt shape is on a Edge + //! IsInFace => the Nth solution on the second shape is inside a face + //! the corresponding support is obtained by the method SupportOnShape2 BRepExtrema_SupportType SupportTypeShape2(const Standard_Integer N) const { return mySolutionsShape2.Value(N).SupportKind(); } - //! gives the support where the Nth solution on the first shape is situated.
- //! This support can be a Vertex, an Edge or a Face.
+ //! gives the support where the Nth solution on the first shape is situated. + //! This support can be a Vertex, an Edge or a Face. Standard_EXPORT TopoDS_Shape SupportOnShape1(const Standard_Integer N) const; - //! gives the support where the Nth solution on the second shape is situated.
- //! This support can be a Vertex, an Edge or a Face.
+ //! gives the support where the Nth solution on the second shape is situated. + //! This support can be a Vertex, an Edge or a Face. Standard_EXPORT TopoDS_Shape SupportOnShape2(const Standard_Integer N) const; - //! gives the corresponding parameter t if the Nth solution
- //! is situated on an Edge of the first shape
+ //! gives the corresponding parameter t if the Nth solution + //! is situated on an Edge of the first shape Standard_EXPORT void ParOnEdgeS1(const Standard_Integer N, Standard_Real& t) const; - //! gives the corresponding parameter t if the Nth solution
- //! is situated on an Edge of the first shape
+ //! gives the corresponding parameter t if the Nth solution + //! is situated on an Edge of the first shape Standard_EXPORT void ParOnEdgeS2(const Standard_Integer N, Standard_Real& t) const; - //! gives the corresponding parameters (U,V) if the Nth solution
- //! is situated on an face of the first shape
+ //! gives the corresponding parameters (U,V) if the Nth solution + //! is situated on an face of the first shape Standard_EXPORT void ParOnFaceS1(const Standard_Integer N, Standard_Real& u, Standard_Real& v) const; - //! gives the corresponding parameters (U,V) if the Nth solution
- //! is situated on an Face of the second shape
+ //! gives the corresponding parameters (U,V) if the Nth solution + //! is situated on an Face of the second shape Standard_EXPORT void ParOnFaceS2(const Standard_Integer N, Standard_Real& u, Standard_Real& v) const; - //! Prints on the stream o information on the current state of the object.
+ //! Prints on the stream o information on the current state of the object. Standard_EXPORT void Dump(Standard_OStream& o) const; //! Sets unused parameter @@ -175,14 +175,14 @@ public: Standard_Boolean IsMultiThread() const { return myIsMultiThread; } private: - //! computes the minimum distance between two maps of shapes (Face,Edge,Vertex)
+ //! computes the minimum distance between two maps of shapes (Face,Edge,Vertex) Standard_Boolean DistanceMapMap(const TopTools_IndexedMapOfShape& Map1, const TopTools_IndexedMapOfShape& Map2, const Bnd_Array1OfBox& LBox1, const Bnd_Array1OfBox& LBox2, const Message_ProgressRange& theRange); - //! computes the minimum distance between two maps of vertices
+ //! computes the minimum distance between two maps of vertices Standard_Boolean DistanceVertVert(const TopTools_IndexedMapOfShape& theMap1, const TopTools_IndexedMapOfShape& theMap2, const Message_ProgressRange& theRange); diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtCC.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtCC.hxx index c531052b3a..3ebfd62070 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtCC.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtCC.hxx @@ -28,37 +28,37 @@ public: BRepExtrema_ExtCC() {} - //! It calculates all the distances.
+ //! It calculates all the distances. Standard_EXPORT BRepExtrema_ExtCC(const TopoDS_Edge& E1, const TopoDS_Edge& E2); Standard_EXPORT void Initialize(const TopoDS_Edge& E2); - //! An exception is raised if the fields have not been initialized.
+ //! An exception is raised if the fields have not been initialized. Standard_EXPORT void Perform(const TopoDS_Edge& E1); - //! True if the distances are found.
+ //! True if the distances are found. Standard_Boolean IsDone() const { return myExtCC.IsDone(); } - //! Returns the number of extremum distances.
+ //! Returns the number of extremum distances. Standard_Integer NbExt() const { return myExtCC.NbExt(); } - //! Returns True if E1 and E2 are parallel.
+ //! Returns True if E1 and E2 are parallel. Standard_Boolean IsParallel() const { return myExtCC.IsParallel(); } - //! Returns the value of the th extremum square distance.
+ //! Returns the value of the th extremum square distance. Standard_Real SquareDistance(const Standard_Integer N) const { return myExtCC.SquareDistance(N); } - //! Returns the parameter on the first edge of the th extremum distance.
+ //! Returns the parameter on the first edge of the th extremum distance. Standard_EXPORT Standard_Real ParameterOnE1(const Standard_Integer N) const; - //! Returns the Point of the th extremum distance on the edge E1.
+ //! Returns the Point of the th extremum distance on the edge E1. Standard_EXPORT gp_Pnt PointOnE1(const Standard_Integer N) const; - //! Returns the parameter on the second edge of the th extremum distance.
+ //! Returns the parameter on the second edge of the th extremum distance. Standard_EXPORT Standard_Real ParameterOnE2(const Standard_Integer N) const; - //! Returns the Point of the th extremum distance on the edge E2.
+ //! Returns the Point of the th extremum distance on the edge E2. Standard_EXPORT gp_Pnt PointOnE2(const Standard_Integer N) const; - //! if the edges is a trimmed curve,
- //! dist11 is a square distance between the point on E1
- //! of parameter FirstParameter and the point of
- //! parameter FirstParameter on E2.
+ //! if the edges is a trimmed curve, + //! dist11 is a square distance between the point on E1 + //! of parameter FirstParameter and the point of + //! parameter FirstParameter on E2. Standard_EXPORT void TrimmedSquareDistances(Standard_Real& dist11, Standard_Real& distP12, Standard_Real& distP21, diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtCF.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtCF.hxx index a916fa4d5e..49751cd462 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtCF.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtCF.hxx @@ -33,42 +33,42 @@ public: BRepExtrema_ExtCF() {} - //! It calculates all the distances.
+ //! It calculates all the distances. Standard_EXPORT BRepExtrema_ExtCF(const TopoDS_Edge& E, const TopoDS_Face& F); Standard_EXPORT void Initialize(const TopoDS_Edge& E, const TopoDS_Face& F); - //! An exception is raised if the fields have not been initialized.
- //! Be careful: this method uses the Face only for classify not for the fields.
+ //! An exception is raised if the fields have not been initialized. + //! Be careful: this method uses the Face only for classify not for the fields. Standard_EXPORT void Perform(const TopoDS_Edge& E, const TopoDS_Face& F); - //! True if the distances are found.
+ //! True if the distances are found. Standard_Boolean IsDone() const { return myExtCS.IsDone(); } - //! Returns the number of extremum distances.
+ //! Returns the number of extremum distances. Standard_Integer NbExt() const { return mySqDist.Length(); } - //! Returns the value of the th extremum square distance.
+ //! Returns the value of the th extremum square distance. Standard_Real SquareDistance(const Standard_Integer N) const { return mySqDist.Value(N); } - //! Returns True if the curve is on a parallel surface.
+ //! Returns True if the curve is on a parallel surface. Standard_Boolean IsParallel() const { return myExtCS.IsParallel(); } - //! Returns the parameters on the Edge of the th extremum distance.
+ //! Returns the parameters on the Edge of the th extremum distance. Standard_Real ParameterOnEdge(const Standard_Integer N) const { return myPointsOnC.Value(N).Parameter(); } - //! Returns the parameters on the Face of the th extremum distance.
+ //! Returns the parameters on the Face of the th extremum distance. void ParameterOnFace(const Standard_Integer N, Standard_Real& U, Standard_Real& V) const { myPointsOnS.Value(N).Parameter(U, V); } - //! Returns the Point of the th extremum distance.
+ //! Returns the Point of the th extremum distance. gp_Pnt PointOnEdge(const Standard_Integer N) const { return myPointsOnC.Value(N).Value(); } - //! Returns the Point of the th extremum distance.
+ //! Returns the Point of the th extremum distance. gp_Pnt PointOnFace(const Standard_Integer N) const { return myPointsOnS.Value(N).Value(); } private: diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtFF.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtFF.hxx index ed1e55f07b..58267e07a6 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtFF.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtFF.hxx @@ -30,42 +30,42 @@ public: BRepExtrema_ExtFF() {} - //! It calculates all the distances.
+ //! It calculates all the distances. Standard_EXPORT BRepExtrema_ExtFF(const TopoDS_Face& F1, const TopoDS_Face& F2); Standard_EXPORT void Initialize(const TopoDS_Face& F2); - //! An exception is raised if the fields have not been initialized.
- //! Be careful: this method uses the Face F2 only for classify, not for the fields.
+ //! An exception is raised if the fields have not been initialized. + //! Be careful: this method uses the Face F2 only for classify, not for the fields. Standard_EXPORT void Perform(const TopoDS_Face& F1, const TopoDS_Face& F2); - //! True if the distances are found.
+ //! True if the distances are found. Standard_Boolean IsDone() const { return myExtSS.IsDone(); } - //! Returns True if the surfaces are parallel.
+ //! Returns True if the surfaces are parallel. Standard_Boolean IsParallel() const { return myExtSS.IsParallel(); } - //! Returns the number of extremum distances.
+ //! Returns the number of extremum distances. Standard_Integer NbExt() const { return mySqDist.Length(); } - //! Returns the value of the th extremum square distance.
+ //! Returns the value of the th extremum square distance. Standard_Real SquareDistance(const Standard_Integer N) const { return mySqDist.Value(N); } - //! Returns the parameters on the Face F1 of the th extremum distance.
+ //! Returns the parameters on the Face F1 of the th extremum distance. void ParameterOnFace1(const Standard_Integer N, Standard_Real& U, Standard_Real& V) const { myPointsOnS1.Value(N).Parameter(U, V); } - //! Returns the parameters on the Face F2 of the th extremum distance.
+ //! Returns the parameters on the Face F2 of the th extremum distance. void ParameterOnFace2(const Standard_Integer N, Standard_Real& U, Standard_Real& V) const { myPointsOnS2.Value(N).Parameter(U, V); } - //! Returns the Point of the th extremum distance.
+ //! Returns the Point of the th extremum distance. gp_Pnt PointOnFace1(const Standard_Integer N) const { return myPointsOnS1.Value(N).Value(); } - //! Returns the Point of the th extremum distance.
+ //! Returns the Point of the th extremum distance. gp_Pnt PointOnFace2(const Standard_Integer N) const { return myPointsOnS2.Value(N).Value(); } private: diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtPC.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtPC.hxx index cefeb7895b..198286745c 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtPC.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtPC.hxx @@ -28,36 +28,36 @@ public: BRepExtrema_ExtPC() {} - //! It calculates all the distances.
+ //! It calculates all the distances. Standard_EXPORT BRepExtrema_ExtPC(const TopoDS_Vertex& V, const TopoDS_Edge& E); Standard_EXPORT void Initialize(const TopoDS_Edge& E); - //! An exception is raised if the fields have not been initialized.
+ //! An exception is raised if the fields have not been initialized. Standard_EXPORT void Perform(const TopoDS_Vertex& V); - //! True if the distances are found.
+ //! True if the distances are found. Standard_Boolean IsDone() const { return myExtPC.IsDone(); } - //! Returns the number of extremum distances.
+ //! Returns the number of extremum distances. Standard_Integer NbExt() const { return myExtPC.NbExt(); } - //! Returns True if the th extremum distance is a minimum.
+ //! Returns True if the th extremum distance is a minimum. Standard_Boolean IsMin(const Standard_Integer N) const { return myExtPC.IsMin(N); } - //! Returns the value of the th extremum square distance.
+ //! Returns the value of the th extremum square distance. Standard_Real SquareDistance(const Standard_Integer N) const { return myExtPC.SquareDistance(N); } - //! Returns the parameter on the edge of the th extremum distance.
+ //! Returns the parameter on the edge of the th extremum distance. Standard_Real Parameter(const Standard_Integer N) const { return myExtPC.Point(N).Parameter(); } - //! Returns the Point of the th extremum distance.
+ //! Returns the Point of the th extremum distance. gp_Pnt Point(const Standard_Integer N) const { return myExtPC.Point(N).Value(); } - //! if the curve is a trimmed curve,
- //! dist1 is a square distance between

and the point
- //! of parameter FirstParameter and
- //! dist2 is a square distance between

and the point
- //! of parameter LastParameter .
+ //! if the curve is a trimmed curve, + //! dist1 is a square distance between

and the point + //! of parameter FirstParameter and + //! dist2 is a square distance between

and the point + //! of parameter LastParameter . void TrimmedSquareDistances(Standard_Real& dist1, Standard_Real& dist2, gp_Pnt& pnt1, diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtPF.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtPF.hxx index 50622a6cbb..f900644e6b 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtPF.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepExtrema/BRepExtrema_ExtPF.hxx @@ -31,7 +31,7 @@ public: BRepExtrema_ExtPF() {} - //! It calculates all the distances.
+ //! It calculates all the distances. Standard_EXPORT BRepExtrema_ExtPF(const TopoDS_Vertex& TheVertex, const TopoDS_Face& TheFace, const Extrema_ExtFlag TheFlag = Extrema_ExtFlag_MINMAX, @@ -41,26 +41,26 @@ public: const Extrema_ExtFlag TheFlag = Extrema_ExtFlag_MINMAX, const Extrema_ExtAlgo TheAlgo = Extrema_ExtAlgo_Grad); - //! An exception is raised if the fields have not been initialized.
- //! Be careful: this method uses the Face only for classify not for the fields.
+ //! An exception is raised if the fields have not been initialized. + //! Be careful: this method uses the Face only for classify not for the fields. Standard_EXPORT void Perform(const TopoDS_Vertex& TheVertex, const TopoDS_Face& TheFace); - //! True if the distances are found.
+ //! True if the distances are found. Standard_Boolean IsDone() const { return myExtPS.IsDone(); } - //! Returns the number of extremum distances.
+ //! Returns the number of extremum distances. Standard_Integer NbExt() const { return myPoints.Length(); } - //! Returns the value of the th extremum square distance.
+ //! Returns the value of the th extremum square distance. Standard_Real SquareDistance(const Standard_Integer N) const { return mySqDist.Value(N); } - //! Returns the parameters on the Face of the th extremum distance.
+ //! Returns the parameters on the Face of the th extremum distance. void Parameter(const Standard_Integer N, Standard_Real& U, Standard_Real& V) const { myPoints.Value(N).Parameter(U, V); } - //! Returns the Point of the th extremum distance.
+ //! Returns the Point of the th extremum distance. gp_Pnt Point(const Standard_Integer N) const { return myPoints.Value(N).Value(); } void SetFlag(const Extrema_ExtFlag F) { myExtPS.SetFlag(F); } diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Cinert.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Cinert.hxx index 08891e0eaf..9ec670b295 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Cinert.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Cinert.hxx @@ -24,7 +24,7 @@ class BRepAdaptor_Curve; class gp_Pnt; -//! Computes the global properties of bounded curves +//! Computes the global properties of bounded curves //! in 3D space. The curve must have at least a continuity C1. //! It can be a curve as defined in the template CurveTool from //! package GProp. This template gives the minimum of methods diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_EdgeTool.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_EdgeTool.hxx index 3c87befd96..62acefd7d1 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_EdgeTool.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_EdgeTool.hxx @@ -27,7 +27,7 @@ class BRepAdaptor_Curve; class gp_Pnt; class gp_Vec; -//! Provides the required methods to instantiate +//! Provides the required methods to instantiate //! CGProps from GProp with a Curve from BRepAdaptor. class BRepGProp_EdgeTool { @@ -35,18 +35,18 @@ public: DEFINE_STANDARD_ALLOC //! Returns the parametric value of the start point of - //! the curve. The curve is oriented from the start point + //! the curve. The curve is oriented from the start point //! to the end point. Standard_EXPORT static Standard_Real FirstParameter(const BRepAdaptor_Curve& C); //! Returns the parametric value of the end point of - //! the curve. The curve is oriented from the start point + //! the curve. The curve is oriented from the start point //! to the end point. Standard_EXPORT static Standard_Real LastParameter(const BRepAdaptor_Curve& C); //! Returns the number of Gauss points required to do //! the integration with a good accuracy using the - //! Gauss method. For a polynomial curve of degree n + //! Gauss method. For a polynomial curve of degree n //! the maxima of accuracy is obtained with an order //! of integration equal to 2*n-1. Standard_EXPORT static Standard_Integer IntegrationOrder(const BRepAdaptor_Curve& C); @@ -61,15 +61,15 @@ public: gp_Pnt& P, gp_Vec& V1); - //! Returns the number of intervals for continuity + //! Returns the number of intervals for continuity //! . May be one if Continuity(me) >= Standard_EXPORT static Standard_Integer NbIntervals(const BRepAdaptor_Curve& C, const GeomAbs_Shape S); - //! Stores in the parameters bounding the intervals + //! Stores in the parameters bounding the intervals //! of continuity . //! - //! The array must provide enough room to accommodate + //! The array must provide enough room to accommodate //! for the parameters. i.e. T.Length() > NbIntervals() Standard_EXPORT static void Intervals(const BRepAdaptor_Curve& C, TColStd_Array1OfReal& T, diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_MeshCinert.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_MeshCinert.hxx index 838610d7a5..0c1634e13f 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_MeshCinert.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_MeshCinert.hxx @@ -22,8 +22,8 @@ class gp_Pnt; class TopoDS_Edge; -//! Computes the global properties of -//! of polylines represented by set of points. +//! Computes the global properties of +//! of polylines represented by set of points. //! This class is used for computation of global //! properties of edge, which has no exact geometry //! (3d or 2d curve), but has any of allowed @@ -38,8 +38,8 @@ public: Standard_EXPORT void SetLocation(const gp_Pnt& CLocation); - //! Computes the global properties of - //! of polylines represented by set of points. + //! Computes the global properties of + //! of polylines represented by set of points. Standard_EXPORT void Perform(const TColgp_Array1OfPnt& theNodes); //! Prepare set of 3d points on base of any available edge polygons: diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Sinert.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Sinert.hxx index 7491bef0dc..f944103333 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Sinert.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Sinert.hxx @@ -65,7 +65,7 @@ public: const Standard_Real Eps); //! If previously used method contained Eps parameter - //! get actual relative error of the computation, else return 1.0. + //! get actual relative error of the computation, else return 1.0. Standard_EXPORT Standard_Real GetEpsilon(); protected: diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_TFunction.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_TFunction.hxx index 2394c8b62f..e513d17029 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_TFunction.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_TFunction.hxx @@ -76,7 +76,7 @@ public: //! parameter is directly passed to the UFunction. void SetValueType(const GProp_ValueType aType); - //! Setting the tolerance for inner integration + //! Setting the tolerance for inner integration void SetTolerance(const Standard_Real aTol); //! Returns the relative reached error of all values computation since @@ -93,7 +93,7 @@ public: Standard_EXPORT virtual Standard_Boolean Value(const Standard_Real X, Standard_Real& F) Standard_OVERRIDE; - //! Redefined method. Remembers the error reached during + //! Redefined method. Remembers the error reached during //! computation of integral values since the object creation //! or the last call of GetStateNumber. It is invoked in each //! algorithm from the package math. Particularly in the diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Vinert.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Vinert.hxx index 85da1c66fc..75a1f5ad60 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Vinert.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepGProp/BRepGProp_Vinert.hxx @@ -50,7 +50,7 @@ public: //! The method is quick and its precision is enough for many cases of analytical //! surfaces. //! Non-adaptive 2D Gauss integration with predefined numbers of Gauss points - //! is used. Numbers of points depend on types of surfaces and curves. + //! is used. Numbers of points depend on types of surfaces and curves. //! Error of the computation is not calculated. Standard_EXPORT BRepGProp_Vinert(const BRepGProp_Face& S, const gp_Pnt& VLocation); @@ -69,7 +69,7 @@ public: //! The method is quick and its precision is enough for many cases of analytical //! surfaces. //! Non-adaptive 2D Gauss integration with predefined numbers of Gauss points - //! is used. Numbers of points depend on types of surfaces and curves. + //! is used. Numbers of points depend on types of surfaces and curves. //! Error of the computation is not calculated. Standard_EXPORT BRepGProp_Vinert(const BRepGProp_Face& S, const gp_Pnt& O, @@ -92,7 +92,7 @@ public: //! The method is quick and its precision is enough for many cases of analytical //! surfaces. //! Non-adaptive 2D Gauss integration with predefined numbers of Gauss points - //! is used. Numbers of points depend on types of surfaces and curves. + //! is used. Numbers of points depend on types of surfaces and curves. //! Error of the computation is not calculated. Standard_EXPORT BRepGProp_Vinert(const BRepGProp_Face& S, const gp_Pln& Pl, @@ -115,7 +115,7 @@ public: //! The method is quick and its precision is enough for many cases of analytical //! surfaces. //! Non-adaptive 2D Gauss integration with predefined numbers of Gauss points - //! is used. Numbers of points depend on types of surfaces and curves. + //! is used. Numbers of points depend on types of surfaces and curves. //! Error of the computation is not calculated. Standard_EXPORT BRepGProp_Vinert(BRepGProp_Face& S, BRepGProp_Domain& D, const gp_Pnt& VLocation); @@ -135,7 +135,7 @@ public: //! The method is quick and its precision is enough for many cases of analytical //! surfaces. //! Non-adaptive 2D Gauss integration with predefined numbers of Gauss points - //! is used. Numbers of points depend on types of surfaces and curves. + //! is used. Numbers of points depend on types of surfaces and curves. //! Error of the computation is not calculated. Standard_EXPORT BRepGProp_Vinert(BRepGProp_Face& S, BRepGProp_Domain& D, @@ -160,7 +160,7 @@ public: //! The method is quick and its precision is enough for many cases of analytical //! surfaces. //! Non-adaptive 2D Gauss integration with predefined numbers of Gauss points - //! is used. Numbers of points depend on types of surfaces and curves. + //! is used. Numbers of points depend on types of surfaces and curves. //! Error of the computation is not calculated. Standard_EXPORT BRepGProp_Vinert(BRepGProp_Face& S, BRepGProp_Domain& D, @@ -218,8 +218,8 @@ public: const gp_Pln& Pl, const Standard_Real Eps); - //! If previously used methods containe Eps parameter - //! gets actual relative error of the computation, else returns 1.0. + //! If previously used methods contain Eps parameter + //! gets actual relative error of the computation, else returns 1.0. Standard_EXPORT Standard_Real GetEpsilon(); protected: diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepIntCurveSurface/BRepIntCurveSurface_Inter.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepIntCurveSurface/BRepIntCurveSurface_Inter.hxx index ef49cceac0..991e4214b4 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepIntCurveSurface/BRepIntCurveSurface_Inter.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepIntCurveSurface/BRepIntCurveSurface_Inter.hxx @@ -46,7 +46,7 @@ class TopoDS_Face; //! for( i =1; i <= nbCurves;i++) //! { //! Inter.Init(curve); -//! for( ;Inter.More(); Inter.Next()) +//! for( ;Inter.More(); Inter.Next()) //! { //! ....... //! } diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib.hxx index af82fe5c3e..324b642352 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib.hxx @@ -52,7 +52,7 @@ public: //! Computes the max distance between edge //! and its 2d representation on the face. - //! Sets the default precision. The current Precision + //! Sets the default precision. The current Precision //! is returned. Standard_EXPORT static void Precision(const Standard_Real P); @@ -83,9 +83,9 @@ public: Standard_EXPORT static void SameRange(const TopoDS_Edge& E, const Standard_Real Tolerance = 1.0e-5); - //! Computes the 3d curve for the edge if it does - //! not exist. Returns True if the curve was computed - //! or existed. Returns False if there is no planar + //! Computes the 3d curve for the edge if it does + //! not exist. Returns True if the curve was computed + //! or existed. Returns False if there is no planar //! pcurve or the computation failed. //! >= 30 in approximation Standard_EXPORT static Standard_Boolean BuildCurve3d(const TopoDS_Edge& E, @@ -94,7 +94,7 @@ public: const Standard_Integer MaxDegree = 14, const Standard_Integer MaxSegment = 0); - //! Computes the 3d curves for all the edges of + //! Computes the 3d curves for all the edges of //! return False if one of the computation failed. //! >= 30 in approximation Standard_EXPORT static Standard_Boolean BuildCurves3d(const TopoDS_Shape& S, @@ -103,7 +103,7 @@ public: const Standard_Integer MaxDegree = 14, const Standard_Integer MaxSegment = 0); - //! Computes the 3d curves for all the edges of + //! Computes the 3d curves for all the edges of //! return False if one of the computation failed. Standard_EXPORT static Standard_Boolean BuildCurves3d(const TopoDS_Shape& S); @@ -130,43 +130,43 @@ public: } } - //! Checks if the edge has a Tolerance smaller than -- -- - //! -- -- MaxToleranceToCheck if so it will compute the - //! radius of -- the cylindrical pipe surface that + //! Checks if the edge has a Tolerance smaller than + //! MaxToleranceToCheck if so it will compute the + //! radius of the cylindrical pipe surface that //! MinToleranceRequest is the minimum tolerance before it //! is useful to start testing. //! Usually it should be around 10e-5 - //! contains all -- the curve representation of the edge + //! contains all the curve representation of the edge //! returns True if the Edge tolerance had to be updated Standard_EXPORT static Standard_Boolean UpdateEdgeTol(const TopoDS_Edge& E, const Standard_Real MinToleranceRequest, const Standard_Real MaxToleranceToCheck); - //! -- Checks all the edges of the shape whose -- -- -- - //! Tolerance is smaller than MaxToleranceToCheck -- - //! Returns True if at least one edge was updated -- + //! Checks all the edges of the shape whose + //! Tolerance is smaller than MaxToleranceToCheck + //! Returns True if at least one edge was updated //! MinToleranceRequest is the minimum tolerance before - //! -- it -- is useful to start testing. - //! Usually it should be around -- 10e-5-- + //! it is useful to start testing. + //! Usually it should be around 10e-5 //! - //! Warning :The method is very slow as it checks all. - //! Use only in interfaces or processing assimilate batch + //! Warning: The method is very slow as it checks all. + //! Use only in interfaces or processing assimilate batch Standard_EXPORT static Standard_Boolean UpdateEdgeTolerance( const TopoDS_Shape& S, const Standard_Real MinToleranceRequest, const Standard_Real MaxToleranceToCheck); - //! Computes new 2d curve(s) for the edge to have - //! the same parameter as the 3d curve. + //! Computes new 2d curve(s) for the edge to have + //! the same parameter as the 3d curve. //! The algorithm is not done if the flag SameParameter - //! was True on the Edge. + //! was True on the Edge. Standard_EXPORT static void SameParameter(const TopoDS_Edge& theEdge, const Standard_Real Tolerance = 1.0e-5); - //! Computes new 2d curve(s) for the edge to have - //! the same parameter as the 3d curve. + //! Computes new 2d curve(s) for the edge to have + //! the same parameter as the 3d curve. //! The algorithm is not done if the flag SameParameter - //! was True on the Edge.
+ //! was True on the Edge. //! theNewTol is a new tolerance of vertices of the input edge //! (not applied inside the algorithm, but pre-computed). //! If IsUseOldEdge is true then the input edge will be modified, @@ -177,18 +177,18 @@ public: Standard_Real& theNewTol, const Standard_Boolean IsUseOldEdge); - //! Computes new 2d curve(s) for all the edges of - //! to have the same parameter as the 3d curve. + //! Computes new 2d curve(s) for all the edges of + //! to have the same parameter as the 3d curve. //! The algorithm is not done if the flag SameParameter - //! was True on an Edge. + //! was True on an Edge. Standard_EXPORT static void SameParameter(const TopoDS_Shape& S, const Standard_Real Tolerance = 1.0e-5, const Standard_Boolean forced = Standard_False); - //! Computes new 2d curve(s) for all the edges of - //! to have the same parameter as the 3d curve. + //! Computes new 2d curve(s) for all the edges of + //! to have the same parameter as the 3d curve. //! The algorithm is not done if the flag SameParameter - //! was True on an Edge.
+ //! was True on an Edge. //! theReshaper is used to record the modifications of input shape to prevent any //! modifications on the shape itself. //! Thus the input shape (and its subshapes) will not be modified, instead the reshaper will @@ -198,7 +198,7 @@ public: const Standard_Real Tolerance = 1.0e-5, const Standard_Boolean forced = Standard_False); - //! Replaces tolerance of FACE EDGE VERTEX by the + //! Replaces tolerance of FACE EDGE VERTEX by the //! tolerance Max of their connected handling shapes. //! It is not necessary to use this call after //! SameParameter. (called in) @@ -206,10 +206,10 @@ public: const TopoDS_Shape& S, const Standard_Boolean verifyFaceTolerance = Standard_False); - //! Replaces tolerance of FACE EDGE VERTEX by the + //! Replaces tolerance of FACE EDGE VERTEX by the //! tolerance Max of their connected handling shapes. //! It is not necessary to use this call after - //! SameParameter. (called in)
+ //! SameParameter. (called in) //! theReshaper is used to record the modifications of input shape to prevent any //! modifications on the shape itself. //! Thus the input shape (and its subshapes) will not be modified, instead the reshaper will @@ -223,8 +223,8 @@ public: //! of a shape and updates them to satisfy "SameParameter" condition Standard_EXPORT static void UpdateInnerTolerances(const TopoDS_Shape& S); - //! Orients the solid forward and the shell with the - //! orientation to have matter in the solid. Returns + //! Orients the solid forward and the shell with the + //! orientation to have matter in the solid. Returns //! False if the solid is unOrientable (open or incoherent) Standard_EXPORT static Standard_Boolean OrientClosedSolid(TopoDS_Solid& solid); @@ -259,13 +259,13 @@ public: const TopoDS_Face& F2, const Standard_Real TolAng = 1.0e-10); - //! Sorts in LF the Faces of S on the complexity of - //! their surfaces + //! Sorts in LF the Faces of S on the complexity of + //! their surfaces //! (Plane,Cylinder,Cone,Sphere,Torus,other) Standard_EXPORT static void SortFaces(const TopoDS_Shape& S, TopTools_ListOfShape& LF); - //! Sorts in LF the Faces of S on the reverse - //! complexity of their surfaces + //! Sorts in LF the Faces of S on the reverse + //! complexity of their surfaces //! (other,Torus,Sphere,Cone,Cylinder,Plane) Standard_EXPORT static void ReverseSortFaces(const TopoDS_Shape& S, TopTools_ListOfShape& LF); diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeFace.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeFace.hxx index 57370dbe6e..5a21fd7fe3 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeFace.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeFace.hxx @@ -52,7 +52,7 @@ class Geom_Curve; //! * From a surface and a wire. //! //! - A flag Inside is given, when this flag is True -//! the wire is oriented to bound a finite area on +//! the wire is oriented to bound a finite area on //! the surface. //! //! * From a face and a wire. @@ -176,7 +176,7 @@ public: //! Load the face. Standard_EXPORT void Init(const TopoDS_Face& F); - //! Creates the face from the surface. If Bound is + //! Creates the face from the surface. If Bound is //! True a wire is made from the natural bounds. //! Accepts tolerance value (TolDegen) for resolution //! of degenerated edges. @@ -214,7 +214,7 @@ public: protected: private: - //! Reorient the current face if the boundary is not + //! Reorient the current face if the boundary is not //! finite. Standard_EXPORT void CheckInside(); diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakePolygon.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakePolygon.hxx index 053c6944c0..68c691d6ad 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakePolygon.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakePolygon.hxx @@ -38,8 +38,8 @@ class TopoDS_Wire; //! //! - any number of vertices. //! -//! When a point or vertex is added to the polygon if -//! it is identic to the previous point no edge is +//! When a point or vertex is added to the polygon if +//! it is identic to the previous point no edge is //! built. The method added can be used to test it. class BRepLib_MakePolygon : public BRepLib_MakeShape { @@ -79,7 +79,7 @@ public: Standard_EXPORT void Add(const TopoDS_Vertex& V); - //! Returns True if the last vertex or point was + //! Returns True if the last vertex or point was //! successfully added. Standard_EXPORT Standard_Boolean Added() const; diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeShape.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeShape.hxx index 2aef995900..030beb99e1 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeShape.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeShape.hxx @@ -28,17 +28,17 @@ class TopoDS_Face; class TopoDS_Edge; -//! This is the root class for all shape -//! constructions. It stores the result. +//! This is the root class for all shape +//! constructions. It stores the result. //! -//! It provides deferred methods to trace the history +//! It provides deferred methods to trace the history //! of sub-shapes. class BRepLib_MakeShape : public BRepLib_Command { public: DEFINE_STANDARD_ALLOC - //! This is called by Shape(). It does nothing but + //! This is called by Shape(). It does nothing but //! may be redefined. Standard_EXPORT void Build(); diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeShell.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeShell.hxx index 6232fe2e77..4b990c9785 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeShell.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeShell.hxx @@ -49,7 +49,7 @@ public: const Standard_Real VMax, const Standard_Boolean Segment = Standard_False); - //! Creates the shell from the surface and the min-max + //! Creates the shell from the surface and the min-max //! values. Standard_EXPORT void Init(const Handle(Geom_Surface)& S, const Standard_Real UMin, diff --git a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeSolid.hxx b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeSolid.hxx index 8d4d30beb6..59fbbe40fa 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeSolid.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/BRepLib/BRepLib_MakeSolid.hxx @@ -27,7 +27,7 @@ class TopoDS_Shell; class TopoDS_Solid; class TopoDS_Face; -//! Makes a solid from compsolid or shells. +//! Makes a solid from compsolid or shells. class BRepLib_MakeSolid : public BRepLib_MakeShape { public: diff --git a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_Bisec.hxx b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_Bisec.hxx index 5e11978add..dddf34cc42 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_Bisec.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_Bisec.hxx @@ -33,9 +33,9 @@ class Geom2d_Point; //! defined by the two vectors , and . //! //! Definition of the domain: -//! if is true the bisecting line is contained in the sector +//! if is true the bisecting line is contained in the sector //! defined by <-V1> and <-V2> in the sense indirect. -//! if is false the bisecting line is contained in the sector +//! if is false the bisecting line is contained in the sector //! defined by <-V1> and <-V2> in the sense direct. //! //! is used to define degenerate bisector. @@ -45,7 +45,7 @@ class Geom2d_Point; //! if the bisector is a parabola on the focal length is smaller than //! , the bisector is replaced by a semi_line corresponding //! to the axe of symmetry of the parabola. -//! if the bisector is an ellipse and the minor radius is smaller than +//! if the bisector is an ellipse and the minor radius is smaller than //! , the bisector is replaced by a segment corresponding //! to the great axe of the ellipse. class Bisector_Bisec @@ -55,7 +55,7 @@ public: Standard_EXPORT Bisector_Bisec(); - //! Performs the bisecting line between the curves + //! Performs the bisecting line between the curves //! and . //! is True if the point

is common to //! and . @@ -69,7 +69,7 @@ public: const Standard_Real Tolerance, const Standard_Boolean oncurve = Standard_True); - //! Performs the bisecting line between the curve + //! Performs the bisecting line between the curve //! and the point . //! is True if the point

is the point . Standard_EXPORT void Perform(const Handle(Geom2d_Curve)& Cu, @@ -81,7 +81,7 @@ public: const Standard_Real Tolerance, const Standard_Boolean oncurve = Standard_True); - //! Performs the bisecting line between the curve + //! Performs the bisecting line between the curve //! and the point . //! is True if the point

is the point . Standard_EXPORT void Perform(const Handle(Geom2d_Point)& Pnt, @@ -93,8 +93,8 @@ public: const Standard_Real Tolerance, const Standard_Boolean oncurve = Standard_True); - //! Performs the bisecting line between the two points - //! and . + //! Performs the bisecting line between the two points + //! and . Standard_EXPORT void Perform(const Handle(Geom2d_Point)& Pnt1, const Handle(Geom2d_Point)& Pnt2, const gp_Pnt2d& P, diff --git a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecAna.hxx b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecAna.hxx index 0f5a27b86b..cf9cfed85d 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecAna.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecAna.hxx @@ -46,7 +46,7 @@ class Bisector_BisecAna : public Bisector_Curve public: Standard_EXPORT Bisector_BisecAna(); - //! Performs the bisecting line between the curves + //! Performs the bisecting line between the curves //! and . //! is True if the point

is common to //! and . @@ -60,7 +60,7 @@ public: const Standard_Real Tolerance, const Standard_Boolean oncurve = Standard_True); - //! Performs the bisecting line between the curve + //! Performs the bisecting line between the curve //! and the point . //! is True if the point

is the point . Standard_EXPORT void Perform(const Handle(Geom2d_Curve)& Cu, @@ -72,7 +72,7 @@ public: const Standard_Real Tolerance, const Standard_Boolean oncurve = Standard_True); - //! Performs the bisecting line between the curve + //! Performs the bisecting line between the curve //! and the point . //! is True if the point

is the point . Standard_EXPORT void Perform(const Handle(Geom2d_Point)& Pnt, @@ -84,8 +84,8 @@ public: const Standard_Real Tolerance, const Standard_Boolean oncurve = Standard_True); - //! Performs the bisecting line between the two points - //! and . + //! Performs the bisecting line between the two points + //! and . Standard_EXPORT void Perform(const Handle(Geom2d_Point)& Pnt1, const Handle(Geom2d_Point)& Pnt2, const gp_Pnt2d& P, @@ -106,7 +106,7 @@ public: //! nearest from than the extremitis of . Standard_EXPORT void SetTrim(const Handle(Geom2d_Curve)& Cu); - //! Trim by a domain defined by uf and ul + //! Trim by a domain defined by uf and ul Standard_EXPORT void SetTrim(const Standard_Real uf, const Standard_Real ul); Standard_EXPORT void Reverse() Standard_OVERRIDE; @@ -157,16 +157,16 @@ public: Standard_EXPORT Standard_Real ParameterOfEndPoint() const; - //! If necessary, breaks the curve in intervals of - //! continuity . And returns the number of + //! If necessary, breaks the curve in intervals of + //! continuity . And returns the number of //! intervals. Standard_EXPORT Standard_Integer NbIntervals() const Standard_OVERRIDE; - //! Returns the first parameter of the current + //! Returns the first parameter of the current //! interval. Standard_EXPORT Standard_Real IntervalFirst(const Standard_Integer Index) const Standard_OVERRIDE; - //! Returns the last parameter of the current + //! Returns the last parameter of the current //! interval. Standard_EXPORT Standard_Real IntervalLast(const Standard_Integer Index) const Standard_OVERRIDE; diff --git a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecCC.hxx b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecCC.hxx index 48801f389c..b11c3569c2 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecCC.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecCC.hxx @@ -41,10 +41,10 @@ class Bisector_BisecCC : public Bisector_Curve public: Standard_EXPORT Bisector_BisecCC(); - //! Constructs the bisector between the curves + //! Constructs the bisector between the curves //! and . //! - //! (resp ) = 1 if the + //! (resp ) = 1 if the //! bisector curve is on the left of (resp ) //! else (resp ) = -1. //! @@ -59,10 +59,10 @@ public: const gp_Pnt2d& Origin, const Standard_Real DistMax = 500); - //! Computes the bisector between the curves + //! Computes the bisector between the curves //! and . //! - //! (resp ) = 1 if the + //! (resp ) = 1 if the //! bisector curve is on the left of (resp ) //! else (resp ) = -1. //! @@ -90,7 +90,7 @@ public: //! Raised if N < 0. Standard_EXPORT Standard_Boolean IsCN(const Standard_Integer N) const Standard_OVERRIDE; - //! The parameter on is linked to the parameter + //! The parameter on is linked to the parameter //! on the first curve. This method creates the same bisector //! where the curves are inversed. Standard_EXPORT Handle(Bisector_BisecCC) ChangeGuide() const; @@ -109,16 +109,16 @@ public: Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE; - //! If necessary, breaks the curve in intervals of - //! continuity . And returns the number of + //! If necessary, breaks the curve in intervals of + //! continuity . And returns the number of //! intervals. Standard_EXPORT Standard_Integer NbIntervals() const Standard_OVERRIDE; - //! Returns the first parameter of the current + //! Returns the first parameter of the current //! interval. Standard_EXPORT Standard_Real IntervalFirst(const Standard_Integer Index) const Standard_OVERRIDE; - //! Returns the last parameter of the current + //! Returns the last parameter of the current //! interval. Standard_EXPORT Standard_Real IntervalLast(const Standard_Integer Index) const Standard_OVERRIDE; diff --git a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecPC.hxx b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecPC.hxx index 9131c64893..5998122dae 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecPC.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_BisecPC.hxx @@ -84,13 +84,13 @@ public: Standard_EXPORT Standard_Boolean IsExtendAtEnd() const Standard_OVERRIDE; //! Changes the direction of parametrization of . - //! The orientation of the curve is modified. If the curve + //! The orientation of the curve is modified. If the curve //! is bounded the StartPoint of the initial curve becomes the - //! EndPoint of the reversed curve and the EndPoint of the initial + //! EndPoint of the reversed curve and the EndPoint of the initial //! curve becomes the StartPoint of the reversed curve. Standard_EXPORT void Reverse() Standard_OVERRIDE; - //! Returns the parameter on the reversed curve for + //! Returns the parameter on the reversed curve for //! the point of parameter U on . Standard_EXPORT Standard_Real ReversedParameter(const Standard_Real U) const Standard_OVERRIDE; @@ -114,16 +114,16 @@ public: Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE; - //! If necessary, breaks the curve in intervals of - //! continuity . And returns the number of + //! If necessary, breaks the curve in intervals of + //! continuity . And returns the number of //! intervals. Standard_EXPORT Standard_Integer NbIntervals() const Standard_OVERRIDE; - //! Returns the first parameter of the current + //! Returns the first parameter of the current //! interval. Standard_EXPORT Standard_Real IntervalFirst(const Standard_Integer Index) const Standard_OVERRIDE; - //! Returns the last parameter of the current + //! Returns the last parameter of the current //! interval. Standard_EXPORT Standard_Real IntervalLast(const Standard_Integer Index) const Standard_OVERRIDE; @@ -133,7 +133,7 @@ public: Standard_EXPORT Standard_Boolean IsPeriodic() const Standard_OVERRIDE; - //! Returns the distance between the point of + //! Returns the distance between the point of //! parameter U on and my point or my curve. Standard_EXPORT Standard_Real Distance(const Standard_Real U) const; diff --git a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_Curve.hxx b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_Curve.hxx index 90f21619af..2ebc3400c9 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_Curve.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_Curve.hxx @@ -38,16 +38,16 @@ public: Standard_EXPORT virtual Standard_Boolean IsExtendAtEnd() const = 0; - //! If necessary, breaks the curve in intervals of - //! continuity . And returns the number of + //! If necessary, breaks the curve in intervals of + //! continuity . And returns the number of //! intervals. Standard_EXPORT virtual Standard_Integer NbIntervals() const = 0; - //! Returns the first parameter of the current + //! Returns the first parameter of the current //! interval. Standard_EXPORT virtual Standard_Real IntervalFirst(const Standard_Integer Index) const = 0; - //! Returns the last parameter of the current + //! Returns the last parameter of the current //! interval. Standard_EXPORT virtual Standard_Real IntervalLast(const Standard_Integer Index) const = 0; diff --git a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_FunctionH.hxx b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_FunctionH.hxx index e39a25f851..f29ebd13e2 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_FunctionH.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_FunctionH.hxx @@ -28,7 +28,7 @@ #include class Geom2d_Curve; -//! H(v) = (T1 .P2(v) - P1) * ||T(v)|| - +//! H(v) = (T1.P2(v) - P1) * ||T(v)|| - //! 2 2 //! (T(v).P2(v) - P1) * ||T1|| class Bisector_FunctionH : public math_FunctionWithDerivative diff --git a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_FunctionInter.hxx b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_FunctionInter.hxx index f106409e97..c595b00a16 100644 --- a/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_FunctionInter.hxx +++ b/src/ModelingAlgorithms/TKTopAlgo/Bisector/Bisector_FunctionInter.hxx @@ -26,7 +26,7 @@ class Geom2d_Curve; class Bisector_Curve; //! 2 2 -//! F(u) = (PC(u) - PBis1(u)) + (PC(u) - PBis2(u)) +//! F(u) = (PC(u) - PBis1(u)) + (PC(u) - PBis2(u)) class Bisector_FunctionInter : public math_FunctionWithDerivative { public: diff --git a/src/ModelingData/TKBRep/BRepTools/BRepTools.hxx b/src/ModelingData/TKBRep/BRepTools/BRepTools.hxx index 8c52f0a61e..59cdd84a2c 100644 --- a/src/ModelingData/TKBRep/BRepTools/BRepTools.hxx +++ b/src/ModelingData/TKBRep/BRepTools/BRepTools.hxx @@ -45,7 +45,7 @@ class Geom2d_Curve; class Geom_Surface; class OSD_FileSystem; -//! The BRepTools package provides utilities for BRep +//! The BRepTools package provides utilities for BRep //! data structures. //! //! * WireExplorer: Tool to explore the topology of diff --git a/src/ModelingData/TKBRep/BRepTools/BRepTools_ReShape.hxx b/src/ModelingData/TKBRep/BRepTools/BRepTools_ReShape.hxx index 9bb5f5d37d..2f950597c0 100644 --- a/src/ModelingData/TKBRep/BRepTools/BRepTools_ReShape.hxx +++ b/src/ModelingData/TKBRep/BRepTools/BRepTools_ReShape.hxx @@ -167,9 +167,9 @@ protected: //! //! If the first shape has the reversed orientation //! then the both shapes are reversed. - //! If the first shape has the internal or external orientation then:
+ //! If the first shape has the internal or external orientation then: //! - the second shape is oriented forward (reversed) if it's orientation - //! is equal (not equal) to the orientation of the first shape;
+ //! is equal (not equal) to the orientation of the first shape; //! - the first shape is oriented forward. Standard_EXPORT virtual void replace(const TopoDS_Shape& shape, const TopoDS_Shape& newshape, diff --git a/src/ModelingData/TKBRep/TopTools/TopTools_ShapeSet.hxx b/src/ModelingData/TKBRep/TopTools/TopTools_ShapeSet.hxx index 55934e49a4..51e89606de 100644 --- a/src/ModelingData/TKBRep/TopTools/TopTools_ShapeSet.hxx +++ b/src/ModelingData/TKBRep/TopTools/TopTools_ShapeSet.hxx @@ -98,7 +98,7 @@ public: //! Writes the geometry calling WriteGeometry. //! //! Dumps the shapes from last to first. - //! For each shape : + //! For each shape: //! Write the type. //! calls WriteGeometry(S). //! Write the flags, the subshapes. diff --git a/src/ModelingData/TKGeomBase/GC/GC_MakeHyperbola.hxx b/src/ModelingData/TKGeomBase/GC/GC_MakeHyperbola.hxx index f68dc7bdf2..669e0c33b1 100644 --- a/src/ModelingData/TKGeomBase/GC/GC_MakeHyperbola.hxx +++ b/src/ModelingData/TKGeomBase/GC/GC_MakeHyperbola.hxx @@ -63,7 +63,7 @@ class GC_MakeHyperbola : public GC_Root public: DEFINE_STANDARD_ALLOC - //! Creates an Hyperbola from a non persistent hyperbola from package gp by conversion. + //! Creates an Hyperbola from a non persistent hyperbola from package gp by conversion. Standard_EXPORT GC_MakeHyperbola(const gp_Hypr& H); //! Constructs a hyperbola centered on the origin of the coordinate system diff --git a/src/ModelingData/TKGeomBase/GC/GC_MakePlane.hxx b/src/ModelingData/TKGeomBase/GC/GC_MakePlane.hxx index 2a0d8ad740..c23602a93a 100644 --- a/src/ModelingData/TKGeomBase/GC/GC_MakePlane.hxx +++ b/src/ModelingData/TKGeomBase/GC/GC_MakePlane.hxx @@ -79,7 +79,7 @@ public: //! It returns false if are confused. Standard_EXPORT GC_MakePlane(const gp_Pnt& P1, const gp_Pnt& P2, const gp_Pnt& P3); - //! Make a Plane passing through the location of and + //! Make a Plane passing through the location of and //! normal to the Direction of . Standard_EXPORT GC_MakePlane(const gp_Ax1& Axis); diff --git a/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeEllipse.hxx b/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeEllipse.hxx index aca7852aff..0b22433dca 100644 --- a/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeEllipse.hxx +++ b/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeEllipse.hxx @@ -31,7 +31,7 @@ class gp_Pnt2d; //! This class implements the following algorithms used to //! create Ellipse from Geom2d. -//! * Create an Ellipse from two apex and the center. +//! * Create an Ellipse from two apex and the center. //! Defines an ellipse in 2D space. //! The parametrization range is [0,2*PI]. //! The ellipse is a closed and periodic curve. @@ -49,7 +49,7 @@ public: Standard_EXPORT GCE2d_MakeEllipse(const gp_Elips2d& E); //! MajorAxis is the local coordinate system of the ellipse. - //! It is the "XAxis". The minor axis is the YAxis of the + //! It is the "XAxis". The minor axis is the YAxis of the //! ellipse. //! Sense give the sense of parametrization of the Ellipse. //! It is not forbidden to create an ellipse with MajorRadius = diff --git a/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeHyperbola.hxx b/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeHyperbola.hxx index aba24738db..537ad7372f 100644 --- a/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeHyperbola.hxx +++ b/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeHyperbola.hxx @@ -31,7 +31,7 @@ class gp_Pnt2d; //! This class implements the following algorithms used to //! create Hyperbola from Geom2d. -//! * Create an Hyperbola from two apex and the center. +//! * Create an Hyperbola from two apex and the center. //! Defines the main branch of an hyperbola. //! The parameterization range is ]-infinite,+infinite[ //! It is possible to get the other branch and the two conjugate @@ -60,7 +60,7 @@ class GCE2d_MakeHyperbola : public GCE2d_Root public: DEFINE_STANDARD_ALLOC - //! Creates an Hyperbola from a non persistent one from package gp + //! Creates an Hyperbola from a non persistent one from package gp Standard_EXPORT GCE2d_MakeHyperbola(const gp_Hypr2d& H); //! MajorAxis is the "XAxis" of the hyperbola. diff --git a/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeParabola.hxx b/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeParabola.hxx index be98177e9c..d20e34a801 100644 --- a/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeParabola.hxx +++ b/src/ModelingData/TKGeomBase/GCE2d/GCE2d_MakeParabola.hxx @@ -31,8 +31,8 @@ class gp_Pnt2d; //! This class implements the following algorithms used to //! create Parabola from Geom2d. -//! * Create an Parabola from two apex and the center. -//! Defines the parabola in the parameterization range : +//! * Create an Parabola from two apex and the center. +//! Defines the parabola in the parameterization range: //! ]-infinite,+infinite[ //! The vertex of the parabola is the "Location" point of the //! local coordinate system "XAxis" of the parabola. diff --git a/src/ModelingData/TKGeomBase/GCPnts/GCPnts_AbscissaPoint.cxx b/src/ModelingData/TKGeomBase/GCPnts/GCPnts_AbscissaPoint.cxx index 8ad1bed742..ad224f96dc 100644 --- a/src/ModelingData/TKGeomBase/GCPnts/GCPnts_AbscissaPoint.cxx +++ b/src/ModelingData/TKGeomBase/GCPnts/GCPnts_AbscissaPoint.cxx @@ -21,7 +21,7 @@ #include //! Dimension independent used to implement GCPnts_AbscissaPoint -//! compute the type and the length ratio if GCPnts_LengthParametrized. +//! compute the type and the length ratio if GCPnts_LengthParametrized. template static GCPnts_AbscissaType computeType(const TheCurve& theC, Standard_Real& theRatio) { diff --git a/src/ModelingData/TKGeomBase/Geom2dConvert/Geom2dConvert_ApproxCurve.hxx b/src/ModelingData/TKGeomBase/Geom2dConvert/Geom2dConvert_ApproxCurve.hxx index 9b2ce646ca..5497d8c28a 100644 --- a/src/ModelingData/TKGeomBase/Geom2dConvert/Geom2dConvert_ApproxCurve.hxx +++ b/src/ModelingData/TKGeomBase/Geom2dConvert/Geom2dConvert_ApproxCurve.hxx @@ -61,21 +61,21 @@ public: //! approximation algorithm. Standard_EXPORT Handle(Geom2d_BSplineCurve) Curve() const; - //! returns Standard_True if the approximation has - //! been done with within required tolerance + //! returns Standard_True if the approximation has + //! been done with within required tolerance Standard_EXPORT Standard_Boolean IsDone() const; - //! returns Standard_True if the approximation did come out - //! with a result that is not NECESSARELY within the required tolerance + //! returns Standard_True if the approximation did come out + //! with a result that is not NECESSARELY within the required tolerance Standard_EXPORT Standard_Boolean HasResult() const; //! Returns the greatest distance between a point on the //! source conic and the BSpline curve resulting from the //! approximation. (>0 when an approximation - //! has been done, 0 if no approximation) + //! has been done, 0 if no approximation) Standard_EXPORT Standard_Real MaxError() const; - //! Print on the stream o information about the object + //! Print on the stream o information about the object Standard_EXPORT void Dump(Standard_OStream& o) const; protected: diff --git a/src/ModelingData/TKGeomBase/gce/gce_MakeCone.hxx b/src/ModelingData/TKGeomBase/gce/gce_MakeCone.hxx index 6d62ef4ebc..84e156fafa 100644 --- a/src/ModelingData/TKGeomBase/gce/gce_MakeCone.hxx +++ b/src/ModelingData/TKGeomBase/gce/gce_MakeCone.hxx @@ -50,7 +50,7 @@ public: //! Radius is the radius of the circle in the reference plane of //! the cone. //! If Radius is lower than 0.0 the status is " - //! If Ang < Resolution from gp or Ang >= (PI/2) - Resolution. + //! If Ang < Resolution from gp or Ang >= (PI/2) - Resolution. Standard_EXPORT gce_MakeCone(const gp_Ax2& A2, const Standard_Real Ang, const Standard_Real Radius); diff --git a/src/ModelingData/TKGeomBase/gce/gce_MakeElips2d.hxx b/src/ModelingData/TKGeomBase/gce/gce_MakeElips2d.hxx index eb4b3d1792..fcbd4cf7c2 100644 --- a/src/ModelingData/TKGeomBase/gce/gce_MakeElips2d.hxx +++ b/src/ModelingData/TKGeomBase/gce/gce_MakeElips2d.hxx @@ -43,7 +43,7 @@ public: //! Creates an ellipse with the major axis, the major and the //! minor radius. The location of the MajorAxis is the center - //! of the ellipse. + //! of the ellipse. //! The sense of parametrization is given by Sense. //! It is possible to create an ellipse with MajorRadius = MinorRadius. //! the status is "InvertRadius" if MajorRadius < MinorRadius or @@ -57,7 +57,7 @@ public: //! the origin and the sense of parametrization. //! Creates an ellipse with the AxisPlacement the major and the //! minor radius. The location of Axis is the center - //! of the ellipse. + //! of the ellipse. //! It is possible to create an ellipse with MajorRadius = MinorRadius. //! the status is "InvertRadius" if MajorRadius < MinorRadius or //! "NegativeRadius" if MinorRadius < 0.0 @@ -68,7 +68,7 @@ public: //! Makes an Elips2d with its center and two points. //! The sense of parametrization is given by S1, S2, //! and Center. - //! Depending on the constructor, the implicit orientation of the ellipse is: + //! Depending on the constructor, the implicit orientation of the ellipse is: //! - the sense defined by A, //! - the sense defined by points Center, S1 and S2, //! - the trigonometric sense if Sense is not given or is true, or diff --git a/src/ModelingData/TKGeomBase/gce/gce_MakeHypr.hxx b/src/ModelingData/TKGeomBase/gce/gce_MakeHypr.hxx index 4b1fb48d04..88451acd6c 100644 --- a/src/ModelingData/TKGeomBase/gce/gce_MakeHypr.hxx +++ b/src/ModelingData/TKGeomBase/gce/gce_MakeHypr.hxx @@ -57,7 +57,7 @@ class gp_Pnt; //! to the hyperbola's plane. //! //! The "XAxis" of the hyperbola ("Location", "XDirection") is the -//! major axis and the "YAxis" of the hyperbola ("Location", +//! major axis and the "YAxis" of the hyperbola ("Location", //! "YDirection") is the minor axis. //! //! Warnings : diff --git a/src/ModelingData/TKGeomBase/gce/gce_MakeParab.hxx b/src/ModelingData/TKGeomBase/gce/gce_MakeParab.hxx index f19dafd6b0..17f233a63c 100644 --- a/src/ModelingData/TKGeomBase/gce/gce_MakeParab.hxx +++ b/src/ModelingData/TKGeomBase/gce/gce_MakeParab.hxx @@ -29,7 +29,7 @@ class gp_Pnt; //! This class implements the following algorithms used to //! create Parab from gp. -//! Defines the parabola in the parameterization range : +//! Defines the parabola in the parameterization range: //! ]-infinite, +infinite[ //! The vertex of the parabola is the "Location" point of the //! local coordinate system (axis placement) of the parabola. diff --git a/src/ModelingData/TKGeomBase/gce/gce_MakeParab2d.hxx b/src/ModelingData/TKGeomBase/gce/gce_MakeParab2d.hxx index 17b6ba0010..02cd5028ba 100644 --- a/src/ModelingData/TKGeomBase/gce/gce_MakeParab2d.hxx +++ b/src/ModelingData/TKGeomBase/gce/gce_MakeParab2d.hxx @@ -47,7 +47,7 @@ class gp_Pnt2d; //! The focal length F = P/2 is the distance between the vertex //! and the focus of the parabola. //! -//! * Create a Parab2d from one apex and the center. +//! * Create a Parab2d from one apex and the center. //! * Create a Parab2d with the directrix and the focus point. //! * Create a Parab2d with its vertex point and its axis //! of symmetry and its focus length. diff --git a/src/ModelingData/TKGeomBase/gce/gce_MakePln.hxx b/src/ModelingData/TKGeomBase/gce/gce_MakePln.hxx index 18c3dd2478..5cf91f9b56 100644 --- a/src/ModelingData/TKGeomBase/gce/gce_MakePln.hxx +++ b/src/ModelingData/TKGeomBase/gce/gce_MakePln.hxx @@ -58,7 +58,7 @@ public: //! the "YAxis" of the plane used to parametrize the plane. Standard_EXPORT gce_MakePln(const gp_Ax2& A2); - //! Creates a plane with the "Location" point

+ //! Creates a plane with the "Location" point

//! and the normal direction . Standard_EXPORT gce_MakePln(const gp_Pnt& P, const gp_Dir& V); @@ -95,7 +95,7 @@ public: //! The status is "ConfusedPoints" if are confused. Standard_EXPORT gce_MakePln(const gp_Pnt& P1, const gp_Pnt& P2); - //! Make a pln passing through the location of and + //! Make a pln passing through the location of and //! normal to the Direction of . //! Warning - If an error occurs (that is, when IsDone returns //! false), the Status function returns: diff --git a/src/Visualization/TKService/Aspect/Aspect_DisplayConnection.hxx b/src/Visualization/TKService/Aspect/Aspect_DisplayConnection.hxx index 4629786291..da92ff86da 100755 --- a/src/Visualization/TKService/Aspect/Aspect_DisplayConnection.hxx +++ b/src/Visualization/TKService/Aspect/Aspect_DisplayConnection.hxx @@ -41,9 +41,12 @@ public: //! Constructor. Creates connection with display specified in theDisplayName. //! Display name should be in format "hostname:number" or "hostname:number.screen_number", where: - //! hostname - Specifies the name of the host machine on which the display is physically - //! attached. number - Specifies the number of the display server on that host machine. - //! screen_number - Specifies the screen to be used on that server. Optional variable. + //! hostname + //! - Specifies the name of the host machine on which the display is physically attached. + //! number + //! - Specifies the number of the display server on that host machine. + //! screen_number + //! - Specifies the screen to be used on that server. Optional variable. Standard_EXPORT Aspect_DisplayConnection(const TCollection_AsciiString& theDisplayName); //! Constructor wrapping existing Display instance. diff --git a/src/Visualization/TKService/Aspect/Aspect_TypeOfDeflection.hxx b/src/Visualization/TKService/Aspect/Aspect_TypeOfDeflection.hxx index 1a4edd0c4e..2e3143b5f1 100644 --- a/src/Visualization/TKService/Aspect/Aspect_TypeOfDeflection.hxx +++ b/src/Visualization/TKService/Aspect/Aspect_TypeOfDeflection.hxx @@ -17,7 +17,7 @@ #define _Aspect_TypeOfDeflection_HeaderFile //! Defines if the maximal chordial deflection used when -//! drawing an object is absolute or relative to the size +//! drawing an object is absolute or relative to the size //! of the object. enum Aspect_TypeOfDeflection { diff --git a/src/Visualization/TKService/Aspect/Aspect_TypeOfStyleText.hxx b/src/Visualization/TKService/Aspect/Aspect_TypeOfStyleText.hxx index f4901dd8e0..e56208b25f 100644 --- a/src/Visualization/TKService/Aspect/Aspect_TypeOfStyleText.hxx +++ b/src/Visualization/TKService/Aspect/Aspect_TypeOfStyleText.hxx @@ -18,10 +18,12 @@ //! Define the style of the text. //! -//! TOST_NORMAL Default text. The text is displayed like any other graphic object. +//! TOST_NORMAL +//! Default text. The text is displayed like any other graphic object. //! This text can be hidden by another object that is nearest from the //! point of view. -//! TOST_ANNOTATION The text is always visible. The texte is displayed +//! TOST_ANNOTATION +//! The text is always visible. The text is displayed //! over the other object according to the priority. enum Aspect_TypeOfStyleText { diff --git a/src/Visualization/TKService/Font/Font_TextFormatter.hxx b/src/Visualization/TKService/Font/Font_TextFormatter.hxx index 0be56c2c63..d0a7cba927 100644 --- a/src/Visualization/TKService/Font/Font_TextFormatter.hxx +++ b/src/Visualization/TKService/Font/Font_TextFormatter.hxx @@ -27,22 +27,22 @@ class Font_FTFont; DEFINE_STANDARD_HANDLE(Font_TextFormatter, Standard_Transient) -//! This class is intended to prepare formatted text by using:
-//! - font to string combination,
-//! - alignment,
-//! - wrapping.
+//! This class is intended to prepare formatted text by using: +//! - font to string combination, +//! - alignment, +//! - wrapping. //! //! After text formatting, each symbol of formatted text is placed in some position. //! Further work with the formatter is using an iterator. //! The iterator gives an access to each symbol inside the initial row. -//! Also it's possible to get only significant/writable symbols of the text.
+//! Also it's possible to get only significant/writable symbols of the text. //! Formatter gives an access to geometrical position of a symbol by the symbol index in the -//! text.
Example of correspondence of some text symbol to an index in "row_1\n\nrow_2\n":
-//! "row_1\n" - 0-5 indices;
-//! "\n" - 6 index;
-//! "\n" - 7 index;
-//! "row_2\n" - 8-13 indices.
-//! Pay attention that fonts should have the same LineSpacing value for correct formatting.
+//! text. Example of correspondence of some text symbol to an index in "row_1\n\nrow_2\n": +//! "row_1\n" - 0-5 indices; +//! "\n" - 6 index; +//! "\n" - 7 index; +//! "row_2\n" - 8-13 indices. +//! Pay attention that fonts should have the same LineSpacing value for correct formatting. //! Example of the formatter using: //! @code //! Handle(Font_TextFormatter) aFormatter = new Font_TextFormatter(); @@ -209,7 +209,7 @@ public: //! Returns horizontal alignment style Graphic3d_HorizontalTextAlignment HorizontalTextAlignment() const { return myAlignX; } - //! Returns vertical alignment style + //! Returns vertical alignment style Graphic3d_VerticalTextAlignment VerticalTextAlignment() const { return myAlignY; } //! Sets text wrapping width, zero means that the text is not bounded by width diff --git a/src/Visualization/TKService/Graphic3d/Graphic3d_Camera.hxx b/src/Visualization/TKService/Graphic3d/Graphic3d_Camera.hxx index 7b4435d5fb..83a3b91c3f 100644 --- a/src/Visualization/TKService/Graphic3d/Graphic3d_Camera.hxx +++ b/src/Visualization/TKService/Graphic3d/Graphic3d_Camera.hxx @@ -157,8 +157,8 @@ public: //! change if Center and Eye translation will be interpolated independently). E.g.: //! - When both Center and Eye are moved at the same vector -> both will be just translated by //! straight line; - //! - When Center is not moved -> camera Eye will move around Center through arc; - //! - When Eye is not moved -> camera Center will move around Eye through arc; + //! - When Center is not moved -> camera Eye will move around Center through arc; + //! - When Eye is not moved -> camera Center will move around Eye through arc; //! - When both Center and Eye are move by different vectors -> transformation will be something //! in between, //! and will try interpolate linearly the distance between Center and Eye. @@ -283,7 +283,7 @@ public: Standard_EXPORT Standard_Real Scale() const; //! Sets camera scale. For orthographic projection the scale factor - //! corresponds to parallel scale of view mapping (i.e. size + //! corresponds to parallel scale of view mapping (i.e. size //! of viewport). For perspective camera scale is converted to //! distance. The scale specifies equal size of the view projection in //! both dimensions assuming that the aspect is 1.0. The projection height diff --git a/src/Visualization/TKV3d/AIS/AIS_InteractiveContext.hxx b/src/Visualization/TKV3d/AIS/AIS_InteractiveContext.hxx index d6c44640bd..b5d5a52986 100644 --- a/src/Visualization/TKV3d/AIS/AIS_InteractiveContext.hxx +++ b/src/Visualization/TKV3d/AIS/AIS_InteractiveContext.hxx @@ -718,7 +718,7 @@ public: //! @name Selection management //! transformation being applied: //! @code //! const Handle(StdSelect_BRepOwner) aBRepOwner = Handle(StdSelect_BRepOwner)::DownCast - //! (SelectedOwner()); TopoDS_Shape aSelShape = aBRepOwner->Shape(); TopoDS_Shape + //! (SelectedOwner()); TopoDS_Shape aSelShape = aBRepOwner->Shape(); TopoDS_Shape //! aLocatedShape = aSelShape.Located (aBRepOwner->Location() * aSelShape.Location()); //! @endcode //! @sa SelectedOwner(), HasSelectedShape(). diff --git a/src/Visualization/TKV3d/AIS/AIS_Manipulator.hxx b/src/Visualization/TKV3d/AIS/AIS_Manipulator.hxx index 925d67b07c..3aef54c574 100644 --- a/src/Visualization/TKV3d/AIS/AIS_Manipulator.hxx +++ b/src/Visualization/TKV3d/AIS/AIS_Manipulator.hxx @@ -410,16 +410,16 @@ public: //! @name Presentation computation virtual Standard_Boolean IsAutoHilight() const Standard_OVERRIDE { return Standard_False; } //! Method which clear all selected owners belonging - //! to this selectable object ( for fast presentation draw ). + //! to this selectable object (for fast presentation draw). Standard_EXPORT virtual void ClearSelected() Standard_OVERRIDE; - //! Method which draws selected owners ( for fast presentation draw ). + //! Method which draws selected owners (for fast presentation draw). Standard_EXPORT virtual void HilightSelected(const Handle(PrsMgr_PresentationManager)& thePM, const SelectMgr_SequenceOfOwner& theSeq) Standard_OVERRIDE; //! Method which hilight an owner belonging to - //! this selectable object ( for fast presentation draw ). + //! this selectable object (for fast presentation draw). Standard_EXPORT virtual void HilightOwnerWithColor( const Handle(PrsMgr_PresentationManager)& thePM, const Handle(Prs3d_Drawer)& theStyle, diff --git a/src/Visualization/TKV3d/AIS/AIS_PlaneTrihedron.hxx b/src/Visualization/TKV3d/AIS/AIS_PlaneTrihedron.hxx index 39f445d3b2..6ee2323508 100644 --- a/src/Visualization/TKV3d/AIS/AIS_PlaneTrihedron.hxx +++ b/src/Visualization/TKV3d/AIS/AIS_PlaneTrihedron.hxx @@ -38,7 +38,7 @@ class Geom_Plane; //! value for the representation of the axes. If you modify //! these dimensions, you must temporarily recover the //! Drawer object. From inside it, take the Aspects in -//! which the values for length are stocked, for example, +//! which the values for length are stocked, for example, //! PlaneAspect for planes and LineAspect for //! trihedra. Change these values and recalculate the presentation. class AIS_PlaneTrihedron : public AIS_InteractiveObject diff --git a/src/Visualization/TKV3d/AIS/AIS_Triangulation.hxx b/src/Visualization/TKV3d/AIS/AIS_Triangulation.hxx index a2ddb91fcd..ec3a37a13c 100644 --- a/src/Visualization/TKV3d/AIS/AIS_Triangulation.hxx +++ b/src/Visualization/TKV3d/AIS/AIS_Triangulation.hxx @@ -23,7 +23,7 @@ class Poly_Triangulation; DEFINE_STANDARD_HANDLE(AIS_Triangulation, AIS_InteractiveObject) -//! Interactive object that draws data from Poly_Triangulation, optionally with colors associated +//! Interactive object that draws data from Poly_Triangulation, optionally with colors associated //! with each triangulation vertex. For maximum efficiency colors are represented as 32-bit integers //! instead of classic Quantity_Color values. //! Interactive selection of triangles and vertices is not yet implemented. diff --git a/src/Visualization/TKV3d/AIS/AIS_Trihedron.hxx b/src/Visualization/TKV3d/AIS/AIS_Trihedron.hxx index 760fcbc98e..82003505e5 100644 --- a/src/Visualization/TKV3d/AIS/AIS_Trihedron.hxx +++ b/src/Visualization/TKV3d/AIS/AIS_Trihedron.hxx @@ -181,16 +181,16 @@ public: public: //! Method which clear all selected owners belonging - //! to this selectable object ( for fast presentation draw ). + //! to this selectable object (for fast presentation draw). Standard_EXPORT virtual void ClearSelected() Standard_OVERRIDE; - //! Method which draws selected owners ( for fast presentation draw ). + //! Method which draws selected owners (for fast presentation draw). Standard_EXPORT virtual void HilightSelected(const Handle(PrsMgr_PresentationManager)& thePM, const SelectMgr_SequenceOfOwner& theOwners) Standard_OVERRIDE; - //! Method which hilight an owner belonging to - //! this selectable object ( for fast presentation draw ). + //! Method which highlights an owner belonging to + //! this selectable object (for fast presentation draw). Standard_EXPORT virtual void HilightOwnerWithColor( const Handle(PrsMgr_PresentationManager)& thePM, const Handle(Prs3d_Drawer)& theStyle, diff --git a/src/Visualization/TKV3d/AIS/AIS_TypeFilter.hxx b/src/Visualization/TKV3d/AIS/AIS_TypeFilter.hxx index 2ef2422547..dfaad64d1b 100644 --- a/src/Visualization/TKV3d/AIS/AIS_TypeFilter.hxx +++ b/src/Visualization/TKV3d/AIS/AIS_TypeFilter.hxx @@ -32,7 +32,7 @@ DEFINE_STANDARD_HANDLE(AIS_TypeFilter, SelectMgr_Filter) //! to determine whether it has an non-null owner, and if //! so, whether it is of the desired type. If the object //! returns true in each case, it is kept. If not, it is rejected. -//! By default, the interactive object has a None type +//! By default, the interactive object has a None type //! and a signature of 0. A filter for type specifies a //! choice of type out of a range at any level enumerated //! for type or kind. The choice could be for kind of @@ -40,7 +40,7 @@ DEFINE_STANDARD_HANDLE(AIS_TypeFilter, SelectMgr_Filter) //! plane or attribute. //! If you want to give a particular type and signature to //! your Interactive Object, you must redefine two virtual -//! methods: Type and Signature. +//! methods: Type and Signature. //! This filter is used in both Neutral Point and open local contexts. //! In the Collector viewer, you can only locate //! Interactive Objects which answer positively to the diff --git a/src/Visualization/TKV3d/AIS/AIS_ViewController.hxx b/src/Visualization/TKV3d/AIS/AIS_ViewController.hxx index f84996b4d5..4656b69538 100644 --- a/src/Visualization/TKV3d/AIS/AIS_ViewController.hxx +++ b/src/Visualization/TKV3d/AIS/AIS_ViewController.hxx @@ -50,7 +50,7 @@ class WNT_HIDSpaceMouse; //! - Mapping mouse/multi-touch input to View camera manipulations (panning/rotating/zooming). //! - Input events are not applied immediately but queued for separate processing from two working //! threads -//! UI thread receiving user input and Rendering thread for OCCT 3D Viewer drawing. +//! UI thread receiving user input and Rendering thread for OCCT 3D Viewer drawing. class AIS_ViewController : public Aspect_WindowInputListener { public: diff --git a/src/Visualization/TKV3d/DsgPrs/DsgPrs_AnglePresentation.hxx b/src/Visualization/TKV3d/DsgPrs/DsgPrs_AnglePresentation.hxx index 69e2e26e1b..05c1b5271d 100644 --- a/src/Visualization/TKV3d/DsgPrs/DsgPrs_AnglePresentation.hxx +++ b/src/Visualization/TKV3d/DsgPrs/DsgPrs_AnglePresentation.hxx @@ -66,7 +66,7 @@ public: const gp_Dir& dir2, const gp_Pnt& OffsetPoint); - //! Same as above, but contains conversion + //! Same as above, but contains conversion //! in Session units.... Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, @@ -79,8 +79,8 @@ public: const gp_Dir& dir2, const gp_Pnt& OffsetPoint); - //! Same as above, may add one or - //! two Arrows according to value + //! Same as above, may add one or + //! two Arrows according to value Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Real theval, @@ -93,7 +93,7 @@ public: const gp_Pnt& OffsetPoint, const DsgPrs_ArrowSide ArrowSide); - //! Same as above, but axisdir contains the axis direction + //! Same as above, but axisdir contains the axis direction //! useful for Revol that can be opened with 180 degrees Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, @@ -107,8 +107,8 @@ public: const gp_Dir& axisdir, const gp_Pnt& OffsetPoint); - //! Same as above,may add one or - //! two Arrows according to value + //! Same as above,may add one or + //! two Arrows according to value Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Real theval, @@ -125,9 +125,9 @@ public: const DsgPrs_ArrowSide ArrowSide); //! simple representation of a poor lonesome angle dimension - //! Draw a line from to , then operates - //! a rotation around the perpmay add one or - //! two Arrows according to value. The + //! Draw a line from to , then operates + //! a rotation around the perpmay add one or + //! two Arrows according to value. The //! attributes (color,arrowsize,...) are driven by the Drawer. Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, diff --git a/src/Visualization/TKV3d/PrsDim/PrsDim.hxx b/src/Visualization/TKV3d/PrsDim/PrsDim.hxx index f4126dd6fe..d63d048c13 100644 --- a/src/Visualization/TKV3d/PrsDim/PrsDim.hxx +++ b/src/Visualization/TKV3d/PrsDim/PrsDim.hxx @@ -108,7 +108,7 @@ public: gp_Pnt& theLastPnt2, const Handle(Geom_Plane)& thePlane); - //! Used by dimensions only.Computes the 3d geometry + //! Used by dimensions only.Computes the 3d geometry //! of and and checks if they are infinite. Standard_EXPORT static Standard_Boolean ComputeGeometry(const TopoDS_Edge& theFirstEdge, const TopoDS_Edge& theSecondEdge, @@ -121,15 +121,15 @@ public: Standard_Boolean& theIsinfinite1, Standard_Boolean& theIsinfinite2); - //! Used by 2d Relation only Computes the 3d geometry + //! Used by 2d Relation only Computes the 3d geometry //! of and in the current Plane and the - //! extremities if any. Return in ExtCurve the 3d curve - //! (not projected in the plane) of the first edge if + //! extremities if any. Return in ExtCurve the 3d curve + //! (not projected in the plane) of the first edge if //! =1 or of the 2nd edge if = 2. If - //! = 0, ExtCurve is Null. if there is an edge - //! external to the plane, is true if this - //! edge is infinite. So, the extremities of it are not - //! significant. Return TRUE if ok + //! = 0, ExtCurve is Null. if there is an edge + //! external to the plane, is true if this + //! edge is infinite. So, the extremities of it are not + //! significant. Return TRUE if ok Standard_EXPORT static Standard_Boolean ComputeGeometry(const TopoDS_Edge& theFirstEdge, const TopoDS_Edge& theSecondEdge, Standard_Integer& theExtIndex, @@ -160,11 +160,11 @@ public: const Handle(Geom_Plane)& aPlane, Standard_Boolean& isOnPlane); - //! Tries to get Plane from Face. Returns Surface of Face - //! in aSurf. Returns Standard_True and Plane of Face in - //! aPlane in following cases: + //! Tries to get Plane from Face. Returns Surface of Face + //! in aSurf. Returns Standard_True and Plane of Face in + //! aPlane in following cases: //! Face is Plane, Offset of Plane, - //! Extrusion of Line and Offset of Extrusion of Line + //! Extrusion of Line and Offset of Extrusion of Line //! Returns pure type of Surface which can be: //! Plane, Cylinder, Cone, Sphere, Torus, //! SurfaceOfRevolution, SurfaceOfExtrusion @@ -222,13 +222,13 @@ public: const gp_Dir& aDir, const Bnd_Box& aBndBox); - //! returns True if point with anAttachPar is - //! in domain of arc + //! returns True if point with anAttachPar is + //! in domain of arc Standard_EXPORT static Standard_Boolean InDomain(const Standard_Real aFirstPar, const Standard_Real aLastPar, const Standard_Real anAttachPar); - //! computes nearest to ellipse arc apex + //! computes nearest to ellipse arc apex Standard_EXPORT static gp_Pnt NearestApex(const gp_Elips& elips, const gp_Pnt& pApex, const gp_Pnt& nApex, @@ -236,7 +236,7 @@ public: const Standard_Real lpara, Standard_Boolean& IsInDomain); - //! computes length of ellipse arc in parametric units + //! computes length of ellipse arc in parametric units Standard_EXPORT static Standard_Real DistanceFromApex(const gp_Elips& elips, const gp_Pnt& Apex, const Standard_Real par); diff --git a/src/Visualization/TKV3d/PrsDim/PrsDim_MaxRadiusDimension.hxx b/src/Visualization/TKV3d/PrsDim/PrsDim_MaxRadiusDimension.hxx index d75c3c9754..d08acbec5e 100644 --- a/src/Visualization/TKV3d/PrsDim/PrsDim_MaxRadiusDimension.hxx +++ b/src/Visualization/TKV3d/PrsDim/PrsDim_MaxRadiusDimension.hxx @@ -22,21 +22,21 @@ DEFINE_STANDARD_HANDLE(PrsDim_MaxRadiusDimension, PrsDim_EllipseRadiusDimension) -//! Ellipse Max radius dimension of a Shape which can be Edge -//! or Face (planar or cylindrical(surface of extrusion or -//! surface of offset)) +//! Ellipse Max radius dimension of a Shape which can be Edge +//! or Face (planar or cylindrical(surface of extrusion or +//! surface of offset)) class PrsDim_MaxRadiusDimension : public PrsDim_EllipseRadiusDimension { DEFINE_STANDARD_RTTIEXT(PrsDim_MaxRadiusDimension, PrsDim_EllipseRadiusDimension) public: - //! Max Ellipse radius dimension - //! Shape can be edge , planar face or cylindrical face + //! Max Ellipse radius dimension + //! Shape can be edge, planar face or cylindrical face Standard_EXPORT PrsDim_MaxRadiusDimension(const TopoDS_Shape& aShape, const Standard_Real aVal, const TCollection_ExtendedString& aText); - //! Max Ellipse radius dimension with position - //! Shape can be edge , planar face or cylindrical face + //! Max Ellipse radius dimension with position + //! Shape can be edge, planar face or cylindrical face Standard_EXPORT PrsDim_MaxRadiusDimension(const TopoDS_Shape& aShape, const Standard_Real aVal, const TCollection_ExtendedString& aText, diff --git a/src/Visualization/TKV3d/PrsDim/PrsDim_MinRadiusDimension.hxx b/src/Visualization/TKV3d/PrsDim/PrsDim_MinRadiusDimension.hxx index 726e46cce8..e63fffeb7c 100644 --- a/src/Visualization/TKV3d/PrsDim/PrsDim_MinRadiusDimension.hxx +++ b/src/Visualization/TKV3d/PrsDim/PrsDim_MinRadiusDimension.hxx @@ -22,21 +22,21 @@ DEFINE_STANDARD_HANDLE(PrsDim_MinRadiusDimension, PrsDim_EllipseRadiusDimension) -//! -- Ellipse Min radius dimension of a Shape which -//! can be Edge or Face (planar or cylindrical(surface of -//! extrusion or surface of offset)) +//! Ellipse Min radius dimension of a Shape which +//! can be Edge or Face (planar or cylindrical(surface of +//! extrusion or surface of offset)) class PrsDim_MinRadiusDimension : public PrsDim_EllipseRadiusDimension { DEFINE_STANDARD_RTTIEXT(PrsDim_MinRadiusDimension, PrsDim_EllipseRadiusDimension) public: - //! Max Ellipse radius dimension - //! Shape can be edge , planar face or cylindrical face + //! Max Ellipse radius dimension + //! Shape can be edge, planar face or cylindrical face Standard_EXPORT PrsDim_MinRadiusDimension(const TopoDS_Shape& aShape, const Standard_Real aVal, const TCollection_ExtendedString& aText); - //! Max Ellipse radius dimension with position - //! Shape can be edge , planar face or cylindrical face + //! Max Ellipse radius dimension with position + //! Shape can be edge, planar face or cylindrical face Standard_EXPORT PrsDim_MinRadiusDimension(const TopoDS_Shape& aShape, const Standard_Real aVal, const TCollection_ExtendedString& aText, diff --git a/src/Visualization/TKV3d/PrsMgr/PrsMgr_PresentableObject.hxx b/src/Visualization/TKV3d/PrsMgr/PrsMgr_PresentableObject.hxx index 70ee54a3ef..4f30de724c 100644 --- a/src/Visualization/TKV3d/PrsMgr/PrsMgr_PresentableObject.hxx +++ b/src/Visualization/TKV3d/PrsMgr/PrsMgr_PresentableObject.hxx @@ -487,7 +487,7 @@ public: //! @name simplified presentation properties API } //! Removes color settings. Only the Interactive Object - //! knows which Drawer attribute is affected by the color + //! knows which Drawer attribute is affected by the color //! setting. For a wire, for example, wire aspect is the //! attribute affected. For a vertex, however, only point //! aspect is affected by the color setting. diff --git a/src/Visualization/TKV3d/SelectMgr/SelectMgr_SelectableObject.hxx b/src/Visualization/TKV3d/SelectMgr/SelectMgr_SelectableObject.hxx index 4cda0d35f7..a136cb31a1 100644 --- a/src/Visualization/TKV3d/SelectMgr/SelectMgr_SelectableObject.hxx +++ b/src/Visualization/TKV3d/SelectMgr/SelectMgr_SelectableObject.hxx @@ -128,7 +128,7 @@ public: const Handle(PrsMgr_PresentationManager)& theMgr); //! Method which hilight an owner belonging to - //! this selectable object ( for fast presentation draw ) + //! this selectable object (for fast presentation draw) Standard_EXPORT virtual void HilightOwnerWithColor( const Handle(PrsMgr_PresentationManager)& thePM, const Handle(Prs3d_Drawer)& theStyle, diff --git a/src/Visualization/TKV3d/SelectMgr/SelectMgr_Selection.hxx b/src/Visualization/TKV3d/SelectMgr/SelectMgr_Selection.hxx index f61b3ce467..987724242a 100644 --- a/src/Visualization/TKV3d/SelectMgr/SelectMgr_Selection.hxx +++ b/src/Visualization/TKV3d/SelectMgr/SelectMgr_Selection.hxx @@ -24,7 +24,7 @@ class Select3D_SensitiveEntity; -//! Represents the state of a given selection mode for a +//! Represents the state of a given selection mode for a //! Selectable Object. Contains all the sensitive entities available for this mode. //! An interactive object can have an indefinite number of //! modes of selection, each representing a @@ -58,7 +58,7 @@ class Select3D_SensitiveEntity; //! - mode 3 : selection of the wires //! - mode 4 : selection of the faces //! - mode 5 : selection of the shells -//! - mode 6 : selection of the constituent solids. +//! - mode 6 : selection of the constituent solids. class SelectMgr_Selection : public Standard_Transient { DEFINE_STANDARD_RTTIEXT(SelectMgr_Selection, Standard_Transient) diff --git a/src/Visualization/TKV3d/SelectMgr/SelectMgr_SelectionManager.hxx b/src/Visualization/TKV3d/SelectMgr/SelectMgr_SelectionManager.hxx index 4df4ae42e3..0286ef73df 100644 --- a/src/Visualization/TKV3d/SelectMgr/SelectMgr_SelectionManager.hxx +++ b/src/Visualization/TKV3d/SelectMgr/SelectMgr_SelectionManager.hxx @@ -73,7 +73,7 @@ public: Standard_EXPORT void ClearSelectionStructures(const Handle(SelectMgr_SelectableObject)& theObj, const Standard_Integer theMode = -1); - //! Re-adds newly calculated sensitive entities of recomputed selection + //! Re-adds newly calculated sensitive entities of recomputed selection //! defined by mode theMode to all viewer selectors contained that selection. Standard_EXPORT void RestoreSelectionStructures(const Handle(SelectMgr_SelectableObject)& theObj, const Standard_Integer theMode = -1); diff --git a/src/Visualization/TKV3d/SelectMgr/SelectMgr_StateOfSelection.hxx b/src/Visualization/TKV3d/SelectMgr/SelectMgr_StateOfSelection.hxx index 13de9b49ba..b7b3217700 100644 --- a/src/Visualization/TKV3d/SelectMgr/SelectMgr_StateOfSelection.hxx +++ b/src/Visualization/TKV3d/SelectMgr/SelectMgr_StateOfSelection.hxx @@ -21,7 +21,7 @@ enum SelectMgr_StateOfSelection { SelectMgr_SOS_Any = -2, //!< ANY selection state (for querying selections) - SelectMgr_SOS_Unknown = -1, //!< selection, which has never been in SelectMgr_SOS_Activated state + SelectMgr_SOS_Unknown = -1, //!< selection, which has never been in SelectMgr_SOS_Activated state //!< (almost the same thing as SelectMgr_SOS_Deactivated) SelectMgr_SOS_Deactivated = 0, //!< deactivated selection, once been in SelectMgr_SOS_Activated state diff --git a/src/Visualization/TKV3d/SelectMgr/SelectMgr_ViewerSelector.hxx b/src/Visualization/TKV3d/SelectMgr/SelectMgr_ViewerSelector.hxx index a395f1fa86..26d54c93f6 100644 --- a/src/Visualization/TKV3d/SelectMgr/SelectMgr_ViewerSelector.hxx +++ b/src/Visualization/TKV3d/SelectMgr/SelectMgr_ViewerSelector.hxx @@ -58,7 +58,7 @@ typedef NCollection_DataMap //! as priority of the primitive or its depth in the view //! relative to that of other primitives. //! Note that in 3D, the inheriting framework -//! StdSelect_ViewerSelector3d is only to be used +//! StdSelect_ViewerSelector3d is only to be used //! if you do not want to use the services provided by //! AIS. //! Two tools are available to find and select objects @@ -114,7 +114,7 @@ public: //! Return the flag determining precedence of picked depth (distance from eye to entity) over //! entity priority in sorted results; TRUE by default. When flag is TRUE, priority will be - //! considered only if entities have the same depth within the tolerance. When flag is FALSE, + //! considered only if entities have the same depth within the tolerance. When flag is FALSE, //! entities with higher priority will be in front regardless of their depth (like x-ray). bool ToPickClosest() const { return myToPreferClosest; } diff --git a/src/Visualization/TKV3d/StdPrs/StdPrs_PoleCurve.hxx b/src/Visualization/TKV3d/StdPrs/StdPrs_PoleCurve.hxx index b53b15730a..d4707fedad 100644 --- a/src/Visualization/TKV3d/StdPrs/StdPrs_PoleCurve.hxx +++ b/src/Visualization/TKV3d/StdPrs/StdPrs_PoleCurve.hxx @@ -50,7 +50,7 @@ public: const Adaptor3d_Curve& aCurve, const Handle(Prs3d_Drawer)& aDrawer); - //! returns the pole the most near of the point (X,Y,Z) and + //! returns the pole the most near of the point (X,Y,Z) and //! returns its range. The distance between the pole and //! (X,Y,Z) must be less then aDistance. If no pole corresponds, 0 is returned. Standard_EXPORT static Standard_Integer Pick(const Standard_Real X, diff --git a/src/Visualization/TKV3d/StdPrs/StdPrs_ToolTriangulatedShape.hxx b/src/Visualization/TKV3d/StdPrs/StdPrs_ToolTriangulatedShape.hxx index 98d9da6aba..39eff988fc 100644 --- a/src/Visualization/TKV3d/StdPrs/StdPrs_ToolTriangulatedShape.hxx +++ b/src/Visualization/TKV3d/StdPrs/StdPrs_ToolTriangulatedShape.hxx @@ -27,8 +27,8 @@ public: //! @return true if all faces within shape are triangulated. Standard_EXPORT static Standard_Boolean IsTriangulated(const TopoDS_Shape& theShape); - //! Checks back faces visibility for specified shape (to activate back-face culling).
- //! @return true if shape is closed manifold Solid or compound of such Solids.
+ //! Checks back faces visibility for specified shape (to activate back-face culling). + //! @return true if shape is closed manifold Solid or compound of such Solids. Standard_EXPORT static Standard_Boolean IsClosed(const TopoDS_Shape& theShape); //! Computes the absolute deflection value depending on the type of deflection in theDrawer: diff --git a/src/Visualization/TKV3d/StdPrs/StdPrs_WFDeflectionRestrictedFace.hxx b/src/Visualization/TKV3d/StdPrs/StdPrs_WFDeflectionRestrictedFace.hxx index 16a9296f23..1ee57d743e 100644 --- a/src/Visualization/TKV3d/StdPrs/StdPrs_WFDeflectionRestrictedFace.hxx +++ b/src/Visualization/TKV3d/StdPrs/StdPrs_WFDeflectionRestrictedFace.hxx @@ -43,7 +43,7 @@ public: //! particular, the number of U and V isoparameters - are //! set in the attribute manager aDrawer. //! aFace is BRepAdaptor_Surface surface created - //! from a face in a topological shape. which is passed + //! from a face in a topological shape. which is passed //! as an argument through the //! BRepAdaptor_Surface surface created from it. //! This is what allows the topological face to be treated @@ -60,7 +60,7 @@ public: //! particular, the number of U isoparameters - //! are set in the attribute manager aDrawer. //! aFace is BRepAdaptor_Surface surface - //! created from a face in a topological shape. which + //! created from a face in a topological shape. which //! is passed to the function as an argument through //! the BRepAdaptor_Surface surface created from //! it. This is what allows the topological face to be @@ -77,7 +77,7 @@ public: //! particular, the number of V isoparameters - //! are set in the attribute manager aDrawer. //! aFace is BRepAdaptor_Surface surface - //! created from a face in a topological shape. which + //! created from a face in a topological shape. which //! is passed to the function as an argument through //! the BRepAdaptor_Surface surface created from //! it. This is what allows the topological face to be @@ -97,7 +97,7 @@ public: //! isoparameters, NBUiso and NBViso, in the shape. To //! do this, the arguments DrawUIso and DrawVIso must be true. //! aFace is BRepAdaptor_Surface surface created - //! from a face in a topological shape. which is passed + //! from a face in a topological shape. which is passed //! as an argument through the //! BRepAdaptor_Surface surface created from it. //! This is what allows the topological face to be treated diff --git a/src/Visualization/TKV3d/StdSelect/StdSelect_BRepSelectionTool.hxx b/src/Visualization/TKV3d/StdSelect/StdSelect_BRepSelectionTool.hxx index d3b19c7cb3..a4e5d7775a 100644 --- a/src/Visualization/TKV3d/StdSelect/StdSelect_BRepSelectionTool.hxx +++ b/src/Visualization/TKV3d/StdSelect/StdSelect_BRepSelectionTool.hxx @@ -34,7 +34,7 @@ class TopoDS_Face; //! Tool to create specific selections (sets of primitives) //! for Shapes from Topology. -//! These Selections may be used in dynamic selection +//! These Selections may be used in dynamic selection //! Mechanism //! Given a Shape and a mode of selection //! (selection of vertices, @@ -87,8 +87,8 @@ public: const Standard_Integer NbPOnEdge = 9, const Standard_Real MaximalParameter = 500); - //! Same functionalities ; the only - //! difference is that the selectable object from which the + //! Same functionalities. The only + //! difference is that the selectable object from which the //! selection comes is stored in each Sensitive EntityOwner; //! decomposition of into sensitive entities following //! a mode of decomposition . These entities are stored in diff --git a/src/Visualization/TKV3d/V3d/V3d_View.hxx b/src/Visualization/TKV3d/V3d/V3d_View.hxx index 3b1e482855..31ac442183 100644 --- a/src/Visualization/TKV3d/V3d/V3d_View.hxx +++ b/src/Visualization/TKV3d/V3d/V3d_View.hxx @@ -564,9 +564,9 @@ public: //! Updates the view. Standard_EXPORT void SetScale(const Standard_Real Coef); - //! Sets anisotropic (axial) scale factors , , for view . - //! Anisotropic scaling operation is performed through multiplying - //! the current view orientation matrix by a scaling matrix: + //! Sets anisotropic (axial) scale factors , , for view . + //! Anisotropic scaling operation is performed through multiplying + //! the current view orientation matrix by a scaling matrix: //! || Sx 0 0 0 || //! || 0 Sy 0 0 || //! || 0 0 Sz 0 || @@ -882,10 +882,10 @@ public: const Standard_Integer theMouseEndX, const Standard_Integer theMouseEndY); - //! Performs anisotropic scaling of view along the given . - //! The scale factor is calculated on a basis of + //! Performs anisotropic scaling of view along the given . + //! The scale factor is calculated on a basis of //! the mouse pointer displacement . - //! The calculated scale factor is then passed to SetAxialScale(Sx, Sy, Sz) method. + //! The calculated scale factor is then passed to SetAxialScale(Sx, Sy, Sz) method. Standard_EXPORT void AxialScale(const Standard_Integer Dx, const Standard_Integer Dy, const V3d_TypeOfAxe Axis); -- 2.39.5