[occt.git] / src / Contap / Contap_Line.cdl

-- File:      Contap_Line.cdl
-- Created:   Fri Feb  5 12:13:00 1993
-- Author:    Jacques GOUSSARD
---Copyright: Matra Datavision 1993

generic class Line from Contap
    (TheVertex           as any;
     TheArc              as any;
     ThePoint            as any;       --as Point from Contap(TheVertex,TheArc)
     TheHSequenceOfPoint as Transient) --as HSequence from TCollection
                                       --     (ThePoint)

	---Purpose: 

uses Pnt            from gp,
     LineOn2S       from IntSurf,
     PntOn2S        from IntSurf,
     TypeTrans      from IntSurf,
     Lin            from gp,
     Circ           from gp,
     Dir            from gp,
     IType          from Contap -- duplique IntPatch_IType. Mettre ds  IntSurf

raises DomainError from Standard,
       OutOfRange  from Standard

is

    Create

       	returns Line from Contap;

	
    SetLineOn2S(me: in out; L: LineOn2S from IntSurf)
    
        is static;
	
    Clear(me: in out)
    
    	is static;

    LineOn2S(me)
    
    	returns LineOn2S from IntSurf
	---C++: inline
	---C++: return const&
	is static;

    ResetSeqOfVertex(me: in out)
    
	is static;    

    Add(me: in out; P: PntOn2S from IntSurf)
    
	---C++: inline
    	is static;

    SetValue(me: in out; L: Lin from gp)
    
    	is static;


    SetValue(me: in out; C: Circ from gp)
    
    	is static;


    SetValue(me: in out; A: TheArc)
    
    	is static;


    Add(me: in out; P: ThePoint)
    
    	is static;


    NbVertex(me)
    
    	returns Integer from Standard
	---C++: inline
	
	is static;


    Vertex(me; Index: Integer from Standard)
    
    	returns ThePoint
	---C++: return &
	---C++: inline

	raises OutOfRange from Standard
	
	is static;


    TypeContour(me)
    
	---Purpose: Returns Contap_Lin for a line, Contap_Circle for
	--          a circle, and Contap_Walking for a Walking line,
	--          Contap_Restriction for a part of  boundarie.
    
    	returns IType from Contap
	---C++: inline
	
	is static;


    NbPnts(me)
    
    	returns Integer from Standard
	---C++: inline
	
	raises DomainError from Standard
	-- The exception DomainError is raised if TypeContour does not return
	-- Contap_Walking.
	
	is static;


    Point(me; Index: Integer from Standard)
    
    	returns PntOn2S from IntSurf
	---C++: return const&
	---C++: inline
	
	raises DomainError from Standard,
	       OutOfRange  from Standard
	-- The exception DomainError is raised if TypeContour does not return
	-- Contap_Walking.
	-- The exception OutOfRange is raised if Index<=0 or Index>NbPoints.
	
	is static;


    Line(me)
    
    	returns Lin from gp
	---C++: inline
	
	raises DomainError from Standard
	-- The exception DomainError is raised if TypeContour does not return
	-- Contap_Lin.
	
	is static;


    Circle(me)
    
    	returns Circ from gp
	---C++: inline
	
	raises DomainError from Standard
	-- The exception DomainError is raised if TypeContour does not return
	-- Contap_Circle.
	
	is static;


    Arc(me)
    
    	returns any TheArc
	---C++: return const&
	
	raises DomainError from Standard
	-- The exception DomainError is raised if TypeContour does not return
	-- Contap_Restriction.
	
	is static;


    SetTransitionOnS(me: in out; T: TypeTrans from IntSurf) 
    
    	---Purpose: Set The Tansition of the line.
    	--          
	is static;
	
	
    TransitionOnS(me) 
    
    	---Purpose: returns IN if at the "left" of the line, the normale of the 
    	--          surface is oriented to the observator.  
    	
    
    	returns TypeTrans from IntSurf
	is static;


fields

    Trans   : TypeTrans            from IntSurf;
    curv    : LineOn2S             from IntSurf;
    svtx    : TheHSequenceOfPoint;
    thearc  : TheArc;
    typL    : IType                from Contap;
    pt      : Pnt                  from gp;
    dir1    : Dir                  from gp;
    dir2    : Dir                  from gp;
    rad     : Real                 from Standard;

end Line;
Commit	Line	Data
733a0e55 S	1	-- File: Contap_Line.cdl
	2	-- Created: Fri Feb 5 12:13:00 1993
	3	-- Author: Jacques GOUSSARD
	4	---Copyright: Matra Datavision 1993
7fd59977	5
	6	generic class Line from Contap
	7	(TheVertex as any;
	8	TheArc as any;
	9	ThePoint as any; --as Point from Contap(TheVertex,TheArc)
	10	TheHSequenceOfPoint as Transient) --as HSequence from TCollection
	11	-- (ThePoint)
	12
	13	---Purpose:
	14
	15	uses Pnt from gp,
	16	LineOn2S from IntSurf,
	17	PntOn2S from IntSurf,
	18	TypeTrans from IntSurf,
	19	Lin from gp,
	20	Circ from gp,
	21	Dir from gp,
	22	IType from Contap -- duplique IntPatch_IType. Mettre ds IntSurf
	23
	24	raises DomainError from Standard,
	25	OutOfRange from Standard
	26
	27	is
	28
	29	Create
	30
	31	returns Line from Contap;
	32
	33
	34	SetLineOn2S(me: in out; L: LineOn2S from IntSurf)
	35
	36	is static;
	37
	38	Clear(me: in out)
	39
	40	is static;
	41
	42	LineOn2S(me)
	43
	44	returns LineOn2S from IntSurf
	45	---C++: inline
	46	---C++: return const&
	47	is static;
	48
	49	ResetSeqOfVertex(me: in out)
	50
	51	is static;
	52
	53	Add(me: in out; P: PntOn2S from IntSurf)
	54
	55	---C++: inline
	56	is static;
	57
	58	SetValue(me: in out; L: Lin from gp)
	59
	60	is static;
	61
	62
	63	SetValue(me: in out; C: Circ from gp)
	64
	65	is static;
	66
	67
	68	SetValue(me: in out; A: TheArc)
69
70	is static;
71
72
73	Add(me: in out; P: ThePoint)
74
75	is static;
76
77
78	NbVertex(me)
79
80	returns Integer from Standard
81	---C++: inline
82
83	is static;
84
85
86	Vertex(me; Index: Integer from Standard)
87
88	returns ThePoint
89	---C++: return &
90	---C++: inline
91
92	raises OutOfRange from Standard
93
94	is static;
95
96
97	TypeContour(me)
98
99	---Purpose: Returns Contap_Lin for a line, Contap_Circle for
100	-- a circle, and Contap_Walking for a Walking line,
101	-- Contap_Restriction for a part of boundarie.
102
103	returns IType from Contap
104	---C++: inline
105
106	is static;
107
108
109	NbPnts(me)
110
111	returns Integer from Standard
112	---C++: inline
113
114	raises DomainError from Standard
115	-- The exception DomainError is raised if TypeContour does not return
116	-- Contap_Walking.
117
118	is static;
119
120
121	Point(me; Index: Integer from Standard)
122
123	returns PntOn2S from IntSurf
124	---C++: return const&
125	---C++: inline
126
127	raises DomainError from Standard,
128	OutOfRange from Standard
129	-- The exception DomainError is raised if TypeContour does not return
130	-- Contap_Walking.
131	-- The exception OutOfRange is raised if Index<=0 or Index>NbPoints.
132
133	is static;
134
135
136	Line(me)
137
138	returns Lin from gp
139	---C++: inline
140
141	raises DomainError from Standard
142	-- The exception DomainError is raised if TypeContour does not return
143	-- Contap_Lin.
144
145	is static;
146
147
148	Circle(me)
149
150	returns Circ from gp
151	---C++: inline
152
153	raises DomainError from Standard
154	-- The exception DomainError is raised if TypeContour does not return
155	-- Contap_Circle.
156
157	is static;
158
159
160
161	Arc(me)
162
163	returns any TheArc
164	---C++: return const&
165
166	raises DomainError from Standard
167	-- The exception DomainError is raised if TypeContour does not return
168	-- Contap_Restriction.
169
170	is static;
171
172
173	SetTransitionOnS(me: in out; T: TypeTrans from IntSurf)
174
175	---Purpose: Set The Tansition of the line.
176	--
177	is static;
178
179
180
181	TransitionOnS(me)
182
183	---Purpose: returns IN if at the "left" of the line, the normale of the
184	-- surface is oriented to the observator.
185
186
187	returns TypeTrans from IntSurf
188	is static;
189
190
191	fields
192
193	Trans : TypeTrans from IntSurf;
194	curv : LineOn2S from IntSurf;
195	svtx : TheHSequenceOfPoint;
196	thearc : TheArc;
197	typL : IType from Contap;
198	pt : Pnt from gp;
199	dir1 : Dir from gp;
200	dir2 : Dir from gp;
201	rad : Real from Standard;
202
203	end Line;