History: Mogre Intermediate Tutorial 1

Source of version: 5 (current)

__Animation, Walking Between Points, and Basic Quaternions__

Original Version By [http://www.idleengineer.net|Clay Culver].
C# changes by DigitalCyborg.
Mogre changes by Djthorn

{maketoc}

!!Introduction
In this tutorial we will be covering how to take an Entity, animate it, and have it walk between predefined points. This will also cover the basics of Quaternion rotation by showing how to keep the Entity facing the direction it is moving.

!!Prerequisites
This tutorial will assume that you already know how to set up an Mogre project and make it compile successfully. This tutorial also makes use of .NETs LinkedList<T> data structure. While no prior knowledge of how to use it, you should at least know what templates are.

If you are not familiar with STL, Clay recommends picking up STL Pocket Reference [[ISBN 0-596-00556-3]. This will save you a lot of time in the future. I think most of the stuff that's in the STL has equivalent data structures which live in System.Collections and System.Collections.Generic. If you know of a good .NET Framework book, please update this wiki & share your knowledge so that the whole ODN community can benefit. Otherwise, you can probably find the information in the [http://msdn2.microsoft.com/en-us/library/ms310245.aspx|.NET Development pages]

!!Getting Started
First, you need to create a new project for the demo. Add a file called â€œMoveDemo.csâ€ to the project, and add this to it:

{CODE(wrap="1", colors="c#")} 
 using System;
 using System.Collections.Generic;
 using System.Text;
 using Mogre;
 using MogreFramework;
  
  
 namespace MogreTutorial
 {
      
     public class MoveDemo : OgreWindow
     { 
        AnimationState mAnimationState = null; //The AnimationState the moving object
        float mDistance = 0.0f;              //The distance the object has left to travel
        Vector3 mDirection = Vector3.ZERO;   // The direction the object is moving
        Vector3 mDestination = Vector3.ZERO; // The destination the object is moving towards
        LinkedList<Vector3> mWalkList = null; // A doubly linked containing the waypoints
        float mWalkSpeed =50.0f;  // The speed at which the object is moving
 
 
        protected override void CreateSceneManager()
        {
            
           
          
   
        }
 
        protected override void CreateInputHandler()
        {
            base.CreateInputHandler();
            this.Root.FrameStarted += new FrameListener.FrameStartedHandler(FrameStarted);
 
          
        }
 
        protected bool nextLocation()
        {
            return true;
        }
 
        bool FrameStarted(FrameEvent evt)
        {
 
          
            return true;
        }
 
         
    }
 }
{CODE}
And also, don't forget to change "Program.cs" like this.

{CODE(wrap="1", colors="c#")} using System;
 using System.Windows.Forms;
 using MogreFramework;
 using Mogre;
  
 namespace MogreTutorial
 {
    #region class Program
    static class Program
    {
        [STAThread]
        static void Main()
        {
            try
            {
                MoveDemo win = new MoveDemo();
                win.Go();
            }
            catch (System.Runtime.InteropServices.SEHException)
            {
                if (OgreException.IsThrown)
                    MessageBox.Show(OgreException.LastException.FullDescription, "An Ogre exception has occurred!");
                else
                    throw;
            }
        }
    }
    #endregion
 
 }
{CODE}
Be sure you can compile this code before continuing.

!!Setting up the Scene
Before we begin, notice that we have already defined some variables in MoveDemoApplication. The variable mAnimationState will hold the animation state of the object, mDistance will contain the distance from our location to the next waypoint, mDirection will hold the direction the object is moving, mDestination will hold the next waypoint location, mWalkList will contain all the points we wish the object to walk to, mWalkSpeed will hold our speed.

Go to the CreateSceneManager() method and add the following code to it. First we are going to create our scene manager and then set the ambient light to white so that we can see objects we put on the screen.
{CODE(wrap="1", colors="c#")}            
            // Create SceneManager
            SceneManager = Root.CreateSceneManager(SceneType.ST_EXTERIOR_CLOSE);
 
            //Set ambient light
            SceneManager.AmbientLight = ColourValue.White;
 
{CODE}
Next we will create a Robot on the screen so that we can play with him. To do this we will create the entity for the Robot, then create a SceneNode for him to dangle from.

{CODE(wrap="1", colors="c#")}            // Create the Robot entity
            Entity ent = SceneManager.CreateEntity("Robot", "robot.mesh");
           
            // Create the Robot's SceneNode
            SceneNode node = SceneManager.RootSceneNode.CreateChildSceneNode("RobotNode",
                             new Vector3(0.0f, 0.0f, 0.25f));
            node.AttachObject(ent);
 {CODE}
Next, we want to place some objects on the scene to show where the robot is supposed to be moving. This will allow us to see the robot moving with respect to other objects on the screen. Notice the negative Y component to their position. This puts the objects under where the robot is moving to, and he will stand on top of them when he gets to the correct place.
{CODE(wrap="1", colors="c#")}           
            // Create knot objects so we can see movement
            ent = SceneManager.CreateEntity("Knot1", "knot.mesh");
            node = SceneManager.RootSceneNode.CreateChildSceneNode("Knot1Node",
                new Vector3(0.0f, -10.0f, 25.0f));
            node.AttachObject(ent);
            node.Scale(0.1f, 0.1f, 0.1f);
            //
            ent = SceneManager.CreateEntity("Knot2", "knot.mesh");
            node = SceneManager.RootSceneNode.CreateChildSceneNode("Knot2Node",
                new Vector3(550.0f, -10.0f, 50.0f));
            node.AttachObject(ent);
            node.Scale(0.1f, 0.1f, 0.1f);
            //
            ent = SceneManager.CreateEntity("Knot3", "knot.mesh");
            node = SceneManager.RootSceneNode.CreateChildSceneNode("Knot3Node",
                new Vector3(-100.0f, -10.0f, -200.0f));
            node.AttachObject(ent);
            node.Scale(0.1f, 0.1f, 0.1f);
 
 {CODE}
This all should be very basic, so I will not go into detail about any of it. In the next chunk of code, we are going to tell the robot where he needs to be moved to. For those of you who don't know anything about .NETs LinkedList, it is an efficient? implementation of a doublely linked list that we can use as a two ended queue. We will only be using a few of its methods. The AddFirst and AddLast methods put items at the front and back of the list respectively. The First and Last methods return the items at the front and back of the list respectively. The RemoveFirst and RemoveLast methods remove the items from the front and back of the list respectively. Finally, the Count method returns the number of entries in the list. This code creates the list, then adds three Vectors to it. We will use these later when we make the robot move
{CODE(wrap="1", colors="c#")} 
            // Create the walking list
            mWalkList = new LinkedList<Vector3>();
            mWalkList.AddLast(new Vector3(550.0f, 0.0f, 50.0f));
            mWalkList.AddLast(new Vector3(-100.0f, 0.0f, -200.0f));
            mWalkList.AddLast(new Vector3(0.0f, 0.0f, 25.0f));
 
   
          {CODE}
Now compile and run the code. You should see our robot and three knots.

!!Animation
We are now going to setup some basic animation. Animation in OGRE is very simple. To do this, you need to get the AnimationState from the Entity object, set its options, and enable it. This will make the animation active, but you will also need to add time to it after each frame in order for the animation to run. We'll take this one step at a time. First, add this to the bottom of CreateSceneManager().
{CODE(wrap="1", colors="c#")} 
 
            // Set idle animation
            mAnimationState = SceneManager.GetEntity("Robot").GetAnimationState("Idle");
            mAnimationState.Loop = true;
            mAnimationState.Enabled = true;
{CODE}
The first line of code gets the AnimationState out of the entity. In the second line we call SetLoop( true ), which makes the animation loop over and over. For some animations (like the death animation), we would want to set this to false instead. The third line actually enables the Animation. But wait...where did we get â€œIdleâ€ from? How did this magic string slip in there? Every mesh has their own set of Animations defined for them. In order to see all of the Animations for the particular mesh you are working on, you need to download the OgreMeshViewer and view the mesh from there.

Now, if we compile and run the demo we see...nothing has changed. This is because we need to update the animation state with a time every frame. Find the FrameStarted method, and add this line of code:

{CODE(wrap="1", colors="c#")}            //Update the Animation State.
            mAnimationState.AddTime(evt.timeSinceLastFrame * mWalkSpeed /20);

 {CODE}
Now build and run the application. You should see a robot performing his idle animation standing in place. pretty spiffy huh?

!!Moving the Robot
Now we are going to perform the slightly tricky task of making the robot walk from waypoint to waypoint. Before we begin I would like to re-describe some the variables that we are storing in the class. We are going to use 4 variables to accomplish the task of moving the robot. The direction the robot is moving is stored in mDirection. The robot's current destination is stored in mDestination. The distance the robot has left to travel is stored in mDistance. Last but not least, the robot's speed is stored in mWalkSpeed.

Since the variables are already initialized we can use them to set the robot in motion. To make the robot move, we simply tell it to change animations. However, we only want to start the robot moving if there is another location to move to. the nextLocation is used for this.

Add this code to FrameStarted method just above mAnimationState.AddTime(mDeltaTime) which should be just above the return line.

{CODE(wrap="1", colors="c#")}            if (!mWalking)
            //either we've not started walking or reached a way point
            {
                //check if there are places to go
                if (nextLocation())
                {
                    LinkedListNode<Vector3> tmp;
 
                    //Start the walk animation
                    mAnimationState = mEntity.GetAnimationState("Walk");
                    mAnimationState.SetLoop(true);
                    mAnimationState.SetEnabled(true);
                    mWalking = true;
                    
                    //Update the destination using the walklist.
 
                }//if(nextLocation())
            }
{CODE}
If you compile and run the code right now, the robot will walk in place. This is because the robot starts out with a mWalking = false and our nextLocation function always returns true. In later steps we will be adding a bit more intelligence to the nextLocation function. Note that we also left a placeholder for the code to update the Robot's destination. we'll get to that later too :)

Now we are going to actually move the robot in the scene. To do this we need to have him move a small bit every frame. We will be adding the following code just after our previous if statement and just above the return line of the method. This code will handle the case when the robot is actually moving; (mWalking == true)

{CODE(wrap="1", colors="c#")}            else //we're in motion
            {
                //determine how far to move this frame
                float move = mWalkSpeed * mDeltaTime;
                mDistance -= move;
{CODE}
Now, we need to check and see if we've arrived at the waypoint. That is, if mDistance is now less than or equal to zero, we need to set the point and setup the move to the next point. Note that we are setting mDirection to the ZERO vector and that we are setting mWalking to false.(the robot stops at each waypoint, then checks to see if it has another waypoint).

{CODE(wrap="1", colors="c#")}                //Check to see if we've arrived at a waypoint
                if (mDistance <= 0.0f)
                {
                    //set our node to the destination we've just reached & reset direction to 0
                    mNode.SetPosition( mDestination );
                    mDirection = Vector3.Zero;
                    mWalking = false;
                }//if(mDistance <= 0.0f)
                else
                { 
                    //Rotation code goes here
 
                    //movement code goes here
                }
{CODE}
Now that we have moved to the point, we need to setup the motion to the next point. Once we know if we need to move to another point or not, we can set the appropriate animation; walking if there is another point to go to and idle if there are no more destination points. This is a simple matter of setting the Idle animation if there are no more locations. update Framestarted just below the close of the if statement

{CODE(wrap="1", colors="c#")}                } //if(nextLocation())

                else //nowhere to go. set the idle animation. (or Die)
                {
                    mAnimationState = mEntity.GetAnimationState("Idle");
                    //mAnimationState = mEntity.GetAnimationState("Die");
                    //mAnimationState.SetLoop(false);
                }
 {CODE}
Note that we have no need to set the walking animation again if there are more points in the queue to walk to. Since the robot is already walking there is no reason to tell him to do so again. However, if the robot needs to go to another point, then we need to rotate him to face that point. For now we leave a placeholder comment in the else clause; remember this spot as we will come back to it later.

This takes care of when we are very close to the target position. Now we need to handle the normal case, when we are just on the way to the position but we're not there yet. To do that we will translate the robot in the direction we are traveling, and move it by the amount specified by the move variable. This is accomplished by adding the following code:

{CODE(wrap="1", colors="c#")}                else
                {
                    //movement code goes here
                    mNode.Translate(mDirection * move);
                    
                    //Rotation code goes here
                }
  {CODE}
We are almost done. Our code now does everything except set up the variables required for movement. If we can properly set the movement variables our Robot will move like he is supposed to. Find the NextLocation function. This function returns false when we run out of points to go to. This will be the first of code line in our function. (Note you should leave the return true statement at the bottom of the function.)

{CODE(wrap="1", colors="c#")}            if (mWalkList.Count == 0) 
                return false;
{CODE}
Now we need to set the movement variables. We'll do this where we left this placeholder earlier

{CODE(wrap="1", colors="c#")}                   //Update the destination using the walklist.
{CODE}
First we will extract the destination vector from the front of the LinkedList and then add the LinkedListNode that held it to the end of the list. This will make the robot keep walking around from point to point. 
We will set the direction vector by subtracting the SceneNode's current position from the destination. We have a problem though. Remember how we multiplied mDirection by the move amount in FrameStarted? If we do this, we need the direction vector to be a unit vector (that is, it's length equals one). The normalise function does this for us, and returns the old length of the vector. Handy that, since we need to also set the distance to the destination.

{CODE(wrap="1", colors="c#")}                    //Update the destination using the walklist.
                    LinkedListNode<Vector3> tmp;  //temporary listNode
                    mDestination = mWalkList.First.Value; //get the next destination.
                    tmp = mWalkList.First; //save the node that held it
                    mWalkList.RemoveFirst(); //remove that node from the front of the list
                    mWalkList.AddLast(tmp);  //add it to the back of the list.
 
                    //update the direction and the distance
                    mDirection = mDestination - mNode.GetPosition();
                    mDistance = mDirection.Normalize();
{CODE}
Now compile and run the code. It works! Mostly... The robot now walks to all the points, but he is always facing the Vector3.UnitX direction (his default). We will need to change the direction he is facing when he is moving towards points.

What we need to do is get the direction the Robot is facing, and use the rotate function to rotate the object in the right position. Insert the following code where we left the following placeholder comment earlier.

{CODE(wrap="1", colors="c#")}                   //Rotation code goes here
{CODE}
The first line gets the direction the Robot is facing. The second line builds a Quaternion representing the rotation from the current direction to the destination direction. The third line actually rotates the Robot.

{CODE(wrap="1", colors="c#")}                    Vector3 src = mNode.GetOrientation() * Vector3.UnitX;
                    Quaternion quat = src.GetRotationTo(mDirection);
                    mNode.Rotate( quat );
{CODE}
A lot is going on in that small chunk code! A few questions pop into mind. The most pertenant is: "What is a Quaternion?" Basically, Quaternions are representations of rotations in 3 dimensional space. They are used to keep track of how the object is positioned in space. In the first line we call the getOrientation method, which returns a vector representing the way the Robot is currently facing. By multiplying it by the UnitX vector, we obtain the direction the robot is currently facing, which we store in src. In the second line, the getRotationTo method gives us a Quaternion that represents the rotation from the direction the Robot is facing to the direction we want him to be facing. In the third line we use the quaternion to rotate the node so that it faces the new orientation.

There is only one problem with the code we have created. There is a special case where SceneNode::rotate will fail. If we are trying to turn the Robot 180 degrees, the rotate code will bomb with a divide by zero error. In order to fix that, we will test to see if we are performing a 180 degree rotation. If so, we will simply yaw the Robot by 180 degrees instead of using rotate. To do this, delete the three lines we just put in and replace them with this:

{CODE(wrap="1", colors="c#")}                    Vector3 src = mNode.GetOrientation() * Vector3.UnitX;
                    if((1.0f + src.Dot(mDirection)) < 0.0001f)
                    {
                        mNode.Yaw(180.0f);
                    }
                    else
                    {
                        Quaternion quat = src.GetRotationTo(mDirection);
                        mNode.Rotate( quat );
                    }
{CODE}
All of this should now be self explanatory except for what is wrapped in that if statement. If two unit vectors oppose each other (that is, the angle between them is 180 degrees), then their dot product will be -1. So, if we dotProduct the two vectors together and the result equals 1.0f, then we need to yaw by 180 degrees, otherwise we use rotate instead. Why do I add 1.0f and check to see if it is less than 0.0001f? Don't ever forget about floating point rounding error. You should never directly compare two floating point numbers. Finally, note that in this case the dot product of these two vectors will fall in the range [[-1, 1]. In case it is not abundantly clear, you need to know at minimum basic linear algebra to do graphics programming! At the very least you should review the ((Quaternion and Rotation Primer)) and consult a book on basic vector and matrix operations.

Now our code is complete! Compile and run the demo to see the Robot walk the points he was given.

!!Here's the full code
{CODE(wrap="1", colors="c#")} using System;
 using System.Collections.Generic;
 using System.Text;
 using Mogre;
 using MogreFramework;
 using System.Windows.Forms;
 
 
 namespace MogreTutorial
 {
     
    public class MoveDemo : OgreWindow
    {
        AnimationState mAnimationState = null; //The AnimationState the moving object
        float mDistance = 0.0f;              //The distance the object has left to travel
        Vector3 mDirection = Vector3.ZERO;   // The direction the object is moving
        Vector3 mDestination = Vector3.ZERO; // The destination the object is moving towards
        LinkedList<Vector3> mWalkList = null; // A doubly linked containing the waypoints
 
        float mWalkSpeed =50.0f;  // The speed at which the object is moving
 
 
        protected override void CreateSceneManager()
        {
            
            SceneManager = Root.CreateSceneManager(SceneType.ST_EXTERIOR_CLOSE);
 
            SceneManager.AmbientLight = ColourValue.White;
    
            Entity ent = SceneManager.CreateEntity("Robot", "robot.mesh");
 
            SceneNode node = SceneManager.RootSceneNode.CreateChildSceneNode("RobotNode", new Vector3(0.0f, 0.0f, 0.25f));
            node.AttachObject(ent);
 
            // Create knot objects so we can see movement
            ent = SceneManager.CreateEntity("Knot1", "knot.mesh");
            node = SceneManager.RootSceneNode.CreateChildSceneNode("Knot1Node",
                new Vector3(0.0f, -10.0f, 25.0f));
            node.AttachObject(ent);
            node.Scale(0.1f, 0.1f, 0.1f);
            //
            ent = SceneManager.CreateEntity("Knot2", "knot.mesh");
            node = SceneManager.RootSceneNode.CreateChildSceneNode("Knot2Node",
                new Vector3(550.0f, -10.0f, 50.0f));
            node.AttachObject(ent);
            node.Scale(0.1f, 0.1f, 0.1f);
            //
            ent = SceneManager.CreateEntity("Knot3", "knot.mesh");
            node = SceneManager.RootSceneNode.CreateChildSceneNode("Knot3Node",
                new Vector3(-100.0f, -10.0f, -200.0f));
            node.AttachObject(ent);
            node.Scale(0.1f, 0.1f, 0.1f);
 
            mWalkList = new LinkedList<Vector3>();
            mWalkList.AddLast(new Vector3(550.0f, 0.0f, 50.0f));
            mWalkList.AddLast(new Vector3(-100.0f, 0.0f, -200.0f));
            mWalkList.AddLast(new Vector3(0.0f, 0.0f, 25.0f));
 
            // Set idle animation
            mAnimationState = SceneManager.GetEntity("Robot").GetAnimationState("Idle");
            mAnimationState.Loop = true;
            mAnimationState.Enabled = true;
 
        }
 
        protected override void CreateInputHandler()
        {
            base.CreateInputHandler();
            this.Root.FrameStarted += new FrameListener.FrameStartedHandler(FrameStarted);
        }
 
        protected bool nextLocation()
        {
            if (mWalkList.Count == 0)
                return false;
            return true;
        }
 
        bool FrameStarted(FrameEvent evt)
        {
            
             
            Entity ent = SceneManager.GetEntity("Robot");
            SceneNode node = SceneManager.GetSceneNode("RobotNode");
 
            float move = mWalkSpeed * (evt.timeSinceLastFrame);
            mDistance -= move;
 
            //Knot arrival check
            if (mDistance <= 0.0f)
            {
                if (!TurnNextLocation())
                {
                    mAnimationState = ent.GetAnimationState("Idle");
                    return true;
                }
            }
            else
            {
                //movement code goes here
                node.Translate(mDirection * move);
            }
           
            //Update the Animation State.
            mAnimationState.AddTime(evt.timeSinceLastFrame * mWalkSpeed /20);
 
            return true;
             
        }
 
        bool TurnNextLocation()
        {
            Entity ent = SceneManager.GetEntity("Robot");
            SceneNode node = SceneManager.GetSceneNode("RobotNode");
 
            if (nextLocation())
            {
                //Start the walk animation
                mAnimationState = ent.GetAnimationState("Walk");
                mAnimationState.Loop = true;
                mAnimationState.Enabled = true;
            
                LinkedListNode<Vector3> tmp;  //temporary listNode
                mDestination = mWalkList.First.Value; //get the next destination.
                tmp = mWalkList.First; //save the node that held it
                mWalkList.RemoveFirst(); //remove that node from the front of the list
                mWalkList.AddLast(tmp);  //add it to the back of the list.
 
                //update the direction and the distance
                mDirection = mDestination - node.Position;
                mDistance = mDirection.Normalise();
 
                Vector3 src = node.Orientation * Vector3.UNIT_X;
               
 
                if ((1.0f + src.DotProduct(mDirection)) < 0.0001f)
                {
                    node.Yaw(new Angle(180.0f));
                }
                else
                {
                    Quaternion quat = src.GetRotationTo(mDirection);
                    node.Rotate(quat);
                } 
 
                return true;
 
            } 
 
            return false;
        }
        
    }
     
 
 }
{CODE}
!!Exercises for Further Study


!!!Easy Questions
# Add more points to the robot's path. Be sure to also add more knots that sit under his position so you can track where he is supposed to go.
# Robots who have outlived their usefulness should not continue existing! When the robot has finished walking, have him perform the death animation instead of idle. The animation for death is â€œDieâ€.

!!!Difficult Questions
# One of the limitations of this class is that you cannot add points to the robot's walking path after you have created the object. Fix this problem by implementing a new method which takes in a Vector3 and adds it to the mWalkList deque. (Hint, if the robot has not finished walking you will only need to add the point to the end of the deque. If the robot has finished, you will need to make him start walking again, and call nextLocation to start him walking again.)

!!!Expert Questions
# Another major limitation of this class is that it only tracks one object. Reimplement this class so that it can move and animate any number of objects independently of each other. (Hint, you should create another class that contains everything that needs to be known to animate one object completely. Store this in a STL map object so that you can retrieve data later based on a key.) You get bonus points if you can do this without registering any additional frame listeners.
# After making the previous change, you might have noticed that Robots can now collide with each other. Fix this by either creating a smart path finding function, or detecting when robots collide and stopping them from passing through each other.

!!Credits
Thanks Clay Culver for providing the original tutorial
History: Mogre Intermediate Tutorial 1

Source of version: 5 (current)

Search by Tags

Latest Changes

Search

Online Users
