Sophie

Sophie

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

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/halo.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/halo.h</h1><a href="iengine_2halo_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 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_HALO_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IENGINE_HALO_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 <span class="preprocessor">#include "<a class="code" href="vector4_8h.html" title="4D vector.">csgeom/vector4.h</a>"</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <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="l00033"></a>00033 
<a name="l00037"></a><a class="code" href="group__engine3d__light.html#g482a040cff77601b9b340bcc38cb3f76">00037</a> <span class="keyword">enum</span> <a class="code" href="group__engine3d__light.html#g482a040cff77601b9b340bcc38cb3f76" title="The possible halo-types.">csHaloType</a>
<a name="l00038"></a>00038 {
<a name="l00040"></a><a class="code" href="group__engine3d__light.html#gg482a040cff77601b9b340bcc38cb3f7642f5ce2483c630e10c39c91dc1666b12">00040</a>   <a class="code" href="group__engine3d__light.html#gg482a040cff77601b9b340bcc38cb3f7642f5ce2483c630e10c39c91dc1666b12" title="Cross halo.">cshtCross</a>,
<a name="l00042"></a><a class="code" href="group__engine3d__light.html#gg482a040cff77601b9b340bcc38cb3f76dcbcf1c751a00e94401180ac4bdf0c09">00042</a>   <a class="code" href="group__engine3d__light.html#gg482a040cff77601b9b340bcc38cb3f76dcbcf1c751a00e94401180ac4bdf0c09" title="Nova halo.">cshtNova</a>,
<a name="l00044"></a><a class="code" href="group__engine3d__light.html#gg482a040cff77601b9b340bcc38cb3f7641543e7b1b5b59d4a37b93963721c89f">00044</a>   <a class="code" href="group__engine3d__light.html#gg482a040cff77601b9b340bcc38cb3f7641543e7b1b5b59d4a37b93963721c89f" title="Flare halo.">cshtFlare</a>
<a name="l00045"></a>00045 };
<a name="l00046"></a>00046 
<a name="l00050"></a><a class="code" href="structiBaseHalo.html">00050</a> <span class="keyword">struct </span><a class="code" href="structiBaseHalo.html" title="This is the basic interface for all types of halos.">iBaseHalo</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="structiBaseHalo.html" title="This is the basic interface for all types of halos.">iBaseHalo</a>,2,0,0);
<a name="l00054"></a>00054   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBaseHalo.html#96f5b0ef4e951a5b8d1dd0b118c0af7f" title="Set intensity.">SetIntensity</a> (<span class="keywordtype">float</span> i) = 0;
<a name="l00056"></a>00056   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiBaseHalo.html#cfe9b3cb7655164b6af64e7000311c18" title="Get intensity.">GetIntensity</a> () = 0;
<a name="l00058"></a>00058   <span class="keyword">virtual</span> <a class="code" href="group__engine3d__light.html#g482a040cff77601b9b340bcc38cb3f76" title="The possible halo-types.">csHaloType</a> <a class="code" href="structiBaseHalo.html#522818e9d5340e2eba1ec10e77aa8cc3" title="Get halo type.">GetType</a> () = 0;
<a name="l00059"></a>00059 };
<a name="l00060"></a>00060 
<a name="l00064"></a><a class="code" href="structiCrossHalo.html">00064</a> <span class="keyword">struct </span><a class="code" href="structiCrossHalo.html" title="This is a halo which resembles a cross.">iCrossHalo</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="l00065"></a>00065 {
<a name="l00066"></a>00066   SCF_INTERFACE(<a class="code" href="structiCrossHalo.html" title="This is a halo which resembles a cross.">iCrossHalo</a>,2,0,0);
<a name="l00068"></a>00068   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCrossHalo.html#636f9977b93a0858b6391d473196070b" title="Set intensity factor.">SetIntensityFactor</a> (<span class="keywordtype">float</span> i) = 0;
<a name="l00070"></a>00070   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiCrossHalo.html#d18cb563147c0a2c434343f53ab56afa" title="Get intensity factor.">GetIntensityFactor</a> () = 0;
<a name="l00072"></a>00072   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCrossHalo.html#2e93bf90d5ff6bce2135ff18757c79d0" title="Set cross factor.">SetCrossFactor</a> (<span class="keywordtype">float</span> i) = 0;
<a name="l00074"></a>00074   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiCrossHalo.html#9a2b667ad8060f3fd7fbd6a8ae38cb1d" title="Get cross factor.">GetCrossFactor</a> () = 0;
<a name="l00075"></a>00075 };
<a name="l00076"></a>00076 
<a name="l00080"></a><a class="code" href="structiNovaHalo.html">00080</a> <span class="keyword">struct </span><a class="code" href="structiNovaHalo.html" title="This is a halo which resembles a nova.">iNovaHalo</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="l00081"></a>00081 {
<a name="l00082"></a>00082   SCF_INTERFACE(<a class="code" href="structiNovaHalo.html" title="This is a halo which resembles a nova.">iNovaHalo</a>,2,0,0);
<a name="l00084"></a>00084   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiNovaHalo.html#75178bc04e9d1f19ecc9007e46a7b8c8" title="Set random seed for generating the halo.">SetRandomSeed</a> (<span class="keywordtype">int</span> s) = 0;
<a name="l00086"></a>00086   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiNovaHalo.html#9ba1e340e043eb77d175ea1551976ea5" title="Get random seed.">GetRandomSeed</a> () = 0;
<a name="l00088"></a>00088   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiNovaHalo.html#e8974e7e01a3b031b3f89430d74a77cb" title="Set the number of halo spokes.">SetSpokeCount</a> (<span class="keywordtype">int</span> s) = 0;
<a name="l00090"></a>00090   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiNovaHalo.html#5e1e63a97c38d0132b47ba76c363c99b" title="Get the number of halo spokes.">GetSpokeCount</a> () = 0;
<a name="l00092"></a>00092   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiNovaHalo.html#a0e3b377230e498eecad077420302c7d" title="Set the roundness factor.">SetRoundnessFactor</a> (<span class="keywordtype">float</span> r) = 0;
<a name="l00094"></a>00094   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiNovaHalo.html#ada7d93b287cbcd43f4a84893024d627" title="Get the roundness factor.">GetRoundnessFactor</a> () = 0;
<a name="l00095"></a>00095 };
<a name="l00096"></a>00096 
<a name="l00100"></a><a class="code" href="structiFlareHalo.html">00100</a> <span class="keyword">struct </span><a class="code" href="structiFlareHalo.html" title="This is a halo which resembles a (solar) flare.">iFlareHalo</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="l00101"></a>00101 {
<a name="l00102"></a>00102   SCF_INTERFACE(<a class="code" href="structiFlareHalo.html" title="This is a halo which resembles a (solar) flare.">iFlareHalo</a>,2,0,0);
<a name="l00109"></a>00109   <span class="keyword">virtual</span> <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> <a class="code" href="structiFlareHalo.html#6794a95f4f4ab0ea98a6a0cb2d3bf28f" title="Add a visual component to the flare.">AddComponent</a> (<span class="keywordtype">float</span> pos, <span class="keywordtype">float</span> w, <span class="keywordtype">float</span> h, <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> mode,
<a name="l00110"></a>00110     <a class="code" href="structiMaterialWrapper.html" title="A material wrapper is an engine-level object that wraps around an actual material...">iMaterialWrapper</a> *image) = 0;
<a name="l00111"></a>00111 
<a name="l00115"></a>00115   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiFlareHalo.html#70bbed9f5845423bee23f4215aa38a73" title="Set component color, use id retrieved from AddComponent.">SetComponentColor</a> (<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> component, <span class="keyword">const</span> <a class="code" href="classcsVector4.html" title="A 4D vector with &amp;quot;float&amp;quot; components.">csVector4</a>&amp; color) = 0;
<a name="l00116"></a>00116 };
<a name="l00117"></a>00117 
<a name="l00120"></a>00120 <span class="preprocessor">#endif // __CS_IENGINE_HALO_H__</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