Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages
sprite3d.h
00001 /* 00002 Copyright (C) 2000-2001 by Jorrit Tyberghein 00003 00004 This library is free software; you can redistribute it and/or 00005 modify it under the terms of the GNU Library General Public 00006 License as published by the Free Software Foundation; either 00007 version 2 of the License, or (at your option) any later version. 00008 00009 This library is distributed in the hope that it will be useful, 00010 but WITHOUT ANY WARRANTY; without even the implied warranty of 00011 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00012 Library General Public License for more details. 00013 00014 You should have received a copy of the GNU Library General Public 00015 License along with this library; if not, write to the Free 00016 Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 00017 */ 00018 00019 #ifndef __CS_IMESH_SPRITE3D_H__ 00020 #define __CS_IMESH_SPRITE3D_H__ 00021 00022 #include "csutil/scf.h" 00023 #include "csutil/dirtyaccessarray.h" 00024 #include "csutil/cscolor.h" 00025 #include "ivideo/graph3d.h" 00026 00027 class csColor; 00028 struct iMaterialWrapper; 00029 struct iMeshObject; 00030 struct iMeshWrapper; 00031 struct iMeshObjectFactory; 00032 struct iRenderView; 00033 struct iRenderView; 00034 00038 #define CS_SPR_LIGHTING_HQ 0 00039 #define CS_SPR_LIGHTING_LQ 1 00040 #define CS_SPR_LIGHTING_FAST 2 00041 #define CS_SPR_LIGHTING_RANDOM 3 00042 00047 #define CS_SPR_LIGHT_GLOBAL 0 00048 00053 #define CS_SPR_LIGHT_TEMPLATE 1 00054 00059 #define CS_SPR_LIGHT_LOCAL 2 00060 00065 #define CS_SPR_LOD_GLOBAL 0 00066 00070 #define CS_SPR_LOD_TEMPLATE 1 00071 00075 #define CS_SPR_LOD_LOCAL 2 00076 00077 // @@@ CONFIG TODO: global_lighting_quality 00078 // @@@ CONFIG TODO: global_lod_level 00079 00080 SCF_VERSION (iSpriteFrame, 0, 0, 2); 00081 00085 struct iSpriteFrame : public iBase 00086 { 00088 virtual void SetName (char const*) = 0; 00090 virtual char const* GetName () const = 0; 00092 virtual int GetAnmIndex () const = 0; 00094 virtual int GetTexIndex () const = 0; 00095 }; 00096 00097 SCF_VERSION (iSpriteAction, 0, 0, 1); 00098 00102 struct iSpriteAction : public iBase 00103 { 00105 virtual void SetName (char const*) = 0; 00107 virtual char const* GetName () const = 0; 00109 virtual int GetFrameCount () = 0; 00111 virtual iSpriteFrame* GetFrame (int f) = 0; 00113 virtual iSpriteFrame* GetNextFrame (int f) = 0; 00115 virtual int GetFrameDelay (int f) = 0; 00117 virtual float GetFrameDisplacement (int f) = 0; 00119 virtual void AddFrame (iSpriteFrame* frame, int delay, float displacement) = 0; 00120 }; 00121 00122 SCF_VERSION (iSpriteSocket, 0, 0, 1); 00123 00128 struct iSpriteSocket : public iBase 00129 { 00131 virtual void SetName (char const*) = 0; 00133 virtual char const* GetName () const = 0; 00134 00136 virtual void SetMeshWrapper (iMeshWrapper* mesh) = 0; 00138 virtual iMeshWrapper* GetMeshWrapper () const = 0; 00139 00141 virtual void SetTriangleIndex (int tri_index) = 0; 00143 virtual int GetTriangleIndex () const = 0; 00144 }; 00145 00146 SCF_VERSION (iSprite3DFactoryState, 0, 0, 3); 00147 00151 struct iSprite3DFactoryState : public iBase 00152 { 00154 virtual void SetMaterialWrapper (iMaterialWrapper* material) = 0; 00156 virtual iMaterialWrapper* GetMaterialWrapper () const = 0; 00157 00166 virtual void AddVertices (int num) = 0; 00168 virtual int GetVertexCount () const = 0; 00169 00171 virtual const csVector3& GetVertex (int frame, int vertex) const = 0; 00173 virtual void SetVertex (int frame, int vertex, const csVector3 &Value) = 0; 00175 virtual csVector3* GetVertices (int frame) const = 0; 00180 virtual void SetVertices (csVector3 const* vert, int frame) = 0; 00181 00183 virtual const csVector2& GetTexel (int frame, int vertex) const = 0; 00185 virtual void SetTexel (int frame, int vertex, const csVector2 &Value) = 0; 00187 virtual csVector2* GetTexels (int frame) const = 0; 00192 virtual void SetTexels (csVector2 const* tex, int frame) = 0; 00193 00195 virtual const csVector3& GetNormal (int frame, int vertex) const = 0; 00197 virtual void SetNormal (int frame, int vertex, const csVector3 &Value) = 0; 00199 virtual csVector3* GetNormals (int frame) const = 0; 00204 virtual void SetNormals (csVector3 const* norms, int frame) = 0; 00205 00210 virtual void AddTriangle (int a, int b, int c) = 0; 00212 virtual csTriangle GetTriangle (int x) const = 0; 00214 virtual csTriangle* GetTriangles () const = 0; 00216 virtual int GetTriangleCount () const = 0; 00218 virtual void SetTriangleCount (int count) = 0; 00220 virtual void SetTriangles( csTriangle const* trigs, int count) = 0; 00221 00223 virtual iSpriteFrame* AddFrame () = 0; 00225 virtual iSpriteFrame* FindFrame (const char* name) const = 0; 00227 virtual int GetFrameCount () const = 0; 00229 virtual iSpriteFrame* GetFrame (int f) const = 0; 00230 00232 virtual iSpriteAction* AddAction () = 0; 00234 virtual iSpriteAction* FindAction (const char* name) const = 0; 00236 virtual iSpriteAction* GetFirstAction () const = 0; 00238 virtual int GetActionCount () const = 0; 00240 virtual iSpriteAction* GetAction (int No) const = 0; 00241 00243 virtual iSpriteSocket* AddSocket () = 0; 00245 virtual iSpriteSocket* FindSocket (const char * name) const = 0; 00247 virtual iSpriteSocket* FindSocket (iMeshWrapper *mesh) const = 0; 00249 virtual int GetSocketCount () const = 0; 00251 virtual iSpriteSocket* GetSocket (int f) const = 0; 00252 00254 virtual void EnableTweening (bool en) = 0; 00256 virtual bool IsTweeningEnabled () const = 0; 00258 virtual void SetLightingQuality (int qual) = 0; 00260 virtual int GetLightingQuality () const = 0; 00271 virtual void SetLightingQualityConfig (int qual) = 0; 00273 virtual int GetLightingQualityConfig () const = 0; 00274 00285 virtual void SetLodLevelConfig (int config_flag) = 0; 00286 00288 virtual int GetLodLevelConfig () const = 0; 00289 00295 virtual void MergeNormals (int base, int frame) = 0; 00296 00302 virtual void MergeNormals (int base) = 0; 00303 00309 virtual void MergeNormals () = 0; 00310 00312 virtual void SetMixMode (uint mode) = 0; 00314 virtual uint GetMixMode () const = 0; 00315 }; 00316 00317 SCF_VERSION (iSprite3DState, 0, 0, 6); 00318 00322 struct iSprite3DState : public iBase 00323 { 00325 virtual void SetMaterialWrapper (iMaterialWrapper* material) = 0; 00327 virtual iMaterialWrapper* GetMaterialWrapper () const = 0; 00329 virtual void SetMixMode (uint mode) = 0; 00331 virtual uint GetMixMode () const = 0; 00333 virtual void SetLighting (bool l) = 0; 00335 virtual bool IsLighting () const = 0; 00336 00337 // @@@ TODO: what about convenience functions to set colors for verts? 00338 00340 virtual void SetFrame (int f) = 0; 00341 00343 virtual int GetCurFrame () const = 0; 00344 00346 virtual int GetFrameCount () const = 0; 00347 00352 virtual bool SetAction (const char * name, 00353 bool loop = true, float speed = 1) = 0; 00354 00359 virtual bool SetAction (int index, 00360 bool loop = true, float speed = 1) = 0; 00361 00363 virtual void SetReverseAction(bool reverse) = 0; 00364 00366 virtual void SetSingleStepAction(bool singlestep) = 0; 00367 00372 virtual bool SetOverrideAction(const char *name, 00373 float speed = 1) = 0; 00374 00379 virtual bool SetOverrideAction(int index, 00380 float speed = 1) = 0; 00381 00383 virtual bool PropagateAction (const char *name) = 0; 00384 00386 virtual iSpriteAction* GetCurAction () const = 0; 00387 00389 virtual bool GetReverseAction () const = 0; 00390 00392 virtual void EnableTweening (bool en) = 0; 00394 virtual bool IsTweeningEnabled () const = 0; 00395 00397 virtual void UnsetTexture () = 0; 00398 00404 virtual int GetLightingQuality () = 0; 00405 00410 virtual void SetLocalLightingQuality (int lighting_quality) = 0; 00411 00421 virtual void SetLightingQualityConfig (int config_flag) = 0; 00422 00426 virtual int GetLightingQualityConfig () const = 0; 00427 00437 virtual void SetLodLevelConfig (int config_flag) = 0; 00438 00442 virtual int GetLodLevelConfig () const = 0; 00443 00447 virtual bool IsLodEnabled () const = 0; 00448 00454 virtual void SetBaseColor (const csColor& col) = 0; 00455 00459 virtual void GetBaseColor (csColor& col) const = 0; 00460 00462 virtual iSpriteSocket* FindSocket (iMeshWrapper *mesh) const = 0; 00463 00465 virtual iSpriteSocket* FindSocket (const char * name) const = 0; 00466 }; 00467 00468 #endif // __CS_IMESH_SPRITE3D_H__ 00469
Generated for Crystal Space by doxygen 1.3.9.1