Sophie

Sophie

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

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: iSpriteSocket 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>iSpriteSocket Struct Reference<br>
<small>
[<a class="el" href="group__meshplugins.html">Mesh plugins</a>]</small>
</h1><!-- doxytag: class="iSpriteSocket" --><!-- doxytag: inherits="iBase" -->A socket for specifying where sprites can plug into other sprites.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="sprite3d_8h-source.html">imesh/sprite3d.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iSpriteSocket:</div>
<div class="dynsection">
<p><center><img src="structiSpriteSocket__inherit__graph.png" border="0" usemap="#iSpriteSocket__inherit__map" alt="Inheritance graph"></center>
<map name="iSpriteSocket__inherit__map">
<area shape="rect" href="structiSpriteCal3DSocket.html" title="A socket for specifying where sprites can plug into other sprites." alt="" coords="5,161,152,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="51,7,107,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiSpriteSocket-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 <a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteSocket.html#ccdb40ee1a0b87ccea864c010ea9e927">GetMeshWrapper</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the attached sprite.  <a href="#ccdb40ee1a0b87ccea864c010ea9e927"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char const *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteSocket.html#427abf5ddb91a4df27462faeb35152d3">GetName</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name.  <a href="#427abf5ddb91a4df27462faeb35152d3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteSocket.html#d52bf08876ed41950a34f5483521f4a8">GetTriangleIndex</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the index of the triangle for the socket.  <a href="#d52bf08876ed41950a34f5483521f4a8"></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="structiSpriteSocket.html#2a9722a6467d9ad53aa2754706919242">SetMeshWrapper</a> (<a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> *mesh)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the attached sprite.  <a href="#2a9722a6467d9ad53aa2754706919242"></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="structiSpriteSocket.html#2cb7aa677b85bea4dbb2d4660e4a6c89">SetName</a> (char const *)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the name.  <a href="#2cb7aa677b85bea4dbb2d4660e4a6c89"></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="structiSpriteSocket.html#4b971fa642278446e856b66ac1962065">SetTriangleIndex</a> (int tri_index)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the index of the triangle for the socket.  <a href="#4b971fa642278446e856b66ac1962065"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A socket for specifying where sprites can plug into other sprites. 
<p>Definition at line <a class="el" href="sprite3d_8h-source.html#l00134">134</a> of file <a class="el" href="sprite3d_8h-source.html">sprite3d.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ccdb40ee1a0b87ccea864c010ea9e927"></a><!-- doxytag: member="iSpriteSocket::GetMeshWrapper" ref="ccdb40ee1a0b87ccea864c010ea9e927" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiMeshWrapper.html">iMeshWrapper</a>* iSpriteSocket::GetMeshWrapper           </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 attached sprite. 
<p>

</div>
</div><p>
<a class="anchor" name="427abf5ddb91a4df27462faeb35152d3"></a><!-- doxytag: member="iSpriteSocket::GetName" ref="427abf5ddb91a4df27462faeb35152d3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual char const* iSpriteSocket::GetName           </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 name. 
<p>

</div>
</div><p>
<a class="anchor" name="d52bf08876ed41950a34f5483521f4a8"></a><!-- doxytag: member="iSpriteSocket::GetTriangleIndex" ref="d52bf08876ed41950a34f5483521f4a8" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iSpriteSocket::GetTriangleIndex           </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 index of the triangle for the socket. 
<p>

</div>
</div><p>
<a class="anchor" name="2a9722a6467d9ad53aa2754706919242"></a><!-- doxytag: member="iSpriteSocket::SetMeshWrapper" ref="2a9722a6467d9ad53aa2754706919242" args="(iMeshWrapper *mesh)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iSpriteSocket::SetMeshWrapper           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> *&nbsp;</td>
          <td class="paramname"> <em>mesh</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the attached sprite. 
<p>

</div>
</div><p>
<a class="anchor" name="2cb7aa677b85bea4dbb2d4660e4a6c89"></a><!-- doxytag: member="iSpriteSocket::SetName" ref="2cb7aa677b85bea4dbb2d4660e4a6c89" args="(char const *)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iSpriteSocket::SetName           </td>
          <td>(</td>
          <td class="paramtype">char const *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the name. 
<p>

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

<p>
Set the index of the triangle for the socket. 
<p>

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