07f687e8ad4874d4ccdb569d13aeafc210f357be
[occt.git] / src / AIS / AIS_Dimension.hxx
1 // Created on: 2013-11-11
2 // Created by: Anastasia BORISOVA
3 // Copyright (c) 2013-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _AIS_Dimension_HeaderFile
17 #define _AIS_Dimension_HeaderFile
18
19 #include <AIS_DimensionSelectionMode.hxx>
20 #include <AIS_DimensionOwner.hxx>
21 #include <AIS_DisplaySpecialSymbol.hxx>
22 #include <AIS_InteractiveObject.hxx>
23 #include <AIS_KindOfInteractive.hxx>
24 #include <AIS_KindOfDimension.hxx>
25 #include <AIS_KindOfSurface.hxx>
26 #include <Geom_Curve.hxx>
27 #include <gp_Pln.hxx>
28 #include <Prs3d_ArrowAspect.hxx>
29 #include <Prs3d_DimensionAspect.hxx>
30 #include <Prs3d_DimensionUnits.hxx>
31 #include <Prs3d_Drawer.hxx>
32 #include <Prs3d_LineAspect.hxx>
33 #include <Prs3d_Presentation.hxx>
34 #include <Prs3d_TextAspect.hxx>
35 #include <SelectMgr_EntityOwner.hxx>
36 #include <Standard.hxx>
37 #include <TCollection_ExtendedString.hxx>
38 #include <TColgp_HSequenceOfPnt.hxx>
39 #include <TopoDS_Edge.hxx>
40 #include <TopoDS_Face.hxx>
41 #include <TopoDS_Shape.hxx>
42 #include <NCollection_Sequence.hxx>
43 #include <NCollection_Handle.hxx>
44
45 DEFINE_STANDARD_HANDLE(AIS_Dimension, AIS_InteractiveObject)
46
47 //! AIS_Dimension is a base class for 2D presentations of linear (length, diameter, radius)
48 //! and angular dimensions.
49 //!
50 //! The dimensions provide measurement of quantities, such as lengths or plane angles.
51 //! The measurement of dimension "value" is done in model space "as is".
52 //! These "value" are said to be represented in "model units", which can be specified by user.
53 //! During the display the measured value converted from "model units" to "display units".
54 //! The display and model units are stored in common Prs3d_Drawer (drawer of the context)
55 //! to share it between all dimensions.
56 //! The specified by user units are stored in the dimension's drawer.
57 //!
58 //! As a drawing, the dimension is composed from the following components:
59 //! - Attachment (binding) points. The points where the dimension lines attaches to, for
60 //!   length dimensions the distances are measured between these points.
61 //! - Main dimension line. The which extends from the attachment points in "up" direction,
62 //!   and which contains text label on it with value string.
63 //! - Flyouts. The lines connecting the attachment points with main dimension line.
64 //! - Extension. The lines used to extend the main dimension line in the cases when text
65 //!   or arrows do not fit into the main dimension line due to their size.
66 //! - Arrows.
67 //!
68 //! <pre>
69 //!  Linear dimensions:
70 //!
71 //!  extension
72 //!   line                                     arrow
73 //!       -->|------- main dimension line -------|<--
74 //!          |                                   |
75 //!          |flyout                       flyout|
76 //!          |                                   |
77 //!          +-----------------------------------+
78 //! attachment                                attachment
79 //!  point                                       point
80 //!
81 //!  Angular dimensions:
82 //!
83 //!                  extension
84 //!                     line
85 //!                        -->|+++++
86 //!                     arrow |     +++
87 //!                           |        90(deg) - main dimension line
88 //!                    flyout |         +++
89 //!                           |           +
90 //!                           o---flyout---
91 //!                         center         ^ 
92 //!                         point          | extension
93 //!                                          line
94 //! </pre>
95 //!
96 //! Being a 2D drawings, the dimensions are created on imaginary plane, called "dimension plane",
97 //! which can be thought of as reference system of axes (X,Y,N) for constructing the presentation.
98 //!
99 //! The role of axes of the dimension plane is to guide you through the encapsualted automations
100 //! of presentation building to help you understand how is the presentation will look and how it
101 //! will be oriented in model space during construction.
102 //! 
103 //! Orientation of dimension line in model space relatively to the base shapes is defined 
104 //! with the flyouts. Flyouts specify length of flyout lines and their orientation relatively
105 //! to the attachment points on the working plane.
106 //! For linear dimensions: 
107 //!   Direction of flyouts is specified with direction of main dimension line
108 //!   (vector from the first attachment to the second attachment) and the normal of the dimension plane.
109 //!   Positive direction of flyouts is defined by vector multiplication: AttachVector * PlaneNormal.
110 //! For angular dimensions:
111 //!   Flyouts are defined by vectors from the center point to the attachment points.
112 //!   These vectors directions are supposed to be the positive directions of flyouts.
113 //!   Negative flyouts directions means that these vectors should be reversed
114 //!   (and dimension will be built out of the angle constructed with center and two attach points).
115 //!
116 //! The dimension plane can be constructed automatically by application (where possible,
117 //! it depends on the measured geometry).
118 //! It can be also set by user. However, if the user-defined plane does not fit the
119 //! geometry of the dimension (attach points do not belong to it), the dimension could not
120 //! be built.
121 //! If it is not possible to compute automatic plane (for example, in case of length between 
122 //! two points) the user is supposed to specify the custom plane.
123 //!
124 //! Since the dimensions feature automated construction procedures from an arbitrary shapes,
125 //! the interfaces to check the validness are also implemented. Once the measured geometry is
126 //! specified, the one can inquire the validness status by calling "IsValid()" method. If the result
127 //! is TRUE, then all of public parameters should be pre-computed and ready. The presentation
128 //! should be also computable. Otherwise, the parameters may return invalid values. In this case,
129 //! the presentation will not be computed and displayed.
130 //! 
131 //! The dimension support two local selection modes: main dimension line selection and text label
132 //! selection. These modes can be used to develop interactive modification of dimension presentations.
133 //! The component highlighting in these selection modes is provided by AIS_DimensionOwner class.
134 //! Please note that selection is unavailable until the presentation is computed.
135 //! 
136 //! The specific drawing attributes are controlled through Prs3d_DimensionAspect. The one can change
137 //! color, arrows, text and arrow style and specify positioning of value label by setting corresponding
138 //! values to the aspect.
139 //!
140 //! Such set of parameters that consists of:
141 //! - flyout size and direction,
142 //! - user-defined  dimension plane,
143 //! - horizontal and vertical text alignment
144 //! can be uniquely replaced with text position in 3d space. Therefore, there are methods to convert
145 //! this set of parameters to the text position and vice versa:
146 //!
147 //! - If the fixed text position is defined by user, called SetTextPosition (theTextPos) method converts
148 //! this 3d point to the set of parameters including adjusting of the dimension plane (this plane will be
149 //! automatic plane, NOT user-defined one).
150 //! If the fixed text position is set, the flag myIsFixedTextPosition is set to TRUE.
151 //! ATTENSION! myIsFixedTextPosition fixes all parameters of the set from recomputing inside
152 //! SetMeasureGeometry() methods. Parameters in dimension aspect (they are horizontal text position
153 //! and extension size) are adjusted on presentation computing step, user-defined values in
154 //! dimension aspect are not changed.
155 //! But plane and flyout as dimension position parameters are changed by SetTextPosition() method
156 //! according with user-defined text position.
157 //! If parameters from the set are changed by user with calls of setters, it leads to disabling of
158 //! fixed text position (myIsFixedTextPosition is set to FALSE).
159 //! If the fixed text position is set and geometry is changed by user (SetMeasureGeometry() method
160 //! is called) and the geometry doesn't satisfy computed dimension plane, the dimension is not valid.
161 //!
162 //! - If the set of parameters was set by user (may be without the user-defined plane or with it),
163 //! it can be converted to the text position by calling the method GetTextPosition(). In this case
164 //! the text position is NOT fixed, and SetMeasureGeometry() without user-defined plane adjusts
165 //! the automatic plane according input geometry (if it is possible).
166 //!
167 class AIS_Dimension : public AIS_InteractiveObject
168 {
169 protected:
170
171   //! Geometry type defines type of shapes on which the dimension is to be built.
172   //! Some type of geometry allows automatic plane computing and
173   //! can be built without user-defined plane
174   //! Another types can't be built without user-defined plane.
175   enum GeometryType
176   {
177     GeometryType_UndefShapes,
178     GeometryType_Edge,
179     GeometryType_Face,
180     GeometryType_Points,
181     GeometryType_Edges,
182     GeometryType_Faces,
183     GeometryType_EdgeFace,
184     GeometryType_EdgeVertex
185   };
186
187   //! Specifies supported at base level horizontal and vertical
188   //! label positions for drawing extension lines and centered text.
189   enum LabelPosition
190   {
191     LabelPosition_None    = 0x00,
192
193     LabelPosition_Left    = 0x01,
194     LabelPosition_Right   = 0x02,
195     LabelPosition_HCenter = 0x04,
196     LabelPosition_HMask   = LabelPosition_Left | LabelPosition_Right | LabelPosition_HCenter,
197
198     LabelPosition_Above   = 0x10,
199     LabelPosition_Below   = 0x20,
200     LabelPosition_VCenter = 0x40,
201     LabelPosition_VMask   = LabelPosition_Above | LabelPosition_Below | LabelPosition_VCenter
202   };
203
204 public:
205
206   //! Specifies supported presentation compute modes.
207   //! Used to compute only parts of presentation for
208   //! advanced highlighting.
209   enum ComputeMode
210   {
211     ComputeMode_All  = 0, //!< "0" is reserved as neutral mode
212     ComputeMode_Line = 1, //!< corresponds to selection mode
213     ComputeMode_Text = 2  //!< corresponds to selection mode
214   };
215
216 public:
217
218   //! Constructor with default parameters values.
219   //! @param theType [in] the type of dimension.
220   Standard_EXPORT AIS_Dimension (const AIS_KindOfDimension theType);
221
222   //! Gets dimension measurement value. If the value to display is not
223   //! specified by user, then the dimension object is responsible to
224   //! compute it on its own in model space coordinates.
225   //! @return the dimension value (in model units) which is used
226   //! during display of the presentation.
227   Standard_Real GetValue() const
228   {
229     return myIsValueCustom ? myCustomValue : ComputeValue();
230   }
231
232   //! Sets user-defined dimension value.
233   //! The user-defined dimension value is specified in model space,
234   //! and affect by unit conversion during the display.
235   //! @param theValue [in] the user-defined value to display.
236   Standard_EXPORT void SetCustomValue (const Standard_Real theValue);
237
238   //! Get the dimension plane in which the 2D dimension presentation is computed.
239   //! By default, if plane is not defined by user, it is computed automatically
240   //! after dimension geometry is computed.
241   //! If computed dimension geometry (points) can't be placed on the user-defined
242   //! plane, dimension geometry was set as invalid (validity flag is set to false)
243   //! and dimension presentation will not be computed.
244   //! If user-defined plane allow geometry placement on it, it will be used for
245   //! computing of the dimension presentation.
246   //! @return dimension plane used for presentation computing.
247   Standard_EXPORT const gp_Pln& GetPlane() const;
248
249   //! Geometry type defines type of shapes on which the dimension is to be built. 
250   //! @return type of geometry on which the dimension will be built.
251   Standard_EXPORT const Standard_Integer GetGeometryType () const;
252
253   //! Sets user-defined plane where the 2D dimension presentation will be placed.
254   //! Checks validity of this plane if geometry has been set already.
255   //! Validity of the plane is checked according to the geometry set
256   //! and has different criteria for different kinds of dimensions.
257   Standard_EXPORT virtual void SetCustomPlane (const gp_Pln& thePlane);
258
259   //! Unsets user-defined plane. Therefore the plane for dimension will be
260   //! computed automatically.
261   Standard_EXPORT void UnsetCustomPlane() { myIsPlaneCustom = Standard_False; }
262
263   //! @return TRUE if text position is set by user with method SetTextPosition().
264   Standard_Boolean IsTextPositionCustom() const
265   {
266     return myIsTextPositionFixed;
267   }
268
269   //! Fixes the absolute text position and adjusts flyout, plane and text alignment
270   //! according to it. Updates presentation if the text position is valid.
271   //! ATTENTION! It does not change vertical text alignment.
272   //! @param theTextPos [in] the point of text position.
273   virtual void SetTextPosition (const gp_Pnt& /*theTextPos*/) { }
274
275   //! Computes absolute text position from dimension parameters
276   //! (flyout, plane and text alignment).
277   virtual const gp_Pnt GetTextPosition () const { return gp_Pnt(); }
278
279 public:
280
281   //! Gets the dimension aspect from AIS object drawer.
282   //! Dimension aspect contains aspects of line, text and arrows for dimension presentation.
283   Handle(Prs3d_DimensionAspect) DimensionAspect() const
284   {
285     return myDrawer->DimensionAspect();
286   }
287
288   //! Sets new dimension aspect for the interactive object drawer.
289   //! The dimension aspect provides dynamic properties which are generally
290   //! used during computation of dimension presentations.
291   Standard_EXPORT void SetDimensionAspect (const Handle(Prs3d_DimensionAspect)& theDimensionAspect);
292
293   //! @return the kind of dimension.
294   AIS_KindOfDimension KindOfDimension() const
295   {
296     return myKindOfDimension;
297   }
298
299   //! @return the kind of interactive.
300   virtual AIS_KindOfInteractive Type() const
301   {
302     return AIS_KOI_Dimension;
303   }
304
305   //! Returns true if the class of objects accepts the display mode theMode.
306   //! The interactive context can have a default mode of representation for
307   //! the set of Interactive Objects. This mode may not be accepted by object.
308   virtual Standard_Boolean AcceptDisplayMode (const Standard_Integer theMode) const
309   {
310     return theMode == ComputeMode_All;
311   }
312
313 public:
314
315   //! @return dimension special symbol display options.
316   AIS_DisplaySpecialSymbol DisplaySpecialSymbol() const
317   {
318     return myDisplaySpecialSymbol;
319   }
320
321   //! Specifies whether to display special symbol or not.
322   Standard_EXPORT void SetDisplaySpecialSymbol (const AIS_DisplaySpecialSymbol theDisplaySpecSymbol);
323
324   //! @return special symbol.
325   Standard_ExtCharacter SpecialSymbol() const
326   {
327     return mySpecialSymbol;
328   }
329
330   //! Specifies special symbol.
331   Standard_EXPORT void SetSpecialSymbol (const Standard_ExtCharacter theSpecialSymbol);
332
333   Standard_EXPORT virtual const TCollection_AsciiString& GetDisplayUnits() const;
334
335   Standard_EXPORT virtual const TCollection_AsciiString& GetModelUnits() const;
336
337   Standard_EXPORT virtual void SetDisplayUnits (const TCollection_AsciiString& /*theUnits*/) { }
338
339   Standard_EXPORT virtual void SetModelUnits (const TCollection_AsciiString& /*theUnits*/) { }
340
341   //! Unsets user defined text positioning and enables text positioning
342   //!  by other parameters: text alignment, extension size, flyout and custom plane.
343   Standard_EXPORT void UnsetFixedTextPosition();
344
345 public:
346
347   //! Returns selection tolerance for text2d:
348   //! For 2d text selection detection sensitive point with tolerance is used
349   //! Important! Only for 2d text.
350   Standard_Real SelToleranceForText2d() const
351   {
352     return mySelToleranceForText2d;
353   }
354
355   //! Sets selection tolerance for text2d:
356   //! For 2d text selection detection sensitive point with tolerance is used
357   //! to change this tolerance use this method
358   //! Important! Only for 2d text.
359   Standard_EXPORT void SetSelToleranceForText2d (const Standard_Real theTol);
360
361   //! @return flyout value for dimension.
362   Standard_Real GetFlyout() const
363   {
364     return myFlyout;
365   }
366
367   //! Sets flyout value for dimension.
368   Standard_EXPORT void SetFlyout (const Standard_Real theFlyout);
369
370   //! Check that the input geometry for dimension is valid and the
371   //! presentation can be successfully computed.
372   //! @return TRUE if dimension geometry is ok.
373   virtual Standard_Boolean IsValid() const
374   {
375     return myIsGeometryValid && CheckPlane (GetPlane());
376   }
377
378 public:
379
380   DEFINE_STANDARD_RTTI(AIS_Dimension, AIS_InteractiveObject)
381
382 protected:
383
384   Standard_EXPORT Standard_Real ValueToDisplayUnits() const;
385
386   //! Get formatted value string and its model space width.
387   //! @param theWidth [out] the model space with of the string.
388   //! @return formatted dimension value string.
389   Standard_EXPORT TCollection_ExtendedString GetValueString (Standard_Real& theWidth) const;
390
391   //! Performs drawing of 2d or 3d arrows on the working plane
392   //! @param theLocation [in] the location of the arrow tip.
393   //! @param theDirection [in] the direction from the tip to the bottom of the arrow.
394   Standard_EXPORT void DrawArrow (const Handle(Prs3d_Presentation)& thePresentation,
395                                   const gp_Pnt& theLocation,
396                                   const gp_Dir& theDirection);
397
398   //! Performs drawing of 2d or 3d text on the working plane
399   //! @param theTextPos [in] the position of the text label.
400   //! @param theTestDir [in] the direction of the text label.
401   //! @param theText [in] the text label string.
402   //! @param theLabelPosition [in] the text label vertical and horizontal positioning option
403   //! respectively to the main dimension line. 
404   //! @return text width relative to the dimension working plane. For 2d text this value will be zero.
405   Standard_EXPORT void DrawText (const Handle(Prs3d_Presentation)& thePresentation,
406                                  const gp_Pnt& theTextPos,
407                                  const gp_Dir& theTextDir,
408                                  const TCollection_ExtendedString& theText,
409                                  const Standard_Integer theLabelPosition);
410
411   //! Performs computing of dimension linear extension with text
412   //! @param thePresentation [in] the presentation to fill with graphical primitives.
413   //! @param theExtensionSize [in] the size of extension line.
414   //! @param theExtensionStart [in] the point where extension line connects to dimension.
415   //! @param theExtensionDir [in] the direction of extension line.
416   //! @param theLabelString [in] the string with value.
417   //! @param theLabelWidth [in] the geometrical width computed for value string.
418   //! @param theMode [in] the display mode.
419   //! @param theLabelPosition [in] position flags for the text label.
420   Standard_EXPORT void DrawExtension (const Handle(Prs3d_Presentation)& thePresentation,
421                                       const Standard_Real theExtensionSize,
422                                       const gp_Pnt& theExtensionStart,
423                                       const gp_Dir& theExtensionDir,
424                                       const TCollection_ExtendedString& theLabelString,
425                                       const Standard_Real theLabelWidth,
426                                       const Standard_Integer theMode,
427                                       const Standard_Integer theLabelPosition);
428
429   //! Performs computing of linear dimension (for length, diameter, radius and so on).
430   //! Please note that this method uses base dimension properties, like working plane
431   //! flyout length, drawer attributes.
432   //! @param thePresentation [in] the presentation to fill with primitives.
433   //! @param theMode [in] the presentation compute mode.
434   //! @param theFirstPoint [in] the first attach point of linear dimension.
435   //! @param theSecondPoint [in] the second attach point of linear dimension.
436   //! @param theIsOneSide [in] specifies whether the dimension has only one flyout line.
437   Standard_EXPORT void DrawLinearDimension (const Handle(Prs3d_Presentation)& thePresentation,
438                                             const Standard_Integer theMode,
439                                             const gp_Pnt& theFirstPoint,
440                                             const gp_Pnt& theSecondPoint,
441                                             const Standard_Boolean theIsOneSide = Standard_False);
442
443   //! Compute selection sensitives for linear dimension flyout lines (length, diameter, radius).
444   //! Please note that this method uses base dimension properties: working plane and flyout length.
445   //! @param theSelection [in] the selection structure to fill with selection primitives.
446   //! @param theOwner [in] the selection entity owner.
447   //! @param theFirstPoint [in] the first attach point of linear dimension.
448   //! @param theSecondPoint [in] the second attach point of linear dimension.
449   Standard_EXPORT void ComputeLinearFlyouts (const Handle(SelectMgr_Selection)& theSelection,
450                                              const Handle(SelectMgr_EntityOwner)& theOwner,
451                                              const gp_Pnt& theFirstPoint,
452                                              const gp_Pnt& theSecondPoint);
453
454
455   //! Performs initialization of circle and middle arc point from the passed
456   //! shape which is assumed to contain circular geometry.
457   //! @param theShape [in] the shape to explore.
458   //! @param theCircle [out] the circle geometry.
459   //! @param theMiddleArcPoint [out] the middle point of the arc.
460   //! @param theIsClosed [out] returns TRUE if the geometry is closed circle.
461   //! @return TRUE if the the circle is successfully got from the input shape.
462   Standard_EXPORT Standard_Boolean InitCircularDimension (const TopoDS_Shape& theShape,
463                                                           gp_Circ& theCircle,
464                                                           gp_Pnt& theMiddleArcPoint,
465                                                           Standard_Boolean& theIsClosed);
466  
467   //! Produce points for triangular arrow face.
468   //! @param thePeakPnt [in] the arrow peak position.
469   //! @param theDirection [in] the arrow direction.
470   //! @param thePlane [in] the face plane.
471   //! @param theArrowLength [in] the length of arrow.
472   //! @param theArrowAngle [in] the angle of arrow.
473   //! @param theSidePnt1 [out] the first side point.
474   //! @param theSidePnt2 [out] the second side point.
475   Standard_EXPORT void PointsForArrow (const gp_Pnt& thePeakPnt,
476                                        const gp_Dir& theDirection,
477                                        const gp_Dir& thePlane,
478                                        const Standard_Real theArrowLength,
479                                        const Standard_Real theArrowAngle,
480                                        gp_Pnt& theSidePnt1,
481                                        gp_Pnt& theSidePnt2);
482
483   //! Compute point of text position for dimension parameters
484   //! for linear kinds of dimensions (length, radius, diameter).
485   Standard_EXPORT gp_Pnt GetTextPositionForLinear (const gp_Pnt& theFirstPoint,
486                                                    const gp_Pnt& theSecondPoint,
487                                                    const Standard_Boolean theIsOneSide = Standard_False) const;
488
489   //! Fits text alignment relatively to the dimension line.
490   //! @param theFirstPoint [in] the first attachment point.
491   //! @param theSecondPoint [in] the second attachment point.
492   //! @param theIsOneSide [in] is the arrow displayed only on the one side of the dimension.
493   //! @param theHorizontalTextPos [in] the text horizontal position (alignment).
494   //! @param theLabelPosition [out] the label position, contains bits that defines
495   //! vertical and horizontal alignment. (for internal usage in count text position)
496   //! @param theIsArrowExternal [out] is the arrows external,
497   //! if arrow orientation in the dimension aspect is Prs3d_DAO_Fit, it fits arrow
498   //! orientation automatically.
499   Standard_EXPORT void FitTextAlignmentForLinear (const gp_Pnt& theFirstPoint,
500                                                   const gp_Pnt& theSecondPoint,
501                                                   const Standard_Boolean theIsOneSide,
502                                                   const Prs3d_DimensionTextHorizontalPosition& theHorizontalTextPos,
503                                                   Standard_Integer& theLabelPosition,
504                                                   Standard_Boolean& theIsArrowsExternal) const;
505
506   //! Adjusts aspect parameters according the text position:
507   //! extension size, vertical text alignment and flyout.
508   //! @param theTextPos [in] the user defined 3d point of text position
509   //! @param theFirstPoint [in] the first point of linear measurement.
510   //! @param theSecondPoint [in] the second point of linear measurement.
511   //! @param theExtensionSize [out] the adjusted extension size
512   //! @param theAlignment [out] the horizontal label alignment.
513   //! @param theFlyout [out] the adjusted value of flyout.
514   //! @param thePlane [out] the new plane that contains theTextPos and attachment points.
515   //! @param theIsPlaneOld [out] shows if new plane is computed.
516   Standard_EXPORT Standard_Boolean AdjustParametersForLinear (const gp_Pnt& theTextPos,
517                                                               const gp_Pnt& theFirstPoint,
518                                                               const gp_Pnt& theSecondPoint,
519                                                               Standard_Real& theExtensionSize,
520                                                               Prs3d_DimensionTextHorizontalPosition& theAlignment,
521                                                               Standard_Real& theFlyout,
522                                                               gp_Pln& thePlane,
523                                                               Standard_Boolean& theIsPlaneOld) const;
524
525 protected: //! @name Static auxilliary methods for geometry extraction
526
527   //! If it is possible extracts circle from planar face.
528   //! @param theFace        [in] the planar face
529   //! @param theCurve       [out] the circular curve
530   //! @param theFirstPoint  [out] the point of the first parameter of the circlular curve
531   //! @param theSecondPoint [out] the point of the last parameter of the circlular curve
532   //! @return TRUE in case of successful circle extraction
533   static Standard_Boolean CircleFromPlanarFace (const TopoDS_Face&  theFace,
534                                                 Handle(Geom_Curve)& theCurve,
535                                                 gp_Pnt&             theFirstPoint,
536                                                 gp_Pnt&             theLastPoint);
537
538   //! If it is possible extracts circle from the edge.
539   //! @param theEdge        [in] input edge to extract circle from
540   //! @param theCircle      [out] circle
541   //! @param theFirstPoint  [out] the point of the first parameter of the circlular curve
542   //! @param theSecondPoint [out] the point of the last parameter of the circlular curve
543   //! @return TRUE in case of successful circle extraction.
544   static Standard_Boolean CircleFromEdge (const TopoDS_Edge& theEdge,
545                                           gp_Circ&           theCircle,
546                                           gp_Pnt&            theFirstPoint,
547                                           gp_Pnt&            theLastPoint);
548
549 protected: //! @name Behavior to implement
550
551   //! Override this method to compute automatically dimension plane
552   //! in which the dimension presentation is built.
553   virtual void ComputePlane() { }
554
555   //! Override this method to check if user-defined plane
556   //! is valid for the dimension geometry.
557   //! @param thePlane [in] the working plane for positioning every
558   //! dimension in the application.
559   //! @return true is the plane is suitable for building dimension
560   //! with computed dimension geometry.
561   virtual Standard_Boolean CheckPlane (const gp_Pln& /*thePlane*/) const { return Standard_True; }
562
563   //! Override this method to computed value of dimension.
564   //! @return value from the measured geometry.
565   virtual Standard_Real ComputeValue() const 
566   {
567     return 0.0;
568   }
569
570   //! Override this method to compute selection primitives for
571   //! flyout lines (if the dimension provides it).
572   //! This callback is a only a part of base selection
573   //! computation routine.
574   virtual void ComputeFlyoutSelection (const Handle(SelectMgr_Selection)&,
575                                        const Handle(SelectMgr_EntityOwner)&) {}
576
577
578   //! Base procedure of computing selection (based on selection geometry data).
579   //! @param theSelection [in] the selection structure to will with primitives.
580   //! @param theMode [in] the selection mode.
581   Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
582                                                  const Standard_Integer theMode);
583
584 protected: //! @name Selection geometry
585
586   //! Selection geometry of dimension presentation. The structure is filled with data
587   //! during compute of presentation, then this data is used to generate selection
588   //! sensitives when computing selection.
589   struct SelectionGeometry
590   {
591     //! Arrows are represented by directed triangles.
592     struct Arrow
593     {
594       gp_Pnt Position;
595       gp_Dir Direction;
596     };
597     typedef NCollection_Sequence<gp_Pnt> Curve;
598     typedef NCollection_Handle<Curve>    HCurve;
599     typedef NCollection_Handle<Arrow>    HArrow;
600     typedef NCollection_Sequence<HCurve> SeqOfCurves;
601     typedef NCollection_Sequence<HArrow> SeqOfArrows;
602
603     gp_Pnt           TextPos;            //!< Center of text label.
604     gp_Dir           TextDir;            //!< Direction of text label.
605     Standard_Real    TextWidth;          //!< Width of text label.
606     Standard_Real    TextHeight;         //!< Height of text label.
607     SeqOfCurves      DimensionLine;      //!< Sequence of points for composing the segments of dimension line.
608     SeqOfArrows      Arrows;             //!< Sequence of arrow geometries.
609     Standard_Boolean IsComputed;         //!< Shows if the selection geometry was filled.
610
611   public:
612
613     //! Clear geometry of sensitives for the specified compute mode.
614     //! @param theMode [in] the compute mode to clear.
615     void Clear (const Standard_Integer theMode)
616     {
617       if (theMode == ComputeMode_All || theMode == ComputeMode_Line)
618       {
619         DimensionLine.Clear();
620         Arrows.Clear();
621       }
622
623       if (theMode == ComputeMode_All || theMode == ComputeMode_Text)
624       {
625         TextPos    = gp::Origin();
626         TextDir    = gp::DX();
627         TextWidth  = 0.0;
628         TextHeight = 0.0;
629       }
630
631       IsComputed = Standard_False;
632     }
633
634     //! Add new curve entry and return the reference to populate it.
635     Curve& NewCurve()
636     {
637       DimensionLine.Append( new Curve );
638       HCurve& aLastCurve = DimensionLine.ChangeLast();
639       return *aLastCurve;
640     }
641
642     //! Add new arrow entry and return the reference to populate it.
643     Arrow& NewArrow()
644     {
645       Arrows.Append( new Arrow );
646       HArrow& aLastArrow = Arrows.ChangeLast();
647       return *aLastArrow;
648     }
649   } mySelectionGeom;
650
651   Standard_Real mySelToleranceForText2d; //!< Sensitive point tolerance for 2d text selection.
652
653 protected: //! @name Value properties
654
655   Standard_Real    myCustomValue;   //!< Value of the dimension (computed or user-defined).
656   Standard_Boolean myIsValueCustom; //!< Is user-defined value.
657
658 protected: //! @name Fixed text position properties
659
660   gp_Pnt                  myFixedTextPosition;   //!< Stores text position fixed by user.
661   Standard_Boolean        myIsTextPositionFixed; //!< Is the text label position fixed by user.
662
663 protected: //! @name Units properties
664
665   Standard_ExtCharacter    mySpecialSymbol;        //!< Special symbol.
666   AIS_DisplaySpecialSymbol myDisplaySpecialSymbol; //!< Special symbol display options.
667
668 protected: //! @name Geometrical properties
669
670   GeometryType myGeometryType;  //!< defines type of shapes on which the dimension is to be built. 
671
672   gp_Pln           myPlane;           //!< Plane where dimension will be built (computed or user defined).
673   Standard_Boolean myIsPlaneCustom;   //!< Is plane defined by user (otherwise it will be computed automatically).
674   Standard_Real    myFlyout;          //!< Flyout distance.
675   Standard_Boolean myIsGeometryValid; //!< Is dimension geometry properly defined.
676
677 private:
678
679   AIS_KindOfDimension myKindOfDimension;
680 };
681
682 #endif // _AIS_Dimension_HeaderFile