Init

DependentExtensions/Ogre3DInterpDemo/TransformationHistory.h

@@ -0,0 +1,89 @@
+/*
+ *  Original work: Copyright (c) 2014, Oculus VR, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the BSD-style license found in the
+ *  RakNet License.txt file in the licenses directory of this source tree. An additional grant 
+ *  of patent rights can be found in the RakNet Patents.txt file in the same directory.
+ *
+ *
+ *  Modified work: Copyright (c) 2017, SLikeSoft UG (haftungsbeschränkt)
+ *
+ *  This source code was modified by SLikeSoft. Modifications are licensed under the MIT-style
+ *  license found in the license.txt file in the root directory of this source tree.
+ */
+
+#ifndef __TRANFORMATION_HISTORY_H
+#define __TRANFORMATION_HISTORY_H
+
+#include "slikenet/types.h"
+#include "OgreVector3.h"
+#include "OgreQuaternion.h"
+#include "slikenet/DS_Queue.h"
+#include "slikenet/memoryoverride.h"
+
+struct TransformationHistoryCell
+{
+	TransformationHistoryCell();
+	TransformationHistoryCell(SLNet::TimeMS t, const Ogre::Vector3& pos, const Ogre::Vector3& vel, const Ogre::Quaternion& quat  );
+
+	SLNet::TimeMS time;
+	Ogre::Vector3 position;
+	Ogre::Quaternion orientation;
+	Ogre::Vector3 velocity;
+};
+
+/// \brief This class stores a series of data points consisting of position, orientation, and velocity
+/// Data points are written using Write(). The number of points stored is determined by the values passed to Init()
+/// Points are read out using Read(). Read() will interpolate between two known points given a time between those points, or between the last known and current point.
+/// For smooth interpolation, render entities by reading their past positions by whatever amount of time your update interval is.
+class TransformationHistory
+{
+public:
+	/// \brief Call to setup this class with required parameters
+	/// maxWriteInterval should be equal to or less than the interval between updates for a given entity
+	/// maxHistoryTime is the maximum amount of time you want to read in the past
+	/// \param[in] maxWriteInterval Minimum amount of time that must elapse between new data points added with Write.
+	/// \param[in] maxHistoryTime How long to store data points before they expire
+	void Init(SLNet::TimeMS maxWriteInterval, SLNet::TimeMS maxHistoryTime);
+
+	/// \brief Adds a new data point to the end of the queue
+	/// If less than maxWriteInterval has elapsed since the last call, the Write() call is ignored.
+	/// \param[in] position Position to write
+	/// \param[in] velocity Velocity to write
+	/// \param[in] orientation Orientation to write
+	/// \param[in] curTimeMS Time when data point was generated, which should generally increment each call
+	void Write(const Ogre::Vector3 &position, const Ogre::Vector3 &velocity, const Ogre::Quaternion &orientation, SLNet::TimeMS curTimeMS);
+
+	/// \brief Same as Write(), except that if the point is in the past, an older point updated
+	void Overwrite(const Ogre::Vector3 &position, const Ogre::Vector3 &velocity, const Ogre::Quaternion &orientation, SLNet::TimeMS when);
+
+	enum ReadResult
+	{
+		// We are reading so far in the past there is no data yet
+		READ_OLDEST,
+		// We are not reading in the past, so the input parameters stay the same
+		VALUES_UNCHANGED,
+		// We are reading in the past
+		INTERPOLATED
+	};
+	/// \brief Read an interpolated point in the psast
+	/// Parameters are in/out, modified to reflect the history.
+	/// \param[in/out] position As input, the current position of the object at \a curTime. As output, the position of the object at \when. Pass 0 to ignore.
+	/// \param[in/out] velocity As input, the current velocity of the object at \a curTime. As output, the velocity of the object at \when. Pass 0 to ignore.
+	/// \param[in/out] orientation As input, the current orientation of the object at \a curTime. As output, the orientation of the object at \when. Pass 0 to ignore.
+	/// \param[in] when The time at which you want to read.
+	/// \param[in] curTime Right now
+	/// \return What method was used to calculate outputs
+	ReadResult Read(Ogre::Vector3 *position, Ogre::Vector3 *velocity, Ogre::Quaternion *orientation,
+		SLNet::TimeMS when, SLNet::TimeMS curTime);
+
+	/// \brief Clear all values in the history
+	void Clear(void);
+protected:
+	DataStructures::Queue<TransformationHistoryCell> history;
+	unsigned maxHistoryLength;
+	SLNet::TimeMS writeInterval;
+};
+
+#endif