Difference between revisions of "Castle Game Engine"

From Free Pascal wiki
Jump to navigationJump to search
(fixed paths to new kambi_vrml_game_engine layout in SVN)
(TKamVRMLBrowser better docs, Browser.SceneManager.Items mention)
Line 15: Line 15:
 
== Lazarus components ==
 
== Lazarus components ==
  
We have two components for now: TKamOpenGLControl (simple descendant of standard TOpenGLControl) and TKamVRMLBrowser (descendant of TKamOpenGLControl that allows you to load any 3D model, and acts as VRML browser). If your game is fully contained within a single VRML model, and you just want to "execute" it, then TKamVRMLBrowser component is for you. You just drop this on the form, from code you call
+
Major components that you can drop on the form:
 +
# TKamOpenGLControl: descendant of the standard TOpenGLControl that makes it easy to add our engine 2D controls. In particular you can add a scene manager to handle and render your 3D world.
 +
# TKamVRMLBrowser: more simplified descendant of TKamOpenGLControl, with scene manager already created. Allows you to easily load any 3D model, acts as a ready VRML browser.
 +
 
 +
You just drop TKamVRMLBrowser on the form, and call
  
 
<code>
 
<code>
Line 23: Line 27:
 
</code>
 
</code>
  
and you're done. Animations work, rendering in OpenGL works, navigation and key/mouse sensors work, etc.
+
and you're done. Animations work, rendering in OpenGL works, navigation and key/mouse sensors work, etc. For more advanced uses, you can add 2D controls to Browser.Controls list, and 3D objects to Browser.SceneManager.Items.
  
 
To install Lazarus components, download the engine sources, and see inside "<tt>packages/</tt>" directory. You want to install packages <tt>kambi_base.lpk</tt> and <tt>kambi_components.lpk</tt>.
 
To install Lazarus components, download the engine sources, and see inside "<tt>packages/</tt>" directory. You want to install packages <tt>kambi_base.lpk</tt> and <tt>kambi_components.lpk</tt>.

Revision as of 22:11, 31 March 2010

Features

Kambi VRML game engine allows you to render 3D models in various formats. In particular, support for VRML / X3D format is very versatile. You can define animations, interactions, scripting, shaders and many more in VRML/X3D, so you get quite capable 3D game engine in the end.

Rendering is done through OpenGL. We can use OpenGL context initialized in any way, including Lazarus TOpenGLControl component, our own TGLWindow class (which allows you to create windows with OpenGL context, menu bars and dialog boxes, completely without the LCL), or any other library capable of creating GL context (glut, SDL).

The engine homepage is http://vrmlengine.sourceforge.net/. In particular, this page lists all the engine features.

Engine is open-source (core engine may be used under GNU LGPL, with "static linking exception" like FPC RTL), developed in nice object-oriented way, only for FPC/Lazarus. The engine is not dependent on LCL, Lazarus components are just comfortable "extras".

Screenshot (VRML browser in Lazarus)

kambi vrml browser.jpg

Lazarus components

Major components that you can drop on the form:

  1. TKamOpenGLControl: descendant of the standard TOpenGLControl that makes it easy to add our engine 2D controls. In particular you can add a scene manager to handle and render your 3D world.
  2. TKamVRMLBrowser: more simplified descendant of TKamOpenGLControl, with scene manager already created. Allows you to easily load any 3D model, acts as a ready VRML browser.

You just drop TKamVRMLBrowser on the form, and call

 Browser.Load(FileName);
 Browser.Scene.Spatial := [ssRendering, ssDynamicCollisions];
 Browser.Scene.ProcessEvents := true;

and you're done. Animations work, rendering in OpenGL works, navigation and key/mouse sensors work, etc. For more advanced uses, you can add 2D controls to Browser.Controls list, and 3D objects to Browser.SceneManager.Items.

To install Lazarus components, download the engine sources, and see inside "packages/" directory. You want to install packages kambi_base.lpk and kambi_components.lpk.

For more examples, see inside engine sources --- look for "examples" subdirectories. For example VRML browser done with Lazarus, see inside kambi_vrml_game_engine/examples/vrml/lazarus_vrml_browser/ directory. Full API reference and more high-level documentation about VRML handling are available.

Enjoy! Author: Michalis Kamburelis