Introduction

Using this tutorial, you should be able to "create" a Desktop VR Display like Johnny Lee demonstrated in his Video "Head Tracking for Desktop VR Display using the WiiRemote". Changing the view and projection matrix (like Johnny Lee did it) didn't work for me in Ogre, so I had to find my own way to achieve such an experience, but more on that later.

Prerequisites

  • basic Ogre knowledge (you should have read (and understood!) the basic tutorials)
  • running version of Ogre
  • a WiiMote library (e.g. WiiYourself!)
  • basic knowledge of 3D math, if you want to change some values (e.g. FOV values)

Creating a Scene

First of all, we create a Scene like in the Video (you should be familiar with that, so I don't explain it in depth):

The targets

int numInFront = 2;
float screenAspect = mWindow->getWidth() / mWindow->getHeight();
float depthStep = 2.5f;
float startDepth = -numInFront*depthStep;

for (int i = 0; i < 10; i++)
{
    Plane plane;
    plane.normal = Vector3::NEGATIVE_UNIT_Z;
    MeshManager::getSingleton().createPlane("target"+StringConverter::toString(i), ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, plane, 1, 1);
    Entity* target = mSceneMgr->createEntity("targete"+StringConverter::toString(i), "target"+StringConverter::toString(i));
    target->setMaterialName("headtracking/target");
    target->setCastShadows(false);
    SceneNode* targetNode = mSceneMgr->getRootSceneNode()->createChildSceneNode("targetNode"+StringConverter::toString(i));
    targetNode->attachObject(target);

    targetNode->setPosition(Vector3(-2.5f + (rand() % 5) + (rand() % 10) / 10,
                    -2.5f + (rand() % 5) + (rand() % 10) / 10,
                    startDepth + i * depthStep));
    if (i < numInFront)
    {
        targetNode->setPosition(targetNode->getPosition().x * .5f, targetNode->getPosition().y * .5f, targetNode->getPosition().z); 
    }

    // draw line
    ManualObject* line = mSceneMgr->createManualObject("line" + StringConverter::toString(i));
    line->clear();
    line->begin("", RenderOperation::OT_LINE_LIST);
    line->position(targetNode->getPosition());
    line->colour(ColourValue(1.0, 1.0, 1.0));
    line->position(targetNode->getPosition() + Vector3(0, 0, 30));
    line->end();
    targetNode->attachObject(line);
}

The stadium

Plane plane;
plane.normal = Vector3::NEGATIVE_UNIT_Z;
MeshManager::getSingleton().createPlane("stad", ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, plane, 49, 20);
Entity* stadentity = mSceneMgr->createEntity("stadentity", "stad");
stadentity->setMaterialName("headtracking/stad");
stadentity->setCastShadows(false);
SceneNode* stadNode = mSceneMgr->getRootSceneNode()->createChildSceneNode("stadNode");
stadNode->attachObject(stadentity);
stadNode->setPosition(Vector3(0,0,10));
stadNode->setVisible(false);


Note: the picture of the stadium is hidden at the beginning. If you want to hide the targets and show the picture, assign a key for example and change the visibility.

mSceneMgr->getSceneNode("stadNode")->setVisible(false);
for (int i=0; i<10; i++) {
    mSceneMgr->getSceneNode("targetNode"+StringConverter::toString(i))->setVisible(true);
}

Camera position

If you use my above code, a nice camera position is at Vector3(0,0,0) and the camera looks along the positive z-axis.

Additional variables

Now we need some information about the connected hardware, which we define in class variables and some other class variables:

bool mUseWiiMotes = true;                        // to disable wiiMote support
Vector3 mHeadPosition = Vector3::ZERO;                    // position of the users head when the last frame was rendered
float mHeadX = 0;                            // last calculated X position of the users head
float mHeadY = 0;                            // last calculated Y position of the users head
float mHeadDist = 0;                            // last calculated Z position of the users head
const float mRadiansPerPixel = (float)(Math::PI / 4.0f) / 1024.0f;    // don't change this! it's a fixed value for the WiiMote infrared camera
float mIRDotDistanceInMM = 8.5f * 25.4f;                // distance of the IR dots in mm. change it, if you are not using the original nintendo sensor bar
float mScreenHeightInMM = 20.0f * 25.4f;                // height of your screen
bool mWiiMoteIsAboveScreen = true;                    // is the WiiMote mounted above or below the screen?
float mWiiMoteVerticleAngle = 0;                    // vertical angle of your WiiMote (as radian) pointed straight forward for me.

The WiiMote

Connecting a WiiMote

I use the WiiYourself! library to connect my WiiMote to my PC, but you can use any other library you want, if you don't like it. There are only a few changes that have to be done.

Add another class variable for the WiiMote.

#include "wiimote.h"

wiimote mWiiMote;                            // our wiimote object


Now we have to establish a connection to the WiiMote. Let's look for one once a second for three times. If nothing was found after that continue without WiiMote support and give the user an error message. Otherwise enable the first LED and set the right report type. (For detailed information about report types look at the WiiYourself! demo project, LED states can be found here)

if (mUseWiiMotes) {
    int count = 0;
    while (!mWiiMote.Connect(wiimote::FIRST_AVAILABLE) && count < 3) {
        count++;
        Sleep(1000);
    }

    if (!mWiiMote.IsConnected()) {
        MessageBox(NULL, "Can't find any WiiMote. Continuing without WiiMote Support!", "Can't find WiiMote!", MB_OK);
        mUseWiiMotes = false;
    }
    else {
        mWiiMote.SetLEDs(0x01);
        mWiiMote.SetReportType(wiimote::IN_BUTTONS_ACCEL_IR_EXT);
    }
}

Parsing the data from the WiiMote

For parsing I created a new function in my Application, which returns true if it calculated new data or false otherwise. First we check if we use the WiiMote, if the connection is still alive and if the WiiMote has some new data for us.

bool <someClass>::parseWiiMoteData(void)
{
    if (!mUseWiiMotes)
        return false;

    if (mWiiMote.ConnectionLost()) {
        MessageBox(NULL, "Connection to WiiMote lost. Continuing without WiiMote Support!", "Lost Connection", MB_OK);
        mUseWiiMotes = false;
        return false;
    }

    if (mWiiMote.RefreshState() == NO_CHANGE)
        return false;


Now we have to get two points from the infrared camera.

Vector2 firstPoint = Vector2();
    Vector2 secondPoint = Vector2();
    int numvisible = 0;

    for (int index = 0; index < 4; index++) {
        if (mWiiMote.IR.Dot[index].bFound) {
            if (numvisible == 0) {
                firstPoint.x = mWiiMote.IR.Dot[index].RawX;
                firstPoint.y = mWiiMote.IR.Dot[index].RawY;
                numvisible = 1;
            }
            else if (numvisible == 1) {
                secondPoint.x = mWiiMote.IR.Dot[index].RawX;
                secondPoint.y = mWiiMote.IR.Dot[index].RawY;
                numvisible = 2;
                break;
            }
        }
    }


Now comes the "tricky" part: calculating the head position.

if (numvisible == 2) {
        float dx = firstPoint.x - secondPoint.x;
        float dy = firstPoint.y - secondPoint.y;
        float pointDist = (float)Math::Sqrt(dx * dx + dy * dy);

        float angle = mRadiansPerPixel * pointDist / 2;

        mHeadDist = (float)((mIRDotDistanceInMM / 2) / Math::Tan(angle)) / mScreenHeightInMM;

        float avgX = (firstPoint.x + secondPoint.x) / 2.0f;
        float avgY = (firstPoint.y + secondPoint.y) / 2.0f;

        mHeadX = (float)(Math::Sin(mRadiansPerPixel * (avgX - 512)) * mHeadDist);

        float relativeVerticalAngle = (avgY - 384) * mRadiansPerPixel;

        if(mWiiMoteIsAboveScreen)
            mHeadY = .5f + (float)(Math::Sin(relativeVerticalAngle + mWiiMoteVerticleAngle) * mHeadDist);
        else
            mHeadY = -.5f + (float)(Math::Sin(relativeVerticalAngle + mWiiMoteVerticleAngle) * mHeadDist);

        return true;
    }
    
    return false;
}

Adjusting the camera

Now we "just" have to use the above calculated data. To achieve such a VR experience, we need to do several things:

  • a camera translation
  • adjust the cameras orientation
  • adjust the cameras FOV



The camera translation

This is the easy part. Just move the camera from the old head position to the new one.

Changing the orientation

The camera position is now equal to the position of the users head and we also want to rotate the camera a little bit, so if we move left we want to rotate the camera around a point (which (in the real world) is our screen). As we move the camera position in our 3D world, we can't assume that it's always the origin. So we need to calculate the point we look at. This is the camera position + the distance of the users head to the screen into the cameras direction.

Changing the FOV

As the last part, we need to adjust the cameras FOV. So we want to see more of our 3D world if we get closer to the screen, just like we are looking through a real window. The formula gives you a FOV of 100° at 40cm distance and 30° at 4m distance.

Complete Code

Put this code into the frameStarted method.

if (parseWiiMoteData()) {
    Vector3 newHeadPosition = Vector3(mHeadX, mHeadY, -mHeadDist);
    Vector3 lookAt = mCamera->getPosition() + (mCamera->getDirection().normalisedCopy() * -mHeadPosition.z);
    mCamera->move(newHeadPosition - mHeadPosition);
    mCamera->lookAt(lookAt);
    mHeadPosition = newHeadPosition;
    mCamera->setFOVy(Radian(Degree(107 - 0.1944 * mHeadDist * mScreenHeightInMM/10)));
}


<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.