Sophie

Sophie

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

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/campos.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/campos.h</h1><a href="campos_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) 2000 by Jorrit Tyberghein</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_IENGINE_CAMPOS_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IENGINE_CAMPOS_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="scf_8h.html" title="Crystal Space Shared Class Facility (SCF).">csutil/scf.h</a>"</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="keyword">class </span><a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>;
<a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classcsPlane3.html" title="A plane in 3D space.">csPlane3</a>;
<a name="l00033"></a>00033 <span class="keyword">struct </span><a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>;
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiEngine.html" title="This interface is the main interface to the 3D engine.">iEngine</a>;
<a name="l00035"></a>00035 <span class="keyword">struct </span><a class="code" href="structiCamera.html" title="Camera class.">iCamera</a>;
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 
<a name="l00060"></a><a class="code" href="structiCameraPosition.html">00060</a> <span class="keyword">struct </span><a class="code" href="structiCameraPosition.html" title="A camera position.">iCameraPosition</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="l00061"></a>00061 {
<a name="l00062"></a>00062   SCF_INTERFACE(<a class="code" href="structiCameraPosition.html" title="A camera position.">iCameraPosition</a>,2,0,0);
<a name="l00064"></a>00064   <span class="keyword">virtual</span> <a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *<a class="code" href="structiCameraPosition.html#5258cfb5d9061117888c00b5b208e2a0" title="Get the iObject for this camera position.">QueryObject</a>() = 0;
<a name="l00065"></a>00065 
<a name="l00067"></a>00067   <span class="keyword">virtual</span> <a class="code" href="structiCameraPosition.html" title="A camera position.">iCameraPosition</a>* <a class="code" href="structiCameraPosition.html#8f4ad04b45a404c7f6475b273482ca41" title="Create a clone this camera position.">Clone</a> () <span class="keyword">const</span> = 0;
<a name="l00068"></a>00068 
<a name="l00070"></a>00070   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structiCameraPosition.html#2658c3e8a7bade1203a58d95e1daad8e" title="Return the home sector.">GetSector</a> () = 0;
<a name="l00072"></a>00072   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCameraPosition.html#1d6f44a13c54826e358df70a5b3b5f32" title="Set the home sector.">SetSector</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *Name) = 0;
<a name="l00073"></a>00073 
<a name="l00075"></a>00075   <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="structiCameraPosition.html#739ab5871b57f912024b37b9f41e1f3d" title="Return the position.">GetPosition</a> () = 0;
<a name="l00077"></a>00077   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCameraPosition.html#48ad5f673fa4ebd8218e32b972ae4d9a" title="Set the position.">SetPosition</a> (<span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> &amp;p) = 0;
<a name="l00078"></a>00078 
<a name="l00080"></a>00080   <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="structiCameraPosition.html#7dae9e578708d9146d194240aaaa3c5f" title="Return the &amp;#39;up&amp;#39; vector.">GetUpwardVector</a> () = 0;
<a name="l00082"></a>00082   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCameraPosition.html#c6267bbe939332a92e89cfe4921a580c" title="Set the &amp;#39;up&amp;#39; vector.">SetUpwardVector</a> (<span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> &amp;v) = 0;
<a name="l00083"></a>00083 
<a name="l00085"></a>00085   <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="structiCameraPosition.html#2f68550836f774784dced4498599de73" title="Return the &amp;#39;front&amp;#39; vector.">GetForwardVector</a> () = 0;
<a name="l00087"></a>00087   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCameraPosition.html#98da9ccc294ba36b191908ff0ab0380c" title="Set the &amp;#39;front&amp;#39; vector.">SetForwardVector</a> (<span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> &amp;v) = 0;
<a name="l00088"></a>00088 
<a name="l00090"></a>00090   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCameraPosition.html#049a3062ce70650dbbdb251866bc1941" title="Set all attributes of the camera position.">Set</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *sector, <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> &amp;pos,
<a name="l00091"></a>00091       <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> &amp;forward, <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> &amp;upward) = 0;
<a name="l00092"></a>00092 
<a name="l00094"></a>00094   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiCameraPosition.html#15f694525af59eb5501e511caaf08b20" title="Load the camera position into a camera object.">Load</a> (<a class="code" href="structiCamera.html" title="Camera class.">iCamera</a>*, <a class="code" href="structiEngine.html" title="This interface is the main interface to the 3D engine.">iEngine</a>*) = 0;
<a name="l00095"></a>00095 
<a name="l00104"></a>00104   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCameraPosition.html#da700c6068310cfe2e2133303defac5a" title="Set the 3D far plane used to clip all geometry.">SetFarPlane</a> (<a class="code" href="classcsPlane3.html" title="A plane in 3D space.">csPlane3</a>* pl) = 0;
<a name="l00105"></a>00105 
<a name="l00110"></a>00110   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCameraPosition.html#d993d135ac27c64b16499d5ea7f90d69" title="Clear the far plane so no clipping will occur.">ClearFarPlane</a> () = 0;
<a name="l00111"></a>00111 
<a name="l00115"></a>00115   <span class="keyword">virtual</span> <a class="code" href="classcsPlane3.html" title="A plane in 3D space.">csPlane3</a>* <a class="code" href="structiCameraPosition.html#ffa5ab4c49aca96e0fda8f5a130dea7c" title="Get the current far plane (or 0 if none is defined).">GetFarPlane</a> () <span class="keyword">const</span> = 0;
<a name="l00116"></a>00116 };
<a name="l00117"></a>00117 
<a name="l00128"></a><a class="code" href="structiCameraPositionList.html">00128</a> <span class="keyword">struct </span><a class="code" href="structiCameraPositionList.html" title="A list of camera position objects.">iCameraPositionList</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="l00129"></a>00129 {
<a name="l00130"></a>00130   SCF_INTERFACE(<a class="code" href="structiCameraPositionList.html" title="A list of camera position objects.">iCameraPositionList</a>,2,0,0);
<a name="l00132"></a>00132   <span class="keyword">virtual</span> <a class="code" href="structiCameraPosition.html" title="A camera position.">iCameraPosition</a>* <a class="code" href="structiCameraPositionList.html#e2f07c78bc282954a2d5619a60e0bfbd" title="Create a new empty camera position.">NewCameraPosition</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* name) = 0;
<a name="l00133"></a>00133 
<a name="l00135"></a>00135   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiCameraPositionList.html#d2918880c25b5b2fbe4e5ad80872dbcb" title="Return the number of camera positions in this list.">GetCount</a> () <span class="keyword">const</span> = 0;
<a name="l00136"></a>00136 
<a name="l00138"></a>00138   <span class="keyword">virtual</span> <a class="code" href="structiCameraPosition.html" title="A camera position.">iCameraPosition</a> *<a class="code" href="structiCameraPositionList.html#ccfb7d05d33cc3063a038e51fa313c14" title="Return a camera position by index.">Get</a> (<span class="keywordtype">int</span> n) <span class="keyword">const</span> = 0;
<a name="l00139"></a>00139 
<a name="l00141"></a>00141   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiCameraPositionList.html#95ab94c2b074c9e17df52ee9bdacfb9b" title="Add a camera position.">Add</a> (<a class="code" href="structiCameraPosition.html" title="A camera position.">iCameraPosition</a> *obj) = 0;
<a name="l00142"></a>00142 
<a name="l00144"></a>00144   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiCameraPositionList.html#47912c0cf50fc4a157c3adc94f800efd" title="Remove a camera position.">Remove</a> (<a class="code" href="structiCameraPosition.html" title="A camera position.">iCameraPosition</a> *obj) = 0;
<a name="l00145"></a>00145 
<a name="l00147"></a>00147   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiCameraPositionList.html#47912c0cf50fc4a157c3adc94f800efd" title="Remove a camera position.">Remove</a> (<span class="keywordtype">int</span> n) = 0;
<a name="l00148"></a>00148 
<a name="l00150"></a>00150   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCameraPositionList.html#f058f0282a137a2759465f53de7740e8" title="Remove all camera positions.">RemoveAll</a> () = 0;
<a name="l00151"></a>00151 
<a name="l00153"></a>00153   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiCameraPositionList.html#d8843793fd9944b5914a0b32c7c4ed08" title="Find a camera position and return its index.">Find</a> (<a class="code" href="structiCameraPosition.html" title="A camera position.">iCameraPosition</a> *obj) <span class="keyword">const</span> = 0;
<a name="l00154"></a>00154 
<a name="l00156"></a>00156   <span class="keyword">virtual</span> <a class="code" href="structiCameraPosition.html" title="A camera position.">iCameraPosition</a> *<a class="code" href="structiCameraPositionList.html#5de4f2eb95e8ccc863e954d598c62b50" title="Find a camera position by name.">FindByName</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *Name) <span class="keyword">const</span> = 0;
<a name="l00157"></a>00157 };
<a name="l00158"></a>00158 
<a name="l00161"></a>00161 <span class="preprocessor">#endif // __CS_IENGINE_CAMPOS_H__</span>
<a name="l00162"></a>00162 <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