Files
OCCT/src/GeomFill/GeomFill.cdl
ski ff8178ef85 0024784: Move documentation in CDL files to proper location
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
2014-05-29 16:06:49 +04:00

286 lines
8.1 KiB
Plaintext

-- Created on: 1993-09-28
-- Created by: Bruno DUMORTIER
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
---Purpose: Tools and Data to filling Surface and Sweep Surfaces
package GeomFill
uses
TColgp,
TColGeom,
TColGeom2d,
TColStd,
TCollection,
gp,
Geom,
Geom2d,
GeomAbs,
Convert,
Adaptor3d,
GeomAdaptor,
Law,
Extrema,
AppBlend,
Approx,
math,
MMgt,
StdFail
is
enumeration FillingStyle
is StretchStyle, CoonsStyle, CurvedStyle end;
---Purpose: Defines the three filling styles used in this package
-- - GeomFill_Stretch - the style with the flattest patches
-- - GeomFill_Coons - a rounded style of patch with
-- less depth than those of Curved
-- - GeomFill_Curved - the style with the most rounded patches.
enumeration ApproxStyle
is Section, Location end;
enumeration PipeError
is PipeOk,
PipeNotOk,
PlaneNotIntersectGuide,
ImpossibleContact
end;
enumeration Trihedron
is IsCorrectedFrenet, IsFixed, IsFrenet, IsConstantNormal, IsDarboux,
IsGuideAC, IsGuidePlan,
IsGuideACWithContact, IsGuidePlanWithContact, IsDiscreteTrihedron end;
class Filling;
class Stretch;
class Coons;
class Curved;
class BezierCurves;
class BSplineCurves;
class Profiler;
class SectionGenerator;
class Line;
class AppSurf instantiates AppSurf from AppBlend
( SectionGenerator from GeomFill,
Line from GeomFill);
---Purpose: Approximate a BSplineSurface passing by all the
-- curves described in the SectionGenerator
class SweepSectionGenerator;
class AppSweep instantiates AppSurf from AppBlend
( SweepSectionGenerator from GeomFill,
Line from GeomFill);
---Purpose: Approximate a sweep surface passing by all the
-- curves described in the SweepSectionGenerator.
class Generator;
class Pipe;
--- Family of classes providing algorithms to fill a contour with
-- constraints of tangency.
class Tensor;
class ConstrainedFilling;
deferred class Boundary; -- inherits TShared
class DegeneratedBound; -- inherits Boundary
class SimpleBound; -- inherits Boundary
class BoundWithSurf; -- inherits Boundary
class CoonsAlgPatch; -- inherits TShared
deferred class TgtField; -- inherits TShared
class TgtOnCoons; -- inherits TgteField
class CornerState;
--
-- instantiation of Sequence of Trsf
--
class SequenceOfTrsf
instantiates Sequence from TCollection (Trsf from gp);
class SequenceOfAx2
instantiates Sequence from TCollection (Ax2 from gp);
class HSequenceOfAx2
instantiates HSequence from TCollection (Ax2 from gp,
SequenceOfAx2 from GeomFill);
--
-- private classes
--
private class CircularBlendFunc;
private class SweepFunction;
private class LocFunction;
private class PolynomialConvertor;
private class QuasiAngularConvertor;
private class SnglrFunc;
private class FunctionDraft;
private class PlanFunc;
private class FunctionGuide;
---
--- Sweep Data
---
deferred class SectionLaw;
class UniformSection;
class EvolvedSection;
class NSections;
deferred class LocationLaw;
class CurveAndTrihedron;
class LocationDraft;
class LocationGuide;
deferred class TrihedronLaw;
class Fixed;
class Frenet;
class CorrectedFrenet;
class DiscreteTrihedron;
class ConstantBiNormal;
class Darboux;
class DraftTrihedron;
deferred class TrihedronWithGuide;
class GuideTrihedronAC;
class GuideTrihedronPlan;
class Sweep;
class SectionPlacement;
class Array1OfSectionLaw
instantiates Array1 from TCollection (SectionLaw from GeomFill);
class HArray1OfSectionLaw
instantiates HArray1 from TCollection (SectionLaw from GeomFill,
Array1OfSectionLaw from GeomFill);
class Array1OfLocationLaw
instantiates Array1 from TCollection (LocationLaw from GeomFill);
class HArray1OfLocationLaw
instantiates HArray1 from TCollection (LocationLaw from GeomFill,
Array1OfLocationLaw from GeomFill);
-- package methods
--
Surface( Curve1 : Curve from Geom;
Curve2 : Curve from Geom)
returns Surface from Geom;
---Purpose:
-- Builds a ruled surface between the two curves, Curve1 and Curve2.
GetCircle(TConv : ParameterisationType from Convert;
ns1, ns2 : Vec from gp;
nplan : Vec from gp;
pt1, pt2 : Pnt from gp;
Rayon : Real from Standard;
Center : Pnt from gp;
Poles : out Array1OfPnt from TColgp;
Weigths : out Array1OfReal from TColStd);
GetCircle(TConv : ParameterisationType from Convert;
ns1, ns2 : Vec from gp;
dn1w, dn2w : Vec from gp;
nplan, dnplan : Vec from gp;
pts1, pts2 : Pnt from gp;
tang1, tang2 : Vec from gp;
Rayon, DRayon : Real from Standard;
Center : Pnt from gp;
DCenter : Vec from gp;
Poles : out Array1OfPnt from TColgp;
DPoles : out Array1OfVec from TColgp;
Weigths : out Array1OfReal from TColStd;
DWeigths : out Array1OfReal from TColStd)
---Level: Internal
returns Boolean;
GetCircle(TConv : ParameterisationType from Convert;
ns1, ns2 : Vec from gp;
dn1w, dn2w : Vec from gp;
d2n1w, d2n2w : Vec from gp;
nplan, dnplan, d2nplan : Vec from gp;
pts1 , pts2 : Pnt from gp;
tang1 , tang2 : Vec from gp;
Dtang1, Dtang2 : Vec from gp;
Rayon, DRayon, D2Rayon : Real from Standard;
Center : Pnt from gp;
DCenter, D2Center : Vec from gp;
Poles : out Array1OfPnt from TColgp;
DPoles : out Array1OfVec from TColgp;
D2Poles : out Array1OfVec from TColgp;
Weigths : out Array1OfReal from TColStd;
DWeigths : out Array1OfReal from TColStd;
D2Weigths : out Array1OfReal from TColStd)
---Level: Internal
returns Boolean;
GetShape(MaxAng: Real from Standard;
NbPoles,NbKnots,Degree : out Integer from Standard;
TypeConv : in out ParameterisationType from Convert);
Knots(TypeConv : ParameterisationType from Convert;
TKnots: out Array1OfReal from TColStd);
Mults(TypeConv : ParameterisationType from Convert;
TMults: out Array1OfInteger from TColStd);
GetMinimalWeights(TConv : ParameterisationType from Convert;
AngleMin : Real;
AngleMax : Real;
Weigths : out Array1OfReal from TColStd);
GetTolerance(TConv : ParameterisationType from Convert;
AngleMin : Real;
Radius : Real;
AngularTol : Real;
SpatialTol : Real)
---Purpose: Used by the generical classes to determine
-- Tolerance for approximation
---Level: Internal
returns Real;
end GeomFill;