diff options
Diffstat (limited to 'docs/doxygen/nel/landscape__user_8h-source.html')
-rw-r--r-- | docs/doxygen/nel/landscape__user_8h-source.html | 233 |
1 files changed, 233 insertions, 0 deletions
diff --git a/docs/doxygen/nel/landscape__user_8h-source.html b/docs/doxygen/nel/landscape__user_8h-source.html new file mode 100644 index 00000000..b3517c88 --- /dev/null +++ b/docs/doxygen/nel/landscape__user_8h-source.html @@ -0,0 +1,233 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>landscape_user.h</h1><a href="landscape__user_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This file is part of NEVRAX NEL.</font> +00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font> +00013 <font class="comment"> * any later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font> +00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font> +00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font> +00023 <font class="comment"> * MA 02111-1307, USA.</font> +00024 <font class="comment"> */</font> +00025 +00026 <font class="preprocessor">#ifndef NL_LANDSCAPE_USER_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_LANDSCAPE_USER_H</font> +00028 <font class="preprocessor"></font> +00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font> +00030 <font class="preprocessor">#include "<a class="code" href="u__landscape_8h.html">nel/3d/u_landscape.h</a>"</font> +00031 <font class="preprocessor">#include "<a class="code" href="landscape__model_8h.html">3d/landscape_model.h</a>"</font> +00032 <font class="preprocessor">#include "<a class="code" href="zone__manager_8h.html">3d/zone_manager.h</a>"</font> +00033 <font class="preprocessor">#include "<a class="code" href="scene_8h.html">3d/scene.h</a>"</font> +00034 +<a name="l00035"></a><a class="code" href="landscape__user_8h.html#a0">00035</a> <font class="preprocessor">#define NL3D_MEM_LANDSCAPE NL_ALLOC_CONTEXT( 3dLand )</font> +00036 <font class="preprocessor"></font> +00037 <font class="keyword">namespace </font>NL3D +00038 { +00039 +00040 +00041 <font class="comment">//****************************************************************************</font> +<a name="l00048"></a><a class="code" href="classNL3D_1_1CLandscapeUser.html">00048</a> <font class="comment"></font><font class="keyword">class </font>CLandscapeUser : <font class="keyword">public</font> ULandscape +00049 { +00050 <font class="keyword">private</font>: +00051 <font class="comment">// The Scene.</font> +<a name="l00052"></a><a class="code" href="classNL3D_1_1CLandscapeUser.html#o0">00052</a> CScene *<a class="code" href="classNL3D_1_1CLandscapeUser.html#o0">_Scene</a>; +00053 <font class="comment">// The landscape, owned by the scene.</font> +<a name="l00054"></a><a class="code" href="classNL3D_1_1CLandscapeUser.html#o1">00054</a> CLandscapeModel *<a class="code" href="classNL3D_1_1CLandscapeUser.html#o1">_Landscape</a>; +00055 <font class="comment">// The zoneManager.</font> +<a name="l00056"></a><a class="code" href="classNL3D_1_1CLandscapeUser.html#o2">00056</a> CZoneManager <a class="code" href="classNL3D_1_1CLandscapeUser.html#o2">_ZoneManager</a>; +00057 +00058 <font class="keyword">public</font>: +00059 +00061 <font class="comment">// @{</font> +<a name="l00062"></a><a class="code" href="classNL3D_1_1CLandscapeUser.html#z500_0">00062</a> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z500_0">CLandscapeUser</a>(CScene *scene) +00063 { +00064 <a class="code" href="landscape__user_8h.html#a0">NL3D_MEM_LANDSCAPE</a> +00065 <a class="code" href="debug_8h.html#a6">nlassert</a>(scene); +00066 <a class="code" href="classNL3D_1_1CLandscapeUser.html#o0">_Scene</a>= scene; +00067 <a class="code" href="classNL3D_1_1CLandscapeUser.html#o1">_Landscape</a>= (CLandscapeModel*)<a class="code" href="classNL3D_1_1CLandscapeUser.html#o0">_Scene</a>->createModel(<a class="code" href="namespaceNL3D.html#a72">LandscapeModelId</a>); +00068 } +<a name="l00069"></a><a class="code" href="classNL3D_1_1CLandscapeUser.html#z500_1">00069</a> <font class="keyword">virtual</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z500_1">~CLandscapeUser</a>() +00070 { +00071 <a class="code" href="landscape__user_8h.html#a0">NL3D_MEM_LANDSCAPE</a> +00072 <a class="code" href="classNL3D_1_1CLandscapeUser.html#o0">_Scene</a>->deleteModel(<a class="code" href="classNL3D_1_1CLandscapeUser.html#o1">_Landscape</a>); +00073 <a class="code" href="classNL3D_1_1CLandscapeUser.html#o1">_Landscape</a>= NULL; +00074 } +00075 <font class="comment">// @}</font> +00076 +00077 +00080 <font class="comment">// @{</font> +00082 <font class="comment"> virtual void setZonePath(const std::string &zonePath);</font> +00084 <font class="comment"> virtual void loadBankFiles(const std::string &tileBankFile, const std::string &farBankFile);</font> +00086 <font class="comment"> virtual void loadAllZonesAround(const CVector &pos, float radius);</font> +00087 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z501_2">loadAllZonesAround</a>(<font class="keyword">const</font> CVector &pos, <font class="keywordtype">float</font> radius, std::vector<std::string> &zonesAdded); +00089 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z501_4">refreshZonesAround</a>(<font class="keyword">const</font> CVector &pos, <font class="keywordtype">float</font> radius); +00090 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z501_4">refreshZonesAround</a>(<font class="keyword">const</font> CVector &pos, <font class="keywordtype">float</font> radius, std::string &zoneAdded, std::string &zoneRemoved); +00092 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z501_6">refreshAllZonesAround</a>(<font class="keyword">const</font> CVector &pos, <font class="keywordtype">float</font> radius, std::vector<std::string> &zonesAdded, std::vector<std::string> &zonesRemoved); +00093 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z501_7">getAllZoneLoaded</a>(std::vector<std::string> &zoneLoaded) <font class="keyword">const</font>; +00094 <font class="comment">// @}</font> +00095 +00096 +00098 <font class="comment">// @{</font> +00107 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z502_0">setupStaticLight</a> (<font class="keyword">const</font> CRGBA &diffuse, <font class="keyword">const</font> CRGBA &ambiant, <font class="keywordtype">float</font> multiply); +00108 +00109 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z502_1">setPointLightDiffuseMaterial</a>(CRGBA diffuse); +00110 <font class="keyword">virtual</font> CRGBA <a class="code" href="classNL3D_1_1CLandscapeUser.html#z502_2">getPointLightDiffuseMaterial</a> () <font class="keyword">const</font>; +00111 +00112 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z502_3">setPointLightFactor</a>(<font class="keyword">const</font> std::string &lightGroupName, <a class="code" href="classNLMISC_1_1CRGBA.html">NLMISC::CRGBA</a> nFactor); +00113 +00114 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z502_4">setUpdateLightingFrequency</a>(<font class="keywordtype">float</font> freq); +00115 +00116 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z502_5">updateLightingAll</a>(); +00117 +00118 <font class="comment">// @}</font> +00119 +00120 +00122 <font class="comment">// @{</font> +00124 <font class="comment"> virtual void setThreshold (float thre);</font> +00126 <font class="comment"> virtual float getThreshold () const;</font> +00128 <font class="comment"> virtual void setTileNear (float tileNear);</font> +00130 <font class="comment"> virtual float getTileNear () const;</font> +00132 <font class="comment"> virtual void setTileMaxSubdivision (uint tileDiv);</font> +00134 <font class="comment"> virtual uint getTileMaxSubdivision ();</font> +00135 <font class="comment">// @}</font> +00136 +00137 +00139 <font class="comment">// @{</font> +00141 <font class="comment"> virtual std::string getZoneName(const CVector &pos);</font> +00142 +<a name="l00143"></a><a class="code" href="classNL3D_1_1CLandscapeUser.html#z504_1">00143</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z504_1">show</a>() +00144 { +00145 <a class="code" href="landscape__user_8h.html#a0">NL3D_MEM_LANDSCAPE</a> +00146 <a class="code" href="classNL3D_1_1CLandscapeUser.html#o1">_Landscape</a>->show(); +00147 } +<a name="l00148"></a><a class="code" href="classNL3D_1_1CLandscapeUser.html#z504_2">00148</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z504_2">hide</a>() +00149 { +00150 <a class="code" href="landscape__user_8h.html#a0">NL3D_MEM_LANDSCAPE</a> +00151 <a class="code" href="classNL3D_1_1CLandscapeUser.html#o1">_Landscape</a>->hide(); +00152 } +00153 +00154 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z504_3">enableAdditive</a> (<font class="keywordtype">bool</font> enable); +00155 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z504_4">isAdditiveEnabled</a> () <font class="keyword">const</font>; +00156 +00157 <font class="comment">// @}</font> +00158 +00159 +00161 <font class="comment">// @{</font> +00162 <font class="keyword">virtual</font> CVector <a class="code" href="classNL3D_1_1CLandscapeUser.html#z505_0">getHeightFieldDeltaZ</a>(<font class="keywordtype">float</font> <a class="code" href="driver__opengl__extension__def_8h.html#a364">x</a>, <font class="keywordtype">float</font> <a class="code" href="driver__opengl__extension__def_8h.html#a365">y</a>) <font class="keyword">const</font>; +00163 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z505_1">setHeightField</a>(<font class="keyword">const</font> CHeightMap &hf); +00164 <font class="comment">// @}</font> +00165 +00167 <font class="comment">// @{</font> +00168 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z506_0">enableVegetable</a>(<font class="keywordtype">bool</font> enable); +00169 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z506_1">loadVegetableTexture</a>(<font class="keyword">const</font> std::string &textureFileName); +00170 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z506_2">setupVegetableLighting</a>(<font class="keyword">const</font> CRGBA &ambient, <font class="keyword">const</font> CRGBA &diffuse, <font class="keyword">const</font> CVector &directionalLight); +00171 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z506_3">setVegetableWind</a>(<font class="keyword">const</font> CVector &windDir, <font class="keywordtype">float</font> windFreq, <font class="keywordtype">float</font> windPower, <font class="keywordtype">float</font> windBendMin); +00172 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z506_4">setVegetableUpdateLightingFrequency</a>(<font class="keywordtype">float</font> freq); +00173 <font class="comment">// @}</font> +00174 +00175 +00177 <font class="comment">// @{</font> +00178 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#z507_0">setDLMGlobalVegetableColor</a>(CRGBA gvc); +00179 <font class="keyword">virtual</font> CRGBA <a class="code" href="classNL3D_1_1CLandscapeUser.html#z507_1">getDLMGlobalVegetableColor</a>() <font class="keyword">const</font>; +00180 <font class="comment">// @}</font> +00181 +00182 <font class="keyword">public</font>: +00184 <font class="comment">// @{</font> +<a name="l00185"></a><a class="code" href="classNL3D_1_1CLandscapeUser.html#z508_0">00185</a> CLandscapeModel *<a class="code" href="classNL3D_1_1CLandscapeUser.html#z508_0">getLandscape</a>() +00186 { +00187 <a class="code" href="landscape__user_8h.html#a0">NL3D_MEM_LANDSCAPE</a> +00188 <font class="keywordflow">return</font> <a class="code" href="classNL3D_1_1CLandscapeUser.html#o1">_Landscape</a>; +00189 } +00190 <font class="comment">// @}</font> +00191 +00192 }; +00193 +00194 +00195 } <font class="comment">// NL3D</font> +00196 +00197 +00198 <font class="preprocessor">#endif // NL_LANDSCAPE_USER_H</font> +00199 <font class="preprocessor"></font> +00200 <font class="comment">/* End of landscape_user.h */</font> +</pre></div> + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |