0024428: Implementation of LGPL license
[occt.git] / src / AIS / AIS_ParallelRelation.cdl
1 -- Created on: 1996-12-05
2 -- Created by: Jean-Pierre COMBE/Odile Olivier
3 -- Copyright (c) 1996-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
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.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 class ParallelRelation from AIS inherits Relation from AIS
18
19         ---Purpose: A framework to display constraints of parallelism
20         -- between two or more Interactive Objects. These
21         -- entities can be faces or edges.
22
23 uses Shape                 from TopoDS,
24      Presentation          from Prs3d,
25      PresentationManager3d from PrsMgr,
26      Selection             from SelectMgr,
27      Plane                 from Geom,
28      Dir                   from gp,
29      Pnt                   from gp,
30      Projector             from Prs3d,
31      Transformation        from Geom,
32      ArrowSide             from DsgPrs 
33
34 is
35     Create (aFShape     : Shape          from TopoDS;
36             aSShape     : Shape          from TopoDS;
37             aPlane      : Plane          from Geom)
38         ---Purpose:  Constructs an object to display parallel constraints.
39         -- This object is defined by the first shape aFShape and
40         -- the second shape aSShape and the plane aPlane.
41     returns mutable ParallelRelation from AIS;
42
43     Create (aFShape     : Shape          from TopoDS;
44             aSShape     : Shape          from TopoDS;
45             aPlane      : Plane          from Geom;
46             aPosition   : Pnt            from gp;
47             aSymbolPrs  : ArrowSide      from DsgPrs;    
48             anArrowSize : Real           from Standard = 0.01)
49         ---Purpose: Constructs an object to display parallel constraints.
50         -- This object is defined by the first shape aFShape and
51         -- the second shape aSShape the plane aPlane, the
52         -- position aPosition, the type of arrow, aSymbolPrs and
53         -- its size anArrowSize.
54     returns mutable ParallelRelation from AIS;
55
56     IsMovable(me) returns Boolean from Standard 
57         ---Purpose: Returns true if the parallelism is movable.  
58         ---C++: inline    
59     is redefined;
60     
61 -- Methods from PresentableObject
62
63     Compute(me            : mutable;
64             aPresentationManager: PresentationManager3d from PrsMgr;
65             aPresentation : mutable Presentation from Prs3d;
66             aMode         : Integer from Standard= 0) 
67     is redefined static private;
68     
69     Compute(me:mutable;
70                 aProjector: Projector from Prs3d;
71                 aPresentation: mutable Presentation from Prs3d)
72     is redefined static private;     
73
74     Compute(me            : mutable;
75             aProjector    : Projector from Prs3d;
76             aTrsf         : Transformation from Geom;
77             aPresentation : mutable Presentation from Prs3d)
78     is redefined;
79         ---Purpose: computes the presentation according to a point of view
80         --          given by <aProjector>. 
81         --          To be Used when the associated degenerated Presentations 
82         --          have been transformed by <aTrsf> which is not a Pure
83         --          Translation. The HLR Prs can't be deducted automatically
84         --          WARNING :<aTrsf> must be applied
85         --           to the object to display before computation  !!!
86
87 -- Methods from SelectableObject
88
89     ComputeSelection(me         : mutable;
90                      aSelection : mutable Selection from SelectMgr;
91                      aMode      : Integer from Standard)is private;
92
93
94
95 --
96 --     Computation private methods
97 --
98
99     ComputeTwoFacesParallel(me: mutable;
100                             aPresentation : mutable Presentation from Prs3d)
101     is private;
102     
103     ComputeTwoEdgesParallel(me: mutable;
104                             aPresentation : mutable Presentation from Prs3d)
105     is private;
106     
107
108 fields
109
110     myFAttach   : Pnt   from gp;
111     mySAttach   : Pnt   from gp;
112     myDirAttach : Dir   from gp;
113     
114 end ParallelRelation;
115