0023258: Missing parenthesis
[occt.git] / src / IGESGeom / IGESGeom_TrimmedSurface.cdl
CommitLineData
b311480e 1-- Created on: 1993-01-09
2-- Created by: CKY / Contract Toubro-Larsen ( Kiran )
3-- Copyright (c) 1993-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
7fd59977 5--
b311480e 6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
7fd59977 10--
b311480e 11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
7fd59977 13--
b311480e 14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22class TrimmedSurface from IGESGeom inherits IGESEntity
23
24 ---Purpose: defines IGESTrimmedSurface, Type <144> Form <0>
25 -- in package IGESGeom
26 -- A simple closed curve in Euclidean plane divides the
27 -- plane in to two disjoint, open connected components; one
28 -- bounded, one unbounded. The bounded one is called the
29 -- interior region to the curve. Unbounded component is called
30 -- exterior region to the curve. The domain of the trimmed
31 -- surface is defined as the interior of the outer boundaries
32 -- and exterior of the inner boundaries and includes the
33 -- boundary curves.
34
35uses
36
37 CurveOnSurface from IGESGeom,
38 HArray1OfCurveOnSurface from IGESGeom
39
40raises OutOfRange
41
42is
43
44 Create returns mutable TrimmedSurface;
45
46 -- Specific Methods pertaining to the class
47
48 Init (me : mutable;
49 aSurface : IGESEntity;
50 aFlag : Integer;
51 anOuter : CurveOnSurface;
52 allInners : HArray1OfCurveOnSurface);
53 ---Purpose : This method is used to set the fields of the class
54 -- TrimmedSurface
55 -- - aSurface : Surface to be trimmed
56 -- - aFlag : Outer boundary type
57 -- False = The outer boundary is the boundary of
58 -- rectangle D which is the domain of the
59 -- surface to be trimmed
60 -- True = otherwise
61 -- - anOuter : Closed curve which constitutes outer boundary
62 -- - allInners : Array of closed curves which constitute the
63 -- inner boundary
64
65 Surface (me) returns IGESEntity;
66 ---Purpose : returns the surface to be trimmed
67
68 HasOuterContour (me) returns Boolean;
69 ---Purpose : returns True if outer contour exists
70
71 OuterContour (me) returns CurveOnSurface;
72 ---Purpose : returns the outer contour of the trimmed surface
73
74 OuterBoundaryType(me) returns Integer;
75 ---Purpose : returns the outer contour type of the trimmed surface
76 -- 0 : The outer boundary is the boundary of D
77 -- 1 : otherwise
78
79 NbInnerContours(me) returns Integer;
80 ---Purpose : returns the number of inner boundaries
81
82 InnerContour (me; Index : Integer) returns CurveOnSurface
83 raises OutOfRange;
84 ---Purpose : returns the Index'th inner contour
85 -- raises exception if Index <= 0 or Index > NbInnerContours()
86
87fields
88
89--
90-- Class : IGESGeom_TrimmedSurface
91--
92-- Purpose : Declaration of variables specific to the definition
93-- of the Class TrimmedSurface.
94--
95-- Reminder : A TrimmedSurface instance is defined by :
96-- The surface which is to be trimmed, an array of closed
97-- inner boundary curves, an outer boundary and a flag
98-- indicating the outer boundary
99-- - aSurface : Surface to be trimmed
100-- - aFlag : Outer boundary type
101-- False = The outer boundary is the boundary of
102-- rectangle D which is the domain of the
103-- surface to be trimmed. The rectangle D
104-- consists of those points (u, v) such
105-- that a <= u <= b; c <= v <= d for given
106-- constants a, b, c, d with a < b, c < d.
107-- True = otherwise
108-- - anOuter : Closed curve which constitutes outer boundary
109-- - allInners : Array of closed curves which constitute the
110-- inner boundary
111
112 theSurface : IGESEntity;
113 theFlag : Integer;
114 theOuterCurve : CurveOnSurface;
115 theInnerCurves : HArray1OfCurveOnSurface;
116
117end TrimmedSurface;