OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-09-03 14:10:33 +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

58
src/StdPrs/StdPrs.cdl
View File

@@ -57,88 +57,46 @@ is
class ShadedShape;
class PoleCurve;
---Purpose: computes the presentation of curves by drawing
-- a broken line linking the poles of the curve.
class Plane;
---Purpose: computes the presentation of a infinite plane.
class WFPoleSurface;
---Purpose: computes the presentation of surfaces by drawing a
-- double network of lines linking the poles of the surface
-- in the two parametric direction.
class DeflectionCurve;
---Purpose: computes the presentation of objects to be
-- seen as curves. The computation will be made
-- according to a maximal chordial deviation.
---Category: Wireframe algorithms
class WFDeflectionSurface;
---Purpose: computes the wireframe presentation of surfaces
-- by displaying a given number of U and/or V isoparametric
--- curves. The isoparametric curves are drawn with respect
-- to a given maximal chordial deviation.
class ShadedSurface;
---Purpose: computes the shading presentation of surfaces.
-----------------------------------------------
--- deflection drawing classes :
-----------------------------------------------
class WFDeflectionRestrictedFace;
---Purpose: computes the wireframe presentation of faces with
-- restrictions by displaying a given number of U and/or
-- V isoparametric curves. The isoparametric curves are
-- drawn with respect to a maximal chordial deviation.
-- The presentation includes the restriction curves.
class Curve;
---Purpose: computes the presentation of objects to be
-- seen as curves. The computation will be made
-- whith a constant number of points.
class Curve;
class WFSurface;
---Purpose: computes the wireframe presentation of surfaces
-- by displaying a given number of U and/or V isoparametric
--- curves. The isoparametric curves are drawn with respect
-- to a given number of points.
---Category: Hidden lines removal algorithms.
class HLRPolyShape;
---Purpose: computes the presentation of objects with
-- removal of their hidden lines for a specific
-- projector. The polygonal algorithm is used.
imported HLRShape;
---Purpose: computes the presentation of objects with
-- removal of their hidden lines for a specific
-- projector. The exact algorithm is used.
imported NListOfSequenceOfPnt from Prs3d;
imported NListIteratorOfListOfSequenceOfPnt from Prs3d;
imported WFShape;
imported WFDeflectionShape;
---Purpose: computes the wireframe presentation of surfaces
-- by displaying planar sections.
imported Vertex;
imported Point;
---Purpose: computes the presentation of objects to be
-- seen as points.
imported WFRestrictedFace;
---Purpose: Computes the wireframe presentation of faces with
-- restrictions by displaying a given number of U and/or
-- V isoparametric curves. The isoparametric curves are
-- drawn with a fixed number of points.
-- The presentation includes the restriction curves.
end StdPrs;

1
src/StdPrs/StdPrs_HLRPolyShape.cdl
View File

@@ -27,6 +27,7 @@ inherits Root from Prs3d
-- obtain an exact result, whereas, when you use
-- StdPrs_HLRPolyShape, you reduce computation
-- time but obtain polygonal segments.
-- The polygonal algorithm is used.
uses
Shape from TopoDS,
Presentation from Prs3d,

4
src/StdPrs/StdPrs_HLRShape.hxx
View File

@@ -19,6 +19,10 @@
#include <Prs3d_Drawer.hxx>
#include <Prs3d_Projector.hxx>
// Computes the presentation of objects with
// removal of their hidden lines for a specific
// projector. The exact algorithm is used.
class StdPrs_HLRShape: public Prs3d_Root
{
public:

2
src/StdPrs/StdPrs_Point.hxx
View File

@@ -19,6 +19,6 @@
#include <Prs3d_Drawer.hxx>
#include <Prs3d_Presentation.hxx>
#include <StdPrs_ToolPoint.hxx>
//computes the presentation of objects to be seen as points.
typedef Prs3d_Point<Handle(Geom_Point), StdPrs_ToolPoint> StdPrs_Point;
#endif

6
src/StdPrs/StdPrs_PoleCurve.cdl
View File

@@ -17,9 +17,9 @@
class PoleCurve from StdPrs
inherits Root from Prs3d
---Purpose: A framework to provide display of Bezier or BSpline curves.
---Purpose: A framework to provide display of Bezier or BSpline curves
-- (by drawing a broken line linking the poles of the curve).
uses
Curve from Adaptor3d,

9
src/StdPrs/StdPrs_ShadedSurface.cdl
View File

@@ -17,10 +17,11 @@
class ShadedSurface from StdPrs
inherits Root from Prs3d
--- Purpose: Draws a surface by drawing the isoparametric curves with respect to
-- a maximal chordial deviation.
-- The number of isoparametric curves to be drawn and their color are
-- controlled by the furnished Drawer.
--- Purpose: Computes the shading presentation of surfaces.
-- Draws a surface by drawing the isoparametric curves with respect to
-- a maximal chordial deviation.
-- The number of isoparametric curves to be drawn and their color are
-- controlled by the furnished Drawer.
uses
Surface from Adaptor3d,
Presentation from Prs3d,

5
src/StdPrs/StdPrs_WFDeflectionRestrictedFace.cdl
View File

@@ -22,6 +22,11 @@ inherits Root from Prs3d
---Purpose: A framework to provide display of U and V
-- isoparameters of faces, while allowing you to impose
-- a deflection on them.
-- Computes the wireframe presentation of faces with
-- restrictions by displaying a given number of U and/or
-- V isoparametric curves. The isoparametric curves are
-- drawn with respect to a maximal chordial deviation.
-- The presentation includes the restriction curves.
uses
HSurface from BRepAdaptor,

3
src/StdPrs/StdPrs_WFDeflectionShape.hxx
View File

@@ -24,6 +24,9 @@
#include <TopoDS_Shape.hxx>
#include <TopTools_HSequenceOfShape.hxx>
// Computes the wireframe presentation of surfaces
// by displaying planar sections.
class StdPrs_WFDeflectionShape : public Prs3d_Root
{

7
src/StdPrs/StdPrs_WFPoleSurface.cdl
View File

@@ -17,8 +17,11 @@
class WFPoleSurface from StdPrs
inherits Root from Prs3d
--- Purpose: The number of lines to be drawn is controlled
-- by the NetworkNumber of the given Drawer.
--- Purpose: Computes the presentation of surfaces by drawing a
-- double network of lines linking the poles of the surface
-- in the two parametric direction.
-- The number of lines to be drawn is controlled
-- by the NetworkNumber of the given Drawer.
uses
Surface from Adaptor3d,
Presentation from Prs3d,

6
src/StdPrs/StdPrs_WFRestrictedFace.hxx
View File

@@ -20,6 +20,12 @@
#include <Prs3d_Root.hxx>
#include <Prs3d_NListOfSequenceOfPnt.hxx>
// Computes the wireframe presentation of faces with
// restrictions by displaying a given number of U and/or
// V isoparametric curves. The isoparametric curves are
// drawn with a fixed number of points.
// The presentation includes the restriction curves.
class StdPrs_WFRestrictedFace : public Prs3d_Root
{
public:

4
src/StdPrs/StdPrs_WFSurface.cdl
View File

@@ -15,6 +15,10 @@
-- commercial license or contractual agreement.
class WFSurface from StdPrs
---Purpose: Computes the wireframe presentation of surfaces
-- by displaying a given number of U and/or V isoparametric
--- curves. The isoparametric curves are drawn with respect
-- to a given number of points.
inherits Root from Prs3d