1 // Created on: 2013-11-11
2 // Created by: Anastasia BORISOVA
3 // Copyright (c) 2013-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _AIS_Dimension_HeaderFile
17 #define _AIS_Dimension_HeaderFile
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 <AIS_Drawer.hxx>
27 #include <Geom_Curve.hxx>
29 #include <Prs3d_ArrowAspect.hxx>
30 #include <Prs3d_DimensionAspect.hxx>
31 #include <Prs3d_DimensionUnits.hxx>
32 #include <Prs3d_LineAspect.hxx>
33 #include <Prs3d_Presentation.hxx>
34 #include <Prs3d_TextAspect.hxx>
35 #include <Select3D_ListOfSensitive.hxx>
36 #include <SelectMgr_EntityOwner.hxx>
37 #include <Standard.hxx>
38 #include <TCollection_ExtendedString.hxx>
39 #include <TColgp_HSequenceOfPnt.hxx>
40 #include <TopoDS_Face.hxx>
41 #include <TopoDS_Shape.hxx>
42 #include <NCollection_Sequence.hxx>
43 #include <NCollection_Handle.hxx>
45 DEFINE_STANDARD_HANDLE(AIS_Dimension, AIS_InteractiveObject)
47 //! AIS_Dimension is a base class for 2D presentations of linear (length, diameter, radius)
48 //! and angular dimensions.
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.
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.
69 //! Linear dimensions:
73 //! -->|------- main dimension line -------|<--
77 //! +-----------------------------------+
78 //! attachment attachment
81 //! Angular dimensions:
87 //! | 90(deg) - main dimension line
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.
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.
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).
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
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.
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.
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.
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.
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:
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.
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).
167 class AIS_Dimension : public AIS_InteractiveObject
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.
177 GeometryType_UndefShapes,
183 GeometryType_EdgeFace,
184 GeometryType_EdgeVertex
187 //! Specifies supported at base level horizontal and vertical
188 //! label positions for drawing extension lines and centered text.
191 LabelPosition_None = 0x00,
193 LabelPosition_Left = 0x01,
194 LabelPosition_Right = 0x02,
195 LabelPosition_HCenter = 0x04,
196 LabelPosition_HMask = LabelPosition_Left | LabelPosition_Right | LabelPosition_HCenter,
198 LabelPosition_Above = 0x10,
199 LabelPosition_Below = 0x20,
200 LabelPosition_VCenter = 0x40,
201 LabelPosition_VMask = LabelPosition_Above | LabelPosition_Below | LabelPosition_VCenter
206 //! Specifies supported presentation compute modes.
207 //! Used to compute only parts of presentation for
208 //! advanced highlighting.
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
218 //! Constructor with default parameters values.
219 //! @param theType [in] the type of dimension.
220 Standard_EXPORT AIS_Dimension (const AIS_KindOfDimension theType);
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
229 return myIsValueCustom ? myCustomValue : ComputeValue();
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);
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;
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;
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);
259 //! Unsets user-defined plane. Therefore the plane for dimension will be
260 //! computed automatically.
261 Standard_EXPORT void UnsetCustomPlane() { myIsPlaneCustom = Standard_False; }
263 //! @return TRUE if text position is set by user with method SetTextPosition().
264 Standard_Boolean IsTextPositionCustom() const
266 return myIsTextPositionFixed;
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*/) { }
275 //! Computes absolute text position from dimension parameters
276 //! (flyout, plane and text alignment).
277 virtual const gp_Pnt GetTextPosition () const { return gp_Pnt(); }
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
285 return myDrawer->DimensionAspect();
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);
293 //! @return the kind of dimension.
294 AIS_KindOfDimension KindOfDimension() const
296 return myKindOfDimension;
299 //! @return the kind of interactive.
300 virtual AIS_KindOfInteractive Type() const
302 return AIS_KOI_Dimension;
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
310 return theMode == ComputeMode_All;
315 //! @return dimension special symbol display options.
316 AIS_DisplaySpecialSymbol DisplaySpecialSymbol() const
318 return myDisplaySpecialSymbol;
321 //! Specifies whether to display special symbol or not.
322 Standard_EXPORT void SetDisplaySpecialSymbol (const AIS_DisplaySpecialSymbol theDisplaySpecSymbol);
324 //! @return special symbol.
325 Standard_ExtCharacter SpecialSymbol() const
327 return mySpecialSymbol;
330 //! Specifies special symbol.
331 Standard_EXPORT void SetSpecialSymbol (const Standard_ExtCharacter theSpecialSymbol);
333 Standard_EXPORT virtual const TCollection_AsciiString& GetDisplayUnits() const;
335 Standard_EXPORT virtual const TCollection_AsciiString& GetModelUnits() const;
337 Standard_EXPORT virtual void SetDisplayUnits (const TCollection_AsciiString& /*theUnits*/) { }
339 Standard_EXPORT virtual void SetModelUnits (const TCollection_AsciiString& /*theUnits*/) { }
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();
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
352 return mySelToleranceForText2d;
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);
361 //! @return flyout value for dimension.
362 Standard_Real GetFlyout() const
367 //! Sets flyout value for dimension.
368 Standard_EXPORT void SetFlyout (const Standard_Real theFlyout);
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
375 return myIsGeometryValid && CheckPlane (GetPlane());
380 DEFINE_STANDARD_RTTI(AIS_Dimension)
384 Standard_EXPORT Standard_Real ValueToDisplayUnits() const;
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;
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);
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);
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);
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);
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);
454 //! If it is possible extracts circle from planar face.
455 //! @param theFace [in] the planar face.
456 //! @param theCurve [out] the circular curve.
457 //! @param theFirstPoint [out] the point of the first parameter of the circlular curve.
458 //! @param theSecondPoint [out] the point of the last parameter of the circlular curve.
459 //! @return TRUE in case of successful circle extraction.
460 Standard_EXPORT Standard_Boolean CircleFromPlanarFace (const TopoDS_Face& theFace,
461 Handle(Geom_Curve)& theCurve,
462 gp_Pnt& theFirstPoint,
463 gp_Pnt& theLastPoint);
465 //! Performs initialization of circle and middle arc point from the passed
466 //! shape which is assumed to contain circular geometry.
467 //! @param theShape [in] the shape to explore.
468 //! @param theCircle [out] the circle geometry.
469 //! @param theMiddleArcPoint [out] the middle point of the arc.
470 //! @param theIsClosed [out] returns TRUE if the geometry is closed circle.
471 //! @return TRUE if the the circle is successfully got from the input shape.
472 Standard_EXPORT Standard_Boolean InitCircularDimension (const TopoDS_Shape& theShape,
474 gp_Pnt& theMiddleArcPoint,
475 Standard_Boolean& theIsClosed);
477 //! Produce points for triangular arrow face.
478 //! @param thePeakPnt [in] the arrow peak position.
479 //! @param theDirection [in] the arrow direction.
480 //! @param thePlane [in] the face plane.
481 //! @param theArrowLength [in] the length of arrow.
482 //! @param theArrowAngle [in] the angle of arrow.
483 //! @param theSidePnt1 [out] the first side point.
484 //! @param theSidePnt2 [out] the second side point.
485 Standard_EXPORT void PointsForArrow (const gp_Pnt& thePeakPnt,
486 const gp_Dir& theDirection,
487 const gp_Dir& thePlane,
488 const Standard_Real theArrowLength,
489 const Standard_Real theArrowAngle,
491 gp_Pnt& theSidePnt2);
493 //! Compute point of text position for dimension parameters
494 //! for linear kinds of dimensions (length, radius, diameter).
495 Standard_EXPORT gp_Pnt GetTextPositionForLinear (const gp_Pnt& theFirstPoint,
496 const gp_Pnt& theSecondPoint,
497 const Standard_Boolean theIsOneSide = Standard_False) const;
499 //! Fits text alignment relatively to the dimension line.
500 //! @param theFirstPoint [in] the first attachment point.
501 //! @param theSecondPoint [in] the second attachment point.
502 //! @param theIsOneSide [in] is the arrow displayed only on the one side of the dimension.
503 //! @param theHorizontalTextPos [in] the text horizontal position (alignment).
504 //! @param theLabelPosition [out] the label position, contains bits that defines
505 //! vertical and horizontal alignment. (for internal usage in count text position)
506 //! @param theIsArrowExternal [out] is the arrows external,
507 //! if arrow orientation in the dimension aspect is Prs3d_DAO_Fit, it fits arrow
508 //! orientation automatically.
509 Standard_EXPORT void FitTextAlignmentForLinear (const gp_Pnt& theFirstPoint,
510 const gp_Pnt& theSecondPoint,
511 const Standard_Boolean theIsOneSide,
512 const Prs3d_DimensionTextHorizontalPosition& theHorizontalTextPos,
513 Standard_Integer& theLabelPosition,
514 Standard_Boolean& theIsArrowsExternal) const;
516 //! Adjusts aspect parameters according the text position:
517 //! extension size, vertical text alignment and flyout.
518 //! @param theTextPos [in] the user defined 3d point of text position
519 //! @param theFirstPoint [in] the first point of linear measurement.
520 //! @param theSecondPoint [in] the second point of linear measurement.
521 //! @param theExtensionSize [out] the adjusted extension size
522 //! @param theAlignment [out] the horizontal label alignment.
523 //! @param theFlyout [out] the adjusted value of flyout.
524 //! @param thePlane [out] the new plane that contains theTextPos and attachment points.
525 //! @param theIsPlaneOld [out] shows if new plane is computed.
526 Standard_EXPORT Standard_Boolean AdjustParametersForLinear (const gp_Pnt& theTextPos,
527 const gp_Pnt& theFirstPoint,
528 const gp_Pnt& theSecondPoint,
529 Standard_Real& theExtensionSize,
530 Prs3d_DimensionTextHorizontalPosition& theAlignment,
531 Standard_Real& theFlyout,
533 Standard_Boolean& theIsPlaneOld) const;
535 protected: //! @name Behavior to implement
537 //! Override this method to compute automatically dimension plane
538 //! in which the dimension presentation is built.
539 virtual void ComputePlane() { }
541 //! Override this method to check if user-defined plane
542 //! is valid for the dimension geometry.
543 //! @param thePlane [in] the working plane for positioning every
544 //! dimension in the application.
545 //! @return true is the plane is suitable for building dimension
546 //! with computed dimension geometry.
547 virtual Standard_Boolean CheckPlane (const gp_Pln& /*thePlane*/) const { return Standard_True; }
549 //! Override this method to computed value of dimension.
550 //! @return value from the measured geometry.
551 virtual Standard_Real ComputeValue() const
556 //! Override this method to compute selection primitives for
557 //! flyout lines (if the dimension provides it).
558 //! This callback is a only a part of base selection
559 //! computation routine.
560 virtual void ComputeFlyoutSelection (const Handle(SelectMgr_Selection)&,
561 const Handle(SelectMgr_EntityOwner)&) {}
564 //! Base procedure of computing selection (based on selection geometry data).
565 //! @param theSelection [in] the selection structure to will with primitives.
566 //! @param theMode [in] the selection mode.
567 Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
568 const Standard_Integer theMode);
570 protected: //! @name Selection geometry
572 //! Selection geometry of dimension presentation. The structure is filled with data
573 //! during compute of presentation, then this data is used to generate selection
574 //! sensitives when computing selection.
575 struct SelectionGeometry
577 //! Arrows are represented by directed triangles.
583 typedef NCollection_Sequence<gp_Pnt> Curve;
584 typedef NCollection_Handle<Curve> HCurve;
585 typedef NCollection_Handle<Arrow> HArrow;
586 typedef NCollection_Sequence<HCurve> SeqOfCurves;
587 typedef NCollection_Sequence<HArrow> SeqOfArrows;
589 gp_Pnt TextPos; //!< Center of text label.
590 gp_Dir TextDir; //!< Direction of text label.
591 Standard_Real TextWidth; //!< Width of text label.
592 Standard_Real TextHeight; //!< Height of text label.
593 SeqOfCurves DimensionLine; //!< Sequence of points for composing the segments of dimension line.
594 SeqOfArrows Arrows; //!< Sequence of arrow geometries.
595 Standard_Boolean IsComputed; //!< Shows if the selection geometry was filled.
599 //! Clear geometry of sensitives for the specified compute mode.
600 //! @param theMode [in] the compute mode to clear.
601 void Clear (const Standard_Integer theMode)
603 if (theMode == ComputeMode_All || theMode == ComputeMode_Line)
605 DimensionLine.Clear();
609 if (theMode == ComputeMode_All || theMode == ComputeMode_Text)
611 TextPos = gp::Origin();
617 IsComputed = Standard_False;
620 //! Add new curve entry and return the reference to populate it.
623 DimensionLine.Append( new Curve );
624 HCurve& aLastCurve = DimensionLine.ChangeLast();
628 //! Add new arrow entry and return the reference to populate it.
631 Arrows.Append( new Arrow );
632 HArrow& aLastArrow = Arrows.ChangeLast();
637 Standard_Real mySelToleranceForText2d; //!< Sensitive point tolerance for 2d text selection.
639 protected: //! @name Value properties
641 Standard_Real myCustomValue; //!< Value of the dimension (computed or user-defined).
642 Standard_Boolean myIsValueCustom; //!< Is user-defined value.
644 protected: //! @name Fixed text position properties
646 gp_Pnt myFixedTextPosition; //!< Stores text position fixed by user.
647 Standard_Boolean myIsTextPositionFixed; //!< Is the text label position fixed by user.
649 protected: //! @name Units properties
651 Standard_ExtCharacter mySpecialSymbol; //!< Special symbol.
652 AIS_DisplaySpecialSymbol myDisplaySpecialSymbol; //!< Special symbol display options.
654 protected: //! @name Geometrical properties
656 GeometryType myGeometryType; //!< defines type of shapes on which the dimension is to be built.
658 gp_Pln myPlane; //!< Plane where dimension will be built (computed or user defined).
659 Standard_Boolean myIsPlaneCustom; //!< Is plane defined by user (otherwise it will be computed automatically).
660 Standard_Real myFlyout; //!< Flyout distance.
661 Standard_Boolean myIsGeometryValid; //!< Is dimension geometry properly defined.
665 AIS_KindOfDimension myKindOfDimension;
668 #endif // _AIS_Dimension_HeaderFile