1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-21 10:13:43 +03:00
occt/src/GeomAPI/GeomAPI_IntSS.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

113 lines
3.5 KiB
Plaintext
Executable File

-- Created on: 1995-03-14
-- Created by: Jacques GOUSSARD
-- Copyright (c) 1995-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 IntSS from GeomAPI
---Purpose: This class implements methods for
-- computing the intersection curves between two surfaces.
-- The result is curves from Geom. The "domain" used for
-- a surface is the natural parametric domain
-- unless the surface is a RectangularTrimmedSurface
-- from Geom.
uses IntSS from GeomInt,
Surface from Geom,
Curve from Geom
raises NotDone from StdFail,
OutOfRange from Standard
is
Create
---Purpose: Constructs an empty object. Use the
-- function Perform for further initialization algorithm by two surfaces.
returns IntSS from GeomAPI;
---C++: inline
Create(S1,S2: Surface from Geom; Tol: Real from Standard)
---Purpose: Computes the intersection curves
-- between the two surfaces S1 and S2. Parameter Tol defines the precision
-- of curves computation. For most cases the value 1.0e-7 is recommended to use.
-- Warning
-- Use the function IsDone to verify that the intersections are successfully computed.I
---C++: inline
returns IntSS from GeomAPI;
Perform(me: in out;S1,S2: Surface from Geom; Tol: Real from Standard)
---Purpose: Initializes an algorithm with the
-- given arguments and computes the intersection curves between the two surfaces S1 and S2.
-- Parameter Tol defines the precision of curves computation. For most
-- cases the value 1.0e-7 is recommended to use.
-- Warning
-- Use function IsDone to verify that the intersections are successfully computed.
---C++: inline
is static;
IsDone(me)
---Purpose: Returns True if the intersection was successful.
returns Boolean from Standard
---C++: inline
is static;
NbLines(me)
returns Integer from Standard
---C++: inline
---Purpose: Returns the number of computed intersection curves.
-- Exceptions
-- StdFail_NotDone if the computation fails.
raises NotDone from StdFail
is static;
Line(me; Index: Integer from Standard)
---Purpose: Returns the computed intersection curve of index Index.
-- Exceptions
-- StdFail_NotDone if the computation fails.
-- Standard_OutOfRange if Index is out of range [1, NbLines] where NbLines
-- is the number of computed intersection curves.
returns any Curve from Geom
---C++: return const&
---C++: inline
raises NotDone from StdFail,
OutOfRange from Standard
is static;
fields
myIntersec : IntSS from GeomInt;
end IntSS;