<!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: iPolygonHandle 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>iPolygonHandle Struct Reference<br>
<small>
[<a class="el" href="group__meshplugins.html">Mesh plugins</a>]</small>
</h1><!-- doxytag: class="iPolygonHandle" --><!-- doxytag: inherits="iBase" -->This is an interface that can be used to represent a polygon in situations where a SCF object is required.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="thing_8h-source.html">imesh/thing.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iPolygonHandle:</div>
<div class="dynsection">
<p><center><img src="structiPolygonHandle__inherit__graph.png" border="0" usemap="#iPolygonHandle__inherit__map" alt="Inheritance graph"></center>
<map name="iPolygonHandle__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="37,7,93,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiPolygonHandle-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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiPolygonHandle.html#60585ad3aa1f0c852d144b9dc0110c8e">GetIndex</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the polygon index which this polygon handle represents. <a href="#60585ad3aa1f0c852d144b9dc0110c8e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiMeshObject.html">iMeshObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiPolygonHandle.html#4c030e3fec7efe91423cee5852c28575">GetMeshObject</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the mesh object of this polygon. <a href="#4c030e3fec7efe91423cee5852c28575"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiMeshObjectFactory.html">iMeshObjectFactory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiPolygonHandle.html#b24c27b9390b466b0e4f42d2ad82ad1d">GetMeshObjectFactory</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the mesh object factory for this polygon. <a href="#b24c27b9390b466b0e4f42d2ad82ad1d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiThingFactoryState.html">iThingFactoryState</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiPolygonHandle.html#7ff071c0ee24633fc8b1e9789581fb8b">GetThingFactoryState</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the factory state for this polygon. <a href="#7ff071c0ee24633fc8b1e9789581fb8b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiThingState.html">iThingState</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiPolygonHandle.html#1449bea0c51b37261b11bb670cca80d6">GetThingState</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the instance of this polygon. <a href="#1449bea0c51b37261b11bb670cca80d6"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is an interface that can be used to represent a polygon in situations where a SCF object is required.
<p>
Create an instance of this object using iThingFactoryState->CreatePolygonHandle() or iThingState->CreatePolygonHandle(). Note that this handle will make sure that the returned pointers are cleared if the thing or thing factory happens to be removed.<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiThingState.html#45db8c0af1a30e76ce951fd4d3835ac6" title="Create a polygon handle that can be used to refer to some polygon.">iThingState::CreatePolygonHandle()</a></li><li><a class="el" href="structiThingFactoryState.html#24b669ebb0cb6002c192362e3264ece8" title="Create a polygon handle that can be used to refer to some polygon.">iThingFactoryState::CreatePolygonHandle()</a></li></ul>
<p>
Main users of this interface:<ul>
<li><a class="el" href="structiThingState.html" title="This is the state interface to access the internals of a thing mesh object.">iThingState</a></li><li><a class="el" href="structiThingFactoryState.html" title="This is the state interface to access the internals of a thing mesh factory.">iThingFactoryState</a> </li></ul>
<p>Definition at line <a class="el" href="thing_8h-source.html#l00152">152</a> of file <a class="el" href="thing_8h-source.html">thing.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="60585ad3aa1f0c852d144b9dc0110c8e"></a><!-- doxytag: member="iPolygonHandle::GetIndex" ref="60585ad3aa1f0c852d144b9dc0110c8e" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iPolygonHandle::GetIndex </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 polygon index which this polygon handle represents.
<p>
</div>
</div><p>
<a class="anchor" name="4c030e3fec7efe91423cee5852c28575"></a><!-- doxytag: member="iPolygonHandle::GetMeshObject" ref="4c030e3fec7efe91423cee5852c28575" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiMeshObject.html">iMeshObject</a>* iPolygonHandle::GetMeshObject </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 mesh object of this polygon.
<p>
This can be 0 if this polygon handle was created from a factory or if the instance was removed.
</div>
</div><p>
<a class="anchor" name="b24c27b9390b466b0e4f42d2ad82ad1d"></a><!-- doxytag: member="iPolygonHandle::GetMeshObjectFactory" ref="b24c27b9390b466b0e4f42d2ad82ad1d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiMeshObjectFactory.html">iMeshObjectFactory</a>* iPolygonHandle::GetMeshObjectFactory </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 mesh object factory for this polygon.
<p>
Or 0 if the factory is removed.
</div>
</div><p>
<a class="anchor" name="7ff071c0ee24633fc8b1e9789581fb8b"></a><!-- doxytag: member="iPolygonHandle::GetThingFactoryState" ref="7ff071c0ee24633fc8b1e9789581fb8b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiThingFactoryState.html">iThingFactoryState</a>* iPolygonHandle::GetThingFactoryState </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 factory state for this polygon.
<p>
Or 0 if the factory is removed.
</div>
</div><p>
<a class="anchor" name="1449bea0c51b37261b11bb670cca80d6"></a><!-- doxytag: member="iPolygonHandle::GetThingState" ref="1449bea0c51b37261b11bb670cca80d6" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiThingState.html">iThingState</a>* iPolygonHandle::GetThingState </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 instance of this polygon.
<p>
This can be 0 if this polygon handle was created from a factory or if the instance was removed.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imesh/<a class="el" href="thing_8h-source.html">thing.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
>
3457
