aboutsummaryrefslogtreecommitdiffstats
path: root/LibOVR/Src/Sensors
diff options
context:
space:
mode:
authorBrad Davis <[email protected]>2014-07-24 16:47:31 -0700
committerBrad Davis <[email protected]>2014-07-24 16:47:31 -0700
commit0f49ce8fc6aa54224e4c0d6fda8c4527ad39cce1 (patch)
treeda07ebc6a7f75185bda857dd5f1c34710b416a93 /LibOVR/Src/Sensors
parentca79271759ff7eecd22ec5c4db438370fe51d687 (diff)
0.4 Win-Beta0.4.0
Diffstat (limited to 'LibOVR/Src/Sensors')
-rw-r--r--LibOVR/Src/Sensors/OVR_DeviceConstants.h182
1 files changed, 182 insertions, 0 deletions
diff --git a/LibOVR/Src/Sensors/OVR_DeviceConstants.h b/LibOVR/Src/Sensors/OVR_DeviceConstants.h
new file mode 100644
index 0000000..fc76593
--- /dev/null
+++ b/LibOVR/Src/Sensors/OVR_DeviceConstants.h
@@ -0,0 +1,182 @@
+/************************************************************************************
+
+Filename : OVR_DeviceConstants.h
+Content : Device constants
+Created : February 5, 2013
+Authors : Lee Cooper
+
+Copyright : Copyright 2014 Oculus VR, Inc. All Rights reserved.
+
+Licensed under the Oculus VR Rift SDK License Version 3.1 (the "License");
+you may not use the Oculus VR Rift SDK except in compliance with the License,
+which is provided at the time of installation or download, or which
+otherwise accompanies this software in either electronic or hard copy form.
+
+You may obtain a copy of the License at
+
+http://www.oculusvr.com/licenses/LICENSE-3.1
+
+Unless required by applicable law or agreed to in writing, the Oculus VR SDK
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*************************************************************************************/
+
+#ifndef OVR_DeviceConstants_h
+#define OVR_DeviceConstants_h
+
+#include "../Kernel/OVR_Math.h"
+
+// CAPI forward declarations.
+struct ovrSensorData_;
+typedef struct ovrSensorData_ ovrSensorData;
+
+namespace OVR {
+
+
+//-------------------------------------------------------------------------------------
+// Different device types supported by OVR; this type is reported by DeviceBase::GetType.
+//
+enum DeviceType
+{
+ Device_None,
+ Device_Manager,
+ Device_Sensor,
+ Device_LatencyTester,
+ Device_BootLoader,
+ Device_All = 0xFF // Set for enumeration only, to enumerate all device types.
+};
+
+
+
+//-------------------------------------------------------------------------------------
+// Different lens distortion types supported by devices.
+//
+enum DistortionEqnType
+{
+ Distortion_No_Override = -1,
+ // These two are leagcy and deprecated.
+ Distortion_Poly4 = 0, // scale = (K0 + K1*r^2 + K2*r^4 + K3*r^6)
+ Distortion_RecipPoly4 = 1, // scale = 1/(K0 + K1*r^2 + K2*r^4 + K3*r^6)
+
+ // CatmullRom10 is the preferred distortion format.
+ Distortion_CatmullRom10 = 2, // scale = Catmull-Rom spline through points (1.0, K[1]...K[9])
+
+ Distortion_LAST // For ease of enumeration.
+};
+
+
+//-------------------------------------------------------------------------------------
+// HMD types.
+//
+enum HmdTypeEnum
+{
+ HmdType_None,
+
+ HmdType_DKProto, // First duct-tape model, never sold.
+ HmdType_DK1, // DevKit1 - on sale to developers.
+ HmdType_DKHDProto, // DKHD - shown at various shows, never sold.
+ HmdType_DKHD2Proto, // DKHD2, 5.85-inch panel, never sold.
+ HmdType_DKHDProto566Mi, // DKHD, 5.66-inch panel, never sold.
+ HmdType_CrystalCoveProto, // Crystal Cove, 5.66-inch panel, shown at shows but never sold.
+ HmdType_DK2,
+
+ // Reminder - this header file is public - codenames only!
+
+ HmdType_Unknown, // Used for unnamed HW lab experiments.
+
+ HmdType_LAST
+};
+
+
+//-------------------------------------------------------------------------------------
+// HMD shutter types.
+//
+enum HmdShutterTypeEnum
+{
+ HmdShutter_Global,
+ HmdShutter_RollingTopToBottom,
+ HmdShutter_RollingLeftToRight,
+ HmdShutter_RollingRightToLeft,
+ // TODO:
+ // color-sequential e.g. LCOS?
+ // alternate eyes?
+ // alternate columns?
+ // outside-in?
+
+ HmdShutter_LAST
+};
+
+
+
+//-------------------------------------------------------------------------------------
+// For headsets that use eye cups
+//
+enum EyeCupType
+{
+ // Public lenses
+ EyeCup_DK1A = 0,
+ EyeCup_DK1B = 1,
+ EyeCup_DK1C = 2,
+
+ EyeCup_DK2A = 3,
+
+ // Internal R&D codenames.
+ // Reminder - this header file is public - codenames only!
+ EyeCup_DKHD2A,
+ EyeCup_OrangeA,
+ EyeCup_RedA,
+ EyeCup_PinkA,
+ EyeCup_BlueA,
+ EyeCup_Delilah1A,
+ EyeCup_Delilah2A,
+ EyeCup_JamesA,
+ EyeCup_SunMandalaA,
+
+ EyeCup_LAST
+};
+
+
+//-----------------------------------------------------------------------------
+// BodyFrameState
+//
+#pragma pack(push, 8)
+
+class SensorDataType
+{
+public:
+
+ SensorDataType() : Temperature(0.0f), AbsoluteTimeSeconds(0.0) { }
+
+ // C-interop support
+ SensorDataType(const ovrSensorData& s);
+ operator ovrSensorData () const;
+
+ Vector3f Acceleration; // in m/s^2
+ Vector3f RotationRate; // in rad/s
+ Vector3f MagneticField; // in Gauss
+
+ float Temperature; // in degrees Celsius
+
+ // The absolute time from the host computers perspective that the message should be
+ // interpreted as. This is based on incoming timestamp and processed by a filter
+ // that syncs the clocks while attempting to keep the distance between messages
+ // device clock matching.
+ //
+ // Integration should use TimeDelta, but prediction into the future should derive
+ // the delta time from PredictToSeconds - AbsoluteTimeSeconds.
+ //
+ // This value will generally be <= the return from a call to ovr_GetTimeInSeconds(),
+ // but could be greater by under 1 ms due to system time update interrupt delays.
+ //
+ double AbsoluteTimeSeconds;
+};
+
+#pragma pack(pop)
+
+
+} // namespace OVR
+
+#endif