0023024: Update headers of OCCT files
[occt.git] / src / AIS / AIS_ParallelRelation.cdl
CommitLineData
b311480e 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-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
7fd59977 21
22
23class ParallelRelation from AIS inherits Relation from AIS
24
25 ---Purpose: A framework to display constraints of parallelism
26 -- between two or more Interactive Objects. These
27 -- entities can be faces or edges.
28
29uses Shape from TopoDS,
30 Presentation from Prs3d,
31 PresentationManager3d from PrsMgr,
32 Selection from SelectMgr,
33 Plane from Geom,
34 Dir from gp,
35 Pnt from gp,
36 Projector from Prs3d,
37 Transformation from Geom,
38 PresentationManager2d from PrsMgr,
39 GraphicObject from Graphic2d,
40 ArrowSide from DsgPrs
41
42is
43 Create (aFShape : Shape from TopoDS;
44 aSShape : Shape from TopoDS;
45 aPlane : Plane from Geom)
46 ---Purpose: Constructs an object to display parallel constraints.
47 -- This object is defined by the first shape aFShape and
48 -- the second shape aSShape and the plane aPlane.
49 returns mutable ParallelRelation from AIS;
50
51 Create (aFShape : Shape from TopoDS;
52 aSShape : Shape from TopoDS;
53 aPlane : Plane from Geom;
54 aPosition : Pnt from gp;
55 aSymbolPrs : ArrowSide from DsgPrs;
56 anArrowSize : Real from Standard = 0.01)
57 ---Purpose: Constructs an object to display parallel constraints.
58 -- This object is defined by the first shape aFShape and
59 -- the second shape aSShape the plane aPlane, the
60 -- position aPosition, the type of arrow, aSymbolPrs and
61 -- its size anArrowSize.
62 returns mutable ParallelRelation from AIS;
63
64 IsMovable(me) returns Boolean from Standard
65 ---Purpose: Returns true if the parallelism is movable.
66 ---C++: inline
67 is redefined;
68
69-- Methods from PresentableObject
70
71 Compute(me : mutable;
72 aPresentationManager: PresentationManager3d from PrsMgr;
73 aPresentation : mutable Presentation from Prs3d;
74 aMode : Integer from Standard= 0)
75 is redefined static private;
76
77 Compute(me:mutable;
78 aProjector: Projector from Prs3d;
79 aPresentation: mutable Presentation from Prs3d)
80 is redefined static private;
81
82 Compute(me:mutable;
83 aPresentationManager: PresentationManager2d from PrsMgr;
84 aPresentation: mutable GraphicObject from Graphic2d;
85 aMode: Integer from Standard = 0)
86 is redefined static private;
87
88
89 Compute(me : mutable;
90 aProjector : Projector from Prs3d;
91 aTrsf : Transformation from Geom;
92 aPresentation : mutable Presentation from Prs3d)
93 is redefined;
94 ---Purpose: computes the presentation according to a point of view
95 -- given by <aProjector>.
96 -- To be Used when the associated degenerated Presentations
97 -- have been transformed by <aTrsf> which is not a Pure
98 -- Translation. The HLR Prs can't be deducted automatically
99 -- WARNING :<aTrsf> must be applied
100 -- to the object to display before computation !!!
101
102-- Methods from SelectableObject
103
104 ComputeSelection(me : mutable;
105 aSelection : mutable Selection from SelectMgr;
106 aMode : Integer from Standard)is private;
107
108
109
110--
111-- Computation private methods
112--
113
114 ComputeTwoFacesParallel(me: mutable;
115 aPresentation : mutable Presentation from Prs3d)
116 is private;
117
118 ComputeTwoEdgesParallel(me: mutable;
119 aPresentation : mutable Presentation from Prs3d)
120 is private;
121
122
123fields
124
125 myFAttach : Pnt from gp;
126 mySAttach : Pnt from gp;
127 myDirAttach : Dir from gp;
128
129end ParallelRelation;
130