CInteractionBasics.h
Go to the documentation of this file.
1 //==============================================================================
2 /*
3  Software License Agreement (BSD License)
4  Copyright (c) 2003-2016, CHAI3D.
5  (www.chai3d.org)
6 
7  All rights reserved.
8 
9  Redistribution and use in source and binary forms, with or without
10  modification, are permitted provided that the following conditions
11  are met:
12 
13  * Redistributions of source code must retain the above copyright
14  notice, this list of conditions and the following disclaimer.
15 
16  * Redistributions in binary form must reproduce the above
17  copyright notice, this list of conditions and the following
18  disclaimer in the documentation and/or other materials provided
19  with the distribution.
20 
21  * Neither the name of CHAI3D nor the names of its contributors may
22  be used to endorse or promote products derived from this software
23  without specific prior written permission.
24 
25  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  POSSIBILITY OF SUCH DAMAGE.
37 
38  \author <http://www.chai3d.org>
39  \author Francois Conti
40  \version 3.2.0 $Rev: 1869 $
41 */
42 //==============================================================================
43 
44 //------------------------------------------------------------------------------
45 #ifndef CInteractionBasicsH
46 #define CInteractionBasicsH
47 //------------------------------------------------------------------------------
48 #include "math/CVector3d.h"
49 #include "math/CMatrix3d.h"
50 #include "graphics/CVertexArray.h"
51 #include "materials/CMaterial.h"
52 //------------------------------------------------------------------------------
53 #include <vector>
54 //------------------------------------------------------------------------------
55 
56 //------------------------------------------------------------------------------
57 namespace chai3d {
58 //------------------------------------------------------------------------------
59 
60 //------------------------------------------------------------------------------
61 class cGenericObject;
62 //------------------------------------------------------------------------------
63 
64 //==============================================================================
71 //==============================================================================
72 
73 //==============================================================================
86 //==============================================================================
88 {
91 
93  bool m_isInside;
94 
97 
100 
103 
106 
108  void clear()
109  {
110  m_object = NULL;
111  m_isInside = false;
112  m_localPos.zero();
113  m_localNormal.set(1,0,0);
114  m_localForce.zero();
115  m_localSurfacePos.zero();
116  }
117 };
118 
119 
120 //==============================================================================
132 //==============================================================================
134 {
135  //--------------------------------------------------------------------------
136  // CONSTRUCTOR & DESTRUCTOR:
137  //--------------------------------------------------------------------------
138 
139 public:
140 
143 
145  virtual ~cInteractionRecorder() {};
146 
147 
148  //--------------------------------------------------------------------------
149  // PUBLIC METHODS:
150  //--------------------------------------------------------------------------
151 
152 public:
153 
155  void clear()
156  {
157  m_interactions.clear();
158  }
159 
160 
161  //--------------------------------------------------------------------------
162  // PUBLIC MEMBERS:
163  //--------------------------------------------------------------------------
164 
165 public:
166 
168  std::vector<cInteractionEvent> m_interactions;
169 };
170 
171 //------------------------------------------------------------------------------
172 } // namespace chai3d
173 //------------------------------------------------------------------------------
174 
175 //------------------------------------------------------------------------------
176 #endif
177 //------------------------------------------------------------------------------
This class implements a 3D vector.
Definition: CVector3d.h:88
Implements an array of 3D vertices.
void zero()
This method clears all vector components with zeros.
Definition: CVector3d.h:256
void clear()
This method clears all interaction events.
Definition: CInteractionBasics.h:155
void set(const double &a_x, const double &a_y, const double &a_z)
This method initializes this vector with components x, y, and z passed as arguments.
Definition: CVector3d.h:298
cVector3d m_localPos
Position of the interaction point in reference to the object&#39;s coordinate frame (local coordinates)...
Definition: CInteractionBasics.h:96
This structure stores information associated with the interaction of a haptic tool with a shape primi...
Definition: CInteractionBasics.h:87
This class implements a base class for all 2D or 3D objects in CHAI3D.
Definition: CGenericObject.h:112
bool m_isInside
If true then the interaction event occurred inside the object.
Definition: CInteractionBasics.h:93
Implements a 3D matrix.
virtual ~cInteractionRecorder()
Destructor of cInteractionRecorder.
Definition: CInteractionBasics.h:145
cVector3d m_localForce
Interaction force in object&#39;s local coordinate frame.
Definition: CInteractionBasics.h:102
cGenericObject * m_object
Pointer to the object.
Definition: CInteractionBasics.h:90
void clear()
This method initialize all data contained in current event.
Definition: CInteractionBasics.h:108
Implements a 3D vector.
std::vector< cInteractionEvent > m_interactions
List of interaction events stored in recorder.
Definition: CInteractionBasics.h:168
This class stores a list of interaction events.
Definition: CInteractionBasics.h:133
Implements material properties.
Definition: CAudioBuffer.cpp:56
cInteractionRecorder()
Constructor of cInteractionRecorder.
Definition: CInteractionBasics.h:142
cVector3d m_localNormal
Surface normal at the interaction point in reference to the object&#39;s coordinate frame (local coordina...
Definition: CInteractionBasics.h:99
cVector3d m_localSurfacePos
Nearest point to the object&#39;s surface in local coordinates.
Definition: CInteractionBasics.h:105