Changeset 5668 for code/branches/resource2/src/ois/OISEffect.h

Timestamp:

Aug 22, 2009, 11:16:34 PM (15 years ago)

Author:

rgrieder

Message:

Updated OIS library (still 1.2, but CVS version).
There have been some little fixes and support for force feedback on Linux (but this doesn't concern us for now…)

File:

• code/branches/resource2/src/ois/OISEffect.h (modified) (6 diffs)

code/branches/resource2/src/ois/OISEffect.h

@@ -60 +60 @@
                         PeriodicForce,
                         ConditionalForce,
-                        CustomForce
+                        CustomForce,
+                        _ForcesNumber // Always keep in last position.
                 };
+
+                static const char* getForceTypeName(EForce eValue);
 
                 //! Type of effect
@@ -79 +82 @@
                         Inertia,     //ConditionalForce
                         Spring,      //ConditionalForce
-                        Custom       //CustomForce
+                        Custom,      //CustomForce
+                        _TypesNumber // Always keep in last position.
                 };
+
+                static const char* getEffectTypeName(EType eValue);
 
                 //! Direction of the Force
@@ -92 +98 @@
                         South,
                         SouthWest,
-                        West
+                        West,
+                        _DirectionsNumber // Always keep in last position.
                 };
+
+                static const char* getDirectionName(EDirection eValue);
 
                 /**
@@ -168 +177 @@
                 An optional envelope to be applied to the start/end of an effect. If any of
                 these values are nonzero, then the envelope will be used in setting up the
-                effect. Not currently utilised.. But, will be soon.
+                effect.
         */
         class _OISExport Envelope : public ForceEffect
@@ -178 +187 @@
   #pragma warning (disable : 4800)
 #endif
-                bool isUsed() { return attackLength | attackLevel | fadeLength | fadeLevel; }
+                bool isUsed() const { return attackLength | attackLevel | fadeLength | fadeLevel; }
 #if defined(OIS_MSVC_COMPILER)
   #pragma warning (pop)
 #endif
 
-                unsigned short attackLength;
+                // Duration of the attack (microseconds)
+                unsigned int attackLength;
+
+                // Absolute level at the beginning of the attack (0 to 10K)
+                // (automatically signed when necessary by FF core according to effect level sign)
                 unsigned short attackLevel;
-                unsigned short fadeLength;
+
+                // Duration of fade (microseconds)
+                unsigned int fadeLength;
+
+                // Absolute level at the end of fade (0 to 10K)
+                // (automatically signed when necessary by FF core according to effect level sign)
                 unsigned short fadeLevel;
         };
@@ -211 +229 @@
                 RampEffect() : startLevel(0), endLevel(0) {}
 
-        class Envelope envelope; //Optional envolope
+        class Envelope envelope; //Optional envelope
                 signed short startLevel;  //-10K to +10k
                 signed short endLevel;    //-10K to +10k