[occt.git] / src / BiTgte / BiTgte_CurveOnVertex.cdl

-- File:	BiTgte_CurveOnVertex.cdl
-- Created:	Fri Mar 21 16:32:41 1997
-- Author:	Bruno DUMORTIER
--		<dub@brunox.paris1.matra-dtv.fr>
---Copyright:	 Matra Datavision 1997


private class CurveOnVertex from BiTgte inherits Curve from Adaptor3d

	---Purpose: 

uses
    Array1OfReal    from TColStd,
    Shape           from GeomAbs,
    CurveType       from GeomAbs,
    Vec             from gp,
    Pnt             from gp,
    Circ            from gp,
    Elips           from gp,
    Hypr            from gp,
    Parab           from gp,
    Lin             from gp,
    Curve           from Geom,
    BezierCurve     from Geom,
    BSplineCurve    from Geom,
    HCurve          from Adaptor3d,
    Curve           from Adaptor3d,
    Edge            from TopoDS,
    Vertex          from TopoDS

raises
    OutOfRange       from Standard,
    NoSuchObject     from Standard,
    DomainError      from Standard

is

    Create
    returns CurveOnVertex from BiTgte;
    
    Create( EonF : Edge   from TopoDS;
	    V    : Vertex from TopoDS);

    Init( me   : in out;
    	  EonF : Edge   from TopoDS;
	  V    : Vertex from TopoDS)
    is static;

    --------------------------------
    -- Methodes from Adaptor3d_Curve --
    --------------------------------
    
    FirstParameter(me) returns Real
    is redefined static;

    LastParameter(me) returns Real
    is redefined static;

    Continuity(me) returns Shape from GeomAbs
	---Purpose: 
    is redefined static;
    
    NbIntervals(me; S : Shape from GeomAbs) returns Integer
	---Purpose: Returns  the number  of  intervals for  continuity
	--          <S>. May be one if Continuity(me) >= <S>
    is redefined static;
    
    Intervals(me; T : in out Array1OfReal from TColStd; 
    	          S : Shape from GeomAbs)
	---Purpose: Stores in <T> the  parameters bounding the intervals
	--          of continuity <S>.
	--          
	--          The array must provide  enough room to  accomodate
	--          for the parameters. i.e. T.Length() > NbIntervals()
    raises
    	OutOfRange from Standard 
    is redefined static;
    
    Trim(me; First, Last, Tol : Real) returns HCurve from Adaptor3d
	---Purpose: Returns    a  curve equivalent   of  <me>  between
	--          parameters <First>  and <Last>. <Tol>  is used  to
	--          test for 3d points confusion.
    raises
    	OutOfRange from Standard
	---Purpose: If <First> >= <Last> 
    is redefined static;
    

    IsClosed(me) returns Boolean
    is redefined static;
     
    IsPeriodic(me) returns Boolean
    is redefined static;
    
    Period(me) returns Real
    raises
    	DomainError from Standard -- if the curve is not periodic
    is redefined static;
     
    Value(me; U : Real) returns Pnt from gp
         --- Purpose : Computes the point of parameter U on the curve.
    is redefined static;
    
    D0 (me; U : Real; P : out Pnt from gp)
         --- Purpose : Computes the point of parameter U on the curve.
    is redefined static;
    
    D1 (me; U : Real; P : out Pnt from gp ; V : out Vec from gp)
         --- Purpose : Computes the point of parameter U on the curve with its
         --  first derivative.
     raises 
    	DomainError from Standard
        --- Purpose : Raised if the continuity of the current interval
        --  is not C1.
    is redefined static;
    
    D2 (me; U : Real; P : out Pnt from gp; V1, V2 : out Vec from gp)
        --- Purpose :
        --  Returns the point P of parameter U, the first and second
        --  derivatives V1 and V2.
     raises 
    	DomainError from Standard
        --- Purpose : Raised if the continuity of the current interval
        --  is not C2.
     is redefined static;

    D3 (me; U : Real; P : out Pnt from gp; V1, V2, V3 : out Vec from gp)
        --- Purpose :
        --  Returns the point P of parameter U, the first, the second 
        --  and the third derivative.
     raises 
    	DomainError from Standard
        --- Purpose : Raised if the continuity of the current interval
        --  is not C3.
     is redefined static;
        
    DN (me; U : Real; N : Integer)   returns Vec from gp
        --- Purpose :
        --  The returned vector gives the value of the derivative for the 
        --  order of derivation N.
     raises  
    	DomainError from Standard,
        --- Purpose : Raised if the continuity of the current interval
        --  is not CN.
        OutOfRange from Standard
        --- Purpose : Raised if N < 1.            
     is redefined static;

    Resolution(me; R3d : Real) returns Real
         ---Purpose :  Returns the parametric  resolution corresponding
         --         to the real space resolution <R3d>.
    is redefined static;   
        
    GetType(me) returns CurveType from GeomAbs
	---Purpose: Returns  the  type of the   curve  in the  current
	--          interval :   Line,   Circle,   Ellipse, Hyperbola,
	--          Parabola, BezierCurve, BSplineCurve, OtherCurve.
    is redefined static;

    --
    --     The following methods must  be called when GetType returned
    --     the corresponding type.
    --     

     Line(me) returns Lin from gp
     raises 
    	NoSuchObject from Standard
     is redefined static;
     
     Circle(me) returns Circ from gp
     raises 
    	NoSuchObject from Standard
     is redefined static;
     
     Ellipse(me) returns Elips from gp
     raises 
    	NoSuchObject from Standard
     is redefined static;
     
     Hyperbola(me) returns  Hypr from gp
     raises 
    	NoSuchObject from Standard
     is redefined static;
     
     Parabola(me) returns Parab from gp
     raises 
    	NoSuchObject from Standard
     is redefined static;

     
     Degree(me) returns Integer
     raises 
    	NoSuchObject from Standard
     is redefined static;
     
     IsRational(me) returns Boolean
     raises 
    	NoSuchObject from Standard
     is redefined static;
     
     NbPoles(me) returns Integer
     raises 
    	NoSuchObject from Standard
     is redefined static;

  
     NbKnots(me) returns Integer
     raises 
    	NoSuchObject from Standard
     is redefined static;     
          
     Bezier(me) returns BezierCurve from Geom
     raises 
    	NoSuchObject from Standard
     is redefined static;
    
     BSpline(me) returns BSplineCurve from Geom
     raises 
    	NoSuchObject from Standard
     is redefined static;

fields

    myFirst : Real from Standard;
    myLast  : Real from Standard;
    myPnt   : Pnt from gp;
    
end CurveOnVertex from BiTgte;
Commit	Line	Data
7fd59977	1	-- File: BiTgte_CurveOnVertex.cdl
	2	-- Created: Fri Mar 21 16:32:41 1997
	3	-- Author: Bruno DUMORTIER
	4	-- <dub@brunox.paris1.matra-dtv.fr>
	5	---Copyright: Matra Datavision 1997
	6
	7
	8
	9	private class CurveOnVertex from BiTgte inherits Curve from Adaptor3d
	10
	11	---Purpose:
	12
	13	uses
	14	Array1OfReal from TColStd,
	15	Shape from GeomAbs,
	16	CurveType from GeomAbs,
	17	Vec from gp,
	18	Pnt from gp,
	19	Circ from gp,
	20	Elips from gp,
	21	Hypr from gp,
	22	Parab from gp,
	23	Lin from gp,
	24	Curve from Geom,
	25	BezierCurve from Geom,
	26	BSplineCurve from Geom,
	27	HCurve from Adaptor3d,
	28	Curve from Adaptor3d,
	29	Edge from TopoDS,
	30	Vertex from TopoDS
	31
	32	raises
	33	OutOfRange from Standard,
	34	NoSuchObject from Standard,
	35	DomainError from Standard
	36
	37	is
	38
	39	Create
	40	returns CurveOnVertex from BiTgte;
	41
	42	Create( EonF : Edge from TopoDS;
	43	V : Vertex from TopoDS);
	44
	45	Init( me : in out;
	46	EonF : Edge from TopoDS;
	47	V : Vertex from TopoDS)
	48	is static;
	49
	50	--------------------------------
	51	-- Methodes from Adaptor3d_Curve --
	52	--------------------------------
	53
	54	FirstParameter(me) returns Real
	55	is redefined static;
	56
	57	LastParameter(me) returns Real
	58	is redefined static;
	59
	60	Continuity(me) returns Shape from GeomAbs
	61	---Purpose:
	62	is redefined static;
	63
	64	NbIntervals(me; S : Shape from GeomAbs) returns Integer
65	---Purpose: Returns the number of intervals for continuity
66	-- <S>. May be one if Continuity(me) >= <S>
67	is redefined static;
68
69	Intervals(me; T : in out Array1OfReal from TColStd;
70	S : Shape from GeomAbs)
71	---Purpose: Stores in <T> the parameters bounding the intervals
72	-- of continuity <S>.
73	--
74	-- The array must provide enough room to accomodate
75	-- for the parameters. i.e. T.Length() > NbIntervals()
76	raises
77	OutOfRange from Standard
78	is redefined static;
79
80	Trim(me; First, Last, Tol : Real) returns HCurve from Adaptor3d
81	---Purpose: Returns a curve equivalent of <me> between
82	-- parameters <First> and <Last>. <Tol> is used to
83	-- test for 3d points confusion.
84	raises
85	OutOfRange from Standard
86	---Purpose: If <First> >= <Last>
87	is redefined static;
88
89
90	IsClosed(me) returns Boolean
91	is redefined static;
92
93	IsPeriodic(me) returns Boolean
94	is redefined static;
95
96	Period(me) returns Real
97	raises
98	DomainError from Standard -- if the curve is not periodic
99	is redefined static;
100
101	Value(me; U : Real) returns Pnt from gp
102	--- Purpose : Computes the point of parameter U on the curve.
103	is redefined static;
104
105	D0 (me; U : Real; P : out Pnt from gp)
106	--- Purpose : Computes the point of parameter U on the curve.
107	is redefined static;
108
109	D1 (me; U : Real; P : out Pnt from gp ; V : out Vec from gp)
110	--- Purpose : Computes the point of parameter U on the curve with its
111	-- first derivative.
112	raises
113	DomainError from Standard
114	--- Purpose : Raised if the continuity of the current interval
115	-- is not C1.
116	is redefined static;
117
118	D2 (me; U : Real; P : out Pnt from gp; V1, V2 : out Vec from gp)
119	--- Purpose :
120	-- Returns the point P of parameter U, the first and second
121	-- derivatives V1 and V2.
122	raises
123	DomainError from Standard
124	--- Purpose : Raised if the continuity of the current interval
125	-- is not C2.
126	is redefined static;
127
128	D3 (me; U : Real; P : out Pnt from gp; V1, V2, V3 : out Vec from gp)
129	--- Purpose :
130	-- Returns the point P of parameter U, the first, the second
131	-- and the third derivative.
132	raises
133	DomainError from Standard
134	--- Purpose : Raised if the continuity of the current interval
135	-- is not C3.
136	is redefined static;
137
138	DN (me; U : Real; N : Integer) returns Vec from gp
139	--- Purpose :
140	-- The returned vector gives the value of the derivative for the
141	-- order of derivation N.
142	raises
143	DomainError from Standard,
144	--- Purpose : Raised if the continuity of the current interval
145	-- is not CN.
146	OutOfRange from Standard
147	--- Purpose : Raised if N < 1.
148	is redefined static;
149
150	Resolution(me; R3d : Real) returns Real
151	---Purpose : Returns the parametric resolution corresponding
152	-- to the real space resolution <R3d>.
153	is redefined static;
154
155	GetType(me) returns CurveType from GeomAbs
156	---Purpose: Returns the type of the curve in the current
157	-- interval : Line, Circle, Ellipse, Hyperbola,
158	-- Parabola, BezierCurve, BSplineCurve, OtherCurve.
159	is redefined static;
160
161	--
162	-- The following methods must be called when GetType returned
163	-- the corresponding type.
164	--
165
166	Line(me) returns Lin from gp
167	raises
168	NoSuchObject from Standard
169	is redefined static;
170
171	Circle(me) returns Circ from gp
172	raises
173	NoSuchObject from Standard
174	is redefined static;
175
176	Ellipse(me) returns Elips from gp
177	raises
178	NoSuchObject from Standard
179	is redefined static;
180
181	Hyperbola(me) returns Hypr from gp
182	raises
183	NoSuchObject from Standard
184	is redefined static;
185
186	Parabola(me) returns Parab from gp
187	raises
188	NoSuchObject from Standard
189	is redefined static;
190
191
192	Degree(me) returns Integer
193	raises
194	NoSuchObject from Standard
195	is redefined static;
196
197	IsRational(me) returns Boolean
198	raises
199	NoSuchObject from Standard
200	is redefined static;
201
202	NbPoles(me) returns Integer
203	raises
204	NoSuchObject from Standard
205	is redefined static;
206
207
208	NbKnots(me) returns Integer
209	raises
210	NoSuchObject from Standard
211	is redefined static;
212
213	Bezier(me) returns BezierCurve from Geom
214	raises
215	NoSuchObject from Standard
216	is redefined static;
217
218	BSpline(me) returns BSplineCurve from Geom
219	raises
220	NoSuchObject from Standard
221	is redefined static;
222
223	fields
224
225	myFirst : Real from Standard;
226	myLast : Real from Standard;
227	myPnt : Pnt from gp;
228
229	end CurveOnVertex from BiTgte;