0024153: Adding OpenCL to OCCT prerequisites
[occt.git] / src / AIS / AIS_DimensionOwner.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 class DimensionOwner from AIS inherits EntityOwner from SelectMgr
23
24         ---Purpose: The owner is the entity which makes it possible to link
25         -- the sensitive primitives and the reference shapes that
26         -- you want to detect. It stocks the various pieces of
27         -- information which make it possible to find objects. An
28         -- owner has a priority which you can modulate, so as to
29         -- make one entity more selectable than another. You
30         -- might want to make edges more selectable than
31         -- faces, for example. In that case, you could attribute sa
32         -- higher priority to the one compared to the other. An
33         -- edge, could have priority 5, for example, and a face,
34         -- priority 4. The default priority is 5.
35
36 uses
37
38     SelectableObject from SelectMgr,
39     Shape            from TopoDS
40
41 is
42
43     Create ( aSO      : SelectableObject;
44             aPriority : Integer from Standard =0)
45     returns mutable DimensionOwner from AIS;
46         ---Purpose:
47         -- Initializes the dimension owner, aSO, and attributes it
48         -- the priority, aPriority.    
49     
50     SetShape(me : mutable; aShape : Shape from TopoDS);
51         ---C++: inline
52         ---Purpose:
53         -- Constructs the reference shape owner aShape for
54         -- presentation primitives.
55     
56     FixedShape(me)
57         ---C++: return const &
58         ---C++: inline    
59         ---Purpose:
60         -- Returns the owner shape whose primitives we are concerned with.   
61     returns Shape from TopoDS;
62     
63
64 fields
65
66     myFixedShape : Shape from TopoDS;
67
68 end DimensionOwner;
69