<!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: imesh/sprite3d.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 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 Pages</span></a></li>
</ul>
</div>
<h1>imesh/sprite3d.h</h1><a href="sprite3d_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-2001 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_IMESH_SPRITE3D_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IMESH_SPRITE3D_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <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="l00027"></a>00027
<a name="l00031"></a>00031 <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>;
<a name="l00032"></a>00032 <span class="keyword">struct </span><a class="code" href="structiMeshObject.html" title="This is a general mesh object that the engine can interact with.">iMeshObject</a>;
<a name="l00033"></a>00033 <span class="keyword">struct </span><a class="code" href="structiMeshObjectFactory.html" title="This object is a factory which can generate mesh objects of a certain type.">iMeshObjectFactory</a>;
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a>;
<a name="l00035"></a>00035 <span class="keyword">struct </span><a class="code" href="structiRenderView.html" title="This interface represents all information needed to render some object in a current...">iRenderView</a>;
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">class </span><a class="code" href="classcsColor.html" title="A class used to represent a color in RGB space.">csColor</a>;
<a name="l00038"></a>00038 <span class="keyword">class </span><a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>;
<a name="l00039"></a>00039 <span class="keyword">class </span><a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>;
<a name="l00040"></a>00040 <span class="keyword">struct </span><a class="code" href="structcsTriangle.html" title="A triangle.">csTriangle</a>;
<a name="l00041"></a>00041
<a name="l00045"></a>00045 <span class="keyword">enum</span>
<a name="l00046"></a>00046 {
<a name="l00047"></a><a class="code" href="group__meshplugins.html#ggd63240694c6dc2a28c24bfc2db90ad7ac1dba980950d2a7e41f3222ace80f8bd">00047</a> <a class="code" href="group__meshplugins.html#ggd63240694c6dc2a28c24bfc2db90ad7ac1dba980950d2a7e41f3222ace80f8bd">CS_SPR_LIGHTING_HQ</a> = 0,
<a name="l00048"></a><a class="code" href="group__meshplugins.html#ggd63240694c6dc2a28c24bfc2db90ad7aa43280a1427438d4808f2196e916a153">00048</a> <a class="code" href="group__meshplugins.html#ggd63240694c6dc2a28c24bfc2db90ad7aa43280a1427438d4808f2196e916a153">CS_SPR_LIGHTING_LQ</a> = 1,
<a name="l00049"></a><a class="code" href="group__meshplugins.html#ggd63240694c6dc2a28c24bfc2db90ad7ad0293128420ff7b5ef94428486dcc7cd">00049</a> <a class="code" href="group__meshplugins.html#ggd63240694c6dc2a28c24bfc2db90ad7ad0293128420ff7b5ef94428486dcc7cd">CS_SPR_LIGHTING_FAST</a> = 2,
<a name="l00050"></a><a class="code" href="group__meshplugins.html#ggd63240694c6dc2a28c24bfc2db90ad7afea07fdfcf7dbf5ec72f5e38c219dce3">00050</a> <a class="code" href="group__meshplugins.html#ggd63240694c6dc2a28c24bfc2db90ad7afea07fdfcf7dbf5ec72f5e38c219dce3">CS_SPR_LIGHTING_RANDOM</a> = 3
<a name="l00051"></a>00051 };
<a name="l00052"></a>00052
<a name="l00057"></a><a class="code" href="group__meshplugins.html#ge10adda0ee9574f923dcc5c5b7ca27bc">00057</a> <span class="preprocessor">#define CS_SPR_LIGHT_GLOBAL 0</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span>
<a name="l00063"></a><a class="code" href="group__meshplugins.html#ga213c7faeb83698ae3b6032bf1a19495">00063</a> <span class="preprocessor">#define CS_SPR_LIGHT_TEMPLATE 1</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span>
<a name="l00069"></a><a class="code" href="group__meshplugins.html#g5e9bf3ea329d88cf37a7d9197ecbba6f">00069</a> <span class="preprocessor">#define CS_SPR_LIGHT_LOCAL 2</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span>
<a name="l00075"></a><a class="code" href="group__meshplugins.html#gf47085be65a8b36443681894ee3db6e9">00075</a> <span class="preprocessor">#define CS_SPR_LOD_GLOBAL 0</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span>
<a name="l00080"></a><a class="code" href="group__meshplugins.html#gaf271f4553867589d1a87364770179d5">00080</a> <span class="preprocessor">#define CS_SPR_LOD_TEMPLATE 1</span>
<a name="l00081"></a>00081 <span class="preprocessor"></span>
<a name="l00085"></a><a class="code" href="group__meshplugins.html#gb831b3145c63d04641269c0fe53728e9">00085</a> <span class="preprocessor">#define CS_SPR_LOD_LOCAL 2</span>
<a name="l00086"></a>00086 <span class="preprocessor"></span>
<a name="l00090"></a><a class="code" href="structiSpriteFrame.html">00090</a> <span class="keyword">struct </span><a class="code" href="structiSpriteFrame.html" title="A frame for 3D sprite animation.">iSpriteFrame</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="l00091"></a>00091 {
<a name="l00092"></a>00092 SCF_INTERFACE (<a class="code" href="structiSpriteFrame.html" title="A frame for 3D sprite animation.">iSpriteFrame</a>, 1, 0, 0);
<a name="l00093"></a>00093
<a name="l00095"></a>00095 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSpriteFrame.html#912c8dfe0e65b00e83e7ed4c01d3cc34" title="Set the name.">SetName</a> (<span class="keywordtype">char</span> <span class="keyword">const</span>*) = 0;
<a name="l00097"></a>00097 <span class="keyword">virtual</span> <span class="keywordtype">char</span> <span class="keyword">const</span>* <a class="code" href="structiSpriteFrame.html#335bed32b96c52b7353b4be442d6431d" title="Get the name.">GetName</a> () <span class="keyword">const</span> = 0;
<a name="l00099"></a>00099 <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetAnmIndex () <span class="keyword">const</span> = 0;
<a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetTexIndex () <span class="keyword">const</span> = 0;
<a name="l00102"></a>00102 };
<a name="l00103"></a>00103
<a name="l00107"></a><a class="code" href="structiSpriteAction.html">00107</a> <span class="keyword">struct </span><a class="code" href="structiSpriteAction.html" title="An action frameset for 3D sprite animation.">iSpriteAction</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="l00108"></a>00108 {
<a name="l00109"></a>00109 SCF_INTERFACE (<a class="code" href="structiSpriteAction.html" title="An action frameset for 3D sprite animation.">iSpriteAction</a>, 1, 0, 0);
<a name="l00110"></a>00110
<a name="l00112"></a>00112 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSpriteAction.html#a6abdb9b3b1c1ec7a70be3feeabbac05" title="Set the name.">SetName</a> (<span class="keywordtype">char</span> <span class="keyword">const</span>*) = 0;
<a name="l00114"></a>00114 <span class="keyword">virtual</span> <span class="keywordtype">char</span> <span class="keyword">const</span>* <a class="code" href="structiSpriteAction.html#dc6515595612f080e02e55e02e94347e" title="Get the name.">GetName</a> () <span class="keyword">const</span> = 0;
<a name="l00116"></a>00116 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSpriteAction.html#41ab190feeb5574b5e238e1f240fee04" title="Get the number of frames in this action.">GetFrameCount</a> () = 0;
<a name="l00118"></a>00118 <span class="keyword">virtual</span> <a class="code" href="structiSpriteFrame.html" title="A frame for 3D sprite animation.">iSpriteFrame</a>* <a class="code" href="structiSpriteAction.html#e52d3cfc6ae34d12f5fa001fcd8ef284" title="Get the specified frame.">GetFrame</a> (<span class="keywordtype">int</span> f) = 0;
<a name="l00120"></a>00120 <span class="keyword">virtual</span> <a class="code" href="structiSpriteFrame.html" title="A frame for 3D sprite animation.">iSpriteFrame</a>* <a class="code" href="structiSpriteAction.html#8efc8d0c3f085df2208fc66c0b70bff4" title="Get the next frame after the specified one.">GetNextFrame</a> (<span class="keywordtype">int</span> f) = 0;
<a name="l00122"></a>00122 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSpriteAction.html#a08bebbe4f5e2ce6fc0a6a72d9807e97" title="Get the delay for the specified frame.">GetFrameDelay</a> (<span class="keywordtype">int</span> f) = 0;
<a name="l00124"></a>00124 <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiSpriteAction.html#1cd5417c666c0f595f96f3128eae25a6" title="Get the displacement for the specified frame.">GetFrameDisplacement</a> (<span class="keywordtype">int</span> f) = 0;
<a name="l00126"></a>00126 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSpriteAction.html#54ac2bed5f4e3380b019e218cbe63842" title="Add a frame to this action.">AddFrame</a> (<a class="code" href="structiSpriteFrame.html" title="A frame for 3D sprite animation.">iSpriteFrame</a>* frame, <span class="keywordtype">int</span> delay,
<a name="l00127"></a>00127 <span class="keywordtype">float</span> displacement) = 0;
<a name="l00128"></a>00128 };
<a name="l00129"></a>00129
<a name="l00134"></a><a class="code" href="structiSpriteSocket.html">00134</a> <span class="keyword">struct </span><a class="code" href="structiSpriteSocket.html" title="A socket for specifying where sprites can plug into other sprites.">iSpriteSocket</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="structiSpriteSocket.html" title="A socket for specifying where sprites can plug into other sprites.">iSpriteSocket</a>, 1, 0, 0);
<a name="l00137"></a>00137
<a name="l00139"></a>00139 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSpriteSocket.html#2cb7aa677b85bea4dbb2d4660e4a6c89" title="Set the name.">SetName</a> (<span class="keywordtype">char</span> <span class="keyword">const</span>*) = 0;
<a name="l00141"></a>00141 <span class="keyword">virtual</span> <span class="keywordtype">char</span> <span class="keyword">const</span>* <a class="code" href="structiSpriteSocket.html#427abf5ddb91a4df27462faeb35152d3" title="Get the name.">GetName</a> () <span class="keyword">const</span> = 0;
<a name="l00142"></a>00142
<a name="l00144"></a>00144 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSpriteSocket.html#2a9722a6467d9ad53aa2754706919242" title="Set the attached sprite.">SetMeshWrapper</a> (<a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a>* mesh) = 0;
<a name="l00146"></a>00146 <span class="keyword">virtual</span> <a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a>* <a class="code" href="structiSpriteSocket.html#ccdb40ee1a0b87ccea864c010ea9e927" title="Get the attached sprite.">GetMeshWrapper</a> () <span class="keyword">const</span> = 0;
<a name="l00147"></a>00147
<a name="l00149"></a>00149 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSpriteSocket.html#4b971fa642278446e856b66ac1962065" title="Set the index of the triangle for the socket.">SetTriangleIndex</a> (<span class="keywordtype">int</span> tri_index) = 0;
<a name="l00151"></a>00151 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSpriteSocket.html#d52bf08876ed41950a34f5483521f4a8" title="Get the index of the triangle for the socket.">GetTriangleIndex</a> () <span class="keyword">const</span> = 0;
<a name="l00152"></a>00152 };
<a name="l00153"></a>00153
<a name="l00159"></a><a class="code" href="structiSprite3DFactoryState.html">00159</a> <span class="keyword">struct </span><a class="code" href="structiSprite3DFactoryState.html" title="This interface describes the API for the 3D sprite factory mesh object.">iSprite3DFactoryState</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="l00160"></a>00160 {
<a name="l00161"></a>00161 SCF_INTERFACE (<a class="code" href="structiSprite3DFactoryState.html" title="This interface describes the API for the 3D sprite factory mesh object.">iSprite3DFactoryState</a>, 1, 0, 0);
<a name="l00162"></a>00162
<a name="l00171"></a>00171 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#d92c64d94113d29a5d8d281b067193ee" title="Reserve space for the given number of vertices.">AddVertices</a> (<span class="keywordtype">int</span> num) = 0;
<a name="l00173"></a>00173 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DFactoryState.html#d0f5c57f0a6cad9dd69801d90adba427" title="Return the current number of vertices.">GetVertexCount</a> () <span class="keyword">const</span> = 0;
<a name="l00174"></a>00174
<a name="l00176"></a>00176 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>& <a class="code" href="structiSprite3DFactoryState.html#ac57e9296f6b2672e025c6e632b60e53" title="Get a vertex.">GetVertex</a> (<span class="keywordtype">int</span> frame, <span class="keywordtype">int</span> vertex) <span class="keyword">const</span> = 0;
<a name="l00178"></a>00178 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#15247846fa84d50c0dfa5292491011b5" title="Set a vertex.">SetVertex</a> (<span class="keywordtype">int</span> frame, <span class="keywordtype">int</span> vertex, <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> &Value) = 0;
<a name="l00180"></a>00180 <span class="keyword">virtual</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>* <a class="code" href="structiSprite3DFactoryState.html#d5b5fad16bc12d9e6e31b472dd3a0dca" title="Get vertex array.">GetVertices</a> (<span class="keywordtype">int</span> frame) <span class="keyword">const</span> = 0;
<a name="l00185"></a>00185 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#f531b9c998f974d13f05eae85904d9a0" title="Set array of vertices.">SetVertices</a> (<a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> <span class="keyword">const</span>* vert, <span class="keywordtype">int</span> frame) = 0;
<a name="l00186"></a>00186
<a name="l00188"></a>00188 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>& <a class="code" href="structiSprite3DFactoryState.html#3cf138d9843f4487d92a34868e8ed7c9" title="Get a texel.">GetTexel</a> (<span class="keywordtype">int</span> frame, <span class="keywordtype">int</span> vertex) <span class="keyword">const</span> = 0;
<a name="l00190"></a>00190 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#22fa5bbd696cee11641b359d42ca29d0" title="Set a texel.">SetTexel</a> (<span class="keywordtype">int</span> frame, <span class="keywordtype">int</span> vertex, <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> &Value) = 0;
<a name="l00192"></a>00192 <span class="keyword">virtual</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>* <a class="code" href="structiSprite3DFactoryState.html#4ce4e806055d2aa240ba58cffb088cc9" title="Get array of texels.">GetTexels</a> (<span class="keywordtype">int</span> frame) <span class="keyword">const</span> = 0;
<a name="l00197"></a>00197 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#e5bd0e3b4f787c26cda603c7aafb59d0" title="Set array of texels.">SetTexels</a> (<a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <span class="keyword">const</span>* tex, <span class="keywordtype">int</span> frame) = 0;
<a name="l00198"></a>00198
<a name="l00200"></a>00200 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>& <a class="code" href="structiSprite3DFactoryState.html#6f65ab92628aedae0352069da64b7b95" title="Get a normal.">GetNormal</a> (<span class="keywordtype">int</span> frame, <span class="keywordtype">int</span> vertex) <span class="keyword">const</span> = 0;
<a name="l00202"></a>00202 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#11fba76e42e27e82af9c6083e46bdf46" title="Set a normal.">SetNormal</a> (<span class="keywordtype">int</span> frame, <span class="keywordtype">int</span> vertex, <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> &Value) = 0;
<a name="l00204"></a>00204 <span class="keyword">virtual</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>* <a class="code" href="structiSprite3DFactoryState.html#e747c7b09acd7104420d502a21c74bf4" title="Get normal array.">GetNormals</a> (<span class="keywordtype">int</span> frame) <span class="keyword">const</span> = 0;
<a name="l00209"></a>00209 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#3690100ed95893fed3be7c7e5e8ed068" title="Set array of normals.">SetNormals</a> (<a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> <span class="keyword">const</span>* norms, <span class="keywordtype">int</span> frame) = 0;
<a name="l00210"></a>00210
<a name="l00215"></a>00215 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#aff49928764e3dab400f97b9043fdcf4" title="Add a triangle to the normal, texel, and vertex meshes a, b and c are indices to...">AddTriangle</a> (<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b, <span class="keywordtype">int</span> c) = 0;
<a name="l00217"></a>00217 <span class="keyword">virtual</span> <a class="code" href="structcsTriangle.html" title="A triangle.">csTriangle</a> <a class="code" href="structiSprite3DFactoryState.html#f923572f3778245e41bd4c15c16062a1" title="Returns the texel indices for triangle &#39;x&#39;.">GetTriangle</a> (<span class="keywordtype">int</span> x) <span class="keyword">const</span> = 0;
<a name="l00219"></a>00219 <span class="keyword">virtual</span> <a class="code" href="structcsTriangle.html" title="A triangle.">csTriangle</a>* <a class="code" href="structiSprite3DFactoryState.html#0e639dc72f8f85aad5292f7bf72aa1b6" title="Returns the triangles of the texel_mesh.">GetTriangles</a> () <span class="keyword">const</span> = 0;
<a name="l00221"></a>00221 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DFactoryState.html#8cdf6be1ac4abb7030f068875ab94322" title="Returns the number of triangles in the sprite.">GetTriangleCount</a> () <span class="keyword">const</span> = 0;
<a name="l00223"></a>00223 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#e455cf731f3a66a85fbfeff6b16a4ba6" title="Set the count of triangles.">SetTriangleCount</a> (<span class="keywordtype">int</span> count) = 0;
<a name="l00225"></a>00225 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#e5052870c1130e8c33c80a9f8391ee52" title="Set array of triangles. The array is copied.">SetTriangles</a>( <a class="code" href="structcsTriangle.html" title="A triangle.">csTriangle</a> <span class="keyword">const</span>* trigs, <span class="keywordtype">int</span> count) = 0;
<a name="l00226"></a>00226
<a name="l00228"></a>00228 <span class="keyword">virtual</span> <a class="code" href="structiSpriteFrame.html" title="A frame for 3D sprite animation.">iSpriteFrame</a>* <a class="code" href="structiSprite3DFactoryState.html#0408a0a508eb2b0439ea74c10879a193" title="Create and add a new frame to the sprite.">AddFrame</a> () = 0;
<a name="l00230"></a>00230 <span class="keyword">virtual</span> <a class="code" href="structiSpriteFrame.html" title="A frame for 3D sprite animation.">iSpriteFrame</a>* <a class="code" href="structiSprite3DFactoryState.html#30e10eb4cb0b8c8091c3d45f9b422121" title="Find a named frame.">FindFrame</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span> = 0;
<a name="l00232"></a>00232 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DFactoryState.html#19536010457ce71cb8ce569d5400fafb" title="Query the number of frames.">GetFrameCount</a> () <span class="keyword">const</span> = 0;
<a name="l00234"></a>00234 <span class="keyword">virtual</span> <a class="code" href="structiSpriteFrame.html" title="A frame for 3D sprite animation.">iSpriteFrame</a>* <a class="code" href="structiSprite3DFactoryState.html#cf5758e7532e209e2f15de3e21c80ae4" title="Query the frame number f.">GetFrame</a> (<span class="keywordtype">int</span> f) <span class="keyword">const</span> = 0;
<a name="l00235"></a>00235
<a name="l00237"></a>00237 <span class="keyword">virtual</span> <a class="code" href="structiSpriteAction.html" title="An action frameset for 3D sprite animation.">iSpriteAction</a>* <a class="code" href="structiSprite3DFactoryState.html#01069f0c1da4ea688b72b97fc640f369" title="Create and add a new action frameset to the sprite.">AddAction</a> () = 0;
<a name="l00239"></a>00239 <span class="keyword">virtual</span> <a class="code" href="structiSpriteAction.html" title="An action frameset for 3D sprite animation.">iSpriteAction</a>* <a class="code" href="structiSprite3DFactoryState.html#0857060e18ada48d0be21974c1611b38" title="Find a named action.">FindAction</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span> = 0;
<a name="l00241"></a>00241 <span class="keyword">virtual</span> <a class="code" href="structiSpriteAction.html" title="An action frameset for 3D sprite animation.">iSpriteAction</a>* <a class="code" href="structiSprite3DFactoryState.html#f8f3233319f60b5abeb198ce4394b7ac" title="Get the first action.">GetFirstAction</a> () <span class="keyword">const</span> = 0;
<a name="l00243"></a>00243 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DFactoryState.html#cd341a04820f158b0429c8924f9bbbf7" title="Get number of actions in sprite.">GetActionCount</a> () <span class="keyword">const</span> = 0;
<a name="l00245"></a>00245 <span class="keyword">virtual</span> <a class="code" href="structiSpriteAction.html" title="An action frameset for 3D sprite animation.">iSpriteAction</a>* <a class="code" href="structiSprite3DFactoryState.html#fc352c722f68ade88598b12bee3376e8" title="Get action number No.">GetAction</a> (<span class="keywordtype">int</span> No) <span class="keyword">const</span> = 0;
<a name="l00246"></a>00246
<a name="l00248"></a>00248 <span class="keyword">virtual</span> <a class="code" href="structiSpriteSocket.html" title="A socket for specifying where sprites can plug into other sprites.">iSpriteSocket</a>* <a class="code" href="structiSprite3DFactoryState.html#f5e6702f4559f664af252a277824b5a3" title="Create and add a new socket to the sprite.">AddSocket</a> () = 0;
<a name="l00250"></a>00250 <span class="keyword">virtual</span> <a class="code" href="structiSpriteSocket.html" title="A socket for specifying where sprites can plug into other sprites.">iSpriteSocket</a>* <a class="code" href="structiSprite3DFactoryState.html#1297a02bb96c527e3b8ebb3e6e14ea17" title="find a named socket into the sprite.">FindSocket</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * name) <span class="keyword">const</span> = 0;
<a name="l00252"></a>00252 <span class="keyword">virtual</span> <a class="code" href="structiSpriteSocket.html" title="A socket for specifying where sprites can plug into other sprites.">iSpriteSocket</a>* <a class="code" href="structiSprite3DFactoryState.html#1297a02bb96c527e3b8ebb3e6e14ea17" title="find a named socket into the sprite.">FindSocket</a> (<a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a> *mesh) <span class="keyword">const</span> = 0;
<a name="l00254"></a>00254 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DFactoryState.html#ab271c40fa97212260673e956b6afc7b" title="Query the number of sockets.">GetSocketCount</a> () <span class="keyword">const</span> = 0;
<a name="l00256"></a>00256 <span class="keyword">virtual</span> <a class="code" href="structiSpriteSocket.html" title="A socket for specifying where sprites can plug into other sprites.">iSpriteSocket</a>* <a class="code" href="structiSprite3DFactoryState.html#933db382be4e8fe79f88ff36793dd88b" title="Query the socket number f.">GetSocket</a> (<span class="keywordtype">int</span> f) <span class="keyword">const</span> = 0;
<a name="l00257"></a>00257
<a name="l00259"></a>00259 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#e55678e2c847fc53442ba557d10f1891" title="Enable/disable tweening.">EnableTweening</a> (<span class="keywordtype">bool</span> en) = 0;
<a name="l00261"></a>00261 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSprite3DFactoryState.html#aa60e86e9ac076e93e35e604d56f464e" title="Query state of tweening.">IsTweeningEnabled</a> () <span class="keyword">const</span> = 0;
<a name="l00263"></a>00263 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#abdc8e9cdfd56cb1ea38c902b907b111" title="Set lighting quality (one of CS_SPR_LIGHTING_*).">SetLightingQuality</a> (<span class="keywordtype">int</span> qual) = 0;
<a name="l00265"></a>00265 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DFactoryState.html#c78e782e6c0c7d8b5b47b5d6c38a1ff5" title="Get lighting quality (one of CS_SPR_LIGHTING_*).">GetLightingQuality</a> () <span class="keyword">const</span> = 0;
<a name="l00274"></a>00274 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#8c9ba02c0d60526d1f20cda22734f0ec" title="Sets which lighting config variable that all new sprites created from this template...">SetLightingQualityConfig</a> (<span class="keywordtype">int</span> qual) = 0;
<a name="l00276"></a>00276 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DFactoryState.html#90c8123600d424da374501159a46f773" title="Get the lighting quality config.">GetLightingQualityConfig</a> () <span class="keyword">const</span> = 0;
<a name="l00277"></a>00277
<a name="l00286"></a>00286 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#042a8e8e92327e57f75eb4910e72feec" title="Sets which lod config variable that all new sprites created from this template will...">SetLodLevelConfig</a> (<span class="keywordtype">int</span> config_flag) = 0;
<a name="l00287"></a>00287
<a name="l00289"></a>00289 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DFactoryState.html#c65b98d4d98f285c2b6fdcedd6996e60" title="Returns what this template is using for determining the lod quality.">GetLodLevelConfig</a> () <span class="keyword">const</span> = 0;
<a name="l00290"></a>00290
<a name="l00296"></a>00296 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#67d07689d5fa427ae1598e3a5ecb2516" title="Smooth out the gouraud shading by merging the precalculated vertex normals along...">MergeNormals</a> (<span class="keywordtype">int</span> base, <span class="keywordtype">int</span> frame) = 0;
<a name="l00297"></a>00297
<a name="l00303"></a>00303 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#67d07689d5fa427ae1598e3a5ecb2516" title="Smooth out the gouraud shading by merging the precalculated vertex normals along...">MergeNormals</a> (<span class="keywordtype">int</span> base) = 0;
<a name="l00304"></a>00304
<a name="l00310"></a>00310 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DFactoryState.html#67d07689d5fa427ae1598e3a5ecb2516" title="Smooth out the gouraud shading by merging the precalculated vertex normals along...">MergeNormals</a> () = 0;
<a name="l00311"></a>00311 };
<a name="l00312"></a>00312
<a name="l00317"></a><a class="code" href="structiSprite3DState.html">00317</a> <span class="keyword">struct </span><a class="code" href="structiSprite3DState.html" title="This interface describes the API for the 3D sprite mesh object.">iSprite3DState</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="l00318"></a>00318 {
<a name="l00319"></a>00319 SCF_INTERFACE (<a class="code" href="structiSprite3DState.html" title="This interface describes the API for the 3D sprite mesh object.">iSprite3DState</a>, 1, 0, 0);
<a name="l00320"></a>00320
<a name="l00322"></a>00322 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DState.html#7ef155eb3691ac41fa903b2c747a883e" title="Set mix mode.">SetMixMode</a> (<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> mode) = 0;
<a name="l00324"></a>00324 <span class="keyword">virtual</span> <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> <a class="code" href="structiSprite3DState.html#3acd4e3aa8955c10e6adf70ebc2c4cb1" title="Get mix mode.">GetMixMode</a> () <span class="keyword">const</span> = 0;
<a name="l00326"></a>00326 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DState.html#2f42e07b016184ce5366051e4b703755" title="Set lighting.">SetLighting</a> (<span class="keywordtype">bool</span> l) = 0;
<a name="l00328"></a>00328 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSprite3DState.html#13beb65607c68ddd741f945eb645ff9a" title="Get lighting.">IsLighting</a> () <span class="keyword">const</span> = 0;
<a name="l00329"></a>00329
<a name="l00331"></a>00331 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DState.html#a86a71fdc8dea37867e40275395f8212" title="Go to a specified frame.">SetFrame</a> (<span class="keywordtype">int</span> f) = 0;
<a name="l00332"></a>00332
<a name="l00334"></a>00334 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DState.html#c20e17c5c7b4cbd636f4c19b82bacba6" title="Get the current frame number.">GetCurFrame</a> () <span class="keyword">const</span> = 0;
<a name="l00335"></a>00335
<a name="l00337"></a>00337 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DState.html#59ae625ed953735af7e030098c729deb" title="Get the number of frames.">GetFrameCount</a> () <span class="keyword">const</span> = 0;
<a name="l00338"></a>00338
<a name="l00343"></a>00343 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSprite3DState.html#4b0d9695cf0f4206fd8f00b9b11bb266" title="Select an action by name.">SetAction</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * name,
<a name="l00344"></a>00344 <span class="keywordtype">bool</span> loop = <span class="keyword">true</span>, <span class="keywordtype">float</span> speed = 1) = 0;
<a name="l00345"></a>00345
<a name="l00350"></a>00350 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSprite3DState.html#4b0d9695cf0f4206fd8f00b9b11bb266" title="Select an action by name.">SetAction</a> (<span class="keywordtype">int</span> index,
<a name="l00351"></a>00351 <span class="keywordtype">bool</span> loop = <span class="keyword">true</span>, <span class="keywordtype">float</span> speed = 1) = 0;
<a name="l00352"></a>00352
<a name="l00354"></a>00354 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DState.html#a7695d886e63bfe83a09df5b939b3830" title="Set whether action should run in reverse or not.">SetReverseAction</a>(<span class="keywordtype">bool</span> reverse) = 0;
<a name="l00355"></a>00355
<a name="l00357"></a>00357 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DState.html#9e8430cbbd189c9ba5ba40d4821df10b" title="Set single-step frame advance flag on actions.">SetSingleStepAction</a>(<span class="keywordtype">bool</span> singlestep) = 0;
<a name="l00358"></a>00358
<a name="l00363"></a>00363 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSprite3DState.html#279709306f8a7d73884f18f2fa65a2ce" title="This sets an action to run one time, then the sprite reverts to the prior action...">SetOverrideAction</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00364"></a>00364 <span class="keywordtype">float</span> speed = 1) = 0;
<a name="l00365"></a>00365
<a name="l00370"></a>00370 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSprite3DState.html#279709306f8a7d73884f18f2fa65a2ce" title="This sets an action to run one time, then the sprite reverts to the prior action...">SetOverrideAction</a>(<span class="keywordtype">int</span> index,
<a name="l00371"></a>00371 <span class="keywordtype">float</span> speed = 1) = 0;
<a name="l00372"></a>00372
<a name="l00374"></a>00374 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSprite3DState.html#7fe2441bd9a8c3d10c1a3ebb966ce4c1" title="Propogate set action to all children.">PropagateAction</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name) = 0;
<a name="l00375"></a>00375
<a name="l00377"></a>00377 <span class="keyword">virtual</span> <a class="code" href="structiSpriteAction.html" title="An action frameset for 3D sprite animation.">iSpriteAction</a>* <a class="code" href="structiSprite3DState.html#c355b5c90a671bd7bb4c564a56613543" title="Get the current action.">GetCurAction</a> () <span class="keyword">const</span> = 0;
<a name="l00378"></a>00378
<a name="l00380"></a>00380 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSprite3DState.html#95f07c9d1972afcd0b75d74015e223a1" title="Get whether the current action is reversed or not.">GetReverseAction</a> () <span class="keyword">const</span> = 0;
<a name="l00381"></a>00381
<a name="l00383"></a>00383 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DState.html#04b59a3bbedebe1c8398fb90c5f574f7" title="Enable/disable tweening.">EnableTweening</a> (<span class="keywordtype">bool</span> en) = 0;
<a name="l00385"></a>00385 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSprite3DState.html#c68bc001cd3578b26074e49926ed30e0" title="Query state of tweening.">IsTweeningEnabled</a> () <span class="keyword">const</span> = 0;
<a name="l00386"></a>00386
<a name="l00388"></a>00388 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DState.html#0f4a7e5d65d8fc24ff5728425db8a339" title="Unset the texture (i.e. use the one from the factory).">UnsetTexture</a> () = 0;
<a name="l00389"></a>00389
<a name="l00395"></a>00395 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DState.html#2b4f30d2327aaa744ffb780c20b500e0" title="Returns the lighting quality level used by this sprite.">GetLightingQuality</a> () = 0;
<a name="l00396"></a>00396
<a name="l00401"></a>00401 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DState.html#c1cc04a1c72b532f40d6e16fd2a610e2" title="Sets the local lighting quality for this sprite.">SetLocalLightingQuality</a> (<span class="keywordtype">int</span> lighting_quality) = 0;
<a name="l00402"></a>00402
<a name="l00410"></a>00410 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DState.html#7b0d2d62912721a523236aa1e70ad1c7" title="Sets which lighting config variable this sprite will use.">SetLightingQualityConfig</a> (<span class="keywordtype">int</span> config_flag) = 0;
<a name="l00411"></a>00411
<a name="l00415"></a>00415 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DState.html#397c88f2912c1827178e97f1e459151f" title="Returns what this sprite is using for determining the lighting quality.">GetLightingQualityConfig</a> () <span class="keyword">const</span> = 0;
<a name="l00416"></a>00416
<a name="l00424"></a>00424 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSprite3DState.html#f06df0fb63889ba88754f961b206c194" title="Sets which lighting config variable this sprite will use.">SetLodLevelConfig</a> (<span class="keywordtype">int</span> config_flag) = 0;
<a name="l00425"></a>00425
<a name="l00429"></a>00429 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiSprite3DState.html#abaa81f34b39bfde7ecad1e3c826b42b" title="Returns what this sprite is using for determining the lighting quality.">GetLodLevelConfig</a> () <span class="keyword">const</span> = 0;
<a name="l00430"></a>00430
<a name="l00434"></a>00434 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSprite3DState.html#c4044db8b20dae41a6d8b6244e32a05e" title="Returns true if lod is enabled, else false.">IsLodEnabled</a> () <span class="keyword">const</span> = 0;
<a name="l00435"></a>00435
<a name="l00437"></a>00437 <span class="keyword">virtual</span> <a class="code" href="structiSpriteSocket.html" title="A socket for specifying where sprites can plug into other sprites.">iSpriteSocket</a>* <a class="code" href="structiSprite3DState.html#a609ba0277bdef4d2a1008bd4b8e9531" title="find a socked based on the sprite attached to it.">FindSocket</a> (<a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a> *mesh) <span class="keyword">const</span> = 0;
<a name="l00438"></a>00438
<a name="l00440"></a>00440 <span class="keyword">virtual</span> <a class="code" href="structiSpriteSocket.html" title="A socket for specifying where sprites can plug into other sprites.">iSpriteSocket</a>* <a class="code" href="structiSprite3DState.html#a609ba0277bdef4d2a1008bd4b8e9531" title="find a socked based on the sprite attached to it.">FindSocket</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * name) <span class="keyword">const</span> = 0;
<a name="l00441"></a>00441 };
<a name="l00442"></a>00442
<a name="l00445"></a>00445 <span class="preprocessor">#endif // __CS_IMESH_SPRITE3D_H__</span>
<a name="l00446"></a>00446 <span class="preprocessor"></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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2336
