Horde3D Wiki - User contributions [en]

Sound Extension

2009-03-18T15:13:38Z

Fidora:

Community Branch

2009-01-31T15:48:09Z

Fidora:

== Community SVN Branch ==

For a better integration of the community work we started a community SVN server branch.

The new [http://mm-werkstatt.informatik.uni-augsburg.de/public/Horde3D repository] is provided by the [http://mm-werkstatt.informatik.uni-augsburg.de University of Augsburg]

To get informed about recent changes you can use the [http://cia.vc/stats/project/Horde3D CIA service].

If you want to become part of the community and want to have write access, you can ask [http://horde3d.org/forums/memberlist.php?mode=viewprofile&u=122 Volker] to create an account for you.

'''Of course there are some restrictions:'''

You are not allowed to upload copyright protected files. You should commit only tested things and should not upload code that does not compile on your own development platform. If you are not sure if things you've developed are running on other platforms please post some details about your submission in the [http://horde3d.org/forums/viewforum.php?f=8 development section] on the [http://horde3d.org/forums/ forums], so other people get informed and can test it on their platforms.

We can only accept code that is distributed under the LGPL license and assume that your submission is under that license.

=== What's in ===

Currently the community trunk branch contains nearly the same Horde3D version as the SF trunk branch. We will always try to keep the branches in sync, but since more people have write access to the community branch it may differ sometimes in some features that are not yet overtaken into the other branch.
Next to Horde3D itself, the community branch contains more language bindings, tools and non graphics related extensions. Currently there are a [[Sound Extension | Sound Extension]], a [http://mm-werkstatt.informatik.uni-augsburg.de/projects/GameEngine/ GameEngine Based on Components] and the [[Horde3D Scene Editor | Horde3D Scene Editor]].

Template:Filmstrip

2009-01-27T16:02:37Z

Fidora:

Extensions

2009-01-27T16:00:50Z

Fidora:

==List of all the available extensions for Horde3D==

*[[Terrain Extension]]
*[[Sound Extension]]

Sound Extension

2009-01-27T16:00:18Z

Fidora: New page: category: Extensions {| border="0" | {{ContentBlock|width=800|color=white |content= The Sound Extension extends Horde3D with the capability of 3D positional audio with the help of Ope...

[[category: Extensions]]
{| border="0"
| {{ContentBlock|width=800|color=white |content=
The Sound Extension extends Horde3D with the capability of 3D positional audio with the help of OpenAL. It was designed to integrate as nicely as possible with Horde3D, therefore it comes with some limitations, such as the lack of streaming sound support. This means the whole audio file will be read and decoded all at once, which can be quite time consuming for larger files.

The extension currently decodes ogg vorbis and wave audio files but decoders for more formats can quite easily be implemented. See the decoder.h file for documentation on how to implement more audio decoders.

= Installation Windows =
To install the extension, copy the Extensions directory to the path where the Horde3D SDK resides.

If your version of Horde3D SDK is <= 1.0.0 Beta 2 you will need to apply this patch:

<pre>
--- Bindings/C++/Horde3D.h Sun Sep 14 21:50:46 2008
+++ Bindings/C++/Horde3D.h Tue Dec 09 08:44:13 2008
@@ -791,11 +791,11 @@
res - handle to the resource

Returns:
type of the resource
*/
- DLL ResourceTypes::List getResourceType( ResHandle res );
+ DLL int getResourceType( ResHandle res );

/* Function: getResourceName
Returns the name of a resource.

This function returns a pointer to the name of a specified resource. If the resource handle
@@ -823,11 +823,11 @@
name - name of the resource

Returns:
handle to the resource or 0 if not found
*/
- DLL ResHandle findResource( ResourceTypes::List type, const char *name );
+ DLL ResHandle findResource( int type, const char *name );

/* Function: addResource
Adds a resource.

This function tries to add a resource of a specified type and name to the resource manager. If
@@ -842,11 +842,11 @@
flags - flags used for creating the resource

Returns:
handle to the resource to be added or 0 in case of failure
*/
- DLL ResHandle addResource( ResourceTypes::List type, const char *name, int flags );
+ DLL ResHandle addResource( int type, const char *name, int flags );

/* Function: cloneResource
Duplicates a resource.

This function duplicates a specified resource. In the cloning process a new resource with the
--- Source/Horde3DEngine/egMain.cpp Wed Sep 03 00:28:10 2008
+++ Source/Horde3DEngine/egMain.cpp Tue Dec 09 08:44:13 2008
@@ -236,11 +236,11 @@

// *********************************************************************************************
// Resource functions
// *********************************************************************************************

- DLLEXP ResourceTypes::List getResourceType( ResHandle res )
+ DLLEXP int getResourceType( ResHandle res )
{
Resource *r = Modules::resMan().resolveResHandle( res );

if( r != 0x0 ) return r->getType();
else
@@ -264,20 +264,20 @@
return &emptyString;
}
}

- DLLEXP ResHandle findResource( ResourceTypes::List type, const char *name )
+ DLLEXP ResHandle findResource( int type, const char *name )
{
Resource *res = Modules::resMan().findResource( type, safeStr( name ) );

if( res != 0x0 ) return res->getHandle();
else return 0;
}

- DLLEXP ResHandle addResource( ResourceTypes::List type, const char *name, int flags )
+ DLLEXP ResHandle addResource( int type, const char *name, int flags )
{
return Modules::resMan().addResource( type, safeStr( name ), flags, true );
}

--- Source/Horde3DEngine/egResource.cpp Wed Sep 03 00:28:10 2008
+++ Source/Horde3DEngine/egResource.cpp Tue Dec 09 08:42:30 2008
@@ -37,11 +37,11 @@

// **********************************************************************************
// Class Resource
// **********************************************************************************

-Resource::Resource( ResourceTypes::List type, const string &name, int flags )
+Resource::Resource( int type, const string &name, int flags )
{
_type = type;
_name = name;
_handle = 0;
_loaded = false;
@@ -192,11 +192,11 @@
// Initialize resource type
if( inf != 0 ) (*inf)();
}

-Resource *ResourceManager::findResource( ResourceTypes::List type, const string &name )
+Resource *ResourceManager::findResource( int type, const string &name )
{
for( uint32 i = 0; i < _resources.size(); ++i )
{
if( _resources[i] != 0x0 && _resources[i]->_type == type && _resources[i]->_name == name )
{
@@ -226,11 +226,11 @@
_resources.push_back( &resource );
return resource._handle;
}

-ResHandle ResourceManager::addResource( ResourceTypes::List type, const string &name,
+ResHandle ResourceManager::addResource( int type, const string &name,
int flags, bool userCall )
{
if( name == "" || name.find( ":" ) != string::npos )
{
Modules::log().writeDebugInfo( "Invalid name for added resource of type %i", type );
--- Source/Horde3DEngine/egResource.h Wed Sep 03 00:28:10 2008
+++ Source/Horde3DEngine/egResource.h Tue Dec 09 08:42:30 2008
@@ -65,11 +65,11 @@

class Resource
{
protected:

- ResourceTypes::List _type;
+ int _type;
string _name;
ResHandle _handle;
bool _loaded;
bool _noQuery;
int _flags;
@@ -77,11 +77,11 @@
uint32 _refCount; // Number of other objects referencing to this resource
uint32 _userRefCount; // Number of handles created by user

public:

- Resource( ResourceTypes::List type, const string &name, int flags );
+ Resource( int type, const string &name, int flags );
virtual ~Resource();
virtual Resource *clone(); // TODO: Implement this for all resource types

virtual void initDefault();
virtual void release();
@@ -96,11 +96,11 @@
virtual bool setParamstr( int param, const char *value );

virtual const void *getData( int param );
virtual bool updateData( int param, const void *data, int size );

- ResourceTypes::List &getType() { return _type; }
+ int &getType() { return _type; }
const string &getName() { return _name; }
ResHandle getHandle() { return _handle; }
bool isLoaded() { return _loaded; }
void addRef() { ++_refCount; }
void subRef() { --_refCount; }
@@ -169,12 +169,12 @@
~ResourceManager();

void registerType( int type, const string &typeString, ResTypeInitializationFunc inf,
ResTypeReleaseFunc rf, ResTypeFactoryFunc ff );

- Resource *findResource( ResourceTypes::List type, const string &name );
- ResHandle addResource( ResourceTypes::List type, const string &name, int flags, bool userCall );
+ Resource *findResource( int type, const string &name );
+ ResHandle addResource( int type, const string &name, int flags, bool userCall );
ResHandle addNonExistingResource( Resource &resource, bool userCall );
ResHandle cloneResource( ResHandle sourceRes, const string &name );
int removeResource( ResHandle handle, bool userCall );
void clear();
ResHandle queryUnloadedResource( int index );
</pre>

In Visual Studio, add the extension, sample, ogg, vorbis and vorbisfile projects to the Horde3D solution. Then add the extension project to the project dependencies of the Horde3D Engine and the Horde3D Engine to the dependencies of the Sound Sample. After that, include 'Sound/Source/extension.h' in 'egExtensions.cpp' of the engine and add '#pragma comment( lib, "Extension_Sound.lib" )' to link against the sound extension (under Windows).
Finally, add the following line to ExtensionManager::installExtensions to register the extension:

<pre>
installExtension( Horde3DSound::getExtensionName, Horde3DSound::initExtension, Horde3DSound::releaseExtension );
</pre>

The extension is then part of the Horde3D DLL and can be used with the Horde3DSound.h header file.

= Using the extension =
When using the extension a sound device needs to be opened for playback, then a listener node needs to be created and activated. The activated listener node will act as the ears and all 3D sound calculations will be based on that node's position and orientation. Then you can start creating sound resources, attaching them to sound nodes and start playing the nodes.

OpenAL will need to be installed to be able to run any applications using the Sound Extension.

= Obtaining the extension =
The extension can either be downloaded [http://mm-werkstatt.informatik.uni-augsburg.de/downloads/Horde3D_ExtSound_1.0.zip here] or from the community svn.

}} 
| valign="top" |{{Extension_Summary|
name = Sound Extension|
screenshot = H3Dsound.jpg|
description = The Sound Extension extends Horde3D with the capability of 3D positional audio.|
version = 1.0|
horde3dversion = 1.0.0 Beta 2|
released = 2009-01-27|
author = Ulf Nilsson Tännström|
}}
|}

File:H3Dsound.jpg

2009-01-27T15:58:18Z

Fidora: screenshot of the sound extension's sample

screenshot of the sound extension's sample

Basic Pipeline Tutorial

2009-01-04T12:53:11Z

Fidora:

{| border="0"
| {{ContentBlock|width=800|color=white
|content={{!!}}

== Overview ==
In this tutorial, I will try to show you how the Horde3D pipeline system works. At the first look, when you haven't really work with an advanced pipeline system before, it may look a little bit complicated, but I will show how user friendly it is and how this powerful tool is useful.

'''Requirements:'''<BR/>
- The Horde3D SDK 1.0.0 Beta2

== Creating the pipeline ==
First of all, I will show you how to create a really basic pipeline with only one context. For this, we will use the chicago example in the Horde3D SDK to see how the pipeline and his context can affect a scene. If you use Visual Studio, open the "Horde3D.sln" file to get into the chicago sample, oterwhise use your configuration to open the chicago example or edit each files in your favorite editor. In the "app.cpp" file, we will change the foward pipeline resource to take our custom pipeline instead of the foward pipeline, so in the Application::init() function change this line:

{{CppSourceCode|
description= Old code|
code=
<source lang="cpp" line="1">

_forwardPipeRes = Horde3D::addResource( ResourceTypes::Pipeline, "forward.pipeline.xml", 0 );
</source>}}
<BR/>
<BR/>

to this line:

{{CppSourceCode|
description= New code code|
code=
<source lang="cpp" line="1">
_forwardPipeRes = Horde3D::addResource( ResourceTypes::Pipeline, "myPipeline.pipeline.xml", 0 );
</source>}}
<BR/>
<BR/>

Now, we need to create the "myPipeline.pipeline.xml" file. Go in the "Horde3D\Binaries\Content\pipelines" folder, and create a file named "myPipeline.pipeline.xml" . Open this file and add this :

{{CppSourceCode|
description= myPipeline.pipeline.xml|
code=
<source lang="cpp" line="1">
<Pipeline>
<CommandQueue>

<Stage id="FirstStage" link="globalSettings.material.xml">
<SwitchTarget target="" />
<ClearTarget depthBuf="true" colBuf0="true" />

<DrawGeometry context="AMBIENTCOLOR" class="" />

</Stage>

</CommandQueue>
</Pipeline>
</source>}}
<BR/>
<BR/>

I have tried to make this pipeline as simple as possible. I will explain how it works :

{{CppSourceCode|
description= Pipeline tag|
code=
<source lang="cpp" line="1">
<Pipeline>
</Pipeline>
</source>}}

This tag means that its child tags gonna be pipeline tags related.

<BR/>
<BR/>
{{CppSourceCode|
description= CommandQueuetag tag|
code=
<source lang="cpp" line="1">
<CommandQueue>
</CommandQueue>
</source>}}

This tag means that its child tags gonna be related to direct rendering tags.

<BR/>
<BR/>
{{CppSourceCode|
description= Stage tag|
code=
<source lang="cpp" line="1">
<Stage id="FirstStage" link="globalSettings.material.xml">
</Stage>
</source>}}

The stage is here to include a series of actions, and you can have multiple stages if you want, even if in this example we have only one. It is useful since you can disable or enable a stage within an Horde3D function, and you can link it a material within the optional "link" attribute. If you want, you can look at the "globalSettings.material.xml" file to see what it contains, and if everyting is normal, you should see that a cube map is binded to the texture unit 7, this gonna be the ambient texture that will determine the ambient color of the scene. Finally, for each stages, don't forget to add an id, and in this example the id gonna be "FirstStage".

<BR/>
<BR/>
{{CppSourceCode|
description= SwitchTarget tag|
code=
<source lang="cpp" line="1">
<SwitchTarget target="" />
</source>}}

This tag is useful to designate a render target. It can be a buffer, but in this example we don't have any buffers so the target is the screen. An empty "target" means that everyhing next, until a new "SwitchTarget" tag, gonna be rendered on the screen. When you use a buffer as a target, it is not rendered on the screen, so an empty "target" attribute is required somewhere for each pipelines.

<BR/>
<BR/>
{{CppSourceCode|
description= ClearTarget tag|
code=
<source lang="cpp" line="1">
<ClearTarget depthBuf="true" colBuf0="true" />
</source>}}

This tag is used to clear the content of the current target. The attribute "depthBuf" is used to determine if you want to clear the depth buffer of the target, and each "colBufX" is an attribute to clear the specified color buffer of the target. In this example, we use only one color buffer.

<BR/>
<BR/>
{{CppSourceCode|
description= DrawGeometry tag|
code=
<source lang="cpp" line="1">
<DrawGeometry context="AMBIENTCOLOR" class="" />
</source>}}

This tag mean that you want to draw geometries in the current target. The "context" attribute designate the shader used to render the geometry. It is directly linked to the .shader.xml of each materials of each geometries. If a geometry linked to a material don't have this context in his shader file, the geometry won't be rendered. The class attribute linked to the material file, and an empty "class" attribute means that each class will be used.

<BR/>
<BR/>

Now you have to compile the chicago example. Go in the "build" folder, and copy the new executable in the "win32" folder of the SDK. If you execute this example you should see nothing. If you look at the engine log and there is no error, it means that everyhing have been rightly done. If you see a black screen, it's because there is no "AMBIENTCOLOR" in each shader linked to each geometry. You have to add this context to each used shaders.

In the chicago sample, three shaders are used : one for the animated model one for the sky and one for the parform. Open the "skinning.shader.xml" file since it's the shader used for the animated man. Next, you have to add this within the "shader" tag:
{{CppSourceCode|
description= Shader|
code=
<source lang="cpp" line="1">
<Context id="AMBIENTCOLOR">
<VertexShader>
<InsCode code="utilityLib/vertCommon.glsl" />
<DefCode>
<![CDATA[
// Those attributes are given by the Horde3D context
attribute vec2 texCoords0; // Tex coordinate
attribute vec3 normal; // The normal vector of the vertex

varying vec2 vTextCoords; // Tex coordinate
varying vec3 vNormal; // The normal in world space

void main( void )
{

// Get the world position of the vertex. At his initial position, gl_Vertex is in object space,
// so we must transform his initial position to get the world position
vec4 pos = calcWorldPos( gl_Vertex );

// Get the normal in the world space from the object space
vNormal = calcWorldVec( normal );

// Get the tex coordinate
vTextCoords = texCoords0;

// The gl_ModelViewProjectionMatrix contain two matrices. The first one is the modelview matrix, and
// within the horde3d context, this matrix transform a position into the view space, or camera space.
// To get the view space position with this matrix, you must first get the world position of the vertex before.
// The second matrix is the projection matrix, it is used to project the image into clipping space.
gl_Position = gl_ModelViewProjectionMatrix * pos;
}
]]>
</DefCode>
</VertexShader>

<FragmentShader>
<DefCode>
<![CDATA[
uniform sampler2D tex0; // This is the first texture, it is defined within the material file of the man
uniform samplerCube tex7; // This texture is from the global setting material that we have linked in the pipeline file
varying vec3 vNormal; // The normal in world space
varying vec2 vTextCoords; // The tex coordinate

void main( void )
{
// Get the texture color of the current texel
vec3 albedo = texture2D( tex0, vTextCoords ).rgb;

// Get the ambient color of the texel within the ambient cubemap defined in the "globalSettings.material.xml" file.
vec3 ambient = textureCube( tex7, vNormal ).rgb;

// Get the final texel color by mixing the ambient and the albedo color
gl_FragColor.rgb = albedo * ambient;
}
]]>
</DefCode>
</FragmentShader>
</Context>
</source>}}
<BR/>
<BR/>

As you can see, the id of the context tag is "AMBIENTCOLOR", exactly like the context in our pipeline. It means that within this context this shader will be executed for the current geometry. Then, you have the "InsCode" tag. It is here to insert the "vertCommon.glsl" file wich contain some really useful functions for the vertex shader, like "calcWorldVec()" and "calcWorldPos()". Finally, I have tried to make the vertex and the pixel shader self-explained, so you can read them if you want to learn how basically the context for the shader is within Horde3D.

Now you can execute the chicago sample and you should see each man moving, but they sould not have any animations because, in the shader, we don't use skinning. If you want to learn how skining work with Horde3D, look at the shader within the "AMBIENT" context of the file, and you should see the difference between both vertex shaders. For the other two shaders, the one for the sly and the one for the platform, you can copy the "AMBIENT" context of each shaders file and name them "AMBIENTCOLOR" to see them in the scene.

== Conclusion ==

Finally, I have tried to make this tutorial as simple as possible, with a basic pipeline, so that it shouldn't be too hard for any programmers to learn how the pipeline system work. It's why there is no lighting or multiple buffers, but with the basics, you can learn more by yourself by looking at any of the others Horde3D SDK pipelines and by trying things by yourself!

}}
| valign="top" | {{Extension_Summary
|name = Tutorial - Basic Pipeline Tutoial
|screenshot =
|description = A basic pipeline tutorial
|version = 1.0
|horde3dversion = 1.0 beta 2
|released = 2009-01-04
|author = [http://www.horde3d.org/forums/memberlist.php?mode=viewprofile&u=154 Mikmacer]|
}}
|}
[[category: Tutorial]]