Sophie

Sophie

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

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: iHazeFactoryState Struct Reference (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 class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>iHazeFactoryState Struct Reference<br>
<small>
[<a class="el" href="group__meshplugins.html">Mesh plugins</a>]</small>
</h1><!-- doxytag: class="iHazeFactoryState" --><!-- doxytag: inherits="iBase" -->This interface describes the API for the sprite factory mesh object.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="haze_8h-source.html">imesh/haze.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iHazeFactoryState:</div>
<div class="dynsection">
<p><center><img src="structiHazeFactoryState__inherit__graph.png" border="0" usemap="#iHazeFactoryState__inherit__map" alt="Inheritance graph"></center>
<map name="iHazeFactoryState__inherit__map">
<area shape="rect" href="structiHazeState.html" title="This interface describes the API for the sprite factory mesh object." alt="" coords="29,161,123,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="48,7,104,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiHazeFactoryState-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeFactoryState.html#7f2483413d4c67e1a669b815ba7aee5b">AddLayer</a> (<a class="el" href="structiHazeHull.html">iHazeHull</a> *hull, float scale)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">add a new layer - increasing the layer count  <a href="#7f2483413d4c67e1a669b815ba7aee5b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeFactoryState.html#7f055643eac65b636c4b4cfbe47ee415">GetDirectional</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the topmiddle point of the texture.  <a href="#7f055643eac65b636c4b4cfbe47ee415"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeFactoryState.html#e331a65c0e9c970c4cfe3ceafcb73c86">GetLayerCount</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of layers of hulls.  <a href="#e331a65c0e9c970c4cfe3ceafcb73c86"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiHazeHull.html">iHazeHull</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeFactoryState.html#1387dca7cc8ff0d13df4768f234df1a6">GetLayerHull</a> (int layer) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the convex hull used for layer.  <a href="#1387dca7cc8ff0d13df4768f234df1a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeFactoryState.html#4b6dda04fcd8673ef90d7ed1d1fbe06f">GetLayerScale</a> (int layer) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the layer scale.  <a href="#4b6dda04fcd8673ef90d7ed1d1fbe06f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeFactoryState.html#33e7d119e191d04df5167db3ab44562c">GetOrigin</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the point of origin.  <a href="#33e7d119e191d04df5167db3ab44562c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeFactoryState.html#c0f3971442ff07b850813ef0cfaf0823">SetDirectional</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;pos)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the topmiddle point of the texture.  <a href="#c0f3971442ff07b850813ef0cfaf0823"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeFactoryState.html#7c0b0cbcd8633180030778a137944a7a">SetLayerHull</a> (int layer, <a class="el" href="structiHazeHull.html">iHazeHull</a> *hull)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the convex hull to be used as layer. Increfs the hull.  <a href="#7c0b0cbcd8633180030778a137944a7a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeFactoryState.html#3003f7b9252685bd6e5c1fd90ffa8609">SetLayerScale</a> (int layer, float scale)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the texture percentage used by a layer (total of 1.0 is max).  <a href="#3003f7b9252685bd6e5c1fd90ffa8609"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeFactoryState.html#a0ac21c4a3216544b0777fb6078edd4d">SetOrigin</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;pos)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the point of origin, the center of the texture.  <a href="#a0ac21c4a3216544b0777fb6078edd4d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This interface describes the API for the sprite factory mesh object. 
<p>
When multiple hulls are used, they must have the same number of vertices, vertices are taken to be numbered in the same ordering.<p>
The factory also implements the <a class="el" href="structiHazeHullCreation.html" title="This interface is implemented by the haze factory in order to be able to create the...">iHazeHullCreation</a> interface 
<p>Definition at line <a class="el" href="haze_8h-source.html#l00126">126</a> of file <a class="el" href="haze_8h-source.html">haze.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7f2483413d4c67e1a669b815ba7aee5b"></a><!-- doxytag: member="iHazeFactoryState::AddLayer" ref="7f2483413d4c67e1a669b815ba7aee5b" args="(iHazeHull *hull, float scale)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iHazeFactoryState::AddLayer           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiHazeHull.html">iHazeHull</a> *&nbsp;</td>
          <td class="paramname"> <em>hull</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>scale</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
add a new layer - increasing the layer count 
<p>

</div>
</div><p>
<a class="anchor" name="7f055643eac65b636c4b4cfbe47ee415"></a><!-- doxytag: member="iHazeFactoryState::GetDirectional" ref="7f055643eac65b636c4b4cfbe47ee415" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classcsVector3.html">csVector3</a>&amp; iHazeFactoryState::GetDirectional           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the topmiddle point of the texture. 
<p>

</div>
</div><p>
<a class="anchor" name="e331a65c0e9c970c4cfe3ceafcb73c86"></a><!-- doxytag: member="iHazeFactoryState::GetLayerCount" ref="e331a65c0e9c970c4cfe3ceafcb73c86" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual size_t iHazeFactoryState::GetLayerCount           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the number of layers of hulls. 
<p>

</div>
</div><p>
<a class="anchor" name="1387dca7cc8ff0d13df4768f234df1a6"></a><!-- doxytag: member="iHazeFactoryState::GetLayerHull" ref="1387dca7cc8ff0d13df4768f234df1a6" args="(int layer) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiHazeHull.html">iHazeHull</a>* iHazeFactoryState::GetLayerHull           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>layer</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the convex hull used for layer. 
<p>

</div>
</div><p>
<a class="anchor" name="4b6dda04fcd8673ef90d7ed1d1fbe06f"></a><!-- doxytag: member="iHazeFactoryState::GetLayerScale" ref="4b6dda04fcd8673ef90d7ed1d1fbe06f" args="(int layer) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual float iHazeFactoryState::GetLayerScale           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>layer</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the layer scale. 
<p>

</div>
</div><p>
<a class="anchor" name="33e7d119e191d04df5167db3ab44562c"></a><!-- doxytag: member="iHazeFactoryState::GetOrigin" ref="33e7d119e191d04df5167db3ab44562c" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classcsVector3.html">csVector3</a>&amp; iHazeFactoryState::GetOrigin           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the point of origin. 
<p>

</div>
</div><p>
<a class="anchor" name="c0f3971442ff07b850813ef0cfaf0823"></a><!-- doxytag: member="iHazeFactoryState::SetDirectional" ref="c0f3971442ff07b850813ef0cfaf0823" args="(const csVector3 &amp;pos)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iHazeFactoryState::SetDirectional           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>pos</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the topmiddle point of the texture. 
<p>

</div>
</div><p>
<a class="anchor" name="7c0b0cbcd8633180030778a137944a7a"></a><!-- doxytag: member="iHazeFactoryState::SetLayerHull" ref="7c0b0cbcd8633180030778a137944a7a" args="(int layer, iHazeHull *hull)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iHazeFactoryState::SetLayerHull           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>layer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiHazeHull.html">iHazeHull</a> *&nbsp;</td>
          <td class="paramname"> <em>hull</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the convex hull to be used as layer. Increfs the hull. 
<p>

</div>
</div><p>
<a class="anchor" name="3003f7b9252685bd6e5c1fd90ffa8609"></a><!-- doxytag: member="iHazeFactoryState::SetLayerScale" ref="3003f7b9252685bd6e5c1fd90ffa8609" args="(int layer, float scale)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iHazeFactoryState::SetLayerScale           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>layer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>scale</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the texture percentage used by a layer (total of 1.0 is max). 
<p>

</div>
</div><p>
<a class="anchor" name="a0ac21c4a3216544b0777fb6078edd4d"></a><!-- doxytag: member="iHazeFactoryState::SetOrigin" ref="a0ac21c4a3216544b0777fb6078edd4d" args="(const csVector3 &amp;pos)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iHazeFactoryState::SetOrigin           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>pos</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the point of origin, the center of the texture. 
<p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imesh/<a class="el" href="haze_8h-source.html">haze.h</a></ul>
<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>