[Crystal-cvs] SF.net SVN: crystal: [27969] CS/trunk/docs

[<dar...@us...>]

Revision: 27969
          http://crystal.svn.sourceforge.net/crystal/?rev=27969&view=rev
Author:   darekdawidowski
Date:     2007-10-20 09:27:40 -0700 (Sat, 20 Oct 2007)

Log Message:
-----------
Haze docs.

Modified Paths:
--------------
    CS/trunk/docs/history.txt
    CS/trunk/docs/texinfo/usingcs/meshobj/haze.txi

Modified: CS/trunk/docs/history.txt
===================================================================
--- CS/trunk/docs/history.txt	2007-10-20 15:02:21 UTC (rev 27968)
+++ CS/trunk/docs/history.txt	2007-10-20 16:27:40 UTC (rev 27969)
@@ -20,6 +20,7 @@
 	  CS.
 	- res deprecated the (pretty much defunct for while now) 
 	  iImageIO::SetDithering() method.
+	- Darek updated haze docs.
 19-Oct-2007
 	- caedes fixed element size in swig iDataBuffer buffer declaration.
 	- res changed the GL texture blitting logic to make sure the texture

Modified: CS/trunk/docs/texinfo/usingcs/meshobj/haze.txi
===================================================================
--- CS/trunk/docs/texinfo/usingcs/meshobj/haze.txi	2007-10-20 15:02:21 UTC (rev 27968)
+++ CS/trunk/docs/texinfo/usingcs/meshobj/haze.txi	2007-10-20 16:27:40 UTC (rev 27969)
@@ -7,13 +7,119 @@
 @cindex @code{iMeshObject}
 @cindex @code{iMeshObjectFactory}
 @cindex @code{iMeshObjectType}
-@cindex @code{iTerrFuncState}
+@cindex @code{iHazeState}
+@cindex @code{iHazeFactoryState}
 
-@emph{Written by Jorrit Tyberghein,
-(@email{jorrit.tyberghein@@gmail.com}).}
+This mesh object represents a 'haze' which is a bit like
+volumetric light. For example you can show this way moody
+rays from church windows.
 
-@strong{DOCUMENTATION NOT UP-TO-DATE}
+@subsubheading Basic Structure
 
-This mesh object represents a 'haze' which is a bit like
-volumetric light.
+The following @sc{scf} class names are used (for @code{csLoadPlugin}):
 
+@itemize @bullet
+@item
+Type plugin: @code{crystalspace.mesh.object.haze}
+@item
+Loader plugin: @code{crystalspace.mesh.loader.haze}
+@item
+Factory loader plugin: @code{crystalspace.mesh.loader.factory.haze}
+@end itemize
+
+Objects in this plugin implement the following @sc{scf} interfaces, which you
+can retrieve with @code{scfQueryInterface}:
+
+@itemize @bullet
+@item
+@emph{MeshObject}
+@itemize @bullet
+@item
+Implements @samp{iMeshObject}
+@item
+Implements @samp{iHazeState}
+@end itemize
+@item
+@emph{MeshObjectFactory}
+@itemize @bullet
+@item
+Implements @samp{iMeshObjectFactory}
+@item
+Implements @samp{iHazeFactoryState}
+@end itemize
+@item
+@emph{MeshObjectType}
+@itemize @bullet
+@item
+Implements @samp{iMeshObjectType}
+@end itemize
+@end itemize
+
+@subsubheading Factory State Interface
+
+Use the @samp{iHazeFactoryState} @sc{scf} interface to access settings for
+a haze factory.  The definition of this interface can be found in
+@file{CS/include/imesh/haze.h} and that is also the include file you need
+to include in your applications to use this plugin.  Using this interface you
+can access the direction, origin, layers, scale and various other 
+configuration parameters for a haze factory.
+
+@subsubheading Factory Loader
+
+The haze mesh factory loader has no parameters.
+
+@subsubheading Object State Interface
+
+@samp{iHazeState} (residing in @file{CS/include/imesh/haze.h}) is
+an empty @sc{scf} interface.
+
+@subsubheading Object Loader
+
+@table @code
+@item <material> @dots{} </material>
+Material name.
+@item <mixmode> @dots{} </mixmode>
+Color mixing mode.
+@item <origin x="" y="" z="" />
+Set the origin of the texture.
+@item <directional x="" y="" z="" />
+Set the direction of the texture.
+@item <layer> @dots{} </layer>
+Layer of the haze mesh.
+Inside layer:
+@item <scale> @dots{} </scale>
+Scale of the texture.
+@item <hazebox> @dots{} </hazebox>
+Draws box shape.
+Inside hazebox:
+@item <min x="" y="" z="" />
+First corner of the box.
+@item <max x="" y="" z="" />
+Last corner if the box.
+@example
+<layer>
+  <scale></scale>
+  <hazebox>
+    <min x="" y="" z="" />
+    <max x="" y="" z="" />
+  </hazecone>
+</layer>
+@end example
+@item <hazecone p="" q="" number=""> @dots{} </hazecone>
+Draws cone shape. Give p - radius of the top, q - radius of the bottom
+and number of faces to create cone mesh.
+Inside hazecone:
+@item <min x="" y="" z="" />
+Position of the cone's tip.
+@item <max x="" y="" z="" />
+Position of the cone's bottom.
+@example
+<layer>
+  <scale></scale>
+  <hazecone p="" q="" number="">
+    <min x="" y="" z="" />
+    <max x="" y="" z="" />
+  </hazecone>
+</layer>
+@end example
+@end table


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.