Sophie

Sophie

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

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: iengine/viscull.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>iengine/viscull.h</h1><a href="viscull_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">    Crystal Space 3D engine</span>
<a name="l00003"></a>00003 <span class="comment">    Copyright (C) 2001 by Jorrit Tyberghein</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_IENGINE_VISCULL_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IENGINE_VISCULL_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <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="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="keyword">struct </span><a class="code" href="structiDocumentNode.html" title="Representation of a node in a document.">iDocumentNode</a>;
<a name="l00033"></a>00033 <span class="keyword">struct </span><a class="code" href="structiFrustumView.html" title="This structure represents all information needed for the frustum visibility calculator...">iFrustumView</a>;
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a>;
<a name="l00035"></a>00035 <span class="keyword">struct </span><a class="code" href="structiMovable.html" title="This interface represents the position and orientation of an object relative to its...">iMovable</a>;
<a name="l00036"></a>00036 <span class="keyword">struct </span><a class="code" href="structiObjectModel.html" title="This interface represents data related to some geometry in object space.">iObjectModel</a>;
<a name="l00037"></a>00037 <span class="keyword">struct </span><a class="code" href="structiRenderView.html" title="This interface represents all information needed to render some object in a current...">iRenderView</a>;
<a name="l00038"></a>00038 <span class="keyword">struct </span><a class="code" href="structiVisibilityObject.html" title="An object that wants to know if it is visible or not for some visibility culler needs...">iVisibilityObject</a>;
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="keyword">class </span><a class="code" href="classcsBox3.html" title="A bounding box in 3D space.">csBox3</a>;
<a name="l00041"></a>00041 <span class="keyword">class </span><a class="code" href="classcsFlags.html" title="Set of flags which can be accessed through masks.">csFlags</a>;
<a name="l00042"></a>00042 <span class="keyword">class </span><a class="code" href="classcsPlane3.html" title="A plane in 3D space.">csPlane3</a>;
<a name="l00043"></a>00043 <span class="keyword">class </span><a class="code" href="classcsSphere.html" title="This class represents a sphere.">csSphere</a>;
<a name="l00044"></a>00044 <span class="keyword">class </span><a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>;
<a name="l00045"></a>00045 
<a name="l00049"></a><a class="code" href="structiVisibilityObjectIterator.html">00049</a> <span class="keyword">struct </span><a class="code" href="structiVisibilityObjectIterator.html" title="Iterator to iterate over some visibility objects.">iVisibilityObjectIterator</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="l00050"></a>00050 {
<a name="l00051"></a>00051   SCF_INTERFACE (<a class="code" href="structiVisibilityObjectIterator.html" title="Iterator to iterate over some visibility objects.">iVisibilityObjectIterator</a>, 2, 0, 0);
<a name="l00053"></a>00053   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiVisibilityObjectIterator.html#b2ff0f9a6b0bc515d0cdb2dfe3325f64" title="Are there more elements?">HasNext</a> () <span class="keyword">const</span> = 0;
<a name="l00054"></a>00054 
<a name="l00056"></a>00056   <span class="keyword">virtual</span> <a class="code" href="structiVisibilityObject.html" title="An object that wants to know if it is visible or not for some visibility culler needs...">iVisibilityObject</a>* <a class="code" href="structiVisibilityObjectIterator.html#250c597e8b0911d43a04d693ac74a3fe" title="Get next element.">Next</a> () = 0;
<a name="l00057"></a>00057 
<a name="l00059"></a>00059   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiVisibilityObjectIterator.html#e4e9848b7e3fb7b1239dcbb23f552ced" title="Reset the iterator to the beginning.">Reset</a> () = 0;
<a name="l00060"></a>00060 };
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 
<a name="l00070"></a><a class="code" href="structiVisibilityCullerListener.html">00070</a> <span class="keyword">struct </span><a class="code" href="structiVisibilityCullerListener.html" title="Implement this interface when you want to get notified about visible objects detected...">iVisibilityCullerListener</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="l00071"></a>00071 {
<a name="l00072"></a>00072   SCF_INTERFACE(<a class="code" href="structiVisibilityCullerListener.html" title="Implement this interface when you want to get notified about visible objects detected...">iVisibilityCullerListener</a>, 2,0,0);
<a name="l00080"></a>00080   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiVisibilityCullerListener.html#d662139cfaa77dcfe6dfd1f90d957cca" title="This function is called whenever the visibilty culler discovers a new visible mesh...">ObjectVisible</a> (<a class="code" href="structiVisibilityObject.html" title="An object that wants to know if it is visible or not for some visibility culler needs...">iVisibilityObject</a> *visobject, 
<a name="l00081"></a>00081     <a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a> *mesh, <a class="code" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e" title="unsigned 32-bit integer (0..4 294 967 295)">uint32</a> frustum_mask) = 0;
<a name="l00082"></a>00082 };
<a name="l00083"></a>00083 
<a name="l00101"></a><a class="code" href="structiVisibilityCuller.html">00101</a> <span class="keyword">struct </span><a class="code" href="structiVisibilityCuller.html" title="This interface represents a visibility culling system.">iVisibilityCuller</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="l00102"></a>00102 {
<a name="l00103"></a>00103   SCF_INTERFACE (<a class="code" href="structiVisibilityCuller.html" title="This interface represents a visibility culling system.">iVisibilityCuller</a>, 2, 0, 0);
<a name="l00104"></a>00104 
<a name="l00110"></a>00110   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiVisibilityCuller.html#07a0e0256194f61b96b0f0d2b90c77f9" title="Setup all data for this visibility culler.">Setup</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* name) = 0;
<a name="l00118"></a>00118   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiVisibilityCuller.html#8c96f1babf2e01bfbd3ef96ee47bcb46" title="Register a visibility object with this culler.">RegisterVisObject</a> (<a class="code" href="structiVisibilityObject.html" title="An object that wants to know if it is visible or not for some visibility culler needs...">iVisibilityObject</a>* visobj) = 0;
<a name="l00120"></a>00120   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiVisibilityCuller.html#a02d95359099fca6e6a8bb2ef63e20dd" title="Unregister a visibility object with this culler.">UnregisterVisObject</a> (<a class="code" href="structiVisibilityObject.html" title="An object that wants to know if it is visible or not for some visibility culler needs...">iVisibilityObject</a>* visobj) = 0;
<a name="l00127"></a>00127   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiVisibilityCuller.html#b967bd11db489f4cbcc1d99f8abe59a4" title="Do the visibility test from a given viewpoint.">VisTest</a> (<a class="code" href="structiRenderView.html" title="This interface represents all information needed to render some object in a current...">iRenderView</a>* irview, 
<a name="l00128"></a>00128     <a class="code" href="structiVisibilityCullerListener.html" title="Implement this interface when you want to get notified about visible objects detected...">iVisibilityCullerListener</a>* viscallback) = 0;
<a name="l00135"></a>00135   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiVisibilityCuller.html#11b9eafd09f419254a0f20489afc27fe" title="Precache visibility culling.">PrecacheCulling</a> () = 0;
<a name="l00136"></a>00136 
<a name="l00141"></a>00141   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iVisibilityObjectIterator&gt;</a> <a class="code" href="structiVisibilityCuller.html#b967bd11db489f4cbcc1d99f8abe59a4" title="Do the visibility test from a given viewpoint.">VisTest</a> (<span class="keyword">const</span> <a class="code" href="classcsBox3.html" title="A bounding box in 3D space.">csBox3</a>&amp; box) = 0;
<a name="l00142"></a>00142 
<a name="l00147"></a>00147   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iVisibilityObjectIterator&gt;</a> <a class="code" href="structiVisibilityCuller.html#b967bd11db489f4cbcc1d99f8abe59a4" title="Do the visibility test from a given viewpoint.">VisTest</a> (<span class="keyword">const</span> <a class="code" href="classcsSphere.html" title="This class represents a sphere.">csSphere</a>&amp; sphere) = 0;
<a name="l00152"></a>00152   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiVisibilityCuller.html#b967bd11db489f4cbcc1d99f8abe59a4" title="Do the visibility test from a given viewpoint.">VisTest</a> (<span class="keyword">const</span> <a class="code" href="classcsSphere.html" title="This class represents a sphere.">csSphere</a>&amp; sphere, 
<a name="l00153"></a>00153     <a class="code" href="structiVisibilityCullerListener.html" title="Implement this interface when you want to get notified about visible objects detected...">iVisibilityCullerListener</a>* viscallback) = 0;
<a name="l00154"></a>00154 
<a name="l00160"></a>00160   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iVisibilityObjectIterator&gt;</a> <a class="code" href="structiVisibilityCuller.html#b967bd11db489f4cbcc1d99f8abe59a4" title="Do the visibility test from a given viewpoint.">VisTest</a> (<a class="code" href="classcsPlane3.html" title="A plane in 3D space.">csPlane3</a>* plane,
<a name="l00161"></a>00161         <span class="keywordtype">int</span> num_planes) = 0;
<a name="l00162"></a>00162 
<a name="l00169"></a>00169   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiVisibilityCuller.html#b967bd11db489f4cbcc1d99f8abe59a4" title="Do the visibility test from a given viewpoint.">VisTest</a> (<a class="code" href="classcsPlane3.html" title="A plane in 3D space.">csPlane3</a>* plane, <span class="keywordtype">int</span> num_planes, 
<a name="l00170"></a>00170     <a class="code" href="structiVisibilityCullerListener.html" title="Implement this interface when you want to get notified about visible objects detected...">iVisibilityCullerListener</a>* viscallback) = 0;
<a name="l00171"></a>00171 
<a name="l00178"></a>00178   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iVisibilityObjectIterator&gt;</a> <a class="code" href="structiVisibilityCuller.html#5a45089074cdf23bf2f4bdc656b1a217" title="Intersect a segment with all objects in the visibility culler and return them all...">IntersectSegmentSloppy</a> (
<a name="l00179"></a>00179     <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; start, <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; end) = 0;
<a name="l00180"></a>00180 
<a name="l00186"></a>00186   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iVisibilityObjectIterator&gt;</a> <a class="code" href="structiVisibilityCuller.html#897ff1c31c766d9fc139e934132cd201" title="Intersect a segment with all objects in the visibility culler and return them all...">IntersectSegment</a> (
<a name="l00187"></a>00187     <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; start, <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; end, <span class="keywordtype">bool</span> accurate = <span class="keyword">false</span>) = 0;
<a name="l00188"></a>00188 
<a name="l00198"></a>00198   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiVisibilityCuller.html#897ff1c31c766d9fc139e934132cd201" title="Intersect a segment with all objects in the visibility culler and return them all...">IntersectSegment</a> (<span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; start,
<a name="l00199"></a>00199     <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; end, <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; isect, <span class="keywordtype">float</span>* pr = 0,
<a name="l00200"></a>00200     <a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a>** p_mesh = 0, <span class="keywordtype">int</span>* poly_idx = 0,
<a name="l00201"></a>00201     <span class="keywordtype">bool</span> accurate = <span class="keyword">true</span>) = 0;
<a name="l00202"></a>00202 
<a name="l00213"></a>00213   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiVisibilityCuller.html#10dfd2c7cb565500a07af26d3bff71f0" title="Start casting shadows from a given point in space.">CastShadows</a> (<a class="code" href="structiFrustumView.html" title="This structure represents all information needed for the frustum visibility calculator...">iFrustumView</a>* fview) = 0;
<a name="l00214"></a>00214 
<a name="l00219"></a>00219   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structiVisibilityCuller.html#df625d287371fad6dea9b8fcb6944308" title="Parse a document node with additional parameters for this culler.">ParseCullerParameters</a> (<a class="code" href="structiDocumentNode.html" title="Representation of a node in a document.">iDocumentNode</a>* node) = 0;
<a name="l00220"></a>00220 };
<a name="l00221"></a>00221 
<a name="l00229"></a><a class="code" href="group__engine3d__vis.html#g39aedbb767403fb92218c04880bea2a6">00229</a> <span class="preprocessor">#define CS_CULLER_HINT_GOODOCCLUDER 4</span>
<a name="l00230"></a>00230 <span class="preprocessor"></span>
<a name="l00235"></a><a class="code" href="group__engine3d__vis.html#gf9eaf6c105d2c8abc6ed0068e8a64657">00235</a> <span class="preprocessor">#define CS_CULLER_HINT_BADOCCLUDER 8</span>
<a name="l00236"></a>00236 <span class="preprocessor"></span>
<a name="l00252"></a><a class="code" href="structiVisibilityObject.html">00252</a> <span class="keyword">struct </span><a class="code" href="structiVisibilityObject.html" title="An object that wants to know if it is visible or not for some visibility culler needs...">iVisibilityObject</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="l00253"></a>00253 {
<a name="l00254"></a>00254   SCF_INTERFACE(<a class="code" href="structiVisibilityObject.html" title="An object that wants to know if it is visible or not for some visibility culler needs...">iVisibilityObject</a>, 2, 0, 0);
<a name="l00255"></a>00255 
<a name="l00257"></a>00257   <span class="keyword">virtual</span> <a class="code" href="structiMovable.html" title="This interface represents the position and orientation of an object relative to its...">iMovable</a>* <a class="code" href="structiVisibilityObject.html#9e0b3f844147c87b56d3bf944d4eea7b" title="Get the reference to the movable from this object.">GetMovable</a> () <span class="keyword">const</span> = 0;
<a name="l00259"></a>00259   <span class="keyword">virtual</span> <a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a>* <a class="code" href="structiVisibilityObject.html#e372954a163379ab43dc71169b3d547d" title="Get the reference to the mesh wrapper from this object.">GetMeshWrapper</a> () <span class="keyword">const</span> = 0;
<a name="l00260"></a>00260 
<a name="l00264"></a>00264   <span class="keyword">virtual</span> <a class="code" href="structiObjectModel.html" title="This interface represents data related to some geometry in object space.">iObjectModel</a>* <a class="code" href="structiVisibilityObject.html#11860dcf9e8f8da8fc54112ae6057a00" title="Get the object model corresponding with this object.">GetObjectModel</a> () = 0;
<a name="l00265"></a>00265 
<a name="l00272"></a>00272   <span class="keyword">virtual</span> <a class="code" href="classcsFlags.html" title="Set of flags which can be accessed through masks.">csFlags</a>&amp; <a class="code" href="structiVisibilityObject.html#cc0dcbf6bacf04dee327aa3d5214e898" title="Get flags for this object.">GetCullerFlags</a> () = 0;
<a name="l00273"></a>00273 };
<a name="l00274"></a>00274 
<a name="l00277"></a>00277 <span class="preprocessor">#endif // __CS_IENGINE_VISCULL_H__</span>
<a name="l00278"></a>00278 <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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional