__NOEDITSECTION__ __NOTOC__

{{Filmstrip}}
{{SpacerBlock|1|1}}
{{ContentBlock | width=100% | thickness=1 | color=#999999 | content-color=#ffffcc | content=
'''Welcome to the Horde3D Wiki!'''
As this is a wiki, feel free to make it better! The Horde3D team does not take any responsibility for the content or the accuracy of the content provided on these pages.
}}
{{SpacerBlock|1|1}}

{| width=100% border=0
| valign="top" |

{{ContentBlock | width=100% | icon=Download45.png | header=Getting Started
| sub-header=Overview of the project and how to get started
| content={{!!}}
* [[Overview | Overview]] - Introduction for beginners
* [[Horde3D_Wiki:Getting Started | Installation]] - Acquisition and setup
* [[Language Bindings]] - C#, Lua, Python, ...
}}
{{SpacerBlock|1|1}}
{{ContentBlock | width=100% | color=#FFCC33 | icon=InfoIcon.png | header=Programming
| sub-header=Useful information for programmers
| content={{!!}}
* [[Horde3D_Wiki:Community_Portal#Programming Guide | Tutorials]] - A wide variety of tutorials
** [[Horde3D_Wiki:Community_Portal#Programming Guide | Integration]] - Integration with SDL, Qt, ...
** [[Horde3D_Wiki:Community_Portal#Shader Guide | Pipeline]] - Shader and effect development
* [[Horde3D_Wiki:HOWTO | Recipes]] - How-tos and small code snippets
}}
{{SpacerBlock|1|1}}
{{ContentBlock | width=100% | color=#FFCC33 | icon=InfoIcon.png | header=Content Creation
| sub-header=Useful information for artists
| content={{!!}}
* [[Horde3D_Wiki:Community_Portal#Asset Creation | Tutorials]] - A wide variety of tutorials
** [[Horde3D_Wiki:Community_Portal#Asset Creation | Production Pipeline]] - Get the most out of your tools
* [[Resources]] - Free models and textures
}}

| valign="top" |

{{ContentBlock | width=100% | icon=HighlightIcon.png | header=Documentation
| sub-header=Reference information and documentation
| content={{!!}}
* '''[http://horde3d.org/features.html Features & Requirements]''' - What Horde3D can do for you
* '''[http://horde3d.org/docs/manual.html Reference Manual]''' - The official manual
* [[Horde3D_Wiki:FAQ | FAQ]] - Frequently Asked Questions
* '''[[Glossary | Glossary]]''' - Terms and acronyms explained
}}
{{SpacerBlock|1|1}}
{{ContentBlock | width=100% | color=#FFCC33 | icon=DevIcon45.png | header=Development
| sub-header=These pages are of interest to developers of Horde3D
| content={{!!}}
*[[Community Roadmap | Roadmap]] - Progress and release information
*[[Community Branch | Contributing]] - Getting your code into Horde3D
*[[Platform Issues | Known Issues]] - List of known bugs
}}
{{SpacerBlock|1|1}}
{{ContentBlock | width=100% | icon=HighlightIcon.png | header=Related Projects
| sub-header=Software using or made for Horde3D
| content={{!!}}
* '''[[Horde3D Scene Editor | Horde3D Editor]]''' - Scene editor
* '''[[Extensions | Horde3D Extensions ]]''' - List of extensions
* '''[http://mm-werkstatt.informatik.uni-augsburg.de/projects/GameEngine/ Horde3D GameEngine]''' - Component based game engine
}}

|}

Template:Filmstrip

2013-09-19T00:23:32Z

Volker:

File:Offroad legends screenshot 1.jpg

2013-09-19T00:20:10Z

Volker: http://www.dogbytegames.com/images/offroad_legends_screenshot_1.jpg

http://www.dogbytegames.com/images/offroad_legends_screenshot_1.jpg

Language Bindings

2013-09-19T00:09:15Z

Volker:

Due to its simple 'C' DLL interface, Horde3D can be accessed from most programming and scripting languages without much effort.
The community has already created bindings for the following languages. Most of the bindings can be found in the [[Community Branch | Community SVN Branch]], however, not all of them are constantly maintained and up-to-date.

* '''C#'''
** Maintained by the Horde3D team
** Can be found on [http://sourceforge.net/projects/horde3d/files/Horde3D%20Language%20Bindings/ SourceForge] as well as in the Community Branch
* '''Lua'''
** In the Community Branch
** The Horde3D Editor has separate bindings as well that can be found [http://mm-werkstatt.informatik.uni-augsburg.de/public/Horde3D/trunk/Tools/Horde3DEditor/src/HordeSceneEditor/LuaBindingsHorde.cpp here]
* '''Python'''
** In the Community Branch
** See [http://www.horde3d.org/forums/viewtopic.php?f=1&t=313 this thread] for further info
* '''D'''
** Two independent bindings exist, both located in the Community Branch
** 1. Native bindings which redeclare the C API and are directly usable by linking against the Horde3D library (see [http://www.horde3d.org/forums/viewtopic.php?f=1&t=932 this thread])
** 2. Bindings using Derelict and function pointers (see [http://www.horde3d.org/forums/viewtopic.php?f=1&t=180 this thread])
* '''Pascal'''
** See [http://www.horde3d.org/forums/viewtopic.php?f=1&t=1058 this thread] for further info
* '''Squirrel'''
** In the Community Branch
** See [http://www.horde3d.org/forums/viewtopic.php?f=1&t=578 this thread] for further info
* '''Haskel'''
** See [http://www.horde3d.org/forums/viewtopic.php?f=1&t=550 this thread] for further info
* '''Java'''
** Available in [http://bitbucket.org/fk/horde3d-java/ Felix Krull's Mercurial repository]
** See [http://www.horde3d.org/forums/viewtopic.php?f=1&t=1093 this thread] for further info
* '''WinDev 15'''
** See [http://www.horde3d.org/forums/viewtopic.php?f=8&t=1173 this thread] for further info
* '''BlitzMax'''
** See [http://www.horde3d.org/forums/viewtopic.php?f=4&t=1236 this thread] for further info
* '''Go'''
** See [http://bitbucket.org/tshannon/gohorde/ this page] for further info
** The knight sample implemented with glfw in Go can be found [https://bitbucket.org/tshannon/gohorde/src/0f3d82c4f8b812d1a7c556b8a014af38e2c73285/examples/knight/knight.go?at=default here]
** And example in SDL can be found [https://bitbucket.org/tshannon/gohorde/src/0f3d82c4f8b812d1a7c556b8a014af38e2c73285/examples/sdl/sdl.go?at=default here]
* '''Lisp'''
** See [https://github.com/anwyn/cl-horde3d this git repo] for further info

2011-11-01T14:03:29Z

Volker:

2010-09-17T14:19:07Z

Volker:

__NOEDITSECTION__{{ContentBlock|color=white|content={{!!}}
The HOWTO contains quick answers for smaller problems.

__TOC__

== How to enable anti-aliasing (MSAA) ==

Anti-aliasing can only be enabled for render targets. The RenderTarget element used in Pipeline resources has an attribute '''maxSamples''' which defines the maximum number of samples used for MSAA. The actual number of samples is controlled by the engine option '''SampleCount'''. This makes it possible to control the anti-aliasing quality from the application. If SampleCount is set to zero, MSAA is disabled. Note that the hardware needs to support the EXT_framebuffer_multisample extension in order for the MSAA to work.

== How to get the size of a loaded texture ==

The following code queries the dimensions of the base mipmap of a loaded texture:
{{CppSourceCode|
description= C++ Code|
code=
<source lang="cpp" line="1">
int width = h3dGetResParamI( texResHandle, H3DTexRes::ImageElem, 0, H3DTexRes::ImgWidthI );
int height = h3dGetResParamI( texResHandle, H3DTexRes::ImageElem, 0, H3DTexRes::ImgHeightI );
</source>}}
If you want to get the dimensions of mipmap level ''n'', change the elemIdx parameter which is 0 above to ''n''.

== How to procedurally generate a texture ==

To generate a texture and bind it to a shader, you need to perform three steps:

First, create the texture handle, map data stream and write to it. Note that you need to perform this step '''before''' loading resources from disk (using <code>H3dutLoadResourcesFromDisk()</code>)! Otherwise, the texture creation will fail.
{{CppSourceCode|
description= C++ Code|
code=
<source lang="cpp" line="1">
H3DRes texRes = h3dCreateTexture( "myTexRes", 64, 64, H3DFormats::TEX_RGBA16F, H3DResFlags::NoTexMipmaps );
float *data = static_cast<float*>( h3dMapResStream( texRes, H3DTexRes::ImageElem, 0, H3DTexRes::ImgPixelStream, false, true ) );
for( int row=0; row<64; ++row )
{
float *rowPtr = data + row*64*4;
for( int col=0; col<64; ++col )
{
float *sample = rowPtr + col*4;
sample[0] = ...; // R
sample[1] = ...; // G
sample[2] = ...; // B
sample[3] = ...; // A
}
}
h3dUnmapResStream( texRes );
</source>}}

Second, to bind the texture to a shader, you need to include it in the material XML file like this:

<source lang="xml">
<Material>
<Shader source="shaders/myshader.shader" />
<Sampler name="myTexture" map="myTexRes" />
</Material>
</source>

Finally, to reference the sampler in the shader, you need to declare it like this:
{{CppSourceCode|
description= Shader Code|
code=
<source lang="cpp" line="1">
[[FX]]
sampler myTexture;

// ... declare other samplers, contexts etc.

[[FS_LIGHTING]]

varying vec2 texCoords; // ... assumed given by vertex shader ...
uniform sampler2D myTexture;

void main( void )
{
gl_FragColor = texture2D( myTexture, texCoords );
}
</source>}}
Information taken from [http://www.horde3d.org/forums/viewtopic.php?f=2&t=965 this thread] on the forums.

== How to procedurally generate a geometry resource ==
To generate a geometry resource from given data call '''h3dutCreateGeometryRes''':

the following example will create a simple 2D plane.

{{CppSourceCode|
description= C++ Code|
code=
<source lang="cpp" line="1">
float posData[] = {
0, 0, 0,
10, 0, 0,
0, 10, 0,
10, 10, 0
};

unsigned int indexData[] = { 0, 1, 2, 2, 1, 3 };
short normalData[] = {
0, 0, 1,
0, 0, 1,
0, 0, 1,
0, 0, 1
};

float uvData[] = {
0, 0,
1, 0,
0, 1,
1, 1
};

H3DRes geoRes = h3dutCreateGeometryRes( "geoRes", 4, 6, posData, indexData, normalData, 0, 0, uvData, 0 );
H3DNode model = h3dAddModelNode( H3DRootNode, "DynGeoModelNode", geoRes );
h3dAddMeshNode( model, "DynGeoMesh", matRes, 0, 6, 0, 3 );
</source>}}

== How to modify vertex data ==

Vertex data is stored as streams in geometry resources. A pointer to the vertex data can be obtained by mapping a stream. The following code modifies the y coordinates of all vertex positions stored in the specified geometry resource.

{{CppSourceCode|
description= C++ Code|
code=
<source lang="cpp" line="1">
int vertCount = h3dGetResParamI( myGeoRes, H3DGeoRes::GeometryElem, 0, H3DGeoRes::GeoVertexCountI );
float *pVertPosData = (float *)h3dMapResStream( myGeoRes, H3DGeoRes::GeometryElem, 0, H3DGeoRes::GeoVertPosStream, true, true );

for( int i = 0; i < vertCount; ++i )
{
pVertPosData[i * 3 + 1] = pVertPosData[i * 3 + 1] * 2;
}

h3dUnmapResStream( myGeoRes );
</source>}}

== How to exchange a texture of a mesh ==

Consider you want to exchange the diffuse texture (sampler named ''albedoMap'') of a given mesh (with node handle ''myMesh'') by a texture resource with resource handle ''myNewTex''. You can do that with the following code:

{{CppSourceCode|
description= C++ Code|
code=
<source lang="cpp" line="1">
H3DRes matRes = h3dGetNodeParamI( myMesh, H3DMesh::MatResI );
int idx = h3dFindResElem( matRes, H3DMatRes::SamplerElem, H3DMatRes::SampNameStr, "albedoMap" );
h3dSetResParamI( matRes, H3DMatRes::SamplerElem, idx, H3DMatRes::SampTexResI, myNewTex );
</source>}}

First you need to retrieve the material used by the mesh. After that, you can find the desired sampler in the material. Finally, once you have the sampler index, you can access the sampler data and override its texture resource.

'''Note:''' The code above changes directly the material resource. If several meshes are using the same material, all of them will have the new texture. If that is not desired, you can create a private copy of the material by cloning it.

== How to display text in the scene ==

Usually, text is displayed as part of a GUI or HUD on top of the scene. However, sometimes it can be useful to display text inside the scene at the location of a specific node. The following snippet displays the names of all models at the nodes' origins. For obtaining the right screen position, the node positions are projected and converted to overlay coordinates.

{{CppSourceCode|description= C++ Code|code=
<source lang="cpp" line="1">
// Get camera view matrix
const float *camTrans;
h3dGetNodeTransMats( _cam, 0x0, &camTrans );
Matrix4f viewMat( Matrix4f( camTrans ).inverted() );

// Get camera projection matrix
float camProj[16];
h3dGetCameraProjMat( _cam, camProj );
Matrix4f projMat( camProj );

// Loop over all model nodes
int cnt = h3dFindNodes( H3DRootNode, "", H3DNodeTypes::Model );
for( int i = 0; i < cnt; ++i )
{
// Get node name
H3DNode node = h3dGetNodeFindResult( i );
const char *name = h3dGetNodeParamStr( node, H3DNodeParams::NameStr );

// Get node position
const float *nodeTrans;
h3dGetNodeTransMats( node, 0, &nodeTrans );
Vec4f pos( nodeTrans[12], nodeTrans[13], nodeTrans[14], 1 );

// Project
pos = projMat * viewMat * pos;
float x = pos.x / pos.w;
float y = pos.y / pos.w;

// Transform to overlay coordinates
const float aspectRatio = h3dGetViewportParams( 0x0, 0x0, 0x0, 0x0 );
x = (x * 0.5f + 0.5f)*aspectRatio;
y = -y * 0.5f + 0.5f;

// Show text (avoid back-projection)
if( pos.w > 0 ) h3dutShowText( name, x, y, 0.02f, 1.0f, 1.0f, 1.0f, _fontMatRes);
}
</source>}}
}}

== How to tell the camera to look at a point ==

Only pseudo code here, how the math behind this works can be found by searching for gluLookAt.

{{CppSourceCode|description= Pseudo Code|code=
<source lang="python" line="1">
forward = targetPosition - cameraPosition
forward = normalize(forward)

up = Vector3(0, 1, 0) # vector pointing "up", can be almost any vector
up = normalize(up)

right = cross(forward, up)
right = normalize(right)

up = cross(right, forward)

# rotation matrix, column major format
m1 = [right.x, up.x, -forward.x, 0,
right.y, up.y, -forward.y, 0,
right.z, up.z, -forward.z, 0,
0, 0, 0, 1]

# translation matrix, column major format
m2 = [1, 0, 0, 0,
0, 1, 0, 0,
0, 0, 1, 0,
-cameraPosition.x, -cameraPosition.y, -cameraPosition.z, 1]

# combined transformation matrix ("view" matrix)
m3 = m1 * m2

# since the camera node is just another node in Horde3D we have to invert the matrix m3
m3 = invert(m3)

h3dSetNodeTransMat(cameraNode, m3)

</source>}}
This example will fail when either forward is a zero vector or forward is parallel to the choosen up vector.

== How to orbit / rotate the camera around a point ==
{{CppSourceCode|description= Pseudo Code|code=
<source lang="python" line="1">
# setup: create an anchor node, so that the camera can always rotate around a relative (0, 0, 0) point
anchorNode = h3dAddGroupNode(h3dRootNode, 'camera-anchor')
cameraNode = h3dAddCameraNode(anchorNode, 'camera-orbiter')

# basically calculate point on the surface of a sphere
# by using distance and two angles

phi = phi % 360.0
theta = theta % 360.0

if phi < 0: # will break for phi=0 and theta=0 otherwise
phi = 0.0001

r = distance
p = radians(phi)
t = radians(theta)

x = r * cos(t) * sin(p)
y = r * cos(p)
z = r * sin(t) * sin(p)

# calculate vectors for camera look at
forward = Vector3(0, 0, 0,) - Vector3(x, y, z)
if phi >= 180.0:
up = Vector3(0, 1, 0)
else:
up = Vector3(0, -1, 0)

# with the forward and up vector use the code from the look at example to point the camera at the point (0, 0, 0).

</source>}}
When following another scene node use that node instead of h3dRootNode as a parent in the h3dAddGroupNode call.

Horde3D Wiki:HOWTO

2010-09-17T14:18:38Z

Volker: demonstrate h3dutCreateGeometryRes usage

Building Horde3D

2010-03-25T11:52:14Z

Volker:

__NOTOC__ __NOEDITSECTION__{{ContentBlock|color=white|content={{!!}}
This article contains instructions for building Horde3D from source on all supported platforms. Since Horde3D is very lightweight and has a minimal amount of external dependencies, getting it to compile and run is usually quite straightforward.

== Obtaining the SDK ==

Besides the [http://sourceforge.net/projects/horde3d/files/ official release packages], there is also a subversion repository hosted at SourceForge which is usually more up-to-date than the stable point releases.

The repository has the common SVN structure ''branches'', ''tags'' and ''trunk''. The latest development snapshot can be found in the ''trunk'' folder, while the official releases are tagged in the ''tags'' folder. If you check out the trunk folder, you will get the SDK along with all official extensions.

See [[SVN Source Instructions]] for instructions on how to obtain code from Subversion.

== Building on Windows ==

The preferred way of building Horde3D on Windows is using '''Visual Studio'''. The SDK comes with a solution file for Visual Studio 2005 that can be opened with the Visual C++ Express Edition as well. If you have Visual Studio 2008 (Standard/Professional or Express), you can simply use the VS Conversion Wizard to update the solution and project files. The solution contains the samples that can be started directly from Visual Studio. Just set the desired sample as startup project.

It is also possible to use CMake to create the Visual Studio solution files. The process is similar to what you do on Linux then. However, if you want to use Visual Studio's ''nmake'', you usually have to use the Visual Studio Command Prompt instead of the standard ''cmd'' shell. Sample batch files for creating VS 2005 and 2008 projects can be found in the ''CMake'' folder located in the Horde3D repository.

== Building on Linux ==

The Horde3D SDK is compatible with gcc and ships with [http://www.cmake.org CMake] configuration files. To build Horde3D, just switch to the Horde3D root directory. Create a new directory which will contain the makefiles created by CMake, for example ''CMake'' and change into it. After that, type

cmake ..

which will create the makefiles. Once they are created, you can type <tt>make</tt> to build the code or <tt>make clean</tt> to remove all generated files.

=== Linkage order for your application ===
You must link Horde3D library to your final executable before GL one.

'''WRONG''':
gcc -o app main.cpp -lGL '''-lHorde3D'''

'''RIGHT''':
gcc -o app main.cpp '''-lHorde3D''' -lGL

This is required for GCC 3.x and 4.x series on Linux. If you don't follow the linkage order, you will get [http://horde3d.org/forums/viewtopic.php?f=2&t=384 glCreateShader error within h3dInit call].

== Building on Max OS X ==

Mac OS X is an advanced graphical system layered over a traditional Unix core. Because of this, you can either use Apple's graphical Xcode IDE to develop Horde3D based applications, or you can go the traditional Unix way using gcc and makefiles.

==== The Mac Way Using Xcode ====

To create the Xcode project files, you have to install CMake first. After installing the CMake command line tools (so choose NOT to skip the installation when asked during the CMake installation), you should be able to run CMake from the console. Switch to Horde3D root directory and create a new directory in which the CMake output will be stored, for example ''CMake''. Change the current directory to that newly created one and type

cmake -G "Xcode" ..

You should now be able to open the newly created project in Xcode in order to build Horde3D.

==== The Unix Way Using the Command Line ====

''TODO''
}}

SVN Source Instructions

2010-03-25T11:50:06Z

Volker:

The latest Horde3D code and sample assets can be checked out from the official trunk hosted at SourceForge.

*If you use Tortoise SVN, simply do a checkout with:
<nowiki>https://horde3d.svn.sourceforge.net/svnroot/horde3d</nowiki>

*If you are using command line svn:
<nowiki>svn co https://horde3d.svn.sourceforge.net/svnroot/horde3d horde3d</nowiki>

Check the [[Building_Horde3D|build instructions]] for your platform to compile the source.

Volker:

Horde3D Wiki:Community portal

2010-01-04T11:27:51Z

Volker:

__NOEDITSECTION__ __NOTOC__{{ContentBlock|color=orange
|content= '''The community portal section of the Horde3D wiki contains community contributed articles that are not part of the official documentation. Feel free to add articles to our wiki or links to external tutorials.'''}}
{{SpacerBlock}}
{{ContentBlock|
|header=Information, instructions and tips on using Horde3D
|content={{!!}}
==Programming Guide==
=== Build Instructions ===
#[[Building Horde3D]] - Instructions for obtaining the code and building Horde on all supported platforms

[[Category: Tutorials]]

===Beginner Tutorials===
#[[Tutorial - Hello World]] - In this section we will create a simple application that loads a character and animates it using a walk cycle.
#[[Tutorial - Picking]] - In this section we will demonstrate picking the node under the mouse cursor
#[[Tutorial - Simple HUD]] - How to use showOverlay to create a simple HUD.
#[[Tutorial - Setup Horde with SDL]] - How to Setup Horde with SDL.
#[[Tutorial - Setup Horde with Qt4]] - How to Setup Horde with Qt4.
#[[Tutorial - Setup Horde with Gtkmm]] - How to Setup Horde with Gtkmm
#[[Tutorial - Stereo rendering]] - Basic outline for quad-buffered stereo rendering

===Advanced Tutorials===
#[[Basic Pipeline Tutorial]] - Create your first custom pipeline.
#[[Procedurally generated geometry tutorial]] - How to create Horde3D compatible procedural geometry (Horde3D 1.0.0 '''Beta 3''' only!).

==Shader Development==
[[Category: Techniques]]

===Render System Basics===
#[[The Flexible Rendering Pipeline]] - Introduction to Horde's data-driven rendering pipelines

===Rendering Quality===
#[[Gamma Correction]] - Overview of gamma correction and how to apply it with Horde

===Shading===
#[[Shading Technique - Dot Product Detail Texturing]] - Using the dot product of vectors and signed textures for high frequency detail
#[[Shading Technique - Palette Coloring]] - Quick and dirty palette recoloration of objects
#[[Shading Technique - Gloss Mapping]] - Mask which areas of an object have specular highlights
#[[Shading Technique - Glow Mapping]] - Allow areas on an object to emit a strong glowing highlight
#[[Shading Technique - Fresnel]] - Using reflection and refraction
#[[Shading Technique - Linear Depth Buffer]] - Create a custom linear depth buffer using vertex
#[[Shading Technique - Terrain Shading]] - Height and slope based shading with triplanar texturing

===Preprocessing===
#[[Preprocessing Technique - Distance Field Vector Textures]] - Using Adobe Photoshop to generate textures suitable for efficient vector art rendering

==Asset Creation==

[[Category: Content Import]]
#[[DCC Tool Support]] - List of supported Digital Content Creation Tools
#[[AssetTroubleshooting|Troubleshooting]] - ''"Help, my model is not showing up!"''
#[[Tips and Techniques]] - Asset creation suggestions & ideas for Horde3d, exporting and program quirks..
#[[Extending ColladaConv]] - Add support for exporting cameras
}}

Community Branch

2009-11-26T05:14:06Z

Volker: /* Community SVN Branch */

== 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 or EPL 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]].

Horde3D Scene Editor

2009-11-25T08:21:43Z

Volker:

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

=== Editor Features ===
The Horde3D Scene Editor offers an easy to use interface for the Horde3D graphics engine

Some of the key features are:

* Interface for creating and modifying Horde3D scene graph files
* Instant resource reloading for files modified outside the editor making it possible to use the editor for shader development
* LUA scripting support for rapid prototyping of small applications directly in the editor
* Powerful plugin architecture for integration of game engine functionality and executing game code, physics, etc. directly in the editor
* Cross-platform compatibility
* Open-source code released under the GPL

The current official version is version 0.8.0 compatible with Horde3D v.1.0.0 Beta2.

A more recent version can be found in the [http://mm-werkstatt.informatik.uni-augsburg.de/public/Horde3D/trunk/Tools/Horde3DEditor/ Community Branch] that is compatible with Horde3D v.1.0.0 Beta4

=== Preliminary Documentation ===
A preliminary [http://mm-werkstatt.informatik.uni-augsburg.de/files/project_content/45/231_HordeEditor.pdf PDF documentation] can be found on the project [http://mm-werkstatt.informatik.uni-augsburg.de/Horde3DEditor website]. In the future it will be transferred to the wiki to allow the community to improve the documentation as well.

=== Tutorial Video ===

<VideoFlv width="1024" height="768">http://mm-werkstatt.informatik.uni-augsburg.de/files/project_content/45/Horde3D_Editor.flv</VideoFlv>
You can also [http://mm-werkstatt.informatik.uni-augsburg.de/downloads/Horde3D_Editor.avi download this video] in an [http://www.xvid.org Xvid] coded version!

== Overview of the Horde3D Scene Editor ==

The Horde3D graphics engine is a SDK for rendering three dimensional data. The interface to the graphics data is deﬁned by a Horde3D speciﬁc ﬁle format. Normally you will create a 3D model in your favourite modelling tool like 3Ds Max or Blender and export the data to a Collada ﬁle. This ﬁle can then be converted by the Horde3D Collada converter to the internal Horde3D format.

But what if you want to compose a scene where several single models should
be integrated. The ﬁrst possibility is to use your modelling tool, compose
everything in it and export the whole scenery to create one big Horde3D ﬁle.
But doing it this way suffers still from the lack of possibility to illuminate
your scene with Horde3D lights and visualize it with your custom shaders.
That’s why the second possibility was created: the Horde3D Scene Editor!
It will create scene graph files readable by Horde3D, let you integrate your
custom attachment nodes by using plugins, offers fast prototyping by pro-
viding a Lua interface to all Horde3D functions and also let you instantly
preview changes to shader code, materials, eﬀects, textures and pipelines by reloading
the changed files immediately and automatically after saving them.

== Installation ==

For the Horde3D Scene Editor a graphical installer is provided for the Microsoft Windows platform. You can download the latest release from the
[http://mm-werkstatt.informatik.uni-augsburg.de/project_details.php?id=45 project website]. Release candidates for upcoming versions might be released in the [http://horde3d.org/forums/viewforum.php?f=6 Tools section] of the forums. Currently the Editor supports two different platforms: Windows and Linux! It may be used on the Macintosh platform as well, but since I (volker) don’t have access to a Mac I haven’t tested this yet.

=== Windows ===
After downloading and extracting the compressed archive you simply have
to run the Setup.exe. It will guide you through the rest of the installation
procedure. After installation has been done, a Horde3D Scene Editor link
has been created in your start menu and the ﬁle extension .scn has been associated with the editor. The installation directory will contain an executable as well as the source code and a Visual Studio 2005 solution.

==== Compiling the Editor ====

If you want to compile the Editor yourself with Visual Studio 2005, open the solution ''Horde3DEditor_2005.sln'' in ''trunk/Tools/Horde3DEditor''. To build the solution you need to have Qt installed. Since installing the open source version of Qt is not entirely straightforward, here is a quick installation guide for Visual Studio 2005:

# Download the Qt source archive from ftp://ftp.qt.nokia.com/qt/source/qt-all-opensource-src-4.5.2.zip
# Extract it to a directory '''without any spaces''' (not something like ''C:\Program Files\Qt4'' but rather ''C:\Qt4'')
# Configure Qt to use wchar_t as built-in type
## Open ''mkspecs/win32-msvc2005/qmake.conf'' in the Qt directory
## Find the line ''QMAKE_CFLAGS = -nologo -Zm200 -Zc:wchar_t-'' (around line 19) and remove the last character (the minus)
# Launch the Visual Studio Command Prompt (can be found in the VS start menu entry under Tools)
# Change to the Qt source directory
# Enter ''configure -platform win32-msvc2005 -no-qt3support''
## ''-no-qt3support'' is not required and is just used to speed up the build process
## Follow the instructions on the screen and wait until the configuration process is finished
# Enter ''nmake'' and wait until the build process has finished (can take several hours)
# Configure environment variables in the Windows Control Panel
## Add QTDIR which points to your Qt path
## Add the ''bin'' directory of the Qt path to the PATH variable

If you need more detailed instructions on how to install Qt, please find one of the many tutorials that are available on the net.

=== Linux ===
For the installation under a Linux environment you have to install at least
Qt 4.3.3 to be able to compile the editor. After downloading and extracting
the compressed archive you have to run [http://doc.trolltech.com/4.4/qmake-manual.html qmake], which will create the make
files for your compiler. By typing '''make''' afterwards the editor will be created
in the ''bin'' subfolder of the directory where you placed the extracted files.

=== Mac ===
Although it may be possible to compile the linux package under Mac OS X,
I can't provide support until someone buys me a macintosh. You can ﬁnd
some further information in the [http://www.horde3d.org/forums/viewtopic.php?f=6&t=304 Horde3D forums].

== The first start ==
After you called the executable, the application starts and will present you
the Horde3D Scene Editor with an empty window. During the installation two test scenes have been installed to the bin\TestScene
and bin\Particle folder of the Horde3D Scene Editor installation directory. They contain a
small scenery to provide you with out-of-the-box examples.

=== Open a scene ===
To open it click the ﬁle menu and select Open Scene or press CTRL + O as
a shortcut.
For the ﬁrst test, browse to the TestScene folder and choose the TestScene.scn
ﬁle. After you conﬁrmed your selection with the open button the editor will
load the scene and present it to you.

=== Navigation ===
There are two possibilities to navigate through the scene. The ﬁrst one is
similar to most of the today’s ﬁrst person shooters. With the key combination
W, A, S, D and by clicking with the left mouse button in the viewport widget
you can move the camera through the scene (note that you have to hold the
mouse button pressed to rotate the camera). If you would like to use another
mouse button you can reconﬁgure this in the Settings dialog accessible via
the File menu.

The second possibility is to use the mouse wheel to navigate forward and
backward and straﬁng left, right, up, down by holding the CTRL key and
left mouse button pressed and moving the mouse in the direction to strafe.
You can change the amount of movement between two frames by changing
the Navigation Speed entry within the tool bar. Additionally if you keep the
Shift button pressed the navigation speed will be increased as long as you
hold it.

A third possibility was introduced with version 0.7.0 if you hold both the
mouse navigation button (normally the left one) and the select button (by
default the right one) pressed, you can also strafe along the X- and Y-axis of
the camera.

The transformation changes to the camera are done only within Horde3D
and not saved to the XML ﬁle. To change the transformation of a camera
permanently you have to select it ﬁrst in the scene tree and after you moved
to the place you want, you have to press the Move Node To Camera Position
button or activate the corresponding menu entry in the Edit menu (Shortcut:
CTRL+ALT+C). Now if you press the save button, the transformation of
the camera will be stored in your scene graph ﬁle.

To get a better impression of the scene you can switch the view to fullscreen
mode by clicking on the fullscreen button in the toolbar or activate the corresponding
entry in the View menu. To leave the fullscreen mode you have to press the Escape
key on your keyboard.

Finally the Wireframe (Debug) Mode button toggles between a debug rendering
mode and the normal rendering. It is especially useful if you have problems
with the light and are not sure if a geometry was inserted correctly or not.

For the alignment of objects a parallel projection mode for the cameras has
been integrated. You can access it using the tool buttons in the camera
navigation bar. But be aware that the parallel projection might cause
confusion since the distance of the camera to the objects is only observable
via the near clipping plane. So if you move the camera position using the W
or S key, you might get rid of you models because they are clipped by the
viewing frustum. To zoom when using the parallel projection use the mouse
wheel.

=== Customizing the editor ===
For a better workﬂow you can adjust the dock widgets of the editor to your
personal preferences. To do this just click and drag the titlebar of the dock
widgets and place them where you want them to be. By default the most
important dock widgets are visible to you. If you want reduce the required
screen space there is an option in the Windows menu to toggle the dock
widget visibility depending on the selected scene graph node. By doing this
the attachment widget or material widget are hidden if no editor plugin is
loaded or no node with a material attribute has been selected.
You can also alter the way mouse buttons are used for camera navigation and
object selection in the settings dialogue you can access via the Settings entry
in the ﬁle menu.

=== Manipulating objects ===
After loading the scene ﬁle, the elements of the scene are listed in the Scene
Tree. By selecting one of them, the corresponding transformation - stored
within the XML ﬁle - is shown in the Basic section of the Node Properties
widget. If you change it, an entry in the Undo section of the Edit menu is
created, allowing you to undo the change. Depending on the type of node
you selected, the Node Properties widget shows you additional conﬁguration
settings. For example if you select a light node you can change the light’s
color, ﬁeld of view or many other settings. Nodes referencing a material ﬁle
cause the Material Settings widget to display the content. But take node,
that the changes you made to the materials can not be undone by using the
undo/redo commands. Since the materials are separated ﬁles and not direct
part of the scene graph, you have to save them manually (click on the save
button) to apply the changes to the scene.

=== Reference Node ===
A Reference node represents a separate scene graph ﬁle not directly inte-
grated in the currently shown scene graph tree. To view the content of this
ﬁle you can double click on the reference element. The scene tree now con-
tains the contents of this ﬁle and all changes made on the objects are handled
within the scene graph ﬁle of this element. If you want to switch back to the
parent scene graph ﬁle you can click on the Arrow at the top of the scene
tree or press the backspace key. Take note, that all manipulations are done
in the scene graph currently displayed in the tree view. That’s why you can
only undo actions done within the currently opened scene graph.
If you hold the CTRL key pressed, while double clicking on a reference node,
the camera will be moved to the selected node.

=== Camera Nodes ===
n a scene you can deﬁne multiple cameras. To activate one of them you
have to double click on the scene tree item in the tree view or select it in the
Active Camera combobox of the navigation bar. The active camera can also
be used to set transformations of other nodes. If you navigate the camera to
a special point you can adjust the transformation of the currently selected
node by using the Move Node To Camera Position button or by pressing the
shortcut: CTRL+ALT+C
Orthogonal to this you can set the camera transformation to the transformation
of the currently selected node by using the Move Camera To Node
button.

== A new scene ==
Before you create a new scene you may want to conﬁgure an editor repository.

=== Before you start ===
This will be done in the Settings Dialogue you can ﬁnd under the
Settings menu entry in the File menu. There are six different repository paths
to conﬁgure. The ﬁrst is the path to Horde3D pipelines. These ﬁles conﬁgures
the way Horde3D renders the scene. The next path handles the scene-graph-
(Extension .scene.xml) and Horde3D geometry ﬁles (Extension .geo). The
third is the path to the materials directory that contains the subfolders and
material ﬁles (Extension .material.xml) for the materials of a converted 3d
model. The texture directory deﬁnes the path where the textures are stored
while the shaders directory points to the shader (Extension .shader.xml) and
code ﬁles (Extension .glsl) used by the models stored in the repository. Last
but not least for effect files (.eﬀect.xml) a separate eﬀect directory can be
conﬁgured. By default the repository is located in the ''bin\Repository'' folder
of the Horde3D scene editor and contains the Horde3D samples’ models.
Next to the repository conﬁguration you can also deﬁne a shader editor in
the general tab of the settings dialogue. This editor is used when clicking on
an edit button in the material editor. Other settings are the path to the
plugin directory used to search for attachment plugins and
the number of undo steps that will be available. Note that if you choose
a great number of undo steps or even the Unlimited setting, the Horde3D
Scene Editor could consume a lot of memory if you make many changes to
one scene. To prevent this you can manually clean the undo stack just by
reopen the current scene (every time a scene is closed the undo stack will be
cleared).

=== Creating a scene ===
To create a new scene select the New Scene entry in the ﬁle menu or press
the CTRL + N shortcut. A wizard will appear letting you choose a scene ﬁle
name and a directory where the newly created scene will be stored. If the
directory does not exist you will be prompted if you want to create it.
After choosing the scene directory additional directories for the diﬀerent scene
resources have to be selected on the next page. As before directories not
already existing can be created by the editor automatically. Take care that
the resource directories should be placed below the parent scene directory
and such should be declared relative to this folder

On the next page you have to conﬁgure a default camera used for rendering.
While you can keep the default frustum settings, you have to import a ren-
der pipeline from the repository conﬁgured before. By default some of the
Horde3D example pipelines are listed when you select Import from repository
in the combo box. You can then just press the OK Button or adjust the code
in the edit window. Only the content of this window will be used for the new
camera. The original ﬁle in the repository remains unchanged.

To allow you viewing the geometry placed in your scene and to conﬁgure a
light source for the preview of models, you will be asked to deﬁne a default
light on the next page. The settings you have to make here are depending on
the pipeline conﬁguration you made on the previous page (see the Horde3D
documentation for more details). It is important that you conﬁgure this light
properly since the Material, Lighting Context and Shader Context parameters
are used for the standard light source in the preview window when adding
new models to your scene. If your pipeline settings requires the light to have
a material (e.g. when using deferred rendering), you can import one from
the repository (see [[Editor_Tutorials#Before_you_start | Before you start]] ). The yellow lock next
to the ﬁlename indicates that the material will be imported from the model
data repository you specified before. If you have not specified it properly, or
do not have a light material, you have to manually copy an appropriate light
material and shader file to the specific directories of your scene.
Finally on the last page you can select a plugin for handling Horde3D attachments.
If there have been plugins found by the editor, the selection box
let you choose one of them to be the attachment controller for this scene. At
the moment no public plugin is part of the editor yet.

}}
| valign="top" | {{Extension_Summary
|name = Editor Tutorials
|screenshot = H3Deditor.jpg
|description = Tutorial site for the editor.
|version = 0.8.0
|horde3dversion = 1.0.0 beta2
|released = 2008-01-20
|author = [http://horde3d.org/forums/memberlist.php?mode=viewprofile&u=122 Volker]|
}}
|}
[[category: Tutorials]]

Horde3D Scene Editor

2009-11-25T08:21:15Z

Volker:

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

=== Editor Features ===
The Horde3D Scene Editor offers an easy to use interface for the Horde3D graphics engine

Some of the key features are:

* Interface for creating and modifying Horde3D scene graph files
* Instant resource reloading for files modified outside the editor making it possible to use the editor for shader development
* LUA scripting support for rapid prototyping of small applications directly in the editor
* Powerful plugin architecture for integration of game engine functionality and executing game code, physics, etc. directly in the editor
* Cross-platform compatibility
* Open-source code released under the GPL

The current official version is version 0.8.0 compatible with Horde3D v.1.0.0 Beta2
A more recent version can be found in the [http://mm-werkstatt.informatik.uni-augsburg.de/public/Horde3D/trunk/Tools/Horde3DEditor/ Community Branch] that is compatible with Horde3D v.1.0.0 Beta4

=== Preliminary Documentation ===
A preliminary [http://mm-werkstatt.informatik.uni-augsburg.de/files/project_content/45/231_HordeEditor.pdf PDF documentation] can be found on the project [http://mm-werkstatt.informatik.uni-augsburg.de/Horde3DEditor website]. In the future it will be transferred to the wiki to allow the community to improve the documentation as well.

=== Tutorial Video ===

<VideoFlv width="1024" height="768">http://mm-werkstatt.informatik.uni-augsburg.de/files/project_content/45/Horde3D_Editor.flv</VideoFlv>
You can also [http://mm-werkstatt.informatik.uni-augsburg.de/downloads/Horde3D_Editor.avi download this video] in an [http://www.xvid.org Xvid] coded version!

== Overview of the Horde3D Scene Editor ==

The Horde3D graphics engine is a SDK for rendering three dimensional data. The interface to the graphics data is deﬁned by a Horde3D speciﬁc ﬁle format. Normally you will create a 3D model in your favourite modelling tool like 3Ds Max or Blender and export the data to a Collada ﬁle. This ﬁle can then be converted by the Horde3D Collada converter to the internal Horde3D format.

But what if you want to compose a scene where several single models should
be integrated. The ﬁrst possibility is to use your modelling tool, compose
everything in it and export the whole scenery to create one big Horde3D ﬁle.
But doing it this way suffers still from the lack of possibility to illuminate
your scene with Horde3D lights and visualize it with your custom shaders.
That’s why the second possibility was created: the Horde3D Scene Editor!
It will create scene graph files readable by Horde3D, let you integrate your
custom attachment nodes by using plugins, offers fast prototyping by pro-
viding a Lua interface to all Horde3D functions and also let you instantly
preview changes to shader code, materials, eﬀects, textures and pipelines by reloading
the changed files immediately and automatically after saving them.

== Installation ==

For the Horde3D Scene Editor a graphical installer is provided for the Microsoft Windows platform. You can download the latest release from the
[http://mm-werkstatt.informatik.uni-augsburg.de/project_details.php?id=45 project website]. Release candidates for upcoming versions might be released in the [http://horde3d.org/forums/viewforum.php?f=6 Tools section] of the forums. Currently the Editor supports two different platforms: Windows and Linux! It may be used on the Macintosh platform as well, but since I (volker) don’t have access to a Mac I haven’t tested this yet.

=== Windows ===
After downloading and extracting the compressed archive you simply have
to run the Setup.exe. It will guide you through the rest of the installation
procedure. After installation has been done, a Horde3D Scene Editor link
has been created in your start menu and the ﬁle extension .scn has been associated with the editor. The installation directory will contain an executable as well as the source code and a Visual Studio 2005 solution.

==== Compiling the Editor ====

If you want to compile the Editor yourself with Visual Studio 2005, open the solution ''Horde3DEditor_2005.sln'' in ''trunk/Tools/Horde3DEditor''. To build the solution you need to have Qt installed. Since installing the open source version of Qt is not entirely straightforward, here is a quick installation guide for Visual Studio 2005:

# Download the Qt source archive from ftp://ftp.qt.nokia.com/qt/source/qt-all-opensource-src-4.5.2.zip
# Extract it to a directory '''without any spaces''' (not something like ''C:\Program Files\Qt4'' but rather ''C:\Qt4'')
# Configure Qt to use wchar_t as built-in type
## Open ''mkspecs/win32-msvc2005/qmake.conf'' in the Qt directory
## Find the line ''QMAKE_CFLAGS = -nologo -Zm200 -Zc:wchar_t-'' (around line 19) and remove the last character (the minus)
# Launch the Visual Studio Command Prompt (can be found in the VS start menu entry under Tools)
# Change to the Qt source directory
# Enter ''configure -platform win32-msvc2005 -no-qt3support''
## ''-no-qt3support'' is not required and is just used to speed up the build process
## Follow the instructions on the screen and wait until the configuration process is finished
# Enter ''nmake'' and wait until the build process has finished (can take several hours)
# Configure environment variables in the Windows Control Panel
## Add QTDIR which points to your Qt path
## Add the ''bin'' directory of the Qt path to the PATH variable

If you need more detailed instructions on how to install Qt, please find one of the many tutorials that are available on the net.

=== Linux ===
For the installation under a Linux environment you have to install at least
Qt 4.3.3 to be able to compile the editor. After downloading and extracting
the compressed archive you have to run [http://doc.trolltech.com/4.4/qmake-manual.html qmake], which will create the make
files for your compiler. By typing '''make''' afterwards the editor will be created
in the ''bin'' subfolder of the directory where you placed the extracted files.

=== Mac ===
Although it may be possible to compile the linux package under Mac OS X,
I can't provide support until someone buys me a macintosh. You can ﬁnd
some further information in the [http://www.horde3d.org/forums/viewtopic.php?f=6&t=304 Horde3D forums].

== The first start ==
After you called the executable, the application starts and will present you
the Horde3D Scene Editor with an empty window. During the installation two test scenes have been installed to the bin\TestScene
and bin\Particle folder of the Horde3D Scene Editor installation directory. They contain a
small scenery to provide you with out-of-the-box examples.

=== Open a scene ===
To open it click the ﬁle menu and select Open Scene or press CTRL + O as
a shortcut.
For the ﬁrst test, browse to the TestScene folder and choose the TestScene.scn
ﬁle. After you conﬁrmed your selection with the open button the editor will
load the scene and present it to you.

=== Navigation ===
There are two possibilities to navigate through the scene. The ﬁrst one is
similar to most of the today’s ﬁrst person shooters. With the key combination
W, A, S, D and by clicking with the left mouse button in the viewport widget
you can move the camera through the scene (note that you have to hold the
mouse button pressed to rotate the camera). If you would like to use another
mouse button you can reconﬁgure this in the Settings dialog accessible via
the File menu.

The second possibility is to use the mouse wheel to navigate forward and
backward and straﬁng left, right, up, down by holding the CTRL key and
left mouse button pressed and moving the mouse in the direction to strafe.
You can change the amount of movement between two frames by changing
the Navigation Speed entry within the tool bar. Additionally if you keep the
Shift button pressed the navigation speed will be increased as long as you
hold it.

A third possibility was introduced with version 0.7.0 if you hold both the
mouse navigation button (normally the left one) and the select button (by
default the right one) pressed, you can also strafe along the X- and Y-axis of
the camera.

The transformation changes to the camera are done only within Horde3D
and not saved to the XML ﬁle. To change the transformation of a camera
permanently you have to select it ﬁrst in the scene tree and after you moved
to the place you want, you have to press the Move Node To Camera Position
button or activate the corresponding menu entry in the Edit menu (Shortcut:
CTRL+ALT+C). Now if you press the save button, the transformation of
the camera will be stored in your scene graph ﬁle.

To get a better impression of the scene you can switch the view to fullscreen
mode by clicking on the fullscreen button in the toolbar or activate the corresponding
entry in the View menu. To leave the fullscreen mode you have to press the Escape
key on your keyboard.

Finally the Wireframe (Debug) Mode button toggles between a debug rendering
mode and the normal rendering. It is especially useful if you have problems
with the light and are not sure if a geometry was inserted correctly or not.

For the alignment of objects a parallel projection mode for the cameras has
been integrated. You can access it using the tool buttons in the camera
navigation bar. But be aware that the parallel projection might cause
confusion since the distance of the camera to the objects is only observable
via the near clipping plane. So if you move the camera position using the W
or S key, you might get rid of you models because they are clipped by the
viewing frustum. To zoom when using the parallel projection use the mouse
wheel.

=== Customizing the editor ===
For a better workﬂow you can adjust the dock widgets of the editor to your
personal preferences. To do this just click and drag the titlebar of the dock
widgets and place them where you want them to be. By default the most
important dock widgets are visible to you. If you want reduce the required
screen space there is an option in the Windows menu to toggle the dock
widget visibility depending on the selected scene graph node. By doing this
the attachment widget or material widget are hidden if no editor plugin is
loaded or no node with a material attribute has been selected.
You can also alter the way mouse buttons are used for camera navigation and
object selection in the settings dialogue you can access via the Settings entry
in the ﬁle menu.

=== Manipulating objects ===
After loading the scene ﬁle, the elements of the scene are listed in the Scene
Tree. By selecting one of them, the corresponding transformation - stored
within the XML ﬁle - is shown in the Basic section of the Node Properties
widget. If you change it, an entry in the Undo section of the Edit menu is
created, allowing you to undo the change. Depending on the type of node
you selected, the Node Properties widget shows you additional conﬁguration
settings. For example if you select a light node you can change the light’s
color, ﬁeld of view or many other settings. Nodes referencing a material ﬁle
cause the Material Settings widget to display the content. But take node,
that the changes you made to the materials can not be undone by using the
undo/redo commands. Since the materials are separated ﬁles and not direct
part of the scene graph, you have to save them manually (click on the save
button) to apply the changes to the scene.

=== Reference Node ===
A Reference node represents a separate scene graph ﬁle not directly inte-
grated in the currently shown scene graph tree. To view the content of this
ﬁle you can double click on the reference element. The scene tree now con-
tains the contents of this ﬁle and all changes made on the objects are handled
within the scene graph ﬁle of this element. If you want to switch back to the
parent scene graph ﬁle you can click on the Arrow at the top of the scene
tree or press the backspace key. Take note, that all manipulations are done
in the scene graph currently displayed in the tree view. That’s why you can
only undo actions done within the currently opened scene graph.
If you hold the CTRL key pressed, while double clicking on a reference node,
the camera will be moved to the selected node.

=== Camera Nodes ===
n a scene you can deﬁne multiple cameras. To activate one of them you
have to double click on the scene tree item in the tree view or select it in the
Active Camera combobox of the navigation bar. The active camera can also
be used to set transformations of other nodes. If you navigate the camera to
a special point you can adjust the transformation of the currently selected
node by using the Move Node To Camera Position button or by pressing the
shortcut: CTRL+ALT+C
Orthogonal to this you can set the camera transformation to the transformation
of the currently selected node by using the Move Camera To Node
button.

== A new scene ==
Before you create a new scene you may want to conﬁgure an editor repository.

=== Before you start ===
This will be done in the Settings Dialogue you can ﬁnd under the
Settings menu entry in the File menu. There are six different repository paths
to conﬁgure. The ﬁrst is the path to Horde3D pipelines. These ﬁles conﬁgures
the way Horde3D renders the scene. The next path handles the scene-graph-
(Extension .scene.xml) and Horde3D geometry ﬁles (Extension .geo). The
third is the path to the materials directory that contains the subfolders and
material ﬁles (Extension .material.xml) for the materials of a converted 3d
model. The texture directory deﬁnes the path where the textures are stored
while the shaders directory points to the shader (Extension .shader.xml) and
code ﬁles (Extension .glsl) used by the models stored in the repository. Last
but not least for effect files (.eﬀect.xml) a separate eﬀect directory can be
conﬁgured. By default the repository is located in the ''bin\Repository'' folder
of the Horde3D scene editor and contains the Horde3D samples’ models.
Next to the repository conﬁguration you can also deﬁne a shader editor in
the general tab of the settings dialogue. This editor is used when clicking on
an edit button in the material editor. Other settings are the path to the
plugin directory used to search for attachment plugins and
the number of undo steps that will be available. Note that if you choose
a great number of undo steps or even the Unlimited setting, the Horde3D
Scene Editor could consume a lot of memory if you make many changes to
one scene. To prevent this you can manually clean the undo stack just by
reopen the current scene (every time a scene is closed the undo stack will be
cleared).

=== Creating a scene ===
To create a new scene select the New Scene entry in the ﬁle menu or press
the CTRL + N shortcut. A wizard will appear letting you choose a scene ﬁle
name and a directory where the newly created scene will be stored. If the
directory does not exist you will be prompted if you want to create it.
After choosing the scene directory additional directories for the diﬀerent scene
resources have to be selected on the next page. As before directories not
already existing can be created by the editor automatically. Take care that
the resource directories should be placed below the parent scene directory
and such should be declared relative to this folder

On the next page you have to conﬁgure a default camera used for rendering.
While you can keep the default frustum settings, you have to import a ren-
der pipeline from the repository conﬁgured before. By default some of the
Horde3D example pipelines are listed when you select Import from repository
in the combo box. You can then just press the OK Button or adjust the code
in the edit window. Only the content of this window will be used for the new
camera. The original ﬁle in the repository remains unchanged.

To allow you viewing the geometry placed in your scene and to conﬁgure a
light source for the preview of models, you will be asked to deﬁne a default
light on the next page. The settings you have to make here are depending on
the pipeline conﬁguration you made on the previous page (see the Horde3D
documentation for more details). It is important that you conﬁgure this light
properly since the Material, Lighting Context and Shader Context parameters
are used for the standard light source in the preview window when adding
new models to your scene. If your pipeline settings requires the light to have
a material (e.g. when using deferred rendering), you can import one from
the repository (see [[Editor_Tutorials#Before_you_start | Before you start]] ). The yellow lock next
to the ﬁlename indicates that the material will be imported from the model
data repository you specified before. If you have not specified it properly, or
do not have a light material, you have to manually copy an appropriate light
material and shader file to the specific directories of your scene.
Finally on the last page you can select a plugin for handling Horde3D attachments.
If there have been plugins found by the editor, the selection box
let you choose one of them to be the attachment controller for this scene. At
the moment no public plugin is part of the editor yet.

}}
| valign="top" | {{Extension_Summary
|name = Editor Tutorials
|screenshot = H3Deditor.jpg
|description = Tutorial site for the editor.
|version = 0.8.0
|horde3dversion = 1.0.0 beta2
|released = 2008-01-20
|author = [http://horde3d.org/forums/memberlist.php?mode=viewprofile&u=122 Volker]|
}}
|}
[[category: Tutorials]]