[occt.git] / src / Extrema / Extrema_ExtElC.cdl

-- File:	ExtElC.cdl
-- Created:	Thu Feb 21 18:49:13 1991
-- Author:	Isabelle GRIGNON
--		<isg@topsn3>
---Copyright:	 Matra Datavision 1991


class   ExtElC from Extrema 
	---Purpose: It calculates all the distance between two elementary
	--          curves.
	--          These distances can be maximum or minimum.

uses    Circ    from gp,
     	Elips   from gp,
     	Hypr    from gp,
    	Lin     from gp,
     	Parab   from gp,
	POnCurv from Extrema

raises  InfiniteSolutions from StdFail,
    	NotDone           from StdFail,
    	OutOfRange        from Standard

is
    Create returns ExtElC;

    Create (C1,C2: Lin; AngTol: Real) returns ExtElC;
      	---Purpose: Calculates the distance between two lines.
      	--          AngTol is used to test if the lines are parallel:
      	--          Angle(C1,C2) < AngTol.
    
    Create (C1: Lin; C2: Circ; Tol: Real) returns ExtElC;
        ---Purpose: Calculates the distance between a line and a 
        --          circle.
                  
    Create (C1: Lin; C2: Elips) returns ExtElC;
        ---Purpose: Calculates the distance between a line and an
        --          elipse.
                  
    Create (C1: Lin; C2: Hypr) returns ExtElC;
        ---Purpose: Calculates the distance between a line and a
        --          hyperbola.
                  
    Create (C1: Lin; C2: Parab) returns ExtElC;
        ---Purpose: Calculates the distance between a line and a
        --          parabola.

    Create (C1,C2: Circ) returns ExtElC;
      	---Purpose: Calculates the distance between two circles.
      	--          The circles can be parallel or identical.
    
    Create (C1: Circ; C2: Elips) returns ExtElC;
        ---Purpose: Calculates the distance between a circle and an
        --          elipse.
                  
    Create (C1: Circ; C2: Hypr) returns ExtElC;
        ---Purpose: Calculates the distance between a circle and a
        --          hyperbola.
                  
    Create (C1: Circ; C2: Parab) returns ExtElC;
        ---Purpose: Calculates the distance between a circle and a
        --          parabola.
                  
    Create (C1,C2: Elips) returns ExtElC;
      	---Purpose: Calculates the distance between two elipses.
      	--          The elipses can be parallel or identical.
    
    Create (C1: Elips; C2: Hypr) returns ExtElC;
        ---Purpose: Calculates the distance between an elipse and a
        --          hyperbola.
                  
    Create (C1: Elips; C2: Parab) returns ExtElC;
        ---Purpose: Calculates the distance between an elipse and a
        --          parabola.

    Create (C1,C2: Hypr) returns ExtElC;
      	---Purpose: Calculates the distance between two hyperbolas.
      	--          The hyperbolas can be parallel or identical.
    
    Create (C1: Hypr; C2: Parab) returns ExtElC;
        ---Purpose: Calculates the distance between a hyperbola and a
        --          parabola.

    Create (C1,C2: Parab) returns ExtElC;
      	---Purpose: Calculates the distance between two parabolas
      	--          The parabolas can be parallel or identical.

    IsDone (me) returns Boolean
    	---Purpose: Returns True if the distances are found.
    	is static;

    IsParallel (me) returns Boolean
    	---Purpose: Returns True if the two curves are parallel.
    	raises  NotDone from StdFail
	    	-- if IsDone(me)=False.
    	is static;

    NbExt (me) returns Integer
    	---Purpose: Returns the number of extremum distances.
    	raises  NotDone from StdFail,
	    	-- if IsDone(me)=False.
    	    	InfiniteSolutions from StdFail
		-- if IsParallel(me)= True.
    	is static;

    SquareDistance (me; N: Integer =1) returns Real
    	---Purpose: Returns the value of the Nth extremum square distance.
    	raises  NotDone from StdFail,
	    	-- if IsDone(me)=False.
    	    	InfiniteSolutions from StdFail,
		-- if IsParallel(me)= True and N > 1.
    	    	OutOfRange from Standard
		-- if N < 1 or N > NbExt(me)
    	is static;

    Points (me; N: Integer; P1,P2: out POnCurv)
    	---Purpose: Returns the points of the Nth extremum distance.
    	--          P1 is on the first curve, P2 on the second one.
    	raises  NotDone from StdFail,
	    	-- if IsDone(me)=False.
    	    	InfiniteSolutions from StdFail,
		-- if IsParallel(me)= True.
    	    	OutOfRange from Standard
		-- if N < 1 or N > NbExt(me)
    	is static;

fields
    myDone : Boolean;
    myIsPar: Boolean;
    myNbExt: Integer;
    --modified by NIZNHY-PKV Fri Nov 21 10:47:21 2008 ft  
    --  it was *[4]	
    mySqDist: Real [6];
    myPoint: POnCurv from Extrema [6,2];

end ExtElC;
Commit	Line	Data
7fd59977	1	-- File: ExtElC.cdl
	2	-- Created: Thu Feb 21 18:49:13 1991
	3	-- Author: Isabelle GRIGNON
	4	-- <isg@topsn3>
	5	---Copyright: Matra Datavision 1991
	6
	7
	8	class ExtElC from Extrema
	9	---Purpose: It calculates all the distance between two elementary
	10	-- curves.
	11	-- These distances can be maximum or minimum.
	12
	13	uses Circ from gp,
	14	Elips from gp,
	15	Hypr from gp,
	16	Lin from gp,
	17	Parab from gp,
	18	POnCurv from Extrema
	19
	20	raises InfiniteSolutions from StdFail,
	21	NotDone from StdFail,
	22	OutOfRange from Standard
	23
	24	is
	25	Create returns ExtElC;
	26
	27	Create (C1,C2: Lin; AngTol: Real) returns ExtElC;
	28	---Purpose: Calculates the distance between two lines.
	29	-- AngTol is used to test if the lines are parallel:
	30	-- Angle(C1,C2) < AngTol.
	31
	32	Create (C1: Lin; C2: Circ; Tol: Real) returns ExtElC;
	33	---Purpose: Calculates the distance between a line and a
	34	-- circle.
	35
	36	Create (C1: Lin; C2: Elips) returns ExtElC;
	37	---Purpose: Calculates the distance between a line and an
	38	-- elipse.
	39
	40	Create (C1: Lin; C2: Hypr) returns ExtElC;
	41	---Purpose: Calculates the distance between a line and a
	42	-- hyperbola.
	43
	44	Create (C1: Lin; C2: Parab) returns ExtElC;
	45	---Purpose: Calculates the distance between a line and a
	46	-- parabola.
	47
	48	Create (C1,C2: Circ) returns ExtElC;
	49	---Purpose: Calculates the distance between two circles.
	50	-- The circles can be parallel or identical.
	51
	52	Create (C1: Circ; C2: Elips) returns ExtElC;
	53	---Purpose: Calculates the distance between a circle and an
	54	-- elipse.
	55
	56	Create (C1: Circ; C2: Hypr) returns ExtElC;
	57	---Purpose: Calculates the distance between a circle and a
	58	-- hyperbola.
	59
	60	Create (C1: Circ; C2: Parab) returns ExtElC;
	61	---Purpose: Calculates the distance between a circle and a
	62	-- parabola.
	63
	64	Create (C1,C2: Elips) returns ExtElC;
65	---Purpose: Calculates the distance between two elipses.
66	-- The elipses can be parallel or identical.
67
68	Create (C1: Elips; C2: Hypr) returns ExtElC;
69	---Purpose: Calculates the distance between an elipse and a
70	-- hyperbola.
71
72	Create (C1: Elips; C2: Parab) returns ExtElC;
73	---Purpose: Calculates the distance between an elipse and a
74	-- parabola.
75
76	Create (C1,C2: Hypr) returns ExtElC;
77	---Purpose: Calculates the distance between two hyperbolas.
78	-- The hyperbolas can be parallel or identical.
79
80	Create (C1: Hypr; C2: Parab) returns ExtElC;
81	---Purpose: Calculates the distance between a hyperbola and a
82	-- parabola.
83
84	Create (C1,C2: Parab) returns ExtElC;
85	---Purpose: Calculates the distance between two parabolas
86	-- The parabolas can be parallel or identical.
87
88	IsDone (me) returns Boolean
89	---Purpose: Returns True if the distances are found.
90	is static;
91
92	IsParallel (me) returns Boolean
93	---Purpose: Returns True if the two curves are parallel.
94	raises NotDone from StdFail
95	-- if IsDone(me)=False.
96	is static;
97
98	NbExt (me) returns Integer
99	---Purpose: Returns the number of extremum distances.
100	raises NotDone from StdFail,
101	-- if IsDone(me)=False.
102	InfiniteSolutions from StdFail
103	-- if IsParallel(me)= True.
104	is static;
105
106	SquareDistance (me; N: Integer =1) returns Real
107	---Purpose: Returns the value of the Nth extremum square distance.
108	raises NotDone from StdFail,
109	-- if IsDone(me)=False.
110	InfiniteSolutions from StdFail,
111	-- if IsParallel(me)= True and N > 1.
112	OutOfRange from Standard
113	-- if N < 1 or N > NbExt(me)
114	is static;
115
116	Points (me; N: Integer; P1,P2: out POnCurv)
117	---Purpose: Returns the points of the Nth extremum distance.
118	-- P1 is on the first curve, P2 on the second one.
119	raises NotDone from StdFail,
120	-- if IsDone(me)=False.
121	InfiniteSolutions from StdFail,
122	-- if IsParallel(me)= True.
123	OutOfRange from Standard
124	-- if N < 1 or N > NbExt(me)
125	is static;
126
127	fields
128	myDone : Boolean;
129	myIsPar: Boolean;
130	myNbExt: Integer;
131	--modified by NIZNHY-PKV Fri Nov 21 10:47:21 2008 ft
132	-- it was *[4]
133	mySqDist: Real [6];
134	myPoint: POnCurv from Extrema [6,2];
135
136	end ExtElC;