OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +03:00
Code Activity

0024784: Move documentation in CDL files to proper location

Browse Source 
Mostly duplicated comments were removed and missing ones were moved
into dedicated class CDL files.
Some more duplicated comments were removed from CDL files.
Correction of merge
This commit is contained in:
ski
2014-05-29 16:05:47 +04:00
committed by apn
parent bdd1223f46
commit ff8178ef85
533 changed files with 1047 additions and 2921 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
src/GeomFill/GeomFill.cdl
View File

@@ -65,7 +65,6 @@ is
IsGuideACWithContact, IsGuidePlanWithContact, IsDiscreteTrihedron end;
class Filling;
---Purpose: Root class for Filling;
class Stretch;
@@ -75,26 +74,15 @@ is
class BezierCurves;
---Purpose: class for Filling BezierCurves.
-- WARNING:
-- Some problems may appear with the rational Curves.
class BSplineCurves;
---Purpose: class for Filling BSplineCurves.
-- WARNING:
-- Some problems may appear with the rational Curves.
class Profiler;
---Purpose: class for evaluation of the Common BSpline Profile
-- from a sequence a BSplineCurves.
class SectionGenerator;
---Purpose: class for instantiation of AppBlend .
-- inherits Profiler.
class Line;
---Purpose: class for instantiation of AppBlend
class AppSurf instantiates AppSurf from AppBlend
( SectionGenerator from GeomFill,
Line from GeomFill);
@@ -103,8 +91,6 @@ is
class SweepSectionGenerator;
---Purpose: class for instantiation of AppBlend.
-- evaluate the sections of a sweep surface.
class AppSweep instantiates AppSurf from AppBlend
( SweepSectionGenerator from GeomFill,
@@ -114,74 +100,34 @@ is
class Generator;
---Purpose: Create a surface using generating lines. Inherits
-- profiler. The surface will be a BSplineSurface
-- passing by all the curves described in the
-- generator. The VDegree of the resulting surface is
-- 1.
class Pipe;
---Purpose: Create a pipe surface.
--- Family of classes providing algorithms to fill a contour with
-- constraints of tangency.
-- class Draft;
---Purpose: Depouille
class Tensor;
class ConstrainedFilling;
---Purpose: class for filling a contour of 2, 3 or 4 curves with
-- tangency constaints. The only FillingStyle used is
-- Coons.
--
deferred class Boundary; -- inherits TShared
---Purpose: Root class defining the methods we need to make a
-- constrained boundary. Any new type of constrained
-- boundary must inherit this class.
--
class DegeneratedBound; -- inherits Boundary
---Purpose: class defining a degenerated boundary for a
-- constrained filling with a point and no other
-- constraint. Only used to simulate an ordinary bound,
-- may not be usefull and desapear soon.
--
class SimpleBound; -- inherits Boundary
---Purpose: class defining a boundary for a constrained filling
-- with a 3d curve and no other constraint. Contains
-- fields to allow a reparametrization of curve.
--
class BoundWithSurf; -- inherits Boundary
---Purpose: class defining a boundary for a constrained filling
-- with a curve and a normals field along a surface.
-- Contains fields to allow a reparametrization of curve
-- and normals field.
--
class CoonsAlgPatch; -- inherits TShared
---Purpose: class defining an algorithmic patch based on 4 Curves.
deferred class TgtField; -- inherits TShared
---Purpose: Root class defining the methods we need to definine an
-- algorithmic tgte field.
class TgtOnCoons; -- inherits TgteField
---Purpose: Class defining an algorithmic tgte field along a
-- boundary of a CoonsAlgPatch.
class CornerState;
---Purpose: Class (should be a structure) storing the informations
-- about continuity, normals parallelism, coons
-- conditions and bounds tangents angle on the corner of
-- contour to be filled.
--
-- instantiation of Sequence of Trsf

2
src/GeomFill/GeomFill_BoundWithSurf.cdl
View File

@@ -23,6 +23,8 @@ class BoundWithSurf from GeomFill inherits Boundary from GeomFill
-- the computations are done with a CurveOnSurf and a
-- normals field defined by the normalized normal to
-- the surface along the PCurve.
-- Contains fields to allow a reparametrization of curve
-- and normals field.
uses
Pnt from gp,

1
src/GeomFill/GeomFill_Boundary.cdl
View File

@@ -18,6 +18,7 @@ deferred class Boundary from GeomFill inherits TShared from MMgt
---Purpose: Root class to define a boundary which will form part of a
-- contour around a gap requiring filling.
-- Any new type of constrained boundary must inherit this class.
-- The GeomFill package provides two classes to define constrained boundaries:
-- - GeomFill_SimpleBound to define an unattached boundary
-- - GeomFill_BoundWithSurf to define a boundary attached to a surface.

1
src/GeomFill/GeomFill_ConstrainedFilling.cdl
View File

@@ -21,6 +21,7 @@ class ConstrainedFilling from GeomFill
-- constraints and optionally, as tangency constraints.
-- The algorithm accepts three or four curves as the
-- boundaries of the target surface.
-- The only FillingStyle used is Coons.
-- A ConstrainedFilling object provides a framework for:
-- - defining the boundaries of the surface
-- - implementing the construction algorithm

2
src/GeomFill/GeomFill_CoonsAlgPatch.cdl
View File

@@ -17,7 +17,7 @@
class CoonsAlgPatch from GeomFill inherits TShared from MMgt
---Purpose: Provides evaluation methods on an algorithmic
-- patch defined by its boundaries and blending
-- patch (based on 4 Curves) defined by its boundaries and blending
-- functions.
uses

5
src/GeomFill/GeomFill_DegeneratedBound.cdl
View File

@@ -17,7 +17,10 @@
class DegeneratedBound from GeomFill inherits Boundary from GeomFill
---Purpose: Description of a degenerated boundary (a point).
-- Class defining a degenerated boundary for a
-- constrained filling with a point and no other
-- constraint. Only used to simulate an ordinary bound,
-- may not be usefull and desapear soon.
uses
Pnt from gp,
Vec from gp

2
src/GeomFill/GeomFill_Filling.cdl
View File

@@ -15,7 +15,7 @@
-- commercial license or contractual agreement.
class Filling from GeomFill
---Purpose: Root class for Filling;
uses
Array1OfPnt from TColgp,

2
src/GeomFill/GeomFill_Line.cdl
View File

@@ -16,7 +16,7 @@
class Line from GeomFill
---Purpose:
---Purpose: class for instantiation of AppBlend
inherits TShared from MMgt

1
src/GeomFill/GeomFill_SimpleBound.cdl
View File

@@ -19,6 +19,7 @@ class SimpleBound from GeomFill inherits Boundary from GeomFill
---Purpose: Defines a 3d curve as a boundary for a
-- GeomFill_ConstrainedFilling algorithm.
-- This curve is unattached to an existing surface.D
-- Contains fields to allow a reparametrization of curve.
uses
Pnt from gp,