source: GTP/trunk/App/Demos/Geom/Shark3D/clod_head_demo_win32/readme.txt @ 2325

###############################################################################
##
##      ##  ######
##       ######  ###
##  ## ###############        Shark 3D Engine (www.shark3d.com)
##   ########## # # #
##    ########                Copyright (c) 1996-2006 Spinor GmbH.
##   ######### # # #          All rights reserved.
##  ##   ##########
##      ##
##
###############################################################################

1. About this Demo
------------------

This is a technical demo for Shark 3D featuring realtime area lighting.

Important!
This demo requires the installation of the Shark 3D SDK of the correct version.
See the installation guide of the SDK for details.

The demo includes the full project source code.

2. License
----------

Very important!
This demo contains confidential information and is governed by the licensing
and confidentiality agreement included in the Shark 3D SDK. 
You have to agree to that license and confidentiality agreement in order 
to use this demo. If you don't agree to that agreement, you may not use
this demo and its content in any way. 
See the file license_and_confidentiality.html of the SDK for details.

3. Important! Setting up the demo
---------------------------------

The Shark 3D SDK of the corrrect version must be installed.
This includes installing the requirements.
See the Shark 3D SDK documentation for details.

Open the file "win32_env.bat" and change the first entry
in such way that it points to the location of the Shark 3D SDK.

The shark3D SDK needs Python and Scons to be properly installed.
See the Shark 3D SDK documentation for details about Shark 3D projects.

4. Launching the demo
---------------------

To launch the demo, start "win32_editor.bat" and press "Run".

When starting the demo for the first time, the resources 
are compiled automatically, which needs several minutes.

If starting "win32_editor.bat" gives an error instead of 
launching the editor, then probably the Shark 3D SDK is not 
at the correct location, see above.

5. Demo mode
------------

To move the light source, drag the mouse with the left mouse button 
pressed down.

6. "God" mode
-------------

You can toggle a mobile camera using the "g" key for "god mode".
Then you can rotate the camera by dragging the mouse 
with the left mouse button pressed down.
With the cursor keys you can move the camera.

You can press the "g" key again to leave the god mode.
Within the god mode, you can press the "z" key 
to move the light source in the same way as in the demo mode,
but with keeping the last position of the god camera.

You can toggle catching the mouse by pressing the "c" key.
Then you don't have to hold down the left mouse button anymore.

7. Useful keys
--------------

ESC - Quit.

g   - Toggle god mode, see above.
z   - Toggle to move the light source within the god mode, see above.
c   - Toggle catching the mouse, see above.
    
m   - Toggle wireframe mode.
y   - Toggle fullscreen mode.

f   - Toggle frame time.
j   - Toggle frame time statistics.
k   - Reset frame time statistics.

8. Other information
--------------------

See the documentation of the Shark 3D SDK for details 
about Shark 3D projects.