0023024: Update headers of OCCT files
[occt.git] / src / AIS / AIS_Circle.cdl
1 -- Created on: 1997-01-21
2 -- Created by: Prestataire Christiane ARMAND
3 -- Copyright (c) 1997-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
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.
10 --
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.
13 --
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
21 --   GG  :  GER61351 17/11/1999 Change SetColor() with a compatible Quantity_Color instead
22 --                                     the restricted NameOfColor.
23
24 class Circle from AIS inherits InteractiveObject from AIS
25
26         ---Purpose: Constructs circle datums to be used in construction of
27         -- composite shapes.
28
29 uses 
30     Circle                from Geom,
31     Point                 from Geom,
32     Presentation          from Prs3d,
33     PresentationManager3d from PrsMgr,
34     NameOfColor           from Quantity,
35     Color                         from Quantity,
36     Selection             from SelectMgr,
37     Projector             from Prs3d,
38     Transformation        from Geom,
39     PresentationManager2d from PrsMgr,
40     GraphicObject         from Graphic2d,    
41     Line                  from AIS,
42     KindOfInteractive from AIS
43     
44
45 is
46     Create(aCircle : Circle from Geom) 
47     returns mutable Circle from AIS;
48         ---Purpose: Initializes this algorithm for constructing AIS circle
49         -- datums initializes the circle aCircle
50     Create(aCircle : Circle from Geom;
51            aUStart : Real from Standard;
52            aUEnd   : Real from Standard;
53            aSens   : Boolean from Standard = Standard_True) 
54     returns mutable Circle from AIS;
55         ---Purpose: Initializes this algorithm for constructing AIS circle datums.    
56         -- Initializes the circle aCircle, the arc
57         --   starting point UStart, the arc ending point UEnd,
58         --   and the direction aSens.
59
60     Compute(me            : mutable;
61             aPresentationManager: PresentationManager3d from PrsMgr;
62             aPresentation : mutable Presentation from Prs3d;
63             aMode         : Integer from Standard = 0) 
64     is redefined static  private;
65     
66     Compute(me:mutable;
67                 aProjector: Projector from Prs3d;
68                 aPresentation: mutable Presentation from Prs3d)
69     is redefined static private;     
70
71     Compute(me:mutable;
72             aPresentationManager: PresentationManager2d from PrsMgr;
73             aPresentation: mutable GraphicObject from Graphic2d;
74             aMode: Integer from Standard = 0)
75     is redefined static private;        
76
77     Compute(me            : mutable;
78             aProjector    : Projector from Prs3d;
79             aTrsf         : Transformation from Geom;
80             aPresentation : mutable Presentation from Prs3d)
81     is redefined;
82          ---Purpose: computes the presentation according to a point of view
83          --          given by <aProjector>.
84          --          To be Used when the associated degenerated Presentations
85          --          have been transformed by <aTrsf> which is not a Pure
86          --          Translation. The HLR Prs can't be deducted automatically
87          --          WARNING :<aTrsf> must be applied
88          --           to the object to display before computation  !!!
89
90 -- Methods from SelectableObject
91
92     ComputeSelection(me         : mutable;
93                      aSelection : mutable Selection from SelectMgr;
94                      aMode      : Integer from Standard)is private;
95
96  
97 -- Methods from InteractiveObject
98
99   
100   Signature(me) returns Integer from Standard is redefined;
101          ---C++: inline
102          ---Purpose: Returns index 6 by default.
103   
104   Type(me) returns KindOfInteractive from AIS is redefined;
105          ---C++: inline
106          ---Purpose: Indicates that the type of Interactive Object is a datum.
107   
108   Circle(me) returns any Circle from Geom;
109          ---C++: inline
110          ---C++: return const & 
111          ---Purpose: Returns the circle component defined in SetCircle.
112    
113   Parameters(me; u1,u2 : in out Real from Standard);
114          ---C++: inline
115          ---Purpose:
116          -- Constructs instances of the starting point and the end
117          -- point parameters, u1 and u2.
118  
119   SetCircle(me:mutable;aCircle : Circle from Geom);
120          ---C++: inline
121          ---Purpose: Allows you to provide settings for the circle datum aCircle.
122   
123   SetFirstParam(me:mutable;u:Real);
124          ---C++: inline
125          ---Purpose: Allows you to set the parameter u for the starting point of an arc.
126   
127   SetLastParam(me:mutable;u:Real);
128          ---C++: inline
129          ---Purpose: Allows you to provide the parameter u for the end point of an arc.
130
131     SetColor(me :mutable; aColor : NameOfColor from Quantity)
132     is redefined static;
133         --- Purpose: Assigns the color aColor to the solid line boundary of the circle datum.
134     SetColor(me :mutable; aColor : Color from Quantity)
135     is redefined static;
136          
137     SetWidth(me:mutable; aValue:Real from Standard)
138     is redefined static; 
139         ---Purpose: Assigns the width aValue to the solid line boundary of the circle datum.
140     UnsetColor(me:mutable)
141     is redefined static; 
142         ---Purpose: Removes color from the solid line boundary of the circle datum.    
143     UnsetWidth(me:mutable)    
144     is redefined static; 
145         ---Purpose: Removes width settings from the solid line boundary of the circle datum.
146
147
148     ComputeCircle(me: mutable;
149                   aPresentation : mutable Presentation from Prs3d)
150     is private;
151      
152     ComputeArc(me: mutable;
153                aPresentation : mutable Presentation from Prs3d)
154     is private;
155
156     ComputeCircleSelection(me: mutable;
157                            aSelection : mutable Selection from SelectMgr)
158     is private;
159      
160     ComputeArcSelection(me: mutable;
161                         aSelection : mutable Selection from SelectMgr)
162     is private;
163
164 fields
165
166     myComponent   : Circle  from Geom;
167     myUStart      : Real    from Standard;
168     myUEnd        : Real    from Standard;
169     myCircleIsArc : Boolean from Standard;
170     mySens        : Boolean from Standard;
171     
172 end Circle ;