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

-- File:	IntTools_ShrunkRange.cdl
-- Created:	Sun Mar 11 10:31:46 2001
-- Author:	Peter KURNEV
--		<pkv@irinox>
---Copyright:	 Matra Datavision 2001


class ShrunkRange from IntTools 

	---Purpose:  
	---  The class provides the computation of 
	---  a working (shrunk) range [t1, t2] for 
    	---  the 3D-curve of the edge. 
	 
uses
 
    Edge from TopoDS, 
    Vertex from TopoDS, 
    Range from IntTools, 
    Box from Bnd, 
    Context from IntTools, 
    PContext from IntTools 

--raises

is 
    Create 
    	returns ShrunkRange from IntTools;
	---Purpose:
	--- Empty constructor
	---
	
    Create (aE  : Edge from TopoDS; 
	    aV1 : Vertex from TopoDS;              
	    aV2 : Vertex from TopoDS;              
    	    aR  : Range from IntTools; 
    	    ICtx: Context from IntTools)   
	returns ShrunkRange from IntTools;
	---Purpose:
	---
        
    SetShrunkRange(me:out;  aR:Range from IntTools);
    	---Purpose:
	--- Sets an shrunk range
	---

    ShrunkRange(me) 
    	returns Range from IntTools; 
    	---C++:  return  const& 
	---Purpose:
	--- Returns shrunk range
	---
  
    BndBox  (me) 
    	returns Box from Bnd; 
    	---C++:  return  const& 
	---Purpose:
	--- Returns bounding box for edge restricted
	--- by shrunk range
	---
     
    Edge  (me) 
    	returns Edge from TopoDS; 
    	---C++:  return  const&	 
	---Purpose:
	--- Returns edge for which 
	--- the shrunk range is computed
	---
	     
    Perform(me:out); 
    	---Purpose:
	--- Computes shrunk range for
	--- an edge given in constructor
	--- 
    	
	 
    IsDone (me) 
	returns Boolean from Standard; 
	---Purpose:
	--- Returns true if no error occured
	--- during shrunk range computation
	---
	 
    ErrorStatus(me) 
    	returns Integer from Standard;  
	---Purpose:
	--- Returns code of computing shrunk range
	--- completion
	--- 0 - means successful completion
	--- 1 - nothing has been done
	--- 2 - initial range is out of edge's range
	--- 3 - first boundary of initial range is more than
	---     last boundary
	--- 4 - projection of first vertex failed
	--- 5 - projection of second vertex failed
	--- 6 - shrunk range can not be computed
	---     shrunk range is setted to initial range
	---

fields
    myEdge        :  Edge from TopoDS; 
    myV1          :  Vertex from TopoDS;
    myV2          :  Vertex from TopoDS; 
    myRange       :  Range from IntTools; 
    myShrunkRange :  Range from IntTools; 
    myBndBox      :  Box from Bnd;  
    myCtx         :  PContext from IntTools;
    myIsDone          :  Boolean from Standard; 
    myErrorStatus     :  Integer from Standard;   
     
end ShrunkRange;
Commit	Line	Data
7fd59977	1	-- File: IntTools_ShrunkRange.cdl
	2	-- Created: Sun Mar 11 10:31:46 2001
	3	-- Author: Peter KURNEV
	4	-- <pkv@irinox>
	5	---Copyright: Matra Datavision 2001
	6
	7
	8	class ShrunkRange from IntTools
	9
	10	---Purpose:
	11	--- The class provides the computation of
	12	--- a working (shrunk) range [t1, t2] for
	13	--- the 3D-curve of the edge.
	14
	15	uses
	16
	17	Edge from TopoDS,
	18	Vertex from TopoDS,
	19	Range from IntTools,
	20	Box from Bnd,
	21	Context from IntTools,
	22	PContext from IntTools
	23
	24	--raises
	25
	26	is
	27	Create
	28	returns ShrunkRange from IntTools;
	29	---Purpose:
	30	--- Empty constructor
	31	---
	32
	33	Create (aE : Edge from TopoDS;
	34	aV1 : Vertex from TopoDS;
	35	aV2 : Vertex from TopoDS;
	36	aR : Range from IntTools;
	37	ICtx: Context from IntTools)
	38	returns ShrunkRange from IntTools;
	39	---Purpose:
	40	---
	41
	42	SetShrunkRange(me:out; aR:Range from IntTools);
	43	---Purpose:
	44	--- Sets an shrunk range
	45	---
	46
	47	ShrunkRange(me)
	48	returns Range from IntTools;
	49	---C++: return const&
	50	---Purpose:
	51	--- Returns shrunk range
	52	---
	53
	54	BndBox (me)
	55	returns Box from Bnd;
	56	---C++: return const&
	57	---Purpose:
	58	--- Returns bounding box for edge restricted
	59	--- by shrunk range
	60	---
	61
	62	Edge (me)
	63	returns Edge from TopoDS;
	64	---C++: return const&
65	---Purpose:
66	--- Returns edge for which
67	--- the shrunk range is computed
68	---
69
70	Perform(me:out);
71	---Purpose:
72	--- Computes shrunk range for
73	--- an edge given in constructor
74	---
75
76
77	IsDone (me)
78	returns Boolean from Standard;
79	---Purpose:
80	--- Returns true if no error occured
81	--- during shrunk range computation
82	---
83
84	ErrorStatus(me)
85	returns Integer from Standard;
86	---Purpose:
87	--- Returns code of computing shrunk range
88	--- completion
89	--- 0 - means successful completion
90	--- 1 - nothing has been done
91	--- 2 - initial range is out of edge's range
92	--- 3 - first boundary of initial range is more than
93	--- last boundary
94	--- 4 - projection of first vertex failed
95	--- 5 - projection of second vertex failed
96	--- 6 - shrunk range can not be computed
97	--- shrunk range is setted to initial range
98	---
99
100	fields
101	myEdge : Edge from TopoDS;
102	myV1 : Vertex from TopoDS;
103	myV2 : Vertex from TopoDS;
104	myRange : Range from IntTools;
105	myShrunkRange : Range from IntTools;
106	myBndBox : Box from Bnd;
107	myCtx : PContext from IntTools;
108	myIsDone : Boolean from Standard;
109	myErrorStatus : Integer from Standard;
110
111	end ShrunkRange;