[occt.git] / src / Geom2dHatch / Geom2dHatch_Hatching.cdl

-- Created on: 1993-11-10
-- Created by: Jean Marc LACHAUME
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-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 License 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 Hatching from Geom2dHatch

uses
    ErrorStatus      from HatchGen ,
    PointOnHatching  from HatchGen ,
    PointsOnHatching from HatchGen ,
    Domain           from HatchGen ,
    Domains          from HatchGen , 
    Pnt2d            from gp,
    Curve            from Geom2dAdaptor

raises
    OutOfRange   from Standard

is

     Create
       
       returns Hatching from Geom2dHatch;


    Create (Curve : Curve from Geom2dAdaptor)
    
    	---Purpose: Creates a hatching.

	returns Hatching from Geom2dHatch ;


    Curve (me)
    
    	---Purpose: Returns the curve associated to the hatching.

    	---C++: return const &

        returns Curve from Geom2dAdaptor
        is static ;


    ChangeCurve (me : in out)
    
    	---Purpose: Returns the curve associated to the hatching.

    	---C++: return &

        returns Curve from Geom2dAdaptor
        is static ;


    TrimDone (me : in out ; Flag : Boolean from Standard)

    	---Purpose: Sets the flag about the trimming computations to the
    	--          given value.

    	is static ;


    TrimDone (me)

    	---Purpose: Returns the flag about the trimming computations.

    	returns Boolean from Standard
	is static ;


    TrimFailed (me : in out ; Flag : Boolean from Standard)

    	---Purpose: Sets the flag about the trimming failure to the
    	--          given value.

    	is static ;


    TrimFailed (me)

    	---Purpose: Returns the flag about the trimming failure.

    	returns Boolean from Standard
	is static ;


    IsDone (me : in out ; Flag : Boolean from Standard)

    	---Purpose: Sets the flag about the domains computation to the
    	--          given value.

    	is static ;


    IsDone (me)

    	---Purpose: Returns the flag about the domains computation.

    	returns Boolean from Standard
	is static ;


    Status (me : in out ; Status : ErrorStatus from HatchGen)

    	---Purpose: Sets the error status.

    	is static ;


    Status (me)

    	---Purpose: Returns the error status.

    	returns ErrorStatus from HatchGen
	is static ;


---Category: Points on hatching.

    AddPoint (me : in out ; Point     : PointOnHatching from HatchGen ;
    	    	    	    Confusion : Real            from Standard)
    
    	---Purpose: Adds an intersection point to the hatching.

	is static ;


    NbPoints (me)
    
    	---Purpose: Returns the number of intersection points
    	--          of the hatching.

        returns Integer from Standard
        is static ;


    Point (me ; Index : Integer from Standard)
    
    	---Purpose: Returns the Index-th intersection point of the
    	--          hatching.
    	--          The exception OutOfRange is raised if
    	--          Index < 1 or Index > NbPoints.

    	---C++: return const &

    	returns PointOnHatching from HatchGen
    	raises OutOfRange from Standard
   	is static ;


    ChangePoint (me : in out ; Index : Integer from Standard)
    
    	---Purpose: Returns the Index-th intersection point of the
    	--          hatching.
    	--          The exception OutOfRange is raised if
    	--          Index < 1 or Index > NbPoints.

    	---C++: return &

    	returns PointOnHatching from HatchGen
    	raises OutOfRange from Standard
   	is static ;


    RemPoint (me : in out ; Index : Integer from Standard)
    
    	---Purpose: Removes the Index-th intersection point of the
    	--          hatching.
    	--          The exception OutOfRange is raised if
    	--          Index < 1 or Index > NbPoints.

    	raises OutOfRange from Standard
    	is static ;


    ClrPoints (me : in out)
    
    	---Purpose: Removes all the intersection points of the hatching.

    	is static ;


---Category: Domains.


    AddDomain (me : in out ; Domain : Domain from HatchGen)
    
    	---Purpose: Adds a domain to the hatching.

	is static ;


    NbDomains (me)
    
    	---Purpose: Returns the number of domains of the hatching.

        returns Integer from Standard
        is static ;


    Domain (me ; Index : Integer from Standard)
    
    	---Purpose: Returns the Index-th domain of the hatching.
    	--          The exception OutOfRange is raised if
    	--          Index < 1 or Index > NbDomains.

    	---C++: return const &

    	returns Domain from HatchGen
    	raises OutOfRange from Standard
   	is static ;


    RemDomain (me : in out ; Index : Integer from Standard)
    
    	---Purpose: Removes the Index-th domain of the hatching.
    	--          The exception OutOfRange is raised if
    	--          Index < 1 or Index > NbDomains.

    	raises OutOfRange from Standard
    	is static ;


    ClrDomains (me : in out)
    
    	---Purpose: Removes all the domains of the hatching.

    	is static ;


    ClassificationPoint (me) 
    	---Purpose: Returns a point on the curve. 
    	--          This point will be used for the classification.
    returns Pnt2d from gp
    is static;
       
fields

    myCurve      : Curve from Geom2dAdaptor ;
    myTrimDone   : Boolean          from Standard ;
    myTrimFailed : Boolean          from Standard ;
    myPoints     : PointsOnHatching from HatchGen ;
    myIsDone     : Boolean          from Standard ;
    myStatus     : ErrorStatus      from HatchGen ;
    myDomains    : Domains          from HatchGen ;

end Hatching from Geom2dHatch ;
Commit	Line	Data
b311480e	1	-- Created on: 1993-11-10
	2	-- Created by: Jean Marc LACHAUME
	3	-- Copyright (c) 1993-1999 Matra Datavision
973c2be1	4	-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e	5	--
973c2be1	6	-- This file is part of Open CASCADE Technology software library.
b311480e	7	--
d5f74e42	8	-- This library is free software; you can redistribute it and/or modify it under
d5f74e42	9	-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1	10	-- by the Free Software Foundation, with special exception defined in the file
	11	-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	12	-- distribution for complete text of the license and disclaimer of any warranty.
b311480e	13	--
973c2be1	14	-- Alternatively, this file may be used under the terms of Open CASCADE
973c2be1	15	-- commercial license or contractual agreement.
7fd59977	16
0b85f9a6	17	class Hatching from Geom2dHatch
7fd59977	18
	19	uses
	20	ErrorStatus from HatchGen ,
	21	PointOnHatching from HatchGen ,
	22	PointsOnHatching from HatchGen ,
	23	Domain from HatchGen ,
	24	Domains from HatchGen ,
0b85f9a6	25	Pnt2d from gp,
0b85f9a6	26	Curve from Geom2dAdaptor
7fd59977	27
	28	raises
	29	OutOfRange from Standard
	30
	31	is
	32
	33	Create
	34
0b85f9a6	35	returns Hatching from Geom2dHatch;
7fd59977	36
7fd59977	37
0b85f9a6	38	Create (Curve : Curve from Geom2dAdaptor)
7fd59977	39
	40	---Purpose: Creates a hatching.
	41
0b85f9a6	42	returns Hatching from Geom2dHatch ;
7fd59977	43
	44
	45	Curve (me)
	46
	47	---Purpose: Returns the curve associated to the hatching.
	48
	49	---C++: return const &
	50
0b85f9a6	51	returns Curve from Geom2dAdaptor
7fd59977	52	is static ;
	53
	54
	55	ChangeCurve (me : in out)
	56
	57	---Purpose: Returns the curve associated to the hatching.
	58
	59	---C++: return &
	60
0b85f9a6	61	returns Curve from Geom2dAdaptor
7fd59977	62	is static ;
	63
	64
	65	TrimDone (me : in out ; Flag : Boolean from Standard)
	66
	67	---Purpose: Sets the flag about the trimming computations to the
	68	-- given value.
	69
	70	is static ;
	71
	72
	73	TrimDone (me)
	74
	75	---Purpose: Returns the flag about the trimming computations.
	76
	77	returns Boolean from Standard
	78	is static ;
	79
	80
	81	TrimFailed (me : in out ; Flag : Boolean from Standard)
	82
	83	---Purpose: Sets the flag about the trimming failure to the
	84	-- given value.
	85
	86	is static ;
	87
	88
	89	TrimFailed (me)
	90
	91	---Purpose: Returns the flag about the trimming failure.
	92
	93	returns Boolean from Standard
	94	is static ;
	95
	96
	97	IsDone (me : in out ; Flag : Boolean from Standard)
	98
	99	---Purpose: Sets the flag about the domains computation to the
	100	-- given value.
	101
	102	is static ;
	103
	104
	105	IsDone (me)
	106
	107	---Purpose: Returns the flag about the domains computation.
	108
	109	returns Boolean from Standard
	110	is static ;
	111
	112
	113	Status (me : in out ; Status : ErrorStatus from HatchGen)
	114
	115	---Purpose: Sets the error status.
	116
	117	is static ;
	118
	119
	120	Status (me)
	121
	122	---Purpose: Returns the error status.
	123
	124	returns ErrorStatus from HatchGen
	125	is static ;
126
127
128	---Category: Points on hatching.
129
130	AddPoint (me : in out ; Point : PointOnHatching from HatchGen ;
131	Confusion : Real from Standard)
132
133	---Purpose: Adds an intersection point to the hatching.
134
135	is static ;
136
137
138	NbPoints (me)
139
140	---Purpose: Returns the number of intersection points
141	-- of the hatching.
142
143	returns Integer from Standard
144	is static ;
145
146
147	Point (me ; Index : Integer from Standard)
148
149	---Purpose: Returns the Index-th intersection point of the
150	-- hatching.
151	-- The exception OutOfRange is raised if
152	-- Index < 1 or Index > NbPoints.
153
154	---C++: return const &
155
156	returns PointOnHatching from HatchGen
157	raises OutOfRange from Standard
158	is static ;
159
160
161	ChangePoint (me : in out ; Index : Integer from Standard)
162
163	---Purpose: Returns the Index-th intersection point of the
164	-- hatching.
165	-- The exception OutOfRange is raised if
166	-- Index < 1 or Index > NbPoints.
167
168	---C++: return &
169
170	returns PointOnHatching from HatchGen
171	raises OutOfRange from Standard
172	is static ;
173
174
175	RemPoint (me : in out ; Index : Integer from Standard)
176
177	---Purpose: Removes the Index-th intersection point of the
178	-- hatching.
179	-- The exception OutOfRange is raised if
180	-- Index < 1 or Index > NbPoints.
181
182	raises OutOfRange from Standard
183	is static ;
184
185
186	ClrPoints (me : in out)
187
188	---Purpose: Removes all the intersection points of the hatching.
189
190	is static ;
191
192
193	---Category: Domains.
194
195
196	AddDomain (me : in out ; Domain : Domain from HatchGen)
197
198	---Purpose: Adds a domain to the hatching.
199
200	is static ;
201
202
203	NbDomains (me)
204
205	---Purpose: Returns the number of domains of the hatching.
206
207	returns Integer from Standard
208	is static ;
209
210
211	Domain (me ; Index : Integer from Standard)
212
213	---Purpose: Returns the Index-th domain of the hatching.
214	-- The exception OutOfRange is raised if
215	-- Index < 1 or Index > NbDomains.
216
217	---C++: return const &
218
219	returns Domain from HatchGen
220	raises OutOfRange from Standard
221	is static ;
222
223
224	RemDomain (me : in out ; Index : Integer from Standard)
225
226	---Purpose: Removes the Index-th domain of the hatching.
227	-- The exception OutOfRange is raised if
228	-- Index < 1 or Index > NbDomains.
229
230	raises OutOfRange from Standard
231	is static ;
232
233
234	ClrDomains (me : in out)
235
236	---Purpose: Removes all the domains of the hatching.
237
238	is static ;
239
240
241	ClassificationPoint (me)
242	---Purpose: Returns a point on the curve.
243	-- This point will be used for the classification.
244	returns Pnt2d from gp
245	is static;
246
247	fields
248
0b85f9a6	249	myCurve : Curve from Geom2dAdaptor ;
7fd59977	250	myTrimDone : Boolean from Standard ;
	251	myTrimFailed : Boolean from Standard ;
	252	myPoints : PointsOnHatching from HatchGen ;
	253	myIsDone : Boolean from Standard ;
	254	myStatus : ErrorStatus from HatchGen ;
	255	myDomains : Domains from HatchGen ;
	256
0b85f9a6	257	end Hatching from Geom2dHatch ;