0023024: Update headers of OCCT files
[occt.git] / src / AIS / AIS_Relation.lxx
1 // Created on: 1996-12-05
2 // Created by: 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
21
22 #define BUC60915        //GG 05/06/01 Enable to compute the requested arrow size
23 //                      if any in all dimensions.
24
25 //=======================================================================
26 //function : FirstShape
27 //purpose  : 
28 //=======================================================================
29
30 inline const TopoDS_Shape& AIS_Relation::FirstShape() const 
31 {
32   return myFShape;
33 }
34
35
36 //=======================================================================
37 //function : SecondShape
38 //purpose  : 
39 //=======================================================================
40
41 inline const TopoDS_Shape& AIS_Relation::SecondShape() const 
42 {
43   return mySShape;
44 }
45
46
47 //=======================================================================
48 //function : SetBndBox
49 //purpose  : 
50 //=======================================================================
51
52 inline void AIS_Relation::SetBndBox( const Standard_Real Xmin,
53                                      const Standard_Real Ymin,
54                                      const Standard_Real Zmin,
55                                      const Standard_Real Xmax,
56                                      const Standard_Real Ymax,
57                                      const Standard_Real Zmax )
58 {
59   myBndBox.Update( Xmin, Ymin, Zmin, Xmax, Ymax, Zmax );
60   myIsSetBndBox = Standard_True;
61 }                                   
62
63 inline void AIS_Relation::UnsetBndBox()
64 {
65   myIsSetBndBox = Standard_False;
66 }
67
68 //=======================================================================
69 //function : :Plane
70 //purpose  : 
71 //=======================================================================
72
73 inline const Handle(Geom_Plane)& AIS_Relation::Plane() const 
74 {
75   return myPlane;
76 }
77
78 //=======================================================================
79 //function : SetPlane
80 //purpose  : 
81 //=======================================================================
82
83 inline void AIS_Relation::SetPlane(const Handle(Geom_Plane)& aPlane)
84 {
85   myPlane = aPlane;
86 }
87
88 //=======================================================================
89 //function : Value
90 //purpose  : 
91 //=======================================================================
92
93 inline Standard_Real AIS_Relation::Value() const 
94 {
95   return myVal;
96 }
97
98 //=======================================================================
99 //function : SetValue
100 //purpose  : 
101 //=======================================================================
102
103 inline void AIS_Relation::SetValue(const Standard_Real aVal)
104 {
105   myVal = aVal;
106 }
107
108 //=======================================================================
109 //function : Position
110 //purpose  : 
111 //=======================================================================
112
113 inline const gp_Pnt& AIS_Relation::Position() const 
114 {
115   return myPosition;
116 }
117
118
119 //=======================================================================
120 //function : SetPosition
121 //purpose  : 
122 //=======================================================================
123
124 inline void AIS_Relation::SetPosition(const gp_Pnt& aPosition)
125 {
126   myPosition = aPosition;
127   myAutomaticPosition = Standard_False;
128 }
129
130 //=======================================================================
131 //function : Text
132 //purpose  : 
133 //=======================================================================
134
135 inline const TCollection_ExtendedString& AIS_Relation::Text() const 
136 {
137   return myText;
138 }
139
140 //=======================================================================
141 //function : SetText
142 //purpose  : 
143 //=======================================================================
144
145 inline void AIS_Relation::SetText(const TCollection_ExtendedString& aText)
146 {
147   myText = aText;
148 }
149
150 //=======================================================================
151 //function : ArrowSize
152 //purpose  : 
153 //=======================================================================
154
155 inline Standard_Real AIS_Relation::ArrowSize() const 
156 {
157   return myArrowSize;
158 }
159
160 //=======================================================================
161 //function : SetArrowSize
162 //purpose  : 
163 //=======================================================================
164
165 inline void AIS_Relation::SetArrowSize(const Standard_Real anArrowSize)
166 {
167   myArrowSize = anArrowSize;
168 #ifdef BUC60915
169   myArrowSizeIsDefined = Standard_True;
170 #endif
171 }
172
173 //=======================================================================
174 //function : SymbolPrs
175 //purpose  : 
176 //=======================================================================
177
178 inline DsgPrs_ArrowSide AIS_Relation::SymbolPrs() const 
179 {
180   return mySymbolPrs;
181 }
182
183 //=======================================================================
184 //function : SetSymbolPrs
185 //purpose  : 
186 //=======================================================================
187 inline void AIS_Relation::SetSymbolPrs(const DsgPrs_ArrowSide aSymbolPrs)
188 {
189   mySymbolPrs = aSymbolPrs;
190 }
191
192
193
194 //=======================================================================
195 //function : KindOfInteractive
196 //purpose  : 
197 //=======================================================================
198 inline AIS_KindOfInteractive AIS_Relation::Type() const 
199 {return AIS_KOI_Relation;}
200
201
202 //=======================================================================
203 //function : SetExtShape
204 //purpose  : 
205 //=======================================================================
206 inline void AIS_Relation::SetExtShape(const Standard_Integer ExtSh) 
207 {myExtShape = ExtSh;}
208
209
210 //=======================================================================
211 //function : ExtShape
212 //purpose  : 
213 //=======================================================================
214 inline Standard_Integer AIS_Relation::ExtShape() const
215 {return myExtShape;}
216
217
218 //=======================================================================
219 //function : SetAutomaticPosition
220 //purpose  : 
221 //=======================================================================
222 inline void AIS_Relation::SetAutomaticPosition ( const Standard_Boolean aStatus ) 
223 {
224   myAutomaticPosition = aStatus ;
225 }
226
227 //=======================================================================
228 //function : AutomaticPosition
229 //purpose  : 
230 //=======================================================================
231 inline Standard_Boolean AIS_Relation::AutomaticPosition () const
232 {
233   return myAutomaticPosition;
234 }