Original version by Clay Culver

Initial C# edits by DigitalCyborg & ElectricBliss

Adapted to MOGRE by Adis

VB.NET port by Aeauseth.

Getting Started

Prerequisites

This tutorial assumes you have knowledge of VB.NET programming and are able to setup and compile a standard VB.NET application. You should have Visual Basic 2008 (the free Express Version will work fine) or SharpDevelop installed.

Introduction

In this tutorial we will be going over how to install Mogre and how to setup and run a Mogre application. We will also go over some of the pitfalls of Mogre and how to avoid them, as well as proper Ogre exception handling. If you have questions about this tutorial, or Mogre in general, you should ask the question in the Mogre Forums.

Installation

Downloading Mogre

You can download the latest version of Mogre from the Mogre SourceForge project page. The filename is MogreSDK_1.4.8.exe, although there may be a newer version at some point. When you install the SDK, you will be given the choice of installation locations. This tutorial will assume you have installed the MogreSDK in default location (C:\MogreSDK).

You will also need vcredist_x86.exe; check it out in the same URL above. Some users reported that applications executed correctly after installation (e.g.: Visual Studio 2005, Team Edition, Version 8.0.50727-42).

Alternatively you can install the SP1 for your IDE (Visual Studio, Visual, etc.) So you also can use the debug version of DLL files.

To use the Direct3D9-Renderer you need to install the DirectX Redistributables from November 2007 or newer.

Building Your First Mogre Application

Creating a Project

Open up Visual Basic and create a new Console Application. Name it MogreTutorial0 (or whatever).
Now that we have a project created, we need to add references to it.

Adding References

From the menu bar click “Project”, then “Add Reference”. Click on the "Browse" tab, and change the directory to "C:\MogreSDK\bin\release". Select Mogre.dll and then click "OK". Do this again for Mois.dll.

Adding C++ dlls

The Mogre and Mois references are just 'wrappers' for the Ogre C++ dll's, hence the purpose of MOgre. These wrappers are dependant on several files, and we need to add these files to our project.

From the menu bar click “Project”, then “Add Existing Item”. Browse to "C:\MogreSDK\bin\release" and select OgreMain.dll and then click "OK". Do this again for cg.dll and OIS.dll.

Now you should see OgreMain.dll in the Solution Explorer. Left click on OgreMain.dll to select it. Take a look at the Properties window and you will see the “Copy to Output Directory” witch defaults to “Do not copy”. Change this to “Copy if newer”. Set cg.dll and OIS.dll to "Copy if newer".

Adding Configuration Files

Before we can actually use the project, we have to add three configuration files to our project. From the menu bar click “Project”, then “Add Existing Item”. Browse to "C:\MogreSDK\bin\release" and select media.cfg, Plugins.cfg, and resources.cfg. Select each one from the Solution Explorer and set to “Copy if newer”.
For simplicity we are going to use the resources located in C:\MogreSDK. However to make this a self contained and publishable program you would want to add these resources files to your project. But for now, open up the resources.cfg files you added to your project. You will notice it contains a relative path for the directories. We will have to set this manually to the absolute path. Replace all occurrences of "../../" in the document with "C:\MogreSDK\". Don’t worry about which direction the slashes are going, windows doesn’t really care.
We need to do the same thing to Plugins.cfg. Open the file and make sure the PluginFolder=C:\MogreSDK\bin\release

Testing Your Application

Now that the project is fully setup and ready to be used, open up "Module1.vb" and replace the code with the following:

Imports Mogre
 
 Module Module1
    Sub Main()
 
      Try
 
             'Initialization of Ogre Root and RenderWindow
             Dim myRoot As Root = New Root("Plugins.cfg", "ogre.cfg", "ogre.log")
 
             'Show Ogre Rendering Subsystem setup dialog box
             If Not myRoot.RestoreConfig Then
                 If Not myRoot.ShowConfigDialog Then
                     Exit Sub
                 End If
             End If
 
             'Create an Ogre render window
             Dim myWindow As RenderWindow = myRoot.Initialise(True, "Application")
 
             'Start rendering
             myRoot.StartRendering()
 
      Catch ex As System.Runtime.InteropServices.SEHException
           If OgreException.IsThrown Then
                MsgBox(OgreException.LastException.FullDescription, MsgBoxStyle.Critical, _
                     "An Ogre  exception has occured!")
           Else
                MsgBox(ex.ToString, "An error has occured")
           End If
      End Try
 
    End Sub
 End Module


From the main menu click “File” and then “Save All”. Run the application by pressing F5. You should see black dos type window, then a dialog box that allows you to pick a rendering subsystem. Pick “Direct3D9 Rendering Subsystem”. You should also set “Full Screen” to “No”. Click OK and you will see a second black window titled “Application” with a black background. If so, congratulations! You have just successfully created your first Ogre project. We will be doing more with this later.

Troubleshooting

Checklist

If you have problems getting started, check the following things first:

  • Did you install the Mogre SDK and NOT the standard OgreSDK? The Mogre SDK can be obtained from the http://sourceforge.net/projects/mogre. The Mogre SDK will include Mogre.dll in the C:\MogreSDK\bin\debug and C:\MogreSDK\bin\release directories.
  • FileLoadException was unhandled and something about a prodecure imported by 'Mogre, Version=1.4.6.0'? First disable the Visual Studio hosting process.
  • Did you download more than one version of Ogre? If so then close Visual Basic. Delete the C:\MogreSDK directory, rerun the MOgreSDK extract. Remember the MOgre and Ogre have different SDK's! Delete all the files in your “MyDocuments\Visual Studio 2008\Projects\MogreTutorial0\MogreTutorial0\bin\Debug” and “MyDocuments\Visual Studio 2008\Projects\MogreTutorial0\MogreTutorial0\bin\Release” directories. Restart Visual Basic and load your project. Now delete all the DLL's in your Solution Explorer. Re-add them (see previous section if you forgot how to do this).
  • Did you add references to "Mogre.dll" in your project?
  • Browse to “MyDocuments\Visual Studio 2008\Projects\MogreTutorial0\MogreTutorial0\bin\Debug”. You should have cg.dll, mogre.dll, ogremain.dll, and Plugins.cfg files. If not review the previous sections to see what you missed.
  • Browse to “MyDocuments\Visual Studio 2008\Projects\MogreTutorial0\MogreTutorial0\bin\Debug”. Is there an ogre.log file? If so open it and see if there are any errors reported.
  • The application has failed to start because d3dx9_36dll was not found. Note that your Plugins.cfg file has the line Plugin=RenderSystem_Direct3D9. This is required in order to use the Direct3D9-Renderer. However it is also required that you have DirectX Redistributables from November 2007 or newer installed (don't forget to run DXsetup after the download). Try commenting out the line Plugin=RenderSystem_Direct3D9 (use a #) and see if it works.

Getting Help

If you have checked these things, feel free to post the problem you are having to the Mogre forums. Be sure to include a detailed description of the problem, the things you have tried to fix it, and paste the error messages from the Ogre.log file if there are any (this file is located in the project's output directory).

Exception Handling With Mogre

Before wrapping up this tutorial, I'd like to breifly mention how to handle exceptions which originate from Ogre itself. Mogre and VB can handle C++ exceptions, but they do not act as you would expect them to. If you ever see a message which states "Runtime Error! ... This application has requested the Runtime to terminate in an unusual way..." then you probably encountered an error in Ogre somewhere.

To properly handle an exception thrown by the C++ Ogre library, you need to catch an exception of the type System.Runtime.InteropServices.SEHException. After catching this exception, you can see if it's an Ogre exception (instead of just a crash) by checking the static OgreException.IsThrown property. If that property is true, then you handle the exception. For example, here is a chunk of code to catch and display an Ogre exception:

Try
 …
 Catch ex As System.Runtime.InteropServices.SEHException
      If OgreException.IsThrown Then
           MsgBox(OgreException.LastException.FullDescription, MsgBoxStyle.Critical, _
                "An Ogre  exception has occured!")
      Else
           MsgBox(ex.ToString, "An error has occured")
      End If
 End Try


Wrapping your main method with a try block such as this one can save you lots of headaches down the line when you are debugging your application. Notice we have not added a catch block to catch a generic Exception object. This way when we are debugging the application, Visual Basic can insert a breakpoint for an unhandled VB exception, whereas Visual Basic cannot do this for C++ exceptions.

Final Note

By this point you should be able to create and run an empty Mogre project. All subsequent tutorials will assume you can successfully set up a Mogre project.
Also, a possible way to speed up the creation of new Mogre projects is to create a new Template. From the main menu select “File” then “Export Template”. Take the defaults, although I recommend changing the Template name to “Mogre”.

Proceed to Mogre Basic Tutorial VB 1 The SceneNode, Entity, and SceneManager constructs

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