0023634: Eliminate Polyline and Polygon usage in drawers
[occt.git] / src / MeshVS / MeshVS_MeshOwner.cdl
CommitLineData
b311480e 1-- Created on: 2007-01-24
2-- Created by: Sergey Kochetkov
3-- Copyright (c) 2007-2012 OPEN CASCADE SAS
4--
5-- The content of this file is subject to the Open CASCADE Technology Public
6-- License Version 6.5 (the "License"). You may not use the content of this file
7-- except in compliance with the License. Please obtain a copy of the License
8-- at http://www.opencascade.org and read it completely before using this file.
9--
10-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12--
13-- The Original Code and all software distributed under the License is
14-- distributed on an "AS IS" basis, without warranty of any kind, and the
15-- Initial Developer hereby disclaims all such warranties, including without
16-- limitation, any warranties of merchantability, fitness for a particular
17-- purpose or non-infringement. Please see the License for the specific terms
18-- and conditions governing the rights and limitations under the License.
19
7fd59977 20
21
22class MeshOwner from MeshVS inherits EntityOwner from SelectMgr
23
24 ---Purpose: The custom mesh owner used for advanced mesh selection. This class provides methods to store information:
25 -- 1) IDs of hilighted mesh nodes and elements
26 -- 2) IDs of mesh nodes and elements selected on the mesh
27
28uses
29 SOPtr from SelectMgr,
30 Integer from Standard,
31 EntityType from MeshVS,
32 HPackedMapOfInteger from TColStd,
33 PresentationManager3d from PrsMgr,
34 PresentationManager from PrsMgr,
35 NameOfColor from Quantity,
36 DataSource from MeshVS
37
38is
39
40 Create ( theSelObj : SOPtr from SelectMgr;
41 theDS : DataSource from MeshVS;
42 thePriority : Integer = 0 ) returns mutable MeshOwner from MeshVS;
43
44 GetDataSource( me ) returns DataSource from MeshVS;
45 ---C++: return const &
46
47 GetSelectedNodes( me ) returns HPackedMapOfInteger from TColStd;
48 ---C++: return const &
49 ---Purpose: Returns ids of selected mesh nodes
50
51 GetSelectedElements( me ) returns HPackedMapOfInteger from TColStd;
52 ---C++: return const &
53 ---Purpose: Returns ids of selected mesh elements
54
55 AddSelectedEntities( me : mutable; Nodes : HPackedMapOfInteger from TColStd;
56 Elems : HPackedMapOfInteger from TColStd ) is virtual;
57 ---Purpose: Saves ids of selected mesh entities
58
59 ClearSelectedEntities( me : mutable ) is virtual;
60 ---Purpose: Clears ids of selected mesh entities
61
62 GetDetectedNodes( me ) returns HPackedMapOfInteger from TColStd;
63 ---C++: return const &
64 ---Purpose: Returns ids of hilighted mesh nodes
65
66 GetDetectedElements( me ) returns HPackedMapOfInteger from TColStd;
67 ---C++: return const &
68 ---Purpose: Returns ids of hilighted mesh elements
69
70 SetDetectedEntities( me : mutable; Nodes : HPackedMapOfInteger from TColStd;
71 Elems : HPackedMapOfInteger from TColStd );
72 ---Purpose: Saves ids of hilighted mesh entities
73
74 HilightWithColor ( me : mutable; PM : PresentationManager3d from PrsMgr;
75 theColor : NameOfColor from Quantity;
76 Mode : Integer = 0 ) is redefined;
77
78 Unhilight( me : mutable; PM : PresentationManager from PrsMgr;
79 Mode : Integer from Standard = 0 ) is redefined;
80
81 IsForcedHilight ( me ) returns Boolean from Standard is redefined;
82
83fields
84
85 myDataSource : DataSource from MeshVS;
86 mySelectedNodes : HPackedMapOfInteger from TColStd is protected;
87 mySelectedElems : HPackedMapOfInteger from TColStd is protected;
88 myDetectedNodes : HPackedMapOfInteger from TColStd;
89 myDetectedElems : HPackedMapOfInteger from TColStd;
90 myLastID : Integer from Standard;
91
92end MeshOwner;