summaryrefslogtreecommitdiff
path: root/inc/SelectMgr_Selection.hxx
blob: f013c059d156171a414183e52338f7cfdfee2618 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _SelectMgr_Selection_HeaderFile
#define _SelectMgr_Selection_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_SelectMgr_Selection_HeaderFile
#include <Handle_SelectMgr_Selection.hxx>
#endif

#ifndef _SelectBasics_ListOfSensitive_HeaderFile
#include <SelectBasics_ListOfSensitive.hxx>
#endif
#ifndef _SelectBasics_ListIteratorOfListOfSensitive_HeaderFile
#include <SelectBasics_ListIteratorOfListOfSensitive.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _SelectMgr_TypeOfUpdate_HeaderFile
#include <SelectMgr_TypeOfUpdate.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Handle_SelectBasics_SensitiveEntity_HeaderFile
#include <Handle_SelectBasics_SensitiveEntity.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Standard_NullObject;
class SelectBasics_SensitiveEntity;


//!  Represents the state of a given selection mode for a <br>
//! Selectable Object. Contains all the sensitive entities available for this mode. <br>
//! An interactive object can have an indefinite number of <br>
//! modes of selection, each representing a <br>
//! "decomposition" into sensitive primitives; each <br>
//! primitive has an Owner (SelectMgr_EntityOwner) <br>
//! which allows us to identify the exact entity which has <br>
//! been detected. Each Selection mode is identified by <br>
//! an index. The set of sensitive primitives which <br>
//! correspond to a given mode is stocked in a <br>
//! SelectMgr_Selection object. By Convention, the <br>
//! default selection mode which allows us to grasp the <br>
//! Interactive object in its entirety will be mode 0. <br>
//! AIS_Trihedron : 4 selection modes <br>
//! -   mode 0 : selection of a trihedron <br>
//! -   mode 1 : selection of the origin of the trihedron <br>
//! -   mode 2 : selection of the axes <br>
//! -   mode 3 : selection of the planes XOY, YOZ, XOZ <br>
//! when you activate one of modes 1 2 3 4 , you pick AIS objects of type: <br>
//! -   AIS_Point <br>
//! -   AIS_Axis (and information on the type of axis) <br>
//! -   AIS_Plane (and information on the type of plane). <br>
//!   AIS_PlaneTrihedron offers 3 selection modes: <br>
//! -   mode 0 : selection of the whole trihedron <br>
//! -   mode 1 : selection of the origin of the trihedron <br>
//! -   mode 2 : selection of the axes - same remarks as for the Trihedron. <br>
//! AIS_Shape : 7 maximum selection modes, depending <br>
//! on the complexity of the shape : <br>
//! -   mode 0 : selection of the AIS_Shape <br>
//! -   mode 1 : selection of the vertices <br>
//! -   mode 2 : selection of the edges <br>
//! -   mode 3 : selection of the wires <br>
//! -   mode 4 : selection of the faces <br>
//! -   mode 5 : selection of the shells <br>
//! -   mode 6 :   selection of the constituent solids. <br>
class SelectMgr_Selection : public MMgt_TShared {

public:

  //! Constructs a selection object defined by the selection mode IdMode. <br>
//! The default setting 0 is the selection mode for a shape in its entirety. <br>
  Standard_EXPORT   SelectMgr_Selection(const Standard_Integer IdMode = 0);
  //! Adds the sensitive primitive aprimitive to the list of <br>
//! stored entities in this object. <br>
//! Raises NullObject if the primitive is a null handle. <br>
  Standard_EXPORT     void Add(const Handle(SelectBasics_SensitiveEntity)& aprimitive) ;
  //! empties the selection from all the stored entities <br>
  Standard_EXPORT     void Clear() ;
  //! returns true if no sensitive entity is stored. <br>
  Standard_EXPORT     Standard_Boolean IsEmpty() const;
  //! returns the selection mode represented by this selection <br>
        Standard_Integer Mode() const;
  //! Begins an iteration scanning for sensitive primitives. <br>
        void Init() ;
  //! Continues the iteration scanning for sensitive <br>
//! primitives with the mode defined in this framework. <br>
        Standard_Boolean More() const;
  //! Returns the next sensitive primitive found in the <br>
//! iteration. This is a scan for entities with the mode <br>
//! defined in this framework. <br>
        void Next() ;
  //! Returns any sensitive primitive in this framework. <br>
       const Handle_SelectBasics_SensitiveEntity& Sensitive() const;
  //! Returns the flag UpdateFlag. <br>
//! This flage gives the update status of this framework <br>
//! in a ViewerSelector object: <br>
//! -   full <br>
//! -   partial, or <br>
//! -   none. <br>
        SelectMgr_TypeOfUpdate UpdateStatus() const;
  
        void UpdateStatus(const SelectMgr_TypeOfUpdate UpdateFlag) ;




  DEFINE_STANDARD_RTTI(SelectMgr_Selection)

protected:




private: 


SelectBasics_ListOfSensitive myentities;
SelectBasics_ListIteratorOfListOfSensitive myit;
Standard_Integer myMode;
SelectMgr_TypeOfUpdate myUpdateStatus;


};


#include <SelectMgr_Selection.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif