Differences

This shows you the differences between two versions of the page.

--- public:t-gede-15-1:lab5 [2015/02/16 15:10] – created marino
+++ public:t-gede-15-1:lab5 [2024/04/29 13:33] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
+====== LAB5: Human Interface Devices ======
+This lab is only loosely based on Chapter 8 on human interface devices in the text book. The focus here is on being able to control the on-screen character with a specialized game interface device.
+===== Discussion =====
+Discussion thread for this lab is here on Piazza: [[https://piazza.com/class/i4l9of1fw8j3ew?cid=47]]
+===== Goal ======
+The primary goal of this lab is to hook a joypad game input device up to your Ogre application and use it to control both the character and the camera. This is also an opportunity to see how you set up buffered input (previously you've been using unbuffered input in this application).
+===== Preparation =====
+No special preparation is required - preparing the joypad is explained in the project steps below. You do not have to use the latest lab as a base for this one, you can use the base of lab2 or any other **//except lab1//** if you feel like the project has become to bloated.
+**NOTE:** To get the joypads to start sending data, you may have to press a **Mode** button in the center of the device. This is true for the joypads handed out in the lab class!
 ===== Lab Project =====
@@ Line 4: / Line 24: @@
   - **Create a New Project** Create a new empty project called "Lab4" in the same way you have created new projectsfor other lab projects.
   - **Plug in and Test Joypad** Plug a USB joypad into your computer and find the device in your system's control panel (usually under "Devices and Printers"). Examine the device properties and find a small test panel for the device. Make sure the device works. Intall necessary drivers if the system is not picking it up.
   - **Initialize Joystick Input** Your MyFrameListener class needs to receive callbacks from the joystick device and therefore has to inherit joystick callback methods from an abstract class called ''OIS::JoyStickListener''. Luckily you can inherit from multiple classes! Change your declaration of your MyFrameListener into this: <code cpp>class MyFrameListener : public Ogre::FrameListener, public OIS::JoyStickListener {
@@ Line 82: / Line 101: @@
 _Cam->lookAt(_myogrenode->getPosition());
 </code> Test to see if this works.
+====== Bonus points ======
+<box green 100% | Bonus points>
+   - **Make the input a little bit more useful :)** Either make your own modifications to the input or follow the instructions given:
+     - **Remove the code** from frameStarted: <code cpp>
+Ogre::Vector3 SinbadTranslate(0, 0, 0);
+float _rotation = 0.0f;
+if (_Keyboard->isKeyDown(OIS::KC_UP) || _povState == OIS::Pov::North) {
+	SinbadTranslate += Ogre::Vector3(0, 0, -1);
+	walked = true;
+	_rotation = 3.14f;
+}
+if (_Keyboard->isKeyDown(OIS::KC_DOWN) || _povState == OIS::Pov::South) {
+	SinbadTranslate += Ogre::Vector3(0, 0, 1);
+	walked = true;
+	_rotation = 0.0f;
+}
+if (_Keyboard->isKeyDown(OIS::KC_LEFT) || _povState == OIS::Pov::West) {
+	SinbadTranslate += Ogre::Vector3(-1, 0, 0);
+	walked = true;
+	_rotation = -1.57f;
+}
+if (_Keyboard->isKeyDown(OIS::KC_RIGHT) || _povState == OIS::Pov::East) {
+	SinbadTranslate += Ogre::Vector3(1, 0, 0);
+	walked = true;
+	_rotation = 1.57f;
+}
+_node->translate(SinbadTranslate * evt.timeSinceLastFrame * _WalkingSpeed);
+_node->resetOrientation();
+_node->yaw(Ogre::Radian(_rotation));
+</code>
+    - **Now we will make the Sinbad move with the left analog stick** Add these two member variables to the ''MyFrameListener'' class, they will hold the values for the left analog axis. And make sure to initialize them all to 0. <code cpp>
+int _walkMagnitude;
+int _turnMagnitude;
+float _orientation;
+</code>
+    - **Capture the state of the left axis** in the function ''axisMoved'' by adding to the previously created switch statement. <code cpp>
+bool MyFrameListener::axisMoved(const OIS::JoyStickEvent &e, int axis) {
+	int value = e.state.mAxes[axis].abs;
+	switch (axis) {
+	case 1:
+		_camangle = Ogre::Math::TWO_PI * ((float(-1 * value) / float(_Joystick->MAX_AXIS) + 1.0f) / 2.0f) + Ogre::Math::HALF_PI;
+		break;
+        // Add these lines, dont forget to break :)
+	case 2:
+		_walkMagnitude = (float)value / -float(_Joystick->MAX_AXIS); // Map the range to -1 to 1
+		break;
+	case 3:
+		_turnMagnitude = (float)value / -float(_Joystick->MAX_AXIS); // Map the range to -1 to 1
+		break;
+	}
+	return true;
+}
+</code>
+    - **Now add the new input method for Sinbad** add this code in place for the code removed from section //a// <code cpp>
+bool walked = false;
+Ogre::Vector3 SinbadTranslate(0, 0, 0);
+// If the joystick is not available, use the keyboard as input.
+if (!_Joystick) {
+	if (_Keyboard->isKeyDown(OIS::KC_UP)) {
+		_walkMagnitude = 1;
+	}
+	else if (_Keyboard->isKeyDown(OIS::KC_DOWN)) {
+		_walkMagnitude = -1;
+	}
+	else {
+		_walkMagnitude = 0;
+	}
+	if (_Keyboard->isKeyDown(OIS::KC_LEFT)) {
+		_turnMagnitude = 1;
+	}
+	else if (_Keyboard->isKeyDown(OIS::KC_RIGHT)) {
+		_turnMagnitude = -1;
+	}
+	else {
+		_turnMagnitude = 0;
+	}
+}
+// Create the translation vector.
+SinbadTranslate = _node->getOrientation().zAxis() * evt.timeSinceLastFrame * _WalkingSpeed * _walkMagnitude;
+walked = true;
+// Increment the roation angle.
+_orientation += evt.timeSinceLastFrame * _turnMagnitude*2;
+// Now finally apply the rotation and translation.
+_node->translate(SinbadTranslate);
+_node->setOrientation(Ogre::Quaternion(Ogre::Radian(_orientation), Ogre::Vector3::UNIT_Y));
+</code>
+  - **As of now the camera follows Sinbad in a strange manner.** By adding buffered keyboard input, create a method of toggling the camera from following Sinbad behind his back, and a free roaming camera that you cam move with the mouse and "WASD" \\ **Hints:** \\ <code cpp>
+// This will make the camera a child of the Sinbad Scene node, and thus all transformation made to Sinbad will be applied to the Camera as well.
+_node->attachObject(_Cam);
+</code> Buffered keyboard input, Make the following changes to the MyFrameListener class to enable the buffered keyboard input <code cpp>
+// Add the inheritance of OIS::KeyListener, this will be required to make your FrameListener handle
+// the buffered input by providing you with the two virtual functions, keyPressed and keyReleased.
+class MyFrameListener : public Ogre::FrameListener, OIS::JoyStickListener, OIS::KeyListener {
+    //...
+    // Change the way the frameListener initializes the Keyboard object pointer in the constructor.
+    // And make "MyFrameListener" the event callback Handler for the keyboard.
+    MyFrameListener() : ... {
+        //...
+        // Notice the last parameter in the createInputObject() has changed from false to true!!
+        // That parameter indicates that we want to enable buffered keyboard input.
+        _Keyboard = static_cast<OIS::Keyboard*>(_InputManager->createInputObject(OIS::OISKeyboard, true));
+	_Keyboard->setEventCallback(this);
+        //...
+    }
+    // Now implement those two virtual functions.
+    // The KeyEvent holds information on which key was pressed.
+    virtual bool keyPressed(const OIS::KeyEvent &arg) {
+	return true;
+    }
+    virtual bool keyReleased(const OIS::KeyEvent &arg) {
+        return true;
+     }
+     //...
+}
+</code>Now you have those two functions that trigger only once per key press, and are not continuous like before, did I mention buffered input :)?
+</box>
+===== When You Are Finished =====
+Upload your **commented source files** into Lab5 in MySchool (zip them up if more than one). The lab projects will not be graded, but their completion counts towards your participation grade.