1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-01 10:26:12 +03:00
occt/src/GeomFill/GeomFill_LocationGuide.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

309 lines
10 KiB
Plaintext
Executable File

-- Created on: 1998-07-08
-- Created by: Stephanie HUMEAU
-- Copyright (c) 1998-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class LocationGuide from GeomFill
inherits LocationLaw from GeomFill
uses
HCurve from Adaptor3d,
Mat from gp,
Vec from gp,
Pnt from gp,
Shape from GeomAbs,
Array1OfReal from TColStd,
Array1OfVec2d from TColgp,
Array1OfPnt2d from TColgp,
HArray1OfPnt2d from TColgp,
HArray2OfPnt2d from TColgp,
HArray1OfReal from TColStd,
HSurface from Adaptor3d,
Curve from Geom,
Curve from Adaptor3d,
TrihedronWithGuide from GeomFill,
Dir from gp,
Line from Geom,
TrimmedCurve from Geom,
SectionLaw from GeomFill,
PipeError from GeomFill,
Vector from math
raises
NotImplemented, ConstructionError, OutOfRange
is
Create(Triedre : TrihedronWithGuide from GeomFill)
returns LocationGuide from GeomFill;
Set (me : mutable;
Section : SectionLaw from GeomFill;
rotat : Boolean from Standard;
SFirst, SLast : Real;
PrecAngle : Real;
LastAngle : out Real)
is static;
EraseRotation(me : mutable);
SetRotation(me : mutable;
PrecAngle : Real;
LastAngle : out Real)
is private;
SetCurve(me : mutable; C : HCurve from Adaptor3d)
is redefined;
GetCurve(me)
returns HCurve from Adaptor3d
---C++: return const &
is redefined;
SetTrsf(me : mutable; Transfo : Mat from gp)
is redefined;
Copy(me)
returns LocationLaw from GeomFill
is redefined;
D0(me : mutable;
Param: Real;
M : out Mat from gp;
V : out Vec from gp)
---Purpose: compute Location
returns Boolean is redefined;
D0(me : mutable;
Param: Real;
M : out Mat from gp;
V : out Vec from gp;
Poles2d : out Array1OfPnt2d from TColgp)
---Purpose: compute Location and 2d points
returns Boolean is redefined;
D1(me : mutable;
Param: Real;
M : out Mat from gp;
V : out Vec from gp;
DM : out Mat from gp;
DV : out Vec from gp;
Poles2d : out Array1OfPnt2d from TColgp;
DPoles2d : out Array1OfVec2d from TColgp)
---Purpose: compute location 2d points and associated
-- first derivatives.
-- Warning : It used only for C1 or C2 aproximation
returns Boolean
is redefined;
D2(me : mutable;
Param: Real;
M : out Mat from gp;
V : out Vec from gp;
DM : out Mat from gp;
DV : out Vec from gp;
D2M : out Mat from gp;
D2V : out Vec from gp;
Poles2d : out Array1OfPnt2d from TColgp;
DPoles2d : out Array1OfVec2d from TColgp;
D2Poles2d : out Array1OfVec2d from TColgp)
---Purpose: compute location 2d points and associated
-- first and seconde derivatives.
-- Warning : It used only for C2 aproximation
returns Boolean
is redefined;
-- ================== General Information On The Function ==================
--
HasFirstRestriction(me)
---Purpose: Say if the first restriction is defined in this class.
-- If it is true the first element of poles array in
-- D0,D1,D2... Correspond to this restriction.
-- Returns Standard_False (default implementation)
returns Boolean
is redefined;
HasLastRestriction(me) -- A FAIRE !!
---Purpose: Say if the last restriction is defined in this class.
-- If it is true the last element of poles array in
-- D0,D1,D2... Correspond to this restriction.
-- Returns Standard_False (default implementation)
returns Boolean
is redefined;
TraceNumber(me)
---Purpose: Give the number of trace (Curves 2d wich are not restriction)
-- Returns 1 (default implementation)
returns Integer
is redefined;
ErrorStatus(me)
---Purpose:Give a status to the Law
-- Returns PipeOk (default implementation)
returns PipeError from GeomFill
is redefined;
--
-- =================== Management of continuity ===================
--
NbIntervals(me; S : Shape from GeomAbs)
---Purpose: Returns the number of intervals for continuity
-- <S>.
-- May be one if Continuity(me) >= <S>
returns Integer is redefined;
Intervals(me; T : in out Array1OfReal from TColStd;
S : Shape from GeomAbs)
---Purpose: Stores in <T> the parameters bounding the intervals
-- of continuity <S>.
--
-- The array must provide enough room to accomodate
-- for the parameters. i.e. T.Length() > NbIntervals()
raises
OutOfRange from Standard
is redefined;
SetInterval(me: mutable; First, Last: Real from Standard)
---Purpose: Sets the bounds of the parametric interval on
-- the function
-- This determines the derivatives in these values if the
-- function is not Cn.
is redefined;
GetInterval(me; First, Last: out Real from Standard)
---Purpose: Gets the bounds of the parametric interval on
-- the function
is redefined;
GetDomain(me; First, Last: out Real from Standard)
---Purpose: Gets the bounds of the function parametric domain.
-- Warning: This domain it is not modified by the
-- SetValue method
is redefined;
-- =================== To help computation of Tolerance ===============
--
-- Evaluation of error, in 2d space, or on composed function, is
-- difficult. The following methods can help the approximation to
-- make good evaluation and use good tolerances.
--
-- It is not necessary for the following informations to be very
-- precise. A fast evaluation is sufficient.
SetTolerance(me : mutable; Tol3d, Tol2d : Real)
---Purpose: Is usefull, if (me) have to run numerical
-- algorithm to perform D0, D1 or D2
-- The default implementation make nothing.
is redefined;
Resolution(me;
Index : Integer from Standard;
Tol : Real from Standard;
TolU, TolV : out Real from Standard)
---Purpose: Returns the resolutions in the sub-space 2d <Index>
-- This information is usfull to find an good tolerance in
-- 2d approximation.
-- Warning: Used only if Nb2dCurve > 0
is redefined;
GetMaximalNorm(me : mutable)
---Purpose: Get the maximum Norm of the matrix-location part. It
-- is usful to find an good Tolerance to approx M(t).
returns Real
is redefined;
GetAverageLaw(me : mutable;
AM: out Mat from gp;
AV: out Vec from gp)
---Purpose: Get average value of M(t) and V(t) it is usfull to
-- make fast approximation of rational surfaces.
is redefined;
--
-- To find elementary sweep
--
IsTranslation(me; Error : out Real)
---Purpose: Say if the Location Law, is an translation of Location
-- The default implementation is " returns False ".
returns Boolean
is redefined;
IsRotation(me; Error : out Real )
---Purpose: Say if the Location Law, is a rotation of Location
-- The default implementation is " returns False ".
returns Boolean
is redefined;
Rotation(me; Center : out Pnt from gp)
is redefined;
Section(me)
returns Curve from Geom;
Guide(me)
returns HCurve from Adaptor3d;
InitX(me;
Param : Real from Standard)
is private;
SetOrigine(me : mutable;
Param1 : Real;
Param2 : Real)
is static;
fields
myLaw : TrihedronWithGuide from GeomFill; -- loi de triedre
mySec : SectionLaw from GeomFill; -- loi de section
myCurve : HCurve from Adaptor3d; -- trajectoire
myGuide : HCurve from Adaptor3d; -- guide
myTrimmed : HCurve from Adaptor3d; -- trajectoire trimme
myPoles2d : HArray2OfPnt2d from TColgp is protected;
myNbPts : Integer from Standard;
rotation : Boolean from Standard; -- contact ou non
OrigParam1 : Real from Standard; -- pour ACR
OrigParam2 : Real from Standard;
Uf, Ul : Real from Standard;
myFirstS : Real from Standard;
myLastS : Real from Standard;
ratio : Real from Standard;
WithTrans: Boolean from Standard;
Trans : Mat from gp;
TolRes : Vector from math;
Inf, Sup: Vector from math;
X, R : Vector from math;
myStatus : PipeError from GeomFill;
end LocationGuide;