<!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: iSpriteCal3DSocket 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 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 Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iSpriteCal3DSocket Struct Reference<br>
<small>
[<a class="el" href="group__meshplugins.html">Mesh plugins</a>]</small>
</h1><!-- doxytag: class="iSpriteCal3DSocket" --><!-- doxytag: inherits="iSpriteSocket" -->A socket for specifying where sprites can plug into other sprites.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="spritecal3d_8h-source.html">imesh/spritecal3d.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iSpriteCal3DSocket:</div>
<div class="dynsection">
<p><center><img src="structiSpriteCal3DSocket__inherit__graph.png" border="0" usemap="#iSpriteCal3DSocket__inherit__map" alt="Inheritance graph"></center>
<map name="iSpriteCal3DSocket__inherit__map">
<area shape="rect" href="structiSpriteSocket.html" title="A socket for specifying where sprites can plug into other sprites." alt="" coords="25,84,132,111"><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="structiSpriteCal3DSocket-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 size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#607993f4220acbb33a6698d230b69bd8">AttachSecondary</a> (<a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> *, <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a>)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach a secondary mesh. <a href="#607993f4220acbb33a6698d230b69bd8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#922ece2b163fc55f5a623ee6acc29dec">DetachSecondary</a> (size_t index)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Detach a secondary mesh by index. <a href="#922ece2b163fc55f5a623ee6acc29dec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#4beaecc156a7ff945839a985735b1849">DetachSecondary</a> (const char *mesh_name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Detach a secondary mesh by name. <a href="#4beaecc156a7ff945839a985735b1849"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#7cd851b2a4b2f525288aef6982dfc6ba">FindSecondary</a> (const char *mesh_name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds the index of the given attached secondary mesh. <a href="#7cd851b2a4b2f525288aef6982dfc6ba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#cfcccf8df26389cae6218ae753c220e5">GetMeshIndex</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the index of the mesh for the socket. <a href="#cfcccf8df26389cae6218ae753c220e5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#26dd8b922281ba7d96b92a2535599469">GetSecondaryCount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a count of the secondary attached meshes (this doesn't include the primary mesh). <a href="#26dd8b922281ba7d96b92a2535599469"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#5fbf212a3ba579cbf7640c6c5d9fb324">GetSecondaryMesh</a> (size_t index)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the attached secondary mesh at the given index. <a href="#5fbf212a3ba579cbf7640c6c5d9fb324"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#b0d9befa165036a2208ae5db67ea881d">GetSecondaryTransform</a> (size_t index)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the transform of the attached secondary mesh at the given index. <a href="#b0d9befa165036a2208ae5db67ea881d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#1673e10d578f38a79892faa5e18e6b11">GetSubmeshIndex</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the index of the submesh for the socket. <a href="#1673e10d578f38a79892faa5e18e6b11"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#139d65e4ce8cbb59ee4956ec64c7e85f">GetTransform</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the transform of the main mesh. <a href="#139d65e4ce8cbb59ee4956ec64c7e85f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#b20748624852199b5cdc70982df27607">SetMeshIndex</a> (int m_index)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the index of the mesh for the socket. <a href="#b20748624852199b5cdc70982df27607"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#7cb1dafcfd7f2878a199470bf1846a07">SetSecondaryTransform</a> (size_t index, <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a>)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the transform of the attached secondary mesh at the given index. <a href="#7cb1dafcfd7f2878a199470bf1846a07"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#5735a7254fb7332abdb2eb90335b0529">SetSubmeshIndex</a> (int subm_index)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the index of the submesh for the socket. <a href="#5735a7254fb7332abdb2eb90335b0529"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteCal3DSocket.html#7423f898a893da50f49c63edf2a2faa1">SetTransform</a> (const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> &trans)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the transform of the main mesh. <a href="#7423f898a893da50f49c63edf2a2faa1"></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="spritecal3d_8h-source.html#l00051">51</a> of file <a class="el" href="spritecal3d_8h-source.html">spritecal3d.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="607993f4220acbb33a6698d230b69bd8"></a><!-- doxytag: member="iSpriteCal3DSocket::AttachSecondary" ref="607993f4220acbb33a6698d230b69bd8" args="(iMeshWrapper *, csReversibleTransform)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t iSpriteCal3DSocket::AttachSecondary </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> </td>
<td class="paramname"></td><td> </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>
Attach a secondary mesh.
<p>
</div>
</div><p>
<a class="anchor" name="922ece2b163fc55f5a623ee6acc29dec"></a><!-- doxytag: member="iSpriteCal3DSocket::DetachSecondary" ref="922ece2b163fc55f5a623ee6acc29dec" args="(size_t index)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSpriteCal3DSocket::DetachSecondary </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Detach a secondary mesh by index.
<p>
</div>
</div><p>
<a class="anchor" name="4beaecc156a7ff945839a985735b1849"></a><!-- doxytag: member="iSpriteCal3DSocket::DetachSecondary" ref="4beaecc156a7ff945839a985735b1849" args="(const char *mesh_name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSpriteCal3DSocket::DetachSecondary </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>mesh_name</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Detach a secondary mesh by name.
<p>
</div>
</div><p>
<a class="anchor" name="7cd851b2a4b2f525288aef6982dfc6ba"></a><!-- doxytag: member="iSpriteCal3DSocket::FindSecondary" ref="7cd851b2a4b2f525288aef6982dfc6ba" args="(const char *mesh_name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t iSpriteCal3DSocket::FindSecondary </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>mesh_name</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Finds the index of the given attached secondary mesh.
<p>
</div>
</div><p>
<a class="anchor" name="cfcccf8df26389cae6218ae753c220e5"></a><!-- doxytag: member="iSpriteCal3DSocket::GetMeshIndex" ref="cfcccf8df26389cae6218ae753c220e5" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iSpriteCal3DSocket::GetMeshIndex </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the index of the mesh for the socket.
<p>
</div>
</div><p>
<a class="anchor" name="26dd8b922281ba7d96b92a2535599469"></a><!-- doxytag: member="iSpriteCal3DSocket::GetSecondaryCount" ref="26dd8b922281ba7d96b92a2535599469" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t iSpriteCal3DSocket::GetSecondaryCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a count of the secondary attached meshes (this doesn't include the primary mesh).
<p>
</div>
</div><p>
<a class="anchor" name="5fbf212a3ba579cbf7640c6c5d9fb324"></a><!-- doxytag: member="iSpriteCal3DSocket::GetSecondaryMesh" ref="5fbf212a3ba579cbf7640c6c5d9fb324" args="(size_t index)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiMeshWrapper.html">iMeshWrapper</a>* iSpriteCal3DSocket::GetSecondaryMesh </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the attached secondary mesh at the given index.
<p>
</div>
</div><p>
<a class="anchor" name="b0d9befa165036a2208ae5db67ea881d"></a><!-- doxytag: member="iSpriteCal3DSocket::GetSecondaryTransform" ref="b0d9befa165036a2208ae5db67ea881d" args="(size_t index)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> iSpriteCal3DSocket::GetSecondaryTransform </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the transform of the attached secondary mesh at the given index.
<p>
</div>
</div><p>
<a class="anchor" name="1673e10d578f38a79892faa5e18e6b11"></a><!-- doxytag: member="iSpriteCal3DSocket::GetSubmeshIndex" ref="1673e10d578f38a79892faa5e18e6b11" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iSpriteCal3DSocket::GetSubmeshIndex </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the index of the submesh for the socket.
<p>
</div>
</div><p>
<a class="anchor" name="139d65e4ce8cbb59ee4956ec64c7e85f"></a><!-- doxytag: member="iSpriteCal3DSocket::GetTransform" ref="139d65e4ce8cbb59ee4956ec64c7e85f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> iSpriteCal3DSocket::GetTransform </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the transform of the main mesh.
<p>
</div>
</div><p>
<a class="anchor" name="b20748624852199b5cdc70982df27607"></a><!-- doxytag: member="iSpriteCal3DSocket::SetMeshIndex" ref="b20748624852199b5cdc70982df27607" args="(int m_index)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSpriteCal3DSocket::SetMeshIndex </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>m_index</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the index of the mesh for the socket.
<p>
</div>
</div><p>
<a class="anchor" name="7cb1dafcfd7f2878a199470bf1846a07"></a><!-- doxytag: member="iSpriteCal3DSocket::SetSecondaryTransform" ref="7cb1dafcfd7f2878a199470bf1846a07" args="(size_t index, csReversibleTransform)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSpriteCal3DSocket::SetSecondaryTransform </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> </td>
<td class="paramname"></td><td> </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 transform of the attached secondary mesh at the given index.
<p>
</div>
</div><p>
<a class="anchor" name="5735a7254fb7332abdb2eb90335b0529"></a><!-- doxytag: member="iSpriteCal3DSocket::SetSubmeshIndex" ref="5735a7254fb7332abdb2eb90335b0529" args="(int subm_index)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSpriteCal3DSocket::SetSubmeshIndex </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>subm_index</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the index of the submesh for the socket.
<p>
</div>
</div><p>
<a class="anchor" name="7423f898a893da50f49c63edf2a2faa1"></a><!-- doxytag: member="iSpriteCal3DSocket::SetTransform" ref="7423f898a893da50f49c63edf2a2faa1" args="(const csReversibleTransform &trans)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSpriteCal3DSocket::SetTransform </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> & </td>
<td class="paramname"> <em>trans</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the transform of the main mesh.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imesh/<a class="el" href="spritecal3d_8h-source.html">spritecal3d.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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3792
