CGenericEffect.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 CGenericEffectH
46 #define CGenericEffectH
47 //------------------------------------------------------------------------------
48 #include "math/CVector3d.h"
49 //------------------------------------------------------------------------------
50 
51 //------------------------------------------------------------------------------
52 namespace chai3d {
53 //------------------------------------------------------------------------------
54 
55 //------------------------------------------------------------------------------
56 class cGenericObject;
57 //------------------------------------------------------------------------------
58 
59 //==============================================================================
66 //==============================================================================
67 
68 //------------------------------------------------------------------------------
76 //------------------------------------------------------------------------------
77 const int C_EFFECT_MAX_IDN = 16;
78 
79 
80 //==============================================================================
116 //==============================================================================
118 {
119  //--------------------------------------------------------------------------
120  // CONSTRUCTOR & DESTRUCTOR:
121  //--------------------------------------------------------------------------
122 
123 public:
124 
126  cGenericEffect(cGenericObject* a_parent);
127 
129  virtual ~cGenericEffect() {};
130 
131 
132  //--------------------------------------------------------------------------
133  // PUBLIC METHODS:
134  //--------------------------------------------------------------------------
135 
136 public:
137 
139  virtual bool computeForce(const cVector3d& a_toolPos,
140  const cVector3d& a_toolVel,
141  const unsigned int& a_toolID,
142  cVector3d& a_reactionForce)
143  {
144  a_reactionForce.zero();
145  return (false);
146  }
147 
149  inline void setEnabled(bool a_enabled) { m_enabled = a_enabled; }
150 
152  inline bool getEnabled() const { return (m_enabled); }
153 
154 
155  //--------------------------------------------------------------------------
156  // PUBLIC MEMBERS:
157  //--------------------------------------------------------------------------
158 
159 public:
160 
163 
164 
165  //--------------------------------------------------------------------------
166  // PROTECTED METHODS:
167  //--------------------------------------------------------------------------
168 
169 protected:
170 
172  virtual void initialize() { return; }
173 
174 
175  //--------------------------------------------------------------------------
176  // PROTECTED MEMBERS:
177  //--------------------------------------------------------------------------
178 
179 protected:
180 
182  bool m_enabled;
183 };
184 
185 //------------------------------------------------------------------------------
186 } // namespace chai3d
187 //------------------------------------------------------------------------------
188 
189 //------------------------------------------------------------------------------
190 #endif
191 //------------------------------------------------------------------------------
This class implements a 3D vector.
Definition: CVector3d.h:88
cGenericObject * m_parent
Object to which the force effects applies.
Definition: CGenericEffect.h:162
void zero()
This method clears all vector components with zeros.
Definition: CVector3d.h:256
cGenericEffect(cGenericObject *a_parent)
Constructor of CGenericEffect.
Definition: CGenericEffect.cpp:59
bool getEnabled() const
This method returns true if this effect is enables, false otherwise.
Definition: CGenericEffect.h:152
virtual bool computeForce(const cVector3d &a_toolPos, const cVector3d &a_toolVel, const unsigned int &a_toolID, cVector3d &a_reactionForce)
This method computes the resulting force.
Definition: CGenericEffect.h:139
This class implements a base class for all 2D or 3D objects in CHAI3D.
Definition: CGenericObject.h:112
This class implements a base class for haptic effects.
Definition: CGenericEffect.h:117
virtual ~cGenericEffect()
Destructor of CGenericEffect.
Definition: CGenericEffect.h:129
const int C_EFFECT_MAX_IDN
Definition: CGenericEffect.h:77
Implements a 3D vector.
Definition: CAudioBuffer.cpp:56
virtual void initialize()
This method initializes the haptic effect model.
Definition: CGenericEffect.h:172
bool m_enabled
Is this effect currently enabled?
Definition: CGenericEffect.h:182
void setEnabled(bool a_enabled)
This method enables or disables this effect.
Definition: CGenericEffect.h:149