If only I could see

In this tutorial we are going to be making some changes to existing code. Some are tricky changes, so please take your time. Ogre uses cameras to view Scenes. So far we have been using the default camera created by ExampleApplication, you probably did not realize that. Don’t you think it would be cool if we could attach our camera to our little razor?. But I just don’t want to attach it that easily. Otherwise I would not need this tutorial. No. I want to do something far more interesting.

First off, we need to need to add some more scene nodes to the application. Open up TutorialApplication.h, now add the following two scene nodes just below the existing one.

SceneNode* mControlNode;
SceneNode* mCameraNode;

ControlNode will become the node that is changed by the user’s input.
CameraNode will manage the location of our camera.

Your class should look something like this now:

class TutorialApplication : public ExampleApplication
{
public:
    TutorialApplication();
    virtual ~TutorialApplication();
protected:
    void createScene();
    void createFrameListener();
    void chooseSceneManager();
    Entity* mShip;
    SceneNode* mControlNode;
    SceneNode* mShipNode;
    SceneNode* mCameraNode;
};


Now that we have declared the variables for the new scene nodes, we may as well actually create them. Open up TutorialApplication.cpp, and scroll down to the TutorialApplication::createScene() method. Find the piece of code that looks like

// Create our SceneNode
mShipNode = mSceneMgr->getRootSceneNode()->createChildSceneNode();

We don’t want our ship being controlled directly anymore. So change mShipNode to mControlNode as shown below.

// Create our control SceneNode
mControlNode = mSceneMgr->getRootSceneNode()->createChildSceneNode();

But we still need the Ship Node, add the following line to create the ship node.

// Create a SceneNode for the ship
mShipNode = mControlNode->createChildSceneNode();


What this does is associate the mShipNode as a child of the mControlNode. When we move mControlNode, the mShipNode will automatically move as well. Add the following line right after where we attach the Ship Entity to the mShipNode

mShipNode->setPosition( Vector3( 6, -10, 0) );

The razor is not actually centered in itself. What I mean is, if you could fold the razor in half, wing tip to wing top. The center is not where the center crease would be. So to center the razor on the crease and inside the body we change its position. If this node were our control node, we would constantly have to make this adjustment to keep it centered. By adjusting the ShipNode we have cut down on our coding.

Now we need to create our last node, the camera node. Add the following at the end of the method.

// Create a SceneNode for the Camera
mCameraNode = mControlNode->createChildSceneNode();


Again we have created another scene node as a child of the ControlNode. Another way to think about this, is that we can change the position of the camera without affecting the position of the ship or our control location. Nice huh? Let’s attach the existing camera now to the camera node. That is done this way:

// Attached the camera to the SceneNode
mCameraNode->attachObject( mCamera );
mCameraNode->setPosition( Vector3( 0, 50, -200) );


I am giving the camera a position behind and slightingly above the razor. Like a third person view. Remember how I said that the ExampleApplication created our camera for us? Well we need to undo some of the things the ExampleApplication did. Mostly position and look at. We want our camera at the center of our scenenode, and we want to look up the Z axis. The razor points up the Z axis, so we may as well do the same thing.

// Position it at 0
mCamera->setPosition(Vector3(0,0,0));
// Look back along Z
mCamera->lookAt(Vector3(0,0,100));


The last piece of code I want to add to the createScene method is a position. Because of the way we have created the scene nodes. We can set the overall position of the camera, ship and scene nodes by just setting the position of the mControlNode. Seeing as we have a large terrain, lets put ourselves somewhere near the center.

mControlNode->setPosition(Vector3(750,200,300));


Now we need to make some changes to TutorialFrameListener. There are a number of ways the FrameListener could have been setup. We created it as a separate class. We could of instead, also had the TutorialApplication inherit from ExampleFrameListener, and that would of saved us from having to pass the scene nodes. But, no, I did not do it the simple way. This time at least.
Go to our method TutorialApplication::createFrameListener(), we need to add the two new scene node in the following way, so go ahead and make the changes:

mFrameListener = new TutorialFrameListener(
    mWindow, mCamera, mControlNode, mShipNode, mCameraNode );
mRoot->addFrameListener( mFrameListener );


That does it for working in TutorialApplication.cpp and TutorialApplication.h. Our next changes are in TutorialFrameListener.cpp and TutorialFrameListener.h. I would suggest you
stand up walk around, stretch before continuing. That way I can get myself a drink.
<< INSERT MUSICAL INTERLUDE >>
Ahh. That’s better. Now back to the tutorial. Open up TutorialFrameListener.h, we have a few changes
to make.
We have to add two new SceneNode variables, a bool to indicate first person, and make changes to the
constructor. I will just show you the end result; you should be able to see the changes you need to make.

class TutorialFrameListener : public ExampleFrameListener
{
protected:
    SceneNode* mControlNode;
    SceneNode* mShipNode;
    SceneNode* mCameraNode;
    bool mbFirstPerson;
public:
    TutorialFrameListener(RenderWindow* win, Camera* cam,
    SceneNode* controlNode,
    SceneNode* shipNode,
    SceneNode* cameraNode);
    bool frameStarted(const FrameEvent& evt);
};


That’s right, I’m giving two views of the razor. A third person and first person view. Now that we have done the changes to the class def, its is time to change the class methods. Open up TutorialFrameListener.cpp. The first thing we need to do is change every instance of mShipNode to mControlNode. So use search and replace on the CPP file and make the change. Now make changes to the constructor to match the changes we just did in the header by adding the Control and Camera SceneNodes and re-adding the Ship SceneNode.

In the body of the constructor we need to assign the passed arguments to the proper variables. We also need to set the first person to false so that we start out in third person, add the following.

mControlNode = controlNode;
mShipNode = shipNode;
mCameraNode = cameraNode;
mbFirstPerson = false;

Now scroll down to the bottom of the TutorialFrameListener::frameStarted method. Add the following code just before the return true.

if(mInputDevice->isKeyDown(Ogre::KC_F))
{
    while (mInputDevice->isKeyDown(Ogre::KC_F))
        mInputDevice->capture();
    if (mbFirstPerson)
    {
        // third person
        mCameraNode->setPosition( Vector3( 0, 50, -200) );
        mbFirstPerson = false;
    }
    else
    {
        // first person
        mCameraNode->setPosition( Vector3( 0, 5, 40) );
        mbFirstPerson = true;
    };
};

  • NOTE: Don't forget to change all references to mShipNode (or whatever you may have named it previously) to mControlNode directly above the code here. Should be something like:

if(mInputDevice->isKeyDown(Ogre::KC_UP))
        mShipNode->translate(0.0, MoveFactor, 0.0);


Change that to:

if(mInputDevice->isKeyDown(Ogre::KC_UP))
        mControlNode->translate(0.0, MoveFactor, 0.0);


Ok, here is what this code does, it checks to see if the ‘F’ key has been pressed. It then sits in a loop waiting for the ‘F’ key to be no longer pressed. (Not the best way, but works for this tutorial.) Once the ‘F’ key is released, we toggle first person depending on what it is currently set to. When we do that, we also change the location of the camera node. In third person, the camera is above and behind the Razor. In first person, the camera is close to where the cockpit should be.

Well believe it or not, we are done with the code changes in this tutorial. Wow, talk about sore fingers. So the moment of truth, if you made the changes correctly, and I remembered to tell you all my changes, compile and run!!!!. If everything worked, you should see a screen like the first image following, and after pressing ‘f’ the second image.

xorekis8_1.jpg

Tutorial 9

<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.