Horde3D Wiki - User contributions [en]

Tutorial - Hello World

2008-11-02T19:02:13Z

Dithi: Undo (the problem was with my app)

{| border="0"
| {{ContentBlock|width=800|color=white
|content='''In this section we will create a simple application that loads a character and animates it using a walk cycle. You will see how straightforward it is to use the Horde3D API.'''

As a first step you have to create an application that opens a window which can be used for rendering. This is a pretty standard task and if you are a novice and have problems with that on your platform use Google to find one of the numerous good tutorials on the net or have a look at the samples that come with the Horde3D SDK. The next step is to initialize an OpenGL context for our rendering window. You can do this manually or use the Horde3D Utility Library to make your life easier. After that is done we can finally get to the engine related part.

{{CppSourceCode|
description= Simple Setup of the Horde3D renderer.|
code=
<source lang="cpp" line="1">
NodeHandle model = 0, cam = 0;

void initGame( int winWidth, int winHeight )
{
// Initialize engine
Horde3D::init();
Horde3D::resize( 0, 0, winWidth, winHeight );

// Add pipeline resource
ResHandle pipeRes = Horde3D::addResource( ResourceTypes::Pipeline, "standard.pipeline.xml", 0 );
// Add model resource
ResHandle modelRes = Horde3D::addResource( ResourceTypes::SceneGraph, "character.scene.xml", 0 );
// Add animation resource
ResHandle animRes = Horde3D::addResource( ResourceTypes::Animation, "walk.anim.xml", 0 );
// Load added resources
Horde3DUtils::loadResourcesFromDisk( "" );

// Add model to scene
model = Horde3D::addNodes( RootNode, modelRes );
// Apply animation
Horde3D::setupModelAnimStage( model, 0, animRes, "" );

// Add light source
NodeHandle light = Horde3D::addLightNode( RootNode, "Light1", 0, "LIGHTING", "SHADOWMAP" );
// Set light position and radius
Horde3D::setNodeTransform( light, 0, 20, 0, 0, 0, 0, 1, 1, 1 );
Horde3D::setLightParam( light, LightNodeParams::Radius, 50.0f );

// Add camera
NodeHandle cam = Horde3D::addCameraNode( RootNode, "Camera", pipeRes );
}
</source>
}}

The first line of the code above declares two global handles to Horde scene graph nodes. All objects in Horde are accessible via handles, a concept similar to pointers. The first thing we need to do in our initGame function to use Horde3D is initializing the engine. This happens with the function init. After that we tell the engine the size of our rendering window so that it can adjust the viewport.

The next step is to load the required resources. In Horde resources are data files that are loaded once and can be referenced by several objects for rendering. The function addResource takes the resource type we want to add and the name of the resource (usually the filename) as parameters and returns a handle to the created resource object. In our case we want a model which is represented as a scene graph file in Horde and additionally an animation. Now the resources are created but we still need to load them. Horde supports loading from any sources including encrypted archives or a network but in this case we just want to load our resources from the local hard disk which is done with the utility function loadResourcesFromDisk. Besides our model and animation we also load a pipeline resource. A pipeline defines how the the scene is rendered and can be used to realize post-processing effects or high dynamic range rendering. For the beginning you can just use the files that come with the SDK samples.

After we have loaded the required resources we can finally build up the scene graph. The scene graph represents the objects in our virtual world in a hierarchical tree structure. First we add the model that we have loaded before. We use the function addNodes for doing this which takes a scene graph resource and a parent node. The parent is the scene object to which the new node is attached, in our case just the root node which is the base of the virtual world. Similar to addResource this function also returns a handle to the created scene graph subtree. After that we assign the loaded animation to our model node with the function setupModelAnimStage. Horde allows you to apply several different animations to a model and makes it possible to blend and mix them but for the beginning one should be enough. Now that adding the model is finished we still need a light source. It would be possible to load another scene graph file which contains the light source but we want to add it manually by using the addLightNode function. This function requires several parameters specifying the shaders used for rendering. More information on this can be found in other sections of the manual. The next step is to set the position and orientation which is done with setNodeTransform. After that we specify the light radius which defines the zone of influence using setLightParam. Finally we still need a camera which represents the viewer. It is added with the function addCameraNode and takes our loaded pipeline resource as parameter.

{{CppSourceCode|
description= Game Loop and Destructor|
code=
<source lang="cpp" line="1">
void gameLoop( float fps )
{
static float t = 0;

// Increase animation time
t = t + 10.0f * (1 / fps);

// Play animation
Horde3D::setModelAnimParams( model, 0, t, 1.0f );

// Set new model position
Horde3D::setNodeTransform( model, t * 10, 0, 0, // Translation
0, 0, 0, // Rotation
1, 1, 1 ); // Scale

// Render scene
Horde3D::render( cam );
}

void releaseGame()
{
// Release engine
Horde3D::release();
}
</source>
}}

The next function in our sample is the game loop which is called once every frame. Here we will animate our character model. For doing this we define a time counter which is increased in every frame. To make the animation speed independent from the framerate, we scale the time step by the inverse of the current frames per second value. After that we tell the engine to update the model animation using the setModelAnimParams function. We could also specify a blend weight for combining animations here but since we have only one animation we don't need that. Now we can displace our character a bit so that it moves through the scene. This is achieved by updating the model node transformation. Finally we need to tell the engine to render the scene and recalculate the model animation. This happens with the function render that expects the camera from which the scene is viewed.

The last function releaseGame is called when the application is closed. All we have to do here is freeing the engine with the release function.

That's it so far with the basic tutorial. You can have a look at the Usage Guide now to learn more details.
}}
| valign="top" | {{Extension_Summary|
name = Hello World Tutorial|
screenshot = H3DPlaceHolder.png|
description = This tutorial introduces the basic steps necessary to setup horde3d|
version = 1.0|
horde3dversion = 1.0 beta|
released = 2008-03-30|
author = Nicolas Schulz|
}}
|}
[[category: Tutorials]]

Tutorial - Hello World

2008-11-02T18:36:26Z

Dithi: Fix

{| border="0"
| {{ContentBlock|width=800|color=white
|content='''In this section we will create a simple application that loads a character and animates it using a walk cycle. You will see how straightforward it is to use the Horde3D API.'''

As a first step you have to create an application that opens a window which can be used for rendering. This is a pretty standard task and if you are a novice and have problems with that on your platform use Google to find one of the numerous good tutorials on the net or have a look at the samples that come with the Horde3D SDK. The next step is to initialize an OpenGL context for our rendering window. You can do this manually or use the Horde3D Utility Library to make your life easier. After that is done we can finally get to the engine related part.

{{CppSourceCode|
description= Simple Setup of the Horde3D renderer.|
code=
<source lang="cpp" line="1">
NodeHandle model = 0, cam = 0;

void initGame( int winWidth, int winHeight )
{
// Initialize engine
Horde3D::init();
Horde3D::resize( 0, 0, winWidth, winHeight );

// Add pipeline resource
ResHandle pipeRes = Horde3D::addResource( ResourceTypes::Pipeline, "standard.pipeline.xml", 0 );
// Add model resource
ResHandle modelRes = Horde3D::addResource( ResourceTypes::SceneGraph, "character.scene.xml", 0 );
// Add animation resource
ResHandle animRes = Horde3D::addResource( ResourceTypes::Animation, "walk.anim.xml", 0 );
// Load added resources
Horde3DUtils::loadResourcesFromDisk( "" );

// Add model to scene
model = Horde3D::addNodes( RootNode, modelRes );
// Apply animation
Horde3D::setupModelAnimStage( model, 0, animRes, "" );

// Add light source
NodeHandle light = Horde3D::addLightNode( RootNode, "Light1", 0, "LIGHTING", "SHADOWMAP" );
// Set light position and radius
Horde3D::setNodeTransform( light, 0, 20, 0, 0, 0, 0, 1, 1, 1 );
Horde3D::setLightParam( light, LightNodeParams::Radius, 50.0f );

// Add camera
NodeHandle cam = Horde3D::addCameraNode( RootNode, "Camera", pipeRes );
}
</source>
}}

The first line of the code above declares two global handles to Horde scene graph nodes. All objects in Horde are accessible via handles, a concept similar to pointers. The first thing we need to do in our initGame function to use Horde3D is initializing the engine. This happens with the function init. After that we tell the engine the size of our rendering window so that it can adjust the viewport.

The next step is to load the required resources. In Horde resources are data files that are loaded once and can be referenced by several objects for rendering. The function addResource takes the resource type we want to add and the name of the resource (usually the filename) as parameters and returns a handle to the created resource object. In our case we want a model which is represented as a scene graph file in Horde and additionally an animation. Now the resources are created but we still need to load them. Horde supports loading from any sources including encrypted archives or a network but in this case we just want to load our resources from the local hard disk which is done with the utility function loadResourcesFromDisk. Besides our model and animation we also load a pipeline resource. A pipeline defines how the the scene is rendered and can be used to realize post-processing effects or high dynamic range rendering. For the beginning you can just use the files that come with the SDK samples.

After we have loaded the required resources we can finally build up the scene graph. The scene graph represents the objects in our virtual world in a hierarchical tree structure. First we add the model that we have loaded before. We use the function addNodes for doing this which takes a scene graph resource and a parent node. The parent is the scene object to which the new node is attached, in our case just the root node which is the base of the virtual world. Similar to addResource this function also returns a handle to the created scene graph subtree. After that we assign the loaded animation to our model node with the function setupModelAnimStage. Horde allows you to apply several different animations to a model and makes it possible to blend and mix them but for the beginning one should be enough. Now that adding the model is finished we still need a light source. It would be possible to load another scene graph file which contains the light source but we want to add it manually by using the addLightNode function. This function requires several parameters specifying the shaders used for rendering. More information on this can be found in other sections of the manual. The next step is to set the position and orientation which is done with setNodeTransform. After that we specify the light radius which defines the zone of influence using setLightParam. Finally we still need a camera which represents the viewer. It is added with the function addCameraNode and takes our loaded pipeline resource as parameter.

{{CppSourceCode|
description= Game Loop and Destructor|
code=
<source lang="cpp" line="1">
static float t = 0;

void gameLoop( float fps )
{
// Increase animation time
t = t + 10.0f * (1 / fps);

// Play animation
Horde3D::setModelAnimParams( model, 0, t, 1.0f );

// Set new model position
Horde3D::setNodeTransform( model, t * 10, 0, 0, // Translation
0, 0, 0, // Rotation
1, 1, 1 ); // Scale

// Render scene
Horde3D::render( cam );
}

void releaseGame()
{
// Release engine
Horde3D::release();
}
</source>
}}

The next function in our sample is the game loop which is called once every frame. Here we will animate our character model. For doing this we define a time counter which is increased in every frame. To make the animation speed independent from the framerate, we scale the time step by the inverse of the current frames per second value. After that we tell the engine to update the model animation using the setModelAnimParams function. We could also specify a blend weight for combining animations here but since we have only one animation we don't need that. Now we can displace our character a bit so that it moves through the scene. This is achieved by updating the model node transformation. Finally we need to tell the engine to render the scene and recalculate the model animation. This happens with the function render that expects the camera from which the scene is viewed.

The last function releaseGame is called when the application is closed. All we have to do here is freeing the engine with the release function.

That's it so far with the basic tutorial. You can have a look at the Usage Guide now to learn more details.
}}
| valign="top" | {{Extension_Summary|
name = Hello World Tutorial|
screenshot = H3DPlaceHolder.png|
description = This tutorial introduces the basic steps necessary to setup horde3d|
version = 1.0|
horde3dversion = 1.0 beta|
released = 2008-03-30|
author = Nicolas Schulz|
}}
|}
[[category: Tutorials]]

Tutorial - Setup Horde with SDL

2008-10-26T02:23:30Z

Dithi: make it work

{| border="0"
| {{ContentBlock|width=800|color=white
|content='''Here is a small example on how to use Horde with sdl.'''
Its a simple window that closes when the x is clicked
{{CppSourceCode|
description= Simple SDL Frame|
code=
<source lang="cpp" line="1">

#include <iostream>
#include <Horde3DUtils.h>
#include <SDL.h>

using namespace std;

NodeHandle model = 0, cam = 0;

int main(int argc, char* args[]){
//Creates are bool value for the while loop.
bool running = true;

//Inits sdl with only the video extention.
if (SDL_Init(SDL_INIT_VIDEO) != 0) {
std::cerr << "SDL_Init failed: " << SDL_GetError() << std::endl;
return 0;
}

//Sets are window Caption
SDL_WM_SetCaption("Simple SDL Frame",NULL);

//Sets the sdl video mode width and height as well has creates are opengl context.
if (!SDL_SetVideoMode(800,600,32,SDL_OPENGL)) {
std::cerr << "SDL_SetVideoMode failed: " << SDL_GetError() << std::endl;
return 0;
}

//Creates Our Event Reciver
SDL_Event event;

//Inits Horde3D
Horde3D::init();

//Sizes the Horde3D View
Horde3D::resize( 0, 0, 800, 600 );

// Add pipeline resource
ResHandle pipeRes = Horde3D::addResource( ResourceTypes::Pipeline, "standard.pipeline.xml", 0 );
// Add model resource
ResHandle modelRes = Horde3D::addResource( ResourceTypes::SceneGraph, "character.scene.xml", 0 );
// Add animation resource
ResHandle animRes = Horde3D::addResource( ResourceTypes::Animation, "walk.anim.xml", 0 );
// Load added resources
Horde3DUtils::loadResourcesFromDisk( "" );

// Add model to scene
model = Horde3D::addNodes( RootNode, modelRes );
// Apply animation
Horde3D::setupModelAnimStage( model, 0, animRes, "", false );

// Add light source
NodeHandle light = Horde3D::addLightNode( RootNode, "Light1", 0, "LIGHTING", "SHADOWMAP" );
// Set light position and radius
Horde3D::setNodeTransform( light, 0, 20, 0, 0, 0, 0, 1, 1, 1 );

//Sets the lightnodes radius
Horde3D::setNodeParamf( light, LightNodeParams::Radius, 50 );
//Sets the lightnodes Field of view
Horde3D::setNodeParamf( light, LightNodeParams::FOV, 90 );
//Sets the lightnodes ShadowMapCOunt
Horde3D::setNodeParami( light, LightNodeParams::ShadowMapCount, 3 );
//Sets the lightnodes ShadowSplitLambda
Horde3D::setNodeParamf( light, LightNodeParams::ShadowSplitLambda, 0.9f );
//Sets the lightnodes ShadowMapBias
Horde3D::setNodeParamf( light, LightNodeParams::ShadowMapBias, 0.001f );
//Sets the lightnodes red value
Horde3D::setNodeParamf( light, LightNodeParams::Col_R, 0.9f );
//Sets the lightnodes green value
Horde3D::setNodeParamf( light, LightNodeParams::Col_G, 0.7f );
//Sets the lightnodes blue value
Horde3D::setNodeParamf( light, LightNodeParams::Col_B, 0.75f );

// Add camera
cam = Horde3D::addCameraNode( RootNode, "Camera", pipeRes );

// Our While loop
while(running == true){
static float t = 0;

// Increase animation time
t = t + 10.0f * (1 / 60);
//Checks if there is a event that needs processing
if(SDL_PollEvent(&event)){
//Checks to see if the event is a SDL_QUIT*x on the window is clicked*
if(event.type == SDL_QUIT){
//Sets the while loop to false and ends program
running = false;
}
}

// Play animation
Horde3D::setModelAnimParams( model, 0, t, 1.0f );

// Set new model position
Horde3D::setNodeTransform( model, t * 10, 0, 0, // Translation
0, 0, 0, // Rotation
1, 1, 1 ); // Scale
// Render scene
Horde3D::render( cam );

//Swaps the sdl opengl buffers
SDL_GL_SwapBuffers();
}
//Releases the Horde3D Engine
Horde3D::release();
//Releases SDL and quits the program
SDL_Quit();

}

</source>
}}
--[[User:Wild13|Rj]] 05:28, 1 August 2008 (CEST)
}}
| valign="top" | {{Extension_Summary|
name = Horde With SDL|
screenshot = H3DPlaceHolder.png|
description = This tutorial introduces the use of Horde3D with SDL|
version = 1.0|
horde3dversion = 1.0 beta|
released = 2008-07-31|
author = Raynaldo Rivera|
}}
|}
[[category: Tutorials]]