Sophie

Sophie

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

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/material.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/material.h</h1><a href="iengine_2material_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) 2000 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_MATERIAL_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IENGINE_MATERIAL_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <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="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="iutil_2strset_8h.html" title="Stringset interface.">iutil/strset.h</a>"</span>
<a name="l00024"></a>00024 
<a name="l00033"></a>00033 <span class="keyword">struct </span><a class="code" href="structiMaterial.html" title="This class represents a material as seen from the engine view.">iMaterial</a>;
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiTextureManager.html" title="This is the standard texture manager interface.">iTextureManager</a>;
<a name="l00035"></a>00035 <span class="keyword">struct </span><a class="code" href="structiTextureWrapper.html" title="A texture wrapper is an engine-level object that wraps around an actual texture (iTextureHandle)...">iTextureWrapper</a>;
<a name="l00036"></a>00036 <span class="keyword">struct </span><a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>;
<a name="l00037"></a>00037 
<a name="l00061"></a><a class="code" href="structiMaterialWrapper.html">00061</a> <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> : <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="l00062"></a>00062 {
<a name="l00063"></a>00063   SCF_INTERFACE (<a class="code" href="structiMaterialWrapper.html" title="A material wrapper is an engine-level object that wraps around an actual material...">iMaterialWrapper</a>, 0, 0, 5);
<a name="l00064"></a>00064 
<a name="l00066"></a>00066   <span class="keyword">virtual</span> <a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *<a class="code" href="structiMaterialWrapper.html#dcf47967257f491114d2ca9e29dc1b3b" title="Get the iObject for this material.">QueryObject</a>() = 0;
<a name="l00067"></a>00067 
<a name="l00072"></a>00072   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiMaterialWrapper.html#a2c1b9f35cfa42f705098cbdcfd4e963" title="Change the base material.">SetMaterial</a> (<a class="code" href="structiMaterial.html" title="This class represents a material as seen from the engine view.">iMaterial</a>* material) = 0;
<a name="l00074"></a>00074   <span class="keyword">virtual</span> <a class="code" href="structiMaterial.html" title="This class represents a material as seen from the engine view.">iMaterial</a>* <a class="code" href="structiMaterialWrapper.html#bef1b083ee25e6ba31b945366e06513f" title="Get the original material.">GetMaterial</a> () = 0;
<a name="l00075"></a>00075 
<a name="l00081"></a>00081   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiMaterialWrapper.html#4e8fa88d1594561da14344157b6da854" title="Visit this material.">Visit</a> () = 0;
<a name="l00082"></a>00082 
<a name="l00086"></a>00086   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiMaterialWrapper.html#2de0de7e3ee4568ad568db86e889d28b" title="Return true if it is needed to call Visit().">IsVisitRequired</a> () <span class="keyword">const</span> = 0;
<a name="l00087"></a>00087 };
<a name="l00088"></a>00088 
<a name="l00100"></a><a class="code" href="structiMaterialEngine.html">00100</a> <span class="keyword">struct </span><a class="code" href="structiMaterialEngine.html" title="This interface represents the engine part of the material definition.">iMaterialEngine</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="structiMaterialEngine.html" title="This interface represents the engine part of the material definition.">iMaterialEngine</a>, 2, 0, 0);
<a name="l00103"></a>00103 
<a name="l00107"></a>00107   <span class="keyword">virtual</span> <a class="code" href="structiTextureWrapper.html" title="A texture wrapper is an engine-level object that wraps around an actual texture (iTextureHandle)...">iTextureWrapper</a> *<a class="code" href="structiMaterialEngine.html#749e53e2103fe9c1fc3fad27d7043e0a" title="Get the base texture from the material.">GetTextureWrapper</a> () = 0;
<a name="l00108"></a>00108 
<a name="l00112"></a>00112     <span class="keyword">virtual</span> <a class="code" href="structiTextureWrapper.html" title="A texture wrapper is an engine-level object that wraps around an actual texture (iTextureHandle)...">iTextureWrapper</a>* <a class="code" href="structiMaterialEngine.html#749e53e2103fe9c1fc3fad27d7043e0a" title="Get the base texture from the material.">GetTextureWrapper</a> (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> name) = 0;
<a name="l00113"></a>00113 
<a name="l00117"></a>00117   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiMaterialEngine.html#8edc7eccf3e2de54aa56c75d73c2430e" title="Visit all textures.">Visit</a> () = 0;
<a name="l00118"></a>00118 
<a name="l00122"></a>00122   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiMaterialEngine.html#ad9b514f5258ba0d878b379d1e6ec97c" title="Return true if it is needed to call Visit().">IsVisitRequired</a> () <span class="keyword">const</span> = 0;
<a name="l00123"></a>00123 };
<a name="l00124"></a>00124 
<a name="l00134"></a><a class="code" href="structiMaterialList.html">00134</a> <span class="keyword">struct </span><a class="code" href="structiMaterialList.html" title="This class represents a list of materials.">iMaterialList</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="l00135"></a>00135 {
<a name="l00136"></a>00136   SCF_INTERFACE (<a class="code" href="structiMaterialList.html" title="This class represents a list of materials.">iMaterialList</a>, 1, 0, 0);
<a name="l00137"></a>00137 
<a name="l00139"></a>00139   <span class="keyword">virtual</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 class="code" href="structiMaterialList.html#1bb7303a5e810ec3e856d008a4fc32e4" title="Create a new material.">NewMaterial</a> (<a class="code" href="structiMaterial.html" title="This class represents a material as seen from the engine view.">iMaterial</a>* material,
<a name="l00140"></a>00140         <span class="keyword">const</span> <span class="keywordtype">char</span>* name) = 0;
<a name="l00141"></a>00141 
<a name="l00143"></a>00143   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiMaterialList.html#42ccf148d987f3cb18f19fd8aa35f1a0" title="Return the number of materials in this list.">GetCount</a> () <span class="keyword">const</span> = 0;
<a name="l00144"></a>00144 
<a name="l00146"></a>00146   <span class="keyword">virtual</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 class="code" href="structiMaterialList.html#264d08b1085d05e71d8e7279b7ff25ff" title="Return a material by index.">Get</a> (<span class="keywordtype">int</span> n) <span class="keyword">const</span> = 0;
<a name="l00147"></a>00147 
<a name="l00149"></a>00149   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiMaterialList.html#8c1e8a9e5a314d2ef4f3fff9ebd90db1" title="Add a material.">Add</a> (<a class="code" href="structiMaterialWrapper.html" title="A material wrapper is an engine-level object that wraps around an actual material...">iMaterialWrapper</a> *obj) = 0;
<a name="l00150"></a>00150 
<a name="l00152"></a>00152   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiMaterialList.html#3119dcabd4cfb5d7ba9f1ab9e5785fca" title="Remove a material.">Remove</a> (<a class="code" href="structiMaterialWrapper.html" title="A material wrapper is an engine-level object that wraps around an actual material...">iMaterialWrapper</a> *obj) = 0;
<a name="l00153"></a>00153 
<a name="l00155"></a>00155   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiMaterialList.html#3119dcabd4cfb5d7ba9f1ab9e5785fca" title="Remove a material.">Remove</a> (<span class="keywordtype">int</span> n) = 0;
<a name="l00156"></a>00156 
<a name="l00158"></a>00158   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiMaterialList.html#4d33ecb77eee7f4caae5c7d76528c0c1" title="Remove all materials.">RemoveAll</a> () = 0;
<a name="l00159"></a>00159 
<a name="l00161"></a>00161   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiMaterialList.html#df83649de2435c02f186c150fdcfb5de" title="Find a material and return its index.">Find</a> (<a class="code" href="structiMaterialWrapper.html" title="A material wrapper is an engine-level object that wraps around an actual material...">iMaterialWrapper</a> *obj) <span class="keyword">const</span> = 0;
<a name="l00162"></a>00162 
<a name="l00164"></a>00164   <span class="keyword">virtual</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 class="code" href="structiMaterialList.html#ddb826b007019fd202fb8aad54ee20ac" title="Find a material by name.">FindByName</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *Name) <span class="keyword">const</span> = 0;
<a name="l00165"></a>00165 };
<a name="l00166"></a>00166 
<a name="l00169"></a>00169 <span class="preprocessor">#endif // __CS_IENGINE_MATERIAL_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