0024623: Visualization - improve selection mechanism
[occt.git] / src / SelectMgr / SelectMgr_Selection.cxx
1 // Created on: 1995-02-16
2 // Created by: Mister rmi
3 // Copyright (c) 1995-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 #include <Standard_NullObject.hxx>
18
19 #include <SelectMgr_Selection.hxx>
20
21 IMPLEMENT_STANDARD_HANDLE (SelectMgr_Selection, MMgt_TShared)
22 IMPLEMENT_STANDARD_RTTIEXT(SelectMgr_Selection, MMgt_TShared)
23
24 //==================================================
25 // Function: SelectMgr_Selection
26 // Purpose :
27 //==================================================
28 SelectMgr_Selection::SelectMgr_Selection (const Standard_Integer theModeIdx)
29 : myMode (theModeIdx),
30   mySelectionState (SelectMgr_SOS_Unknown),
31   myBVHUpdateStatus (SelectMgr_TBU_None),
32   mySensFactor (2.0)
33 {}
34
35 SelectMgr_Selection::~SelectMgr_Selection()
36 {
37   Destroy();
38 }
39
40 //==================================================
41 // Function: Destroy
42 // Purpose :
43 //==================================================
44 void SelectMgr_Selection::Destroy()
45 {
46   for (Standard_Integer anEntityIdx = 0; anEntityIdx < myEntities.Size(); ++anEntityIdx)
47   {
48     SelectMgr_HSensitiveEntity& anEntity = myEntities.ChangeValue (anEntityIdx);
49     anEntity->BaseSensitive()->Set (NULL);
50   }
51   mySensFactor = 2.0;
52 }
53
54 //==================================================
55 // Function: ADD
56 // Purpose :
57 //==================================================
58 void SelectMgr_Selection::Add (const Handle(SelectBasics_SensitiveEntity)& theSensitive)
59 {
60   // if input is null:
61   // in debug mode raise exception
62   Standard_NullObject_Raise_if
63     (theSensitive.IsNull(), "Null sensitive entity is added to the selection");
64
65   // in release mode do not add
66   if (!theSensitive.IsNull())
67   {
68     SelectMgr_HSensitiveEntity anEntity = new SelectMgr_SensitiveEntity (theSensitive);
69     myEntities.Append (anEntity);
70     if (mySelectionState == SelectMgr_SOS_Activated &&
71         !anEntity->IsActiveForSelection())
72     {
73       anEntity->SetActiveForSelection();
74     }
75
76     mySensFactor = Max (mySensFactor,
77                         anEntity->BaseSensitive()->SensitivityFactor());
78   }
79 }       
80
81 //==================================================
82 // Function: Clear
83 // Purpose :
84 //==================================================
85 void SelectMgr_Selection::Clear()
86 {
87   for (Standard_Integer anIdx = 0; anIdx < myEntities.Size(); ++anIdx)
88   {
89     SelectMgr_HSensitiveEntity& anEntity = myEntities.ChangeValue (anIdx);
90     anEntity->Clear();
91   }
92
93   myEntities.Clear();
94 }
95
96 //==================================================
97 // Function: IsEmpty 
98 // Purpose :
99 //==================================================
100 Standard_Boolean SelectMgr_Selection::IsEmpty() const
101 {
102   return myEntities.IsEmpty();
103 }
104
105 //==================================================
106 // function: GetEntityById
107 // purpose : Returns sensitive entity stored by
108 //           index theIdx in entites vector
109 //==================================================
110 SelectMgr_HSensitiveEntity& SelectMgr_Selection::GetEntityById (const Standard_Integer theIdx)
111 {
112   return myEntities.ChangeValue (theIdx);
113 }
114
115 //==================================================
116 // function: GetSelectionState
117 // purpose : Returns status of selection
118 //==================================================
119 const SelectMgr_StateOfSelection SelectMgr_Selection::GetSelectionState() const
120 {
121   return mySelectionState;
122 }
123
124 //==================================================
125 // function: SetSelectionState
126 // purpose : Sets status of selection
127 //==================================================
128 void SelectMgr_Selection::SetSelectionState (const SelectMgr_StateOfSelection theState) const
129 {
130   mySelectionState = theState;
131 }
132
133 //==================================================
134 // function: Sensitivity
135 // purpose : Returns sensitivity of the selection
136 //==================================================
137 const Standard_Real SelectMgr_Selection::Sensitivity() const
138 {
139   return mySensFactor;
140 }