0024023: Revamp the OCCT Handle -- ambiguity
[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-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 class Chamf3dDimension from AIS inherits Relation from AIS
18
19         ---Purpose: A framework to define display of 3D chamfers.
20         -- A chamfer is displayed with arrows and text. The text
21         -- gives the length of the chamfer if it is a symmetrical
22         -- chamfer, or the angle if it is not.
23
24
25 uses
26
27     PresentationManager3d from PrsMgr,
28     Presentation          from Prs3d,
29     Selection             from SelectMgr,
30     Shape                 from TopoDS,
31     Pnt                   from gp,
32     Dir                   from gp,
33     Projector             from Prs3d,
34     Transformation        from Geom,
35     ExtendedString        from TCollection,
36     ArrowSide             from DsgPrs,
37     KindOfDimension       from AIS 
38     
39 is
40     Create (aFShape     : Shape          from TopoDS;
41             aVal        : Real           from Standard;
42             aText       : ExtendedString from TCollection)          
43          ---Purpose:  Constructs a display object for 3D chamfers.
44          -- This object is defined by the shape aFShape, the
45          -- dimension aVal and the text aText.
46     returns Chamf3dDimension from AIS;
47
48     Create (aFShape     : Shape          from TopoDS;
49             aVal        : Real           from Standard;
50             aText       : ExtendedString from TCollection;          
51             aPosition   : Pnt            from gp;
52             aSymbolPrs  : ArrowSide      from DsgPrs;    
53             anArrowSize : Real           from Standard = 0.0)
54          ---Purpose:  Constructs a display object for 3D chamfers.
55          -- This object is defined by the shape aFShape, the
56          -- dimension aVal, the text aText, the point of origin of
57          -- the chamfer aPosition, the type of arrow aSymbolPrs
58          -- with the size anArrowSize.
59     returns Chamf3dDimension from AIS;
60
61     KindOfDimension(me) 
62          ---Purpose: Indicates that we are concerned with a 3d length.
63          ---C++: inline
64     returns KindOfDimension from AIS 
65     is redefined;
66     
67     IsMovable(me) returns Boolean from Standard 
68          ---C++: inline    
69          ---Purpose: Returns true if the 3d chamfer dimension is movable.
70     is redefined;
71     
72     -- Methods from PresentableObject
73     
74     Compute(me            : mutable;
75             aPresentationManager: PresentationManager3d from PrsMgr;
76             aPresentation : Presentation from Prs3d;
77             aMode         : Integer from Standard= 0) 
78     is redefined static private;
79     
80     Compute(me:mutable;
81                 aProjector: Projector from Prs3d;
82                 aPresentation: Presentation from Prs3d)
83     is redefined static private;     
84
85     Compute(me            : mutable;
86             aProjector    : Projector from Prs3d;
87             aTrsf         : Transformation from Geom;
88             aPresentation : Presentation from Prs3d)
89     is redefined;
90          ---Purpose: computes the presentation according to a point of view
91          --          given by <aProjector>. 
92          --          To be Used when the associated degenerated Presentations 
93          --          have been transformed by <aTrsf> which is not a Pure
94          --          Translation. The HLR Prs can't be deducted automatically
95          --          WARNING :<aTrsf> must be applied
96          --           to the object to display before computation  !!!
97
98     ComputeSelection(me         : mutable;
99                      aSelection : Selection from SelectMgr;
100                      aMode      : Integer from Standard)
101     is redefined private;
102     
103     
104     
105 fields
106
107     myPntAttach : Pnt     from gp;
108     myDir       : Dir     from gp;
109
110 end Chamf3dDimension;