1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-06 10:36:12 +03:00
occt/src/IntStart/IntStart_SOBTool.cdl
bugmster 973c2be1e1 0024428: Implementation of LGPL license
The copying permission statements at the beginning of source files updated to refer to LGPL.
Copyright dates extended till 2014 in advance.
2013-12-17 12:42:41 +04:00

152 lines
4.6 KiB
Plaintext

-- Created on: 1993-05-04
-- Created by: Jacques GOUSSARD
-- 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 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.
deferred generic class SOBTool from IntStart
(TheVertex as any;
TheArc as any)
---Purpose:
uses Pnt from gp
is
-- Methods for an arc of restrictition
HasBeenSeen(myclass; A: TheArc)
---Purpose: Returns True if all the intersection point and edges
-- are known on the Arc.
returns Boolean from Standard;
-- The following methods are used when HasBeenSeen returns Standard_True
NbPoints(myclass; A: TheArc)
---Purpose: Returns the number of intersection points on the arc A.
returns Integer from Standard;
Value(myclass; A: TheArc; Index: Integer from Standard;
Pt: out Pnt from gp; Tol: out Real from Standard;
U: out Real from Standard);
---Purpose: Returns the value (Pt), the tolerance (Tol), and
-- the parameter (U) on the arc A , of the intersection
-- point of range Index.
IsVertex(myclass; A: TheArc; Index: Integer from Standard)
---Purpose: Returns True if the intersection point of range Index
-- corresponds with a vertex on the arc A.
returns Boolean from Standard;
Vertex(myclass; A: TheArc; Index: Integer from Standard;
Vtx: out TheVertex);
---Purpose: When IsVertex returns True, this method returns the
-- vertex on the arc A.
NbSegments(myclass; A: TheArc)
---Purpose: returns the number of part of A solution of the
-- of intersection problem.
returns Integer from Standard;
HasFirstPoint(myclass; A: TheArc; Index: Integer from Standard;
IndFirst: out Integer from Standard)
---Purpose: Returns True when the segment of range Index is not
-- open at the left side. In that case, IndFirst is the
-- range in the list intersection points (see NbPoints)
-- of the one which defines the left bound of the segment.
-- Otherwise, the method has to return False, and IndFirst
-- has no meaning.
returns Boolean from Standard;
HasLastPoint(myclass; A: TheArc; Index: Integer from Standard;
IndLast: out Integer from Standard)
---Purpose: Returns True when the segment of range Index is not
-- open at the right side. In that case, IndLast is the
-- range in the list intersection points (see NbPoints)
-- of the one which defines the right bound of the segment.
-- Otherwise, the method has to return False, and IndLast
-- has no meaning.
returns Boolean from Standard;
IsAllSolution(myclass; A: TheArc)
---Purpose: Returns True when the whole restriction is solution
-- of the intersection problem.
returns Boolean from Standard;
-- The following methods are used when HasBeenSeen returns Standard_False
NbSamplesOnArc(myclass; A: TheArc)
---Purpose: returns the number of points which is used to make
-- a sample on the arc. this number is a function of
-- the Surface and the CurveOnSurface complexity.
returns Integer from Standard;
Bounds(myclass; A: TheArc; Ufirst,Ulast: out Real from Standard);
---Purpose: Returns the parametric limits on the arc A.
-- These limits must be finite : they are either
-- the real limits of the arc, for a finite arc,
-- or a bounding box for an infinite arc.
Parameter(myclass; V: TheVertex; A: TheArc)
---Purpose: Returns the parameter of the vertex V on the arc A.
returns Real from Standard;
Tolerance(myclass; V: TheVertex; A: TheArc)
---Purpose: Returns the parametric tolerance on the arc used
-- to consider that the vertex and another point meet,
-- i-e if the difference between the parameter of the
-- Vertex and the parameter of the other point is less
-- than Tolerance, the point are "merged".
returns Real from Standard;
end SOBTool;