0024133: Development of improvement of dimensions implementation; new length, radius...
[occt.git] / src / AIS / AIS_Chamf3dDimension.cdl
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
23 class Chamf3dDimension from AIS inherits Relation from AIS
24
25         ---Purpose: A framework to define display of 3D chamfers.
26         -- A chamfer is displayed with arrows and text. The text
27         -- gives the length of the chamfer if it is a symmetrical
28         -- chamfer, or the angle if it is not.
29
30
31 uses
32
33     PresentationManager3d from PrsMgr,
34     Presentation          from Prs3d,
35     Selection             from SelectMgr,
36     Shape                 from TopoDS,
37     Pnt                   from gp,
38     Dir                   from gp,
39     Projector             from Prs3d,
40     Transformation        from Geom,
41     ExtendedString        from TCollection,
42     ArrowSide             from DsgPrs,
43     KindOfDimension       from AIS 
44     
45 is
46     Create (aFShape     : Shape          from TopoDS;
47             aVal        : Real           from Standard;
48             aText       : ExtendedString from TCollection)          
49          ---Purpose:  Constructs a display object for 3D chamfers.
50          -- This object is defined by the shape aFShape, the
51          -- dimension aVal and the text aText.
52     returns mutable Chamf3dDimension from AIS;
53
54     Create (aFShape     : Shape          from TopoDS;
55             aVal        : Real           from Standard;
56             aText       : ExtendedString from TCollection;          
57             aPosition   : Pnt            from gp;
58             aSymbolPrs  : ArrowSide      from DsgPrs;    
59             anArrowSize : Real           from Standard = 0.0)
60          ---Purpose:  Constructs a display object for 3D chamfers.
61          -- This object is defined by the shape aFShape, the
62          -- dimension aVal, the text aText, the point of origin of
63          -- the chamfer aPosition, the type of arrow aSymbolPrs
64          -- with the size anArrowSize.
65     returns mutable Chamf3dDimension from AIS;
66
67     KindOfDimension(me) 
68          ---Purpose: Indicates that we are concerned with a 3d length.
69          ---C++: inline
70     returns KindOfDimension from AIS 
71     is redefined;
72     
73     IsMovable(me) returns Boolean from Standard 
74          ---C++: inline    
75          ---Purpose: Returns true if the 3d chamfer dimension is movable.
76     is redefined;
77     
78     -- Methods from PresentableObject
79     
80     Compute(me            : mutable;
81             aPresentationManager: PresentationManager3d from PrsMgr;
82             aPresentation : mutable Presentation from Prs3d;
83             aMode         : Integer from Standard= 0) 
84     is redefined static private;
85     
86     Compute(me:mutable;
87                 aProjector: Projector from Prs3d;
88                 aPresentation: mutable Presentation from Prs3d)
89     is redefined static private;     
90
91     Compute(me            : mutable;
92             aProjector    : Projector from Prs3d;
93             aTrsf         : Transformation from Geom;
94             aPresentation : mutable Presentation from Prs3d)
95     is redefined;
96          ---Purpose: computes the presentation according to a point of view
97          --          given by <aProjector>. 
98          --          To be Used when the associated degenerated Presentations 
99          --          have been transformed by <aTrsf> which is not a Pure
100          --          Translation. The HLR Prs can't be deducted automatically
101          --          WARNING :<aTrsf> must be applied
102          --           to the object to display before computation  !!!
103
104     ComputeSelection(me         : mutable;
105                      aSelection : mutable Selection from SelectMgr;
106                      aMode      : Integer from Standard)
107     is redefined private;
108     
109     
110     
111 fields
112
113     myPntAttach : Pnt     from gp;
114     myDir       : Dir     from gp;
115
116 end Chamf3dDimension;