0024428: Implementation of LGPL license
[occt.git] / src / AIS / AIS.cdl
CommitLineData
b311480e 1-- Created on: 1996-12-11
2-- Created by: Robert COUBLANC
3-- Copyright (c) 1996-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--
973c2be1 8-- This library is free software; you can redistribute it and / or modify it
9-- under the terms of the GNU Lesser General Public version 2.1 as published
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
15-- commercial license or contractual agreement.
7fd59977 16
17package AIS
18
19 ---Purpose: Application Interactive Services provide the means to
20 -- create links between an application GUI viewer and
21 -- the packages which are used to manage selection
22 -- and presentation. The tools AIS defined in order to
23 -- do this include different sorts of entities: both the
24 -- selectable viewable objects themselves and the
25 -- context and attribute managers to define their
26 -- selection and display.
27 -- To orient the user as he works in a modeling
28 -- environment, views and selections must be
29 -- comprehensible. There must be several different sorts
30 -- of selectable and viewable object defined. These must
31 -- also be interactive, that is, connecting graphic
32 -- representation and the underlying reference
33 -- geometry. These entities are called Interactive
34 -- Objects, and are divided into four types:
35 -- - the Datum
36 -- - the Relation
37 -- - the Object
38 -- - None.
39 -- The Datum groups together the construction elements
40 -- such as lines, circles, points, trihedra, plane trihedra,
41 -- planes and axes.
42 -- The Relation is made up of constraints on one or
43 -- more interactive shapes and the corresponding
44 -- reference geometry. For example, you might want to
45 -- constrain two edges in a parallel relation. This
46 -- contraint is considered as an object in its own right,
47 -- and is shown as a sensitive primitive. This takes the
48 -- graphic form of a perpendicular arrow marked with
49 -- the || symbol and lying between the two edges.
50 -- The Object type includes topological shapes, and
51 -- connections between shapes.
52 -- None, in order not to eliminate the object, tells the
53 -- application to look further until it finds an object
54 -- definition in its generation which is accepted.
55 -- Inside these categories, you have the possibility
56 -- of an additional characterization by means of a
57 -- signature. The signature provides an index to the
58 -- further characterization. By default, the Interactive
59 -- Object has a None type and a signature of 0
60 -- (equivalent to None.) If you want to give a particular
61 -- type and signature to your interactive object, you must
62 -- redefine the two virtual methods: Type and Signature.
63 -- In the C++ inheritance structure of the package, each
64 -- class representing a specific Interactive Object
65 -- inherits AIS_InteractiveObject. Among these
66 -- inheriting classes, AIS_Relation functions as the
67 -- abstract mother class for tinheriting classes defining
68 -- display of specific relational constraints and types of
69 -- dimension. Some of these include:
70 -- - display of constraints based on relations of
71 -- symmetry, tangency, parallelism and concentricity
72 -- - display of dimensions for angles, offsets,
73 -- diameters, radii and chamfers.
74 -- No viewer can show everything at once with any
75 -- coherence or clarity. Views must be managed
76 -- carefully both sequentially and at any given instant.
77 -- Another function of the view is that of a context to
78 -- carry out design in. The design changes are applied
79 -- to the objects in the view and then extended to the
80 -- underlying reference geometry by a solver. To make
81 -- sense of this complicated visual data, several display
82 -- and selection tools are required. To facilitate
83 -- management, each object and each construction
84 -- element has a selection priority. There are also
85 -- means to modify the default priority.
86 -- To define an environment of dynamic detection, you
87 -- can use standard filter classes or create your own. A
88 -- filter questions the owner of the sensitive primitive in
89 -- local context to determine if it has the the desired
90 -- qualities. If it answers positively, it is kept. If not, it is rejected.
91 -- The standard filters supplied in AIS include:
92 -- AIS_AttributeFilter
93 -- AIS_SignatureFilter
94 -- AIS_TypeFilter.
95 -- Only the type filter can be used in the default
96 -- operating mode, the neutral point. The others can
97 -- only be used in open local contexts.
98 -- Neutral point and local context constitute the two
99 -- operating modes of the central entity which pilots
100 -- visualizations and selections, the Interactive Context.
101 -- It is linked to a main viewer and if you like, a trash bin
102 -- viewer as well.
103 -- The neutral point, which is the default mode, allows
104 -- you to easily visualize and select interactive objects
105 -- which have been loaded into the context. Opening
106 -- local contexts allows you to prepare and use a
107 -- temporary selection environment without disturbing
108 -- the neutral point. A set of functions allows you to
109 -- choose the interactive objects which you want to act
110 -- on, the selection modes which you want to activate,
111 -- and the temporary visualizations which you will
112 -- execute. When the operation is finished, you close the
113 -- current local context and return to the state in which
114 -- you were before opening it (neutral point or previous
115 -- local context).
116 -- An interactive object can have a certain number of
117 -- graphic attributes which are specific to it, such as
118 -- visualization mode, color, and material. By the same
119 -- token, the interactive context has a set of graphic
120 -- attributes, the Drawer which is valid by default for the
121 -- objects it controls. When an interactive object is
122 -- visualized, the required graphic attributes are first
123 -- taken from the object's own Drawer if one exists, or
124 -- from the context drawer for the others.
125
126
127uses
128 TCollection,
129 MMgt,
130 Quantity,
131 TColgp,
132 TColStd,
133 TopLoc,
134 gp,
135 Geom,
136 Bnd,
137 Aspect,
7fd59977 138 Graphic3d,
139 V3d,
140 TopAbs,
141 TopoDS,
142 Prs3d,
143 PrsMgr,
144 Select3D,
145 SelectMgr,
146 StdSelect,
147 DsgPrs,
148 TopTools,
149 Poly
150
151is
152
153
0a768f56 154 enumeration DisplayMode is WireFrame, Shaded;
7fd59977 155 ---Purpose:
156 -- Sets display modes other than neutral point ones,
157 -- for interactive objects. The possibilities include:
158 -- - wireframe,
159 -- - shaded,
160
161 enumeration ConnectStatus is
162 CS_None,
163 CS_Connection,
164 CS_Transform,
165 CS_Both;
166 ---Purpose: Gives the status of connection of an Interactive
167 -- Object. This will be one of the following:
168 -- - No connection
169 -- - Connection
170 -- - Transformation
171 -- - Both connection and transformation
172 -- This enumeration is used in
173 -- AIS_ConnectedInteractive. Transform indicates
174 -- that the Interactive Object reference geometry has
175 -- changed location relative to the reference geometry.
176
177 enumeration TypeOfIso is
178 TOI_IsoU,
179 TOI_IsoV,
180 TOI_Both;
181 ---Purpose: Declares the type of isoparameter displayed.
182
183 enumeration DisplayStatus is
184 DS_Displayed,
185 DS_Erased,
7fd59977 186 DS_Temporary,
187 DS_None;
188 ---Purpose:
189 -- To give the display status of an Interactive Object.
190 -- This will be one of the following:
191 -- - DS_Displayed: the Interactive Object is
192 -- displayed in the main viewer;
ed8cad74 193 -- - DS_Erased: the Interactive Object is hidden in main viewer;
7fd59977 194 -- - DS_Temporary: the Interactive Object is temporarily displayed;
195 -- - DS_None: the Interactive Object is nowhere displayed.
196
197 enumeration SelectStatus is
198 SS_Added,
199 SS_Removed,
200 SS_NotDone
201 end SelectStatus;
202
203 enumeration StatusOfPick is
204 SOP_Error,
205 SOP_NothingSelected,
206 SOP_Removed,
207 SOP_OneSelected,
208 SOP_SeveralSelected
209 end StatusOfPick;
210
211 enumeration StatusOfDetection is
212 SOD_Error,
213 SOD_Nothing,
214 SOD_AllBad,
215 SOD_Selected,
216 SOD_OnlyOneDetected,
217 SOD_OnlyOneGood,
218 SOD_SeveralGood
219 end StatusOfDetection;
220
221 enumeration KindOfDimension is
222 KOD_NONE,
223 KOD_LENGTH,
224 KOD_PLANEANGLE,
225 KOD_SOLIDANGLE,
226 KOD_AREA,
227 KOD_VOLUME,
228 KOD_MASS,
229 KOD_TIME,
230 KOD_RADIUS,
231 KOD_DIAMETER,
232 KOD_CHAMF2D,
233 KOD_CHAMF3D,
234 KOD_OFFSET,
235 KOD_ELLIPSERADIUS;
236 ---Purpose: Declares the kinds of dimensions needed in the
237 -- display of Interactive Objects.
238
239 enumeration KindOfInteractive is
240 KOI_None,
241 KOI_Datum,
242 KOI_Shape,
243 KOI_Object,
244 KOI_Relation;
245 --- Purpose: Declares the type of Interactive Object.
246 -- This is one of the following:
247 -- - the Datum
248 -- - the Object
249 -- - the Relation
250 -- - the None type.
251 -- The Datum is the construction element. These include
252 -- points, lines, axes and planes. The object brings
253 -- together topological shapes. The Relation includes
254 -- dimensions and constraints. When the object is of an
255 -- unknown type, the None type is declared.
256
257 enumeration ClearMode is
258 CM_All,
259 CM_Interactive,
260 CM_Filters,
261 CM_StandardModes,
262 CM_TemporaryShapePrs
263 end ClearMode;
264 ---Purpose: Declares which entities in an opened local context
265 -- are to be cleared of mode settings. Temporary
266 -- graphic presentations such as those for sub-shapes,
267 -- for example, are only created for the selection
268 -- process. By means of these enumerations, they can
269 -- be cleared from local context.
a6eb515f 270
7fd59977 271 enumeration KindOfUnit is
272 TOU_LENGTH,
273 TOU_SURFACE,
274 TOU_VOLUME,
275 TOU_PLANE_ANGLE,
276 TOU_SOLID_ANGLE,
277 TOU_MASS,
278 TOU_FORCE,
279 TOU_TIME;
a6eb515f 280 ---Purpose: Declares the type of Interactive Object unit.
281
7fd59977 282 enumeration TypeOfAxis is TOAX_Unknown,TOAX_XAxis,TOAX_YAxis,TOAX_ZAxis;
a6eb515f 283 ---Purpose: Declares the type of axis.
284
7fd59977 285 enumeration TypeOfPlane is TOPL_Unknown,TOPL_XYPlane,TOPL_XZPlane,TOPL_YZPlane;
a6eb515f 286 ---Purpose: Declares the type of plane.
7fd59977 287 enumeration TypeOfDist is TOD_Unknown,TOD_Horizontal,TOD_Vertical;
a6eb515f 288 ---Purpose: To declare the type of distance.
289
7fd59977 290 enumeration TypeOfAttribute is
291 TOA_Line,
a6eb515f 292 TOA_Dimension,
7fd59977 293 TOA_Wire,
294 TOA_Plane,
295 TOA_Vector,
296 TOA_UIso,
297 TOA_VIso,
298 TOA_Free,
299 TOA_UnFree,
300 TOA_Section,
301 TOA_Hidden,
302 TOA_Seen,
303 TOA_FirstAxis,
304 TOA_SecondAxis,
305 TOA_ThirdAxis;
7fd59977 306
a6eb515f 307 enumeration StandardDatum is SD_None,SD_Point,SD_Axis,SD_Trihedron,SD_PlaneTrihedron,SD_Line,SD_Circle,SD_Plane;
308 --- Purpose: Declares the type of standard datum of an Interactive Object.
7fd59977 309
310 enumeration KindOfSurface is KOS_Plane, KOS_Cylinder, KOS_Cone, KOS_Sphere, KOS_Torus,
a6eb515f 311 KOS_Revolution, KOS_Extrusion, KOS_OtherSurface;
312
313-- Enumerations for dimensions management --
314
315 enumeration DisplaySpecialSymbol is DSS_No, DSS_Before, DSS_After;
316 ---Purpose: Specifies dimension special symbol display options
317
fe83e1ea 318 enumeration DimensionSelectionMode is DSM_All, DSM_Line, DSM_Text;
319 ---Purpose: Specifies dimension selection modes.
a6eb515f 320
7fd59977 321 class Triangulation;
322
323 class TexturedShape;
324
325 class Drawer;
326
327 class InteractiveContext;
328
329 class GraphicTool;
330
1bd2fa67 331 class LocalContext;
7fd59977 332
333 private class LocalStatus;
334
335 private class GlobalStatus;
336
337 deferred class InteractiveObject;
338
339 ---Category: VARIOUS STANDARD INTERACTIVE OBJECTS
340 -- each type of Datum has a given signature.
341 -- the other interactive objects don't
342 -- implement this signature.
343 -- Mainly used for selection with Filters...
344
345 ---Category: Datum
346 class Point; --signature 1
347 class Axis; --signature 2
348 class Trihedron; --signature 3
349 class PlaneTrihedron; --signature 4
350 class Line; --signature 5
351 class Circle; --signature 6
352 class Plane; --signature 7
353
354
355 ---Category: Object of type Shape
356 class Shape; --signature 0
357 class ConnectedShape; --signature 1
358 class MultipleConnectedShape; --signature 2
359
360
361
362 ---Category: General Objects
363 class ConnectedInteractive; --signature 0
364 class MultipleConnectedInteractive; --signature 1
365
366 ---Category: DIMENSIONS AND RELATIONS
367
368 class DimensionOwner;
369
370 deferred class Relation;
371 deferred class EllipseRadiusDimension;
372 class MaxRadiusDimension;
373 class MinRadiusDimension;
a6eb515f 374 imported LengthDimension;
375 imported AngleDimension;
376 imported RadiusDimension;
377 imported DiameterDimension;
7fd59977 378 class Chamf2dDimension;
379 class Chamf3dDimension;
380 class OffsetDimension;
381 class FixRelation;
382 class PerpendicularRelation;
383 class ParallelRelation;
384 class TangentRelation;
385 class ConcentricRelation;
386 class IdenticRelation;
387 class SymmetricRelation; -- axial symmetry
388 class MidPointRelation; -- equal distance from point
389 class EqualRadiusRelation;
390 class EqualDistanceRelation;
391
392
393 ---Category: FILTERS
394
395
396 class TypeFilter;
397 class SignatureFilter;
398 class ExclusionFilter;
399 class AttributeFilter;
400 class C0RegularityFilter;
401 class BadEdgeFilter;
402
403 pointer PToContext to InteractiveContext from AIS;
404
405
406
407
408 class Selection;
409
410
411 ---Category: The Collections
412
413
414 class ListOfInteractive instantiates List from TCollection
415 (InteractiveObject from AIS);
416
417 class SequenceOfInteractive instantiates Sequence from TCollection
418 (InteractiveObject from AIS);
419
420 class SequenceOfDimension instantiates Sequence from TCollection
421 (Relation from AIS);
422
423 class MapOfInteractive instantiates Map from TCollection
424 (InteractiveObject from AIS,MapTransientHasher from TColStd);
425
426
427 class DataMapofIntegerListOfinteractive instantiates DataMap from
428 TCollection(Integer from Standard, ListOfInteractive from AIS,MapIntegerHasher from TColStd);
429 -- for further management of layers
430
431 private class DataMapOfIOStatus instantiates DataMap from
432 TCollection(InteractiveObject from AIS,GlobalStatus from AIS,MapTransientHasher from TColStd);
433 -- Management of interactiveObjects Status...
434
435 class IndexedDataMapOfOwnerPrs instantiates IndexedDataMap from TCollection
436 (EntityOwner from SelectMgr,Presentation from Prs3d ,MapTransientHasher from TColStd);
437 -- for dynamic selection management in local context...
438
439 -- san: 18/04/2003 AIS_Selection class optimization
440 -- agv: 04/05/2003 Replace NCollection_List for CDL list
441 imported NListTransient;
442 imported NListIteratorOfListTransient;
443 imported NDataMapOfTransientIteratorOfListTransient;
444 -- service map for AIS_Selection class optimized logic
445
446 private class DataMapOfILC instantiates DataMap from TCollection
447 (Integer from Standard, LocalContext from AIS, MapIntegerHasher from TColStd);
448
449 private class DataMapOfSelStat instantiates DataMap from TCollection
450 (SelectableObject from SelectMgr,LocalStatus from AIS,MapTransientHasher from TColStd);
451 -- to tell if an object is sensitive to Standard Modes Of Selection....
452
453-- Methods for dimensions
454
455 Nearest( aShape : Shape from TopoDS;
456 aPoint : Pnt from gp )
457 returns Pnt from gp;
458 ---Purpose:
459 -- Returns the nearest point in a shape. This is used by
460 -- several classes in calculation of dimensions.
60bf98ae 461
462 Nearest (theLine : Lin from gp;
463 thePoint : Pnt from gp)
464 returns Pnt from gp;
465 ---Purpose:
466 -- @return the nearest point on the line.
467
468 Nearest (theCurve : Curve from Geom;
469 thePoint : Pnt from gp;
470 theFirstPoint : Pnt from gp;
471 theLastPoint : Pnt from gp;
472 theNearestPoint : out Pnt from gp)
473 returns Boolean from Standard;
474 ---Purpose:
475 -- For the given point finds nearest point on the curve,
476 -- @return TRUE if found point is belongs to the curve
477 -- and FALSE otherwise.
478
7fd59977 479 Farest( aShape : Shape from TopoDS;
480 aPoint : Pnt from gp )
481 returns Pnt from gp;
482
60bf98ae 483 ComputeGeometry (theEdge : Edge from TopoDS;
484 theCurve : out Curve from Geom;
485 theFirstPnt : out Pnt from gp;
486 theLastPnt : out Pnt from gp)
7fd59977 487 ---Purpose: Used by 2d Relation only
488 -- Computes the 3d geometry of <anEdge> in the current WorkingPlane
489 -- and the extremities if any
60bf98ae 490 -- Return TRUE if ok.
7fd59977 491 returns Boolean from Standard;
60bf98ae 492
493 ComputeGeometry (theEdge : Edge from TopoDS;
494 theCurve : out Curve from Geom;
495 theFirstPnt : out Pnt from gp;
496 theLastPnt : out Pnt from gp;
497 theIsInfinite : out Boolean from Standard)
498 ---Purpose: Used by dimensions only.
499 -- Computes the 3d geometry of <anEdge>.
500 -- Return TRUE if ok.
501 returns Boolean from Standard;
502
503 ComputeGeometry (theEdge : Edge from TopoDS;
504 theCurve : out Curve from Geom;
505 theFirstPnt : out Pnt from gp;
506 theLastPnt : out Pnt from gp;
507 theExtCurve : out Curve from Geom;
508 theIsInfinite : out Boolean from Standard;
509 theIsOnPlane : out Boolean from Standard;
510 thePlane : Plane from Geom)
7fd59977 511 ---Purpose: Used by 2d Relation only
512 -- Computes the 3d geometry of <anEdge> in the current WorkingPlane
513 -- and the extremities if any.
514 -- If <aCurve> is not in the current plane, <extCurve> contains
515 -- the not projected curve associated to <anEdge>.
516 -- If <anEdge> is infinite, <isinfinite> = true and the 2
517 -- parameters <FirstPnt> and <LastPnt> have no signification.
60bf98ae 518 -- Return TRUE if ok.
7fd59977 519 returns Boolean from Standard;
60bf98ae 520
521 ComputeGeometry (theFirstEdge : Edge from TopoDS;
522 theSecondEdge : Edge from TopoDS;
523 theFirstCurve : out Curve from Geom;
524 theSecondCurve : out Curve from Geom;
525 theFirstPnt1 : out Pnt from gp;
526 theLastPnt1 : out Pnt from gp;
527 theFirstPnt2 : out Pnt from gp;
528 theLastPnt2 : out Pnt from gp;
529 thePlane : Plane from Geom)
7fd59977 530 ---Purpose: Used by 2d Relation only
531 -- Computes the 3d geometry of <anEdge> in the current WorkingPlane
532 -- and the extremities if any
60bf98ae 533 -- Return TRUE if ok.
7fd59977 534 returns Boolean from Standard;
535
60bf98ae 536 ComputeGeometry (theFirstEdge : Edge from TopoDS;
537 theSecondEdge : Edge from TopoDS;
538 theFirstCurve : out Curve from Geom;
539 theSecondCurve : out Curve from Geom;
540 theFirstPnt1 : out Pnt from gp;
541 theLastPnt1 : out Pnt from gp;
542 theFirstPnt2 : out Pnt from gp;
543 theLastPnt2 : out Pnt from gp;
544 theIsinfinite1 : out Boolean from Standard;
545 theIsinfinite2 : out Boolean from Standard)
546 ---Purpose: Used by dimensions only.Computes the 3d geometry
547 -- of<anEdge1> and <anEdge2> and checks if they are infinite.
548 returns Boolean from Standard;
7fd59977 549
60bf98ae 550 ComputeGeometry (theFirstEdge : Edge from TopoDS;
551 theSecondEdge : Edge from TopoDS;
552 theExtIndex : out Integer from Standard;
553 theFirstCurve : out Curve from Geom;
554 theSecondCurve : out Curve from Geom;
555 theFirstPnt1 : out Pnt from gp;
556 theLastPnt1 : out Pnt from gp;
557 theFirstPnt2 : out Pnt from gp;
558 theLastPnt2 : out Pnt from gp;
559 theExtCurve : out Curve from Geom;
560 theIsinfinite1 : out Boolean from Standard;
561 theIsinfinite2 : out Boolean from Standard;
562 thePlane : Plane from Geom)
7fd59977 563 ---Purpose: Used by 2d Relation only Computes the 3d geometry
564 -- of<anEdge1> and <anEdge2> in the current Plane and the
565 -- extremities if any. Return in ExtCurve the 3d curve
566 -- (not projected in the plane) of the first edge if
567 -- <indexExt> =1 or of the 2nd edge if <indexExt> = 2. If
568 -- <indexExt> = 0, ExtCurve is Null. if there is an edge
569 -- external to the plane, <isinfinite> is true if this
570 -- edge is infinite. So, the extremities of it are not
571 -- significant. Return TRUE if ok
572 returns Boolean from Standard;
573
60bf98ae 574 ComputeGeomCurve (aCurve : in out Curve from Geom;
575 first1 : Real from Standard;
576 last1 : Real from Standard;
577 FirstPnt1 : out Pnt from gp;
578 LastPnt1 : out Pnt from gp;
579 aPlane : Plane from Geom;
580 isOnPlane: out Boolean from Standard)
7fd59977 581 ---Purpose: Checks if aCurve belongs to aPlane; if not, projects aCurve in aPlane
582 -- and returns aCurve;
583 -- Return TRUE if ok
584 returns Boolean from Standard;
585
60bf98ae 586 ComputeGeometry (aVertex : Vertex from TopoDS;
587 point : out Pnt from gp;
588 aPlane : Plane from Geom;
589 isOnPlane: out Boolean from Standard)
7fd59977 590 returns Boolean from Standard;
7fd59977 591
60bf98ae 592 GetPlaneFromFace (aFace : Face from TopoDS;
593 aPlane : out Pln from gp;
594 aSurf : out Surface from Geom;
595 aSurfType : out KindOfSurface from AIS;
596 Offset : out Real from Standard)
7fd59977 597 returns Boolean from Standard;
598 ---Purpose: Tryes to get Plane from Face. Returns Surface of Face
599 -- in aSurf. Returns Standard_True and Plane of Face in
600 -- aPlane in following cases:
601 -- Face is Plane, Offset of Plane,
602 -- Extrusion of Line and Offset of Extrusion of Line
60bf98ae 603 -- Returns pure type of Surface which can be:
604 -- Plane, Cylinder, Cone, Sphere, Torus,
605 -- SurfaceOfRevolution, SurfaceOfExtrusion
606
607 InitFaceLength (aFace : Face from TopoDS;
608 aPlane : out Pln from gp;
609 aSurface : out Surface from Geom;
610 aSurfaceType : out KindOfSurface from AIS;
611 anOffset : out Real from Standard );
612
613 InitLengthBetweenCurvilinearFaces (theFirstFace : Face from TopoDS;
614 theSecondFace : Face from TopoDS;
615 theFirstSurf : in out Surface from Geom;
616 theSecondSurf : in out Surface from Geom;
617 theFirstAttach : out Pnt from gp;
618 theSecondAttach : out Pnt from gp;
619 theDirOnPlane : out Dir from gp);
620 ---Purpose: Finds attachment points on two curvilinear faces for length dimension.
621 -- @param thePlaneDir [in] the direction on the dimension plane to
622 -- compute the plane automatically. It will not be taken into account if
623 -- plane is defined by user.
624
625 InitAngleBetweenPlanarFaces (theFirstFace : Face from TopoDS;
626 theSecondFace : Face from TopoDS;
627 theCenter : out Pnt from gp;
628 theFirstAttach : out Pnt from gp;
629 theSecondAttach : out Pnt from gp;
630 theIsFirstPointSet : Boolean from Standard = Standard_False)
631 returns Boolean from Standard;
632 ---Purpose: Finds three points for the angle dimension between
633 -- two planes.
634
635 InitAngleBetweenCurvilinearFaces (theFirstFace : Face from TopoDS;
636 theSecondFace : Face from TopoDS;
637 theFirstSurfType : KindOfSurface from AIS;
638 theSecondSurfType : KindOfSurface from AIS;
639 theCenter : out Pnt from gp;
640 theFirstAttach : out Pnt from gp;
641 theSecondAttach : out Pnt from gp;
642 theIsFirstPointSet : Boolean from Standard = Standard_False)
643 returns Boolean from Standard;
644 ---Purpose: Finds three points for the angle dimension between
645 -- two curvilinear surfaces.
7fd59977 646
647 ProjectPointOnPlane( aPoint : Pnt from gp; aPlane : Pln from gp )
648 returns Pnt from gp;
649
650 ProjectPointOnLine( aPoint : Pnt from gp; aLine : Lin from gp )
651 returns Pnt from gp;
652
653 TranslatePointToBound( aPoint : Pnt from gp; aDir : Dir from gp; aBndBox: Box from Bnd )
654 returns Pnt from gp;
655
656 InDomain( aFirstPar : Real from Standard;
657 aLastPar : Real from Standard;
658 anAttachPar : Real from Standard)
659 returns Boolean from Standard;
660 ---Purpose: returns True if point with anAttachPar is
661 -- in domain of arc
662
663 NearestApex(elips : Elips from gp;
664 pApex : Pnt from gp;
665 nApex : Pnt from gp;
666 fpara : Real from Standard ;
667 lpara : Real from Standard ;
668 IsInDomain : out Boolean from Standard)
669 returns Pnt from gp;
670 ---Purpose: computes nearest to ellipse arc apex
671
672 DistanceFromApex(elips : Elips from gp;
673 Apex : Pnt from gp;
674 par : Real from Standard )
675 returns Real from Standard;
676 ---Purpose: computes length of ellipse arc in parametric units
677
678
679 ComputeProjEdgePresentation(aPres : mutable Presentation from Prs3d;
680 aDrawer : mutable Drawer from AIS;
681 anEdge : Edge from TopoDS;
682 ProjCurve: Curve from Geom;
683 FirstP : Pnt from gp;
684 LastP : Pnt from gp;
685 aColor : NameOfColor from Quantity = Quantity_NOC_PURPLE;
686 aWidth : Real from Standard = 2;
687 aProjTOL : TypeOfLine from Aspect = Aspect_TOL_DASH;
688 aCallTOL : TypeOfLine from Aspect = Aspect_TOL_DOT);
689
690 ComputeProjVertexPresentation(aPres : mutable Presentation from Prs3d;
691 aDrawer : mutable Drawer from AIS;
692 aVertex : Vertex from TopoDS;
693 ProjPoint: Pnt from gp;
694 aColor : NameOfColor from Quantity = Quantity_NOC_PURPLE;
695 aWidth : Real from Standard = 2;
696 aProjTOM : TypeOfMarker from Aspect = Aspect_TOM_PLUS;
697 aCallTOL : TypeOfLine from Aspect = Aspect_TOL_DOT);
698
699end AIS;