H3D API  2.4.1
RotationalSpringEffect.h
Go to the documentation of this file.
1 // Copyright 2004-2019, SenseGraphics AB
3 //
4 // This file is part of H3D API.
5 //
6 // H3D API is free software; you can redistribute it and/or modify
7 // it under the terms of the GNU General Public License as published by
8 // the Free Software Foundation; either version 2 of the License, or
9 // (at your option) any later version.
10 //
11 // H3D API is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
15 //
16 // You should have received a copy of the GNU General Public License
17 // along with H3D API; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 //
20 // A commercial license is also available. Please contact us at
21 // www.sensegraphics.com for more information.
22 //
23 //
27 //
29 #ifndef __ROTATIONALSPRINGEFFECT_H__
30 #define __ROTATIONALSPRINGEFFECT_H__
31 
32 #include <H3D/H3DForceEffect.h>
33 #include <HAPI/HapticRotationalSpring.h>
34 #include <H3D/SFVec3f.h>
35 #include <H3D/MFVec3f.h>
36 #include <H3D/SFBool.h>
37 #include <H3D/SFFloat.h>
38 #include <H3D/SFInt32.h>
39 
40 namespace H3D {
54  class H3DAPI_API RotationalSpringEffect: public H3DForceEffect {
55  public:
57  RotationalSpringEffect( Inst< SFVec3f > _desiredAxis = 0,
58  Inst< MFVec3f > _torque = 0,
59  Inst< SFFloat > _springConstant = 0,
60  Inst< SFBool > _enabled = 0,
61  Inst< MFInt32 > _deviceIndex = 0,
62  Inst< SFNode > _metadata = 0,
63  Inst< SFFloat > _damping = 0 );
64 
69  virtual void traverseSG( TraverseInfo &ti );
70 
76  H3DUniquePtr< SFVec3f > desiredAxis;
77 
83  H3DUniquePtr< MFVec3f > torque;
84 
93  H3DUniquePtr< SFFloat > springConstant;
94 
100  H3DUniquePtr< SFBool > enabled;
101 
107  H3DUniquePtr< SFFloat > damping;
108 
111 
114  protected:
115  bool last_enabled;
116  };
117 }
118 
119 #endif
Header file for H3DForceEffect.
Contains the MFVec3f field class.
Contains the SFBool field class.
Contains the SFFloat field class.
Contains the SFInt32 field class.
Contains the SFVec3f field class.
The base class for scenegraph force effects.
Definition: H3DForceEffect.h:39
RotationalSpringEffect is a localized haptic effect where the haptics device is rotated towards a cer...
Definition: RotationalSpringEffect.h:54
static H3DNodeDatabase database
The H3DNodeDatabase for this node.
Definition: RotationalSpringEffect.h:110
H3DUniquePtr< SFFloat > damping
The damping constant to use in the torque calculation.
Definition: RotationalSpringEffect.h:107
AutoRefVector< HAPI::HapticRotationalSpring > haptic_rotational_spring
Internal haptic spring instance.
Definition: RotationalSpringEffect.h:113
H3DUniquePtr< SFVec3f > desiredAxis
The desired axis of the spring, that is the axis towards which the torque should be directed.
Definition: RotationalSpringEffect.h:76
H3DUniquePtr< SFFloat > springConstant
The spring constant of the spring.
Definition: RotationalSpringEffect.h:93
H3DUniquePtr< SFBool > enabled
The enabled field should be set to true when the force effect should be enabled and active.
Definition: RotationalSpringEffect.h:100
H3DUniquePtr< MFVec3f > torque
The torque applied by the spring to the haptics device since the last scenegraph update.
Definition: RotationalSpringEffect.h:83
TraverseInfo is a structure that is passed along when traversing the scene graph.
Definition: TraverseInfo.h:57
H3D API namespace.
Definition: Anchor.h:38
The H3DNodeDatabase contains a mapping between a name of a Node and the constructor for the Node with...
Definition: H3DNodeDatabase.h:194