Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1809

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: imesh/haze.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>imesh/haze.h</h1><a href="haze_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2001 by W.C.A. Wijngaards</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">    Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_IMESH_HAZE_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IMESH_HAZE_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="scf__interface_8h.html" title="Crystal Space Shared Class Facility (SCF) - interface creation support.">csutil/scf_interface.h</a>"</span>
<a name="l00027"></a>00027 
<a name="l00031"></a>00031 <span class="keyword">struct </span><a class="code" href="structiMaterialWrapper.html" title="A material wrapper is an engine-level object that wraps around an actual material...">iMaterialWrapper</a>;
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>;
<a name="l00034"></a>00034 
<a name="l00050"></a><a class="code" href="structiHazeHull.html">00050</a> <span class="keyword">struct </span><a class="code" href="structiHazeHull.html" title="A mesh specially meant for use by the haze.">iHazeHull</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052   SCF_INTERFACE(<a class="code" href="structiHazeHull.html" title="A mesh specially meant for use by the haze.">iHazeHull</a>, 2, 0, 0);
<a name="l00053"></a>00053 
<a name="l00055"></a>00055   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiHazeHull.html#39ea303811773d04ea084b30d22380d2" title="get the number of polygons">GetPolygonCount</a>() <span class="keyword">const</span> = 0;
<a name="l00057"></a>00057   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiHazeHull.html#bb277811883a6635a1cb462ca16df58e" title="get the total number of vertices">GetVerticeCount</a>() <span class="keyword">const</span> = 0;
<a name="l00059"></a>00059   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiHazeHull.html#5238a7f7096269bc910d49b872781951" title="get the total number of edges">GetEdgeCount</a>() <span class="keyword">const</span> = 0;
<a name="l00060"></a>00060 
<a name="l00062"></a>00062   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiHazeHull.html#22b033a281f90fca11277e29596f0256" title="get a vertex by index">GetVertex</a>(<a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; res, <span class="keywordtype">int</span> vertex_idx) <span class="keyword">const</span> = 0;
<a name="l00064"></a>00064   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiHazeHull.html#966b0b5f02fb726155f6014d01fe3e23" title="get the two (unordered) points of an edge (by index)">GetEdge</a>(<span class="keywordtype">int</span> edge_num, <span class="keywordtype">int</span>&amp; vertex_idx_1, <span class="keywordtype">int</span>&amp; vertex_idx_2)
<a name="l00065"></a>00065     <span class="keyword">const</span> = 0;
<a name="l00066"></a>00066 
<a name="l00068"></a>00068   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiHazeHull.html#681ddbb3eadf9b7ffb31e487d46bd4e6" title="get the number of vertices in a polygon">GetPolVerticeCount</a>(<span class="keywordtype">int</span> polygon_num) <span class="keyword">const</span> = 0;
<a name="l00070"></a>00070   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiHazeHull.html#9742facd08285f8061a13bd86c89ff82" title="get vertexindex in a polygon (given vertex number in polygon)">GetPolVertex</a>(<span class="keywordtype">int</span> polygon_num, <span class="keywordtype">int</span> vertex_num) <span class="keyword">const</span> = 0;
<a name="l00076"></a>00076   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiHazeHull.html#958f983dc5f4cbdb1d9d8943edb1805f" title="Get the edge index that starts at given vertex number in polygon Also returns the...">GetPolEdge</a>(<span class="keywordtype">int</span> polygon_num, <span class="keywordtype">int</span> vertex_num, <span class="keywordtype">int</span>&amp; start_idx,
<a name="l00077"></a>00077     <span class="keywordtype">int</span>&amp; end_idx) <span class="keyword">const</span> = 0;
<a name="l00078"></a>00078 };
<a name="l00079"></a>00079 
<a name="l00083"></a><a class="code" href="structiHazeHullBox.html">00083</a> <span class="keyword">struct </span><a class="code" href="structiHazeHullBox.html" title="A predefined hull.">iHazeHullBox</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085   SCF_INTERFACE(<a class="code" href="structiHazeHullBox.html" title="A predefined hull.">iHazeHullBox</a>, 2, 0, 0);
<a name="l00086"></a>00086 
<a name="l00088"></a>00088   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiHazeHullBox.html#915be6e04943acf07220b15e987fe8a4" title="get box settings, min and max">GetSettings</a>(<a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; min, <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; max) = 0;
<a name="l00089"></a>00089 };
<a name="l00090"></a>00090 
<a name="l00094"></a><a class="code" href="structiHazeHullCone.html">00094</a> <span class="keyword">struct </span><a class="code" href="structiHazeHullCone.html" title="A predefined hull.">iHazeHullCone</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00095"></a>00095 {
<a name="l00096"></a>00096   SCF_INTERFACE(<a class="code" href="structiHazeHullCone.html" title="A predefined hull.">iHazeHullCone</a>, 2, 0, 0);
<a name="l00097"></a>00097 
<a name="l00099"></a>00099   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiHazeHullCone.html#d2abda5d32cf4a92eec06fd91b3226bf" title="get Cone settings, nr_sides, start, end and radii of those">GetSettings</a>(<span class="keywordtype">int</span> &amp;nr, <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; a, <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; b, <span class="keywordtype">float</span> &amp;ra,
<a name="l00100"></a>00100         <span class="keywordtype">float</span> &amp;rb) = 0;
<a name="l00101"></a>00101 };
<a name="l00102"></a>00102 
<a name="l00107"></a><a class="code" href="structiHazeHullCreation.html">00107</a> <span class="keyword">struct </span><a class="code" href="structiHazeHullCreation.html" title="This interface is implemented by the haze factory in order to be able to create the...">iHazeHullCreation</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00108"></a>00108 {
<a name="l00109"></a>00109   SCF_INTERFACE(<a class="code" href="structiHazeHullCreation.html" title="This interface is implemented by the haze factory in order to be able to create the...">iHazeHullCreation</a>, 2, 0, 0);
<a name="l00110"></a>00110 
<a name="l00112"></a>00112   <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iHazeHullBox&gt;</a> <a class="code" href="structiHazeHullCreation.html#3e5f1d8d0b7a3efff7fc9c33ba7a514c" title="create a predefined hull: a box given min and max.">CreateBox</a>(<span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; min,
<a name="l00113"></a>00113     <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; max) <span class="keyword">const</span> = 0;
<a name="l00115"></a>00115   <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iHazeHullCone&gt;</a> <a class="code" href="structiHazeHullCreation.html#daae5c366fe5923e43c064950d38e562" title="create a predefined hull: a cone">CreateCone</a>(<span class="keywordtype">int</span> nr_sides, <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; start,
<a name="l00116"></a>00116     <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; end, <span class="keywordtype">float</span> srad, <span class="keywordtype">float</span> erad) <span class="keyword">const</span> = 0;
<a name="l00117"></a>00117 };
<a name="l00118"></a>00118 
<a name="l00126"></a><a class="code" href="structiHazeFactoryState.html">00126</a> <span class="keyword">struct </span><a class="code" href="structiHazeFactoryState.html" title="This interface describes the API for the sprite factory mesh object.">iHazeFactoryState</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00127"></a>00127 {
<a name="l00128"></a>00128   SCF_INTERFACE(<a class="code" href="structiHazeFactoryState.html" title="This interface describes the API for the sprite factory mesh object.">iHazeFactoryState</a>, 2, 0, 0);
<a name="l00129"></a>00129 
<a name="l00131"></a>00131   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiHazeFactoryState.html#a0ac21c4a3216544b0777fb6078edd4d" title="Set the point of origin, the center of the texture.">SetOrigin</a>(<span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; pos) = 0;
<a name="l00133"></a>00133   <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; <a class="code" href="structiHazeFactoryState.html#33e7d119e191d04df5167db3ab44562c" title="Get the point of origin.">GetOrigin</a>() <span class="keyword">const</span> = 0;
<a name="l00134"></a>00134 
<a name="l00136"></a>00136   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiHazeFactoryState.html#c0f3971442ff07b850813ef0cfaf0823" title="Set the topmiddle point of the texture.">SetDirectional</a>(<span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; pos) = 0;
<a name="l00138"></a>00138   <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; <a class="code" href="structiHazeFactoryState.html#7f055643eac65b636c4b4cfbe47ee415" title="Get the topmiddle point of the texture.">GetDirectional</a>() <span class="keyword">const</span> = 0;
<a name="l00139"></a>00139 
<a name="l00141"></a>00141   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structiHazeFactoryState.html#e331a65c0e9c970c4cfe3ceafcb73c86" title="Get the number of layers of hulls.">GetLayerCount</a>() <span class="keyword">const</span> = 0;
<a name="l00143"></a>00143   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiHazeFactoryState.html#7f2483413d4c67e1a669b815ba7aee5b" title="add a new layer - increasing the layer count">AddLayer</a>(<a class="code" href="structiHazeHull.html" title="A mesh specially meant for use by the haze.">iHazeHull</a> *hull, <span class="keywordtype">float</span> scale) = 0;
<a name="l00145"></a>00145   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiHazeFactoryState.html#7c0b0cbcd8633180030778a137944a7a" title="Set the convex hull to be used as layer. Increfs the hull.">SetLayerHull</a>(<span class="keywordtype">int</span> layer, <a class="code" href="structiHazeHull.html" title="A mesh specially meant for use by the haze.">iHazeHull</a>* hull) = 0;
<a name="l00147"></a>00147   <span class="keyword">virtual</span> <a class="code" href="structiHazeHull.html" title="A mesh specially meant for use by the haze.">iHazeHull</a>* <a class="code" href="structiHazeFactoryState.html#1387dca7cc8ff0d13df4768f234df1a6" title="Get the convex hull used for layer.">GetLayerHull</a>(<span class="keywordtype">int</span> layer) <span class="keyword">const</span> = 0;
<a name="l00149"></a>00149   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiHazeFactoryState.html#3003f7b9252685bd6e5c1fd90ffa8609" title="Set the texture percentage used by a layer (total of 1.0 is max).">SetLayerScale</a>(<span class="keywordtype">int</span> layer, <span class="keywordtype">float</span> scale) = 0;
<a name="l00151"></a>00151   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiHazeFactoryState.html#4b6dda04fcd8673ef90d7ed1d1fbe06f" title="Get the layer scale.">GetLayerScale</a>(<span class="keywordtype">int</span> layer) <span class="keyword">const</span> = 0;
<a name="l00152"></a>00152 };
<a name="l00153"></a>00153 
<a name="l00158"></a><a class="code" href="structiHazeState.html">00158</a> <span class="keyword">struct </span><a class="code" href="structiHazeState.html" title="This interface describes the API for the sprite factory mesh object.">iHazeState</a> : <span class="keyword">public</span> <a class="code" href="structiHazeFactoryState.html" title="This interface describes the API for the sprite factory mesh object.">iHazeFactoryState</a>
<a name="l00159"></a>00159 {
<a name="l00160"></a>00160   SCF_INTERFACE(<a class="code" href="structiHazeState.html" title="This interface describes the API for the sprite factory mesh object.">iHazeState</a>, 2, 0, 0);
<a name="l00161"></a>00161 };
<a name="l00162"></a>00162 
<a name="l00165"></a>00165 <span class="preprocessor">#endif // __CS_IMESH_HAZE_H__</span>
<a name="l00166"></a>00166 <span class="preprocessor"></span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>