[occt.git] / src / IntTools / IntTools_Tools.cdl

-- Created on: 2000-11-16
-- Created by: Peter KURNEV
-- Copyright (c) 2000-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.

class Tools from IntTools 

	---Purpose:  
	---  The class contains handy static functions 
	---  dealing with the geometry and topology. 
	 
uses
    Shape   from  TopoDS, 
    Vertex  from  TopoDS, 
    Edge    from  TopoDS, 
    Wire    from  TopoDS, 
    Face    from  TopoDS,
    Pnt2d   from  gp,   
    Pnt     from  gp, 
    Dir     from  gp,
    CommonPrt         from IntTools, 
    Curve             from IntTools, 
    SequenceOfCurves  from IntTools,
    Curve   from  Geom,
    State   from  TopAbs

is 
    ComputeVV  (myclass;V1,V2:Vertex  from  TopoDS) 
    	returns Integer from Standard; 
	---Purpose:
	--- Computes distance between vertex V1 and vertex V2,
	--- if the distance is less than sum of vertex tolerances
	--- returns zero,
	--- otherwise returns negative value
	---

    HasInternalEdge  (myclass;  
    	    	      aW: Wire  from  TopoDS) 
    	returns  Boolean from Standard;
	---Purpose:
	--- Returns True if wire aW contains edges
	--- with INTERNAL orientation
	---
 
    MakeFaceFromWireAndFace  (myclass; 
    	    	    	      aW: Wire from TopoDS;
    	    	    	      aF: Face from TopoDS;
    	    	    	      aFNew:out Face from TopoDS); 
    	---Purpose:
	--- Build a face based on surface of given face aF
	--- and bounded by wire aW
	---
		   
    ClassifyPointByFace	  (myclass;  
    	    	    	   aF: Face from TopoDS; 
		    	   P:  Pnt2d  from  gp) 
	returns State from TopAbs;
	---Purpose:
	--- 
	---
	
    IsVertex  (myclass; E: Edge    from  TopoDS; 
    	    	        t: Real from Standard) 
	returns Boolean from Standard;
	---Purpose:
	--- Computes square distance between a point on the edge E
	--- corresponded to parameter t and vertices of edge E.
	--- Returns True if this distance is less than square 
	--- tolerance of vertex, otherwise returns false.
	---
	    	 
    IsVertex  (myclass; E: Edge    from  TopoDS;  
    	    	        V: Vertex  from  TopoDS; 
    	    	        t: Real from Standard) 
	returns Boolean from Standard;
	---Purpose:
	--- Returns True if square distance between vertex V
	--- and a point on the edge E corresponded to parameter t
	--- is less than square tolerance of V
	---
	 
    IsVertex  (myclass;  aCmnPrt: CommonPrt from  IntTools) 
	returns Boolean from Standard;
	---Purpose:
	--- Returns True if IsVertx for middle parameter of fist range 
	--- and first edge returns True
	--- and if IsVertex for middle parameter of second range and 
    	--- second range returns True,
	--- otherwise returns False
	---
	 
    IsMiddlePointsEqual(myclass; 
   	    	       E1: Edge    from  TopoDS; 	           
   	    	       E2: Edge    from  TopoDS) 
        returns Boolean from Standard;
	---Purpose:
	--- Gets boundary of parameters of E1 and E2.
	--- Computes 3d points on each corresponded to average parameters.
	--- Returns True if distance between computed points is less than
	--- sum of edge tolerance, otherwise returns False.
	---

    IsVertex        (myclass; 
    	    	    aP  : Pnt  from gp;  
		    aTolPV: Real from Standard;	
    	    	    aV: Vertex  from TopoDS)  
    	returns Boolean from Standard;
	---Purpose:
	--- Returns True if the distance between point aP and 
	--- vertex aV is less or equal to sum of aTolPV and 
	--- vertex tolerance, otherwise returns False
	---

    IntermediatePoint (myclass; 
    	    	       aFirst: Real from Standard; 
                       aLast : Real from Standard) 
    	returns  Real from Standard;
	---Purpose:
	--- Returns some value between aFirst and aLast
	---
    
    SplitCurve  (myclass;  
    	    	 aC : Curve from IntTools;  
    	    	 aS :out SequenceOfCurves  from IntTools) 
    	returns Integer from Standard;
	---Purpose:
	--- Split aC by average parameter if aC is closed in 3D.
	--- Returns positive value if splitting has been done,
	--- otherwise returns zero.
	---
	 
    RejectLines(myclass; 
    	    	aSIn:     SequenceOfCurves  from IntTools; 
    	    	aSOut:out SequenceOfCurves  from IntTools);
    	---Purpose:
	--- Puts curves from aSIn to aSOut except those curves that
	--- are coincide with first curve from aSIn.
	---
			 
    IsDirsCoinside (myclass;  
    	    	    D1:Dir from gp; 
    	    	    D2:Dir from gp) 
    	returns Boolean from Standard;
	---Purpose:
	--- Returns True if D1 and D2 coinside
	--- 

    IsDirsCoinside (myclass;  
    	    	    D1  :Dir from gp; 
    	    	    D2  :Dir from gp; 
    	    	    aTol:Real from Standard) 
    	returns Boolean from Standard;
	---Purpose:
	--- Returns True if D1 and D2 coinside with given tolerance  
	---  

    IsClosed    (myclass;  
    	    	 aC : Curve from Geom)  
    	returns Boolean from Standard;
	---Purpose:
	--- Returns True if aC is BoundedCurve from Geom and
    	--- the distance between first point
	--- of the curve aC and last point
	--- is less than 1.e-12
	---
	
    CurveTolerance(myclass;   
    	    	    	aC   : Curve from Geom; 
			aTolBase : Real from Standard) 
    	returns Real from Standard;
	---Purpose:
	--- Returns adaptive tolerance for given aTolBase
	--- if aC is trimmed curve and basis curve is parabola,
	--- otherwise returns value of aTolBase
	---

end Tools;
Commit	Line	Data
b311480e	1	-- Created on: 2000-11-16
b311480e	2	-- Created by: Peter KURNEV
973c2be1	3	-- Copyright (c) 2000-2014 OPEN CASCADE SAS
b311480e	4	--
973c2be1	5	-- This file is part of Open CASCADE Technology software library.
b311480e	6	--
973c2be1	7	-- This library is free software; you can redistribute it and / or modify it
	8	-- under the terms of the GNU Lesser General Public version 2.1 as published
	9	-- by the Free Software Foundation, with special exception defined in the file
	10	-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	11	-- distribution for complete text of the license and disclaimer of any warranty.
b311480e	12	--
973c2be1	13	-- Alternatively, this file may be used under the terms of Open CASCADE
973c2be1	14	-- commercial license or contractual agreement.
7fd59977	15
	16	class Tools from IntTools
	17
	18	---Purpose:
	19	--- The class contains handy static functions
	20	--- dealing with the geometry and topology.
	21
	22	uses
	23	Shape from TopoDS,
	24	Vertex from TopoDS,
	25	Edge from TopoDS,
	26	Wire from TopoDS,
	27	Face from TopoDS,
	28	Pnt2d from gp,
	29	Pnt from gp,
	30	Dir from gp,
	31	CommonPrt from IntTools,
	32	Curve from IntTools,
	33	SequenceOfCurves from IntTools,
	34	Curve from Geom,
	35	State from TopAbs
	36
	37	is
	38	ComputeVV (myclass;V1,V2:Vertex from TopoDS)
	39	returns Integer from Standard;
	40	---Purpose:
	41	--- Computes distance between vertex V1 and vertex V2,
	42	--- if the distance is less than sum of vertex tolerances
	43	--- returns zero,
	44	--- otherwise returns negative value
	45	---
	46
	47	HasInternalEdge (myclass;
	48	aW: Wire from TopoDS)
	49	returns Boolean from Standard;
	50	---Purpose:
	51	--- Returns True if wire aW contains edges
	52	--- with INTERNAL orientation
	53	---
	54
	55	MakeFaceFromWireAndFace (myclass;
	56	aW: Wire from TopoDS;
	57	aF: Face from TopoDS;
	58	aFNew:out Face from TopoDS);
	59	---Purpose:
	60	--- Build a face based on surface of given face aF
	61	--- and bounded by wire aW
	62	---
	63
	64	ClassifyPointByFace (myclass;
	65	aF: Face from TopoDS;
	66	P: Pnt2d from gp)
	67	returns State from TopAbs;
	68	---Purpose:
	69	---
	70	---
	71
	72	IsVertex (myclass; E: Edge from TopoDS;
	73	t: Real from Standard)
	74	returns Boolean from Standard;
	75	---Purpose:
	76	--- Computes square distance between a point on the edge E
	77	--- corresponded to parameter t and vertices of edge E.
	78	--- Returns True if this distance is less than square
79	--- tolerance of vertex, otherwise returns false.
80	---
81
82	IsVertex (myclass; E: Edge from TopoDS;
83	V: Vertex from TopoDS;
84	t: Real from Standard)
85	returns Boolean from Standard;
86	---Purpose:
87	--- Returns True if square distance between vertex V
88	--- and a point on the edge E corresponded to parameter t
89	--- is less than square tolerance of V
90	---
91
92	IsVertex (myclass; aCmnPrt: CommonPrt from IntTools)
93	returns Boolean from Standard;
94	---Purpose:
95	--- Returns True if IsVertx for middle parameter of fist range
96	--- and first edge returns True
97	--- and if IsVertex for middle parameter of second range and
98	--- second range returns True,
99	--- otherwise returns False
100	---
101
102	IsMiddlePointsEqual(myclass;
103	E1: Edge from TopoDS;
104	E2: Edge from TopoDS)
105	returns Boolean from Standard;
106	---Purpose:
107	--- Gets boundary of parameters of E1 and E2.
108	--- Computes 3d points on each corresponded to average parameters.
109	--- Returns True if distance between computed points is less than
110	--- sum of edge tolerance, otherwise returns False.
111	---
112
113	IsVertex (myclass;
114	aP : Pnt from gp;
115	aTolPV: Real from Standard;
116	aV: Vertex from TopoDS)
117	returns Boolean from Standard;
118	---Purpose:
119	--- Returns True if the distance between point aP and
120	--- vertex aV is less or equal to sum of aTolPV and
121	--- vertex tolerance, otherwise returns False
122	---
123
124	IntermediatePoint (myclass;
125	aFirst: Real from Standard;
126	aLast : Real from Standard)
127	returns Real from Standard;
128	---Purpose:
129	--- Returns some value between aFirst and aLast
130	---
131
132	SplitCurve (myclass;
133	aC : Curve from IntTools;
134	aS :out SequenceOfCurves from IntTools)
135	returns Integer from Standard;
136	---Purpose:
137	--- Split aC by average parameter if aC is closed in 3D.
138	--- Returns positive value if splitting has been done,
139	--- otherwise returns zero.
140	---
141
142	RejectLines(myclass;
143	aSIn: SequenceOfCurves from IntTools;
144	aSOut:out SequenceOfCurves from IntTools);
145	---Purpose:
146	--- Puts curves from aSIn to aSOut except those curves that
147	--- are coincide with first curve from aSIn.
148	---
149
150	IsDirsCoinside (myclass;
151	D1:Dir from gp;
152	D2:Dir from gp)
153	returns Boolean from Standard;
154	---Purpose:
155	--- Returns True if D1 and D2 coinside
156	---
157
158	IsDirsCoinside (myclass;
159	D1 :Dir from gp;
160	D2 :Dir from gp;
161	aTol:Real from Standard)
162	returns Boolean from Standard;
163	---Purpose:
164	--- Returns True if D1 and D2 coinside with given tolerance
165	---
166
167	IsClosed (myclass;
168	aC : Curve from Geom)
169	returns Boolean from Standard;
170	---Purpose:
171	--- Returns True if aC is BoundedCurve from Geom and
172	--- the distance between first point
173	--- of the curve aC and last point
174	--- is less than 1.e-12
175	---
176
177	CurveTolerance(myclass;
178	aC : Curve from Geom;
179	aTolBase : Real from Standard)
180	returns Real from Standard;
181	---Purpose:
182	--- Returns adaptive tolerance for given aTolBase
183	--- if aC is trimmed curve and basis curve is parabola,
184	--- otherwise returns value of aTolBase
185	---
186
187	end Tools;