zaki
/
irrlicht
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update example 01 documentation. 

git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@5494 dfc29bdd-3216-0410-991c-e03cc46cb475
master
cutealien 2017-07-03 21:20:51 +00:00
parent 5a74edd043
commit 7d16b3e6e0
1 changed files with 81 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

134
examples/01.HelloWorld/main.cpp
View File

@ -5,35 +5,40 @@ to write a simple HelloWorld program with it. The program will show how to use
the basics of the VideoDriver, the GUIEnvironment, and the SceneManager.
Microsoft Visual Studio is used as an IDE, but you will also be able to
understand everything if you are using a different one or even another
operating system than windows.
operating system than Windows.
You have to include the header file <irrlicht.h> in order to use the engine. The
header file can be found in the Irrlicht Engine SDK directory \c include. To let
the compiler find this header file, the directory where it is located has to be
specified. This is different for every IDE and compiler you use. Let's explain
shortly how to do this in Microsoft Visual Studio:
added in your project as include path. This is different for every IDE and
compiler you use. Let's explain shortly how to do this in Visual Studio 2010:
- If you use Version 6.0, select the Menu Extras -> Options.
Select the directories tab, and select the 'Include' Item in the combo box.
Add the \c include directory of the irrlicht engine folder to the list of
directories. Now the compiler will find the Irrlicht.h header file. We also
need the irrlicht.lib to be found, so stay in that dialog, select 'Libraries'
in the combo box and add the \c lib/VisualStudio directory.
\image html "vc6optionsdir.jpg"
\image latex "vc6optionsdir.jpg"
\image html "vc6include.jpg"
\image latex "vc6include.jpg"
- In Visual Studio 2010 select the Menu Project -> Properties. Select the
"C/C++" - "General" option, and select the "Additional Include Directories".
Add the \c include directory of the Irrlicht engine folder to the list of
directories. Now the compiler will find the irrlicht.h header file. We also
need the irrlicht.lib to be found, so select "Linker" - "General" and
add the \c lib/Win64-visualStudio or \c lib/Win32-visualStudio directory
to "Additional Library Directories". Which of the 2 Irrlicht versions you
chose depends on the target platform for your application (win32 or x64).
In your project properties you can see what your active solution platform
is, you can use the same one for Irrlicht.
- If your IDE is Visual Studio .NET, select Tools -> Options.
Select the projects entry and then select VC++ directories. Select 'show
directories for include files' in the combo box, and add the \c include
directory of the irrlicht engine folder to the list of directories. Now the
compiler will find the Irrlicht.h header file. We also need the irrlicht.lib
to be found, so stay in that dialog, select 'show directories for Library
files' and add the \c lib/VisualStudio directory.
\image html "vcnetinclude.jpg"
\image latex "vcnetinclude.jpg"
To be able to use the Irrlicht.DLL file, we need to link with the Irrlicht.lib.
In most IDE's you have to add irrlicht.lib (or irrlicht.a or irrlicht.so on
Linux) to your Linker input files.
For VisualStudio we can be lazy and use the pragma comment lib.
We also want to get rid of the console window, which pops up when starting a
program with main() (instead of WinMain). This is done by the second pragma.
We could also use the WinMain method, though losing platform independence then.
*/
#ifdef _MSC_VER
#pragma comment(lib, "Irrlicht.lib")
#pragma comment(linker, "/subsystem:windows /ENTRY:mainCRTStartup")
#endif
/*
That's it. With your IDE set up like this, you will now be able to develop
applications with the Irrlicht Engine.
@ -43,6 +48,11 @@ After we have set up the IDE, the compiler will know where to find the Irrlicht
Engine header files so we can include it now in our code.
*/
#include <irrlicht.h>
/*
That header just adds the getExampleMediaPath tool-functions to help locating
the media we need. More about that later below.
*/
#include "exampleHelper.h"
/*
@ -52,6 +62,9 @@ of the class. For example to use the IrrlichtDevice write: irr::IrrlichtDevice.
To get rid of the irr:: in front of the name of every class, we tell the
compiler that we use that namespace from now on, and we will not have to write
irr:: anymore.
Note that you never should do that in headers - otherwise you will pollute the
namespace of every file including such a header. So in headers always write
out the full names including all namespaces.
*/
using namespace irr;
@ -62,7 +75,7 @@ menu item 'Namespace List' or by using this link:
http://irrlicht.sourceforge.net/docu/namespaces.html
Like the irr namespace, we do not want these 5 sub namespaces now, to keep this
example simple. Hence, we tell the compiler again that we do not want always to
write their names.
write their names.
*/
using namespace core;
using namespace scene;
@ -70,20 +83,6 @@ using namespace video;
using namespace io;
using namespace gui;
/*
To be able to use the Irrlicht.DLL file, we need to link with the Irrlicht.lib.
We could set this option in the project settings, but to make it easy, we use a
pragma comment lib for VisualStudio. On Windows platforms, we have to get rid
of the console window, which pops up when starting a program with main(). This
is done by the second pragma. We could also use the WinMain method, though
losing platform independence then.
*/
#ifdef _MSC_VER
#pragma comment(lib, "Irrlicht.lib")
#pragma comment(linker, "/subsystem:windows /ENTRY:mainCRTStartup")
#endif
/*
This is the main method. We can now use main() on every platform.
*/
@ -92,25 +91,31 @@ int main()
/*
The most important function of the engine is the createDevice()
function. The IrrlichtDevice is created by it, which is the root
object for doing anything with the engine. createDevice() has 7
parameters:
object for doing anything with the engine. createDevice() has the
following parameters:
- deviceType: Type of the device. This can currently be the Null-device,
one of the two software renderers, D3D9, or OpenGL. In this
example we use EDT_SOFTWARE, but to try out, you might want to
change it to EDT_BURNINGSVIDEO, EDT_NULL, EDT_DIRECT3D9, or EDT_OPENGL.
example we use EDT_BURNINGSVIDEO, but to try out, you might want to
change it to EDT_SOFTWARE, EDT_NULL, EDT_DIRECT3D9, or EDT_OPENGL.
Generally you will want to use OpenGL or Direct3D as they are
using your graphic card for calculations instead of the CPU and
are way faster (and usually better looking). We just use one of the
software renderers here as it even works when your graphic card driver
isn't set up for 3d support.
- windowSize: Size of the Window or screen in FullScreenMode to be
created. In this example we use 640x480.
- bits: Amount of color bits per pixel. This should be 16 or 32. The
parameter is often ignored when running in windowed mode.
parameter is often ignored when running in windowed mode. More
commonly you would chose 32 bit, again we're just playing it safe.
- fullscreen: Specifies if we want the device to run in fullscreen mode
or not.
or windowed.
- stencilbuffer: Specifies if we want to use the stencil buffer (for
drawing shadows).
- stencilbuffer: Specifies if we want to use the stencil buffer (you
need it for drawing shadows).
- vsync: Specifies if we want to have vsync enabled, this is only useful
in fullscreen mode.
@ -122,7 +127,7 @@ int main()
dimensions, etc.
*/
IrrlichtDevice *device =
createDevice( video::EDT_SOFTWARE, dimension2d<u32>(640, 480), 16,
createDevice( video::EDT_BURNINGSVIDEO, dimension2d<u32>(640, 480), 16,
false, false, false, 0);
if (!device)
@ -150,20 +155,43 @@ int main()
The text is placed at the position (10,10) as top left corner and
(260,22) as lower right corner.
*/
guienv->addStaticText(L"Hello World! This is the Irrlicht Software renderer!",
guienv->addStaticText(L"Hello World! This is Irrlicht with the burnings software renderer!",
rect<s32>(10,10,260,22), true);
/*
Get a media path dedicated for your platform.
Get a media path dedicated for your platform. Finding media files for your
applications can be tricky. First you have 2 options - working with relative
paths or working with absolute paths.
On Windows a common solution is that your installer will write a key into
the registry with the absolute path of wherever the user installed the
media. And in your application you read out that key from the registry.
On Linux a common solution is to use config file which is placed in some
fixed location (for example in a . file/folder in the user home).
But you can also work with relative paths - which is what we do here. There
is a slight complication with relative paths as they are relative to your
current working directory. And that depends on the way your application is
started and it might change inside your application. But mostly it will be
set to your executable on start so you can ignore that problem while
developing.
When inside VisualStudio the current working directory is set to your
project files location unless you overwrite Project properties - Debugging
- Working Directory. In Irrlicht examples the media folder is on most
platforms ../../media which works for the examples as it's relative to our
project files as well as to the binary (.exe) files.
Whatever you chose to find your base-folder for media - wrap it with some
function and then you can improve the code to locate the media later on.
*/
const io::path mediaPath = getExampleMediaPath();
/*
To show something interesting, we load a Quake 2 model and display it.
We only have to get the Mesh from the Scene Manager with getMesh() and add
a SceneNode to display the mesh with addAnimatedMeshSceneNode(). We
check the return value of getMesh() to become aware of loading problems
and other errors.
We get the Mesh from the Scene Manager with getMesh() and add a SceneNode
to display the mesh with addAnimatedMeshSceneNode(). Check the return value
of getMesh() to become aware of loading problems and other errors.
Instead of writing the filename sydney.md2, it would also be possible
to load a Maya object file (.obj), a complete Quake3 map (.bsp) or any
@ -204,7 +232,7 @@ int main()
Ok, now we have set up the scene, lets draw everything: We run the
device in a while() loop, until the device does not want to run any
more. This would be when the user closes the window or presses ALT+F4
(or whatever keycode closes a window).
(or whatever keycode closes a window on your OS).
*/
while(device->run())
{