Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | 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 00024 struct iMaterialWrapper; 00025 struct iMeshObject; 00026 struct iMeshObjectFactory; 00027 struct iMeshWrapper; 00028 struct iRenderView; 00029 00030 class csColor; 00031 class csVector2; 00032 class csVector3; 00033 struct csTriangle; 00034 00038 enum 00039 { 00040 CS_SPR_LIGHTING_HQ = 0, 00041 CS_SPR_LIGHTING_LQ = 1, 00042 CS_SPR_LIGHTING_FAST = 2, 00043 CS_SPR_LIGHTING_RANDOM = 3 00044 }; 00045 00050 #define CS_SPR_LIGHT_GLOBAL 0 00051 00056 #define CS_SPR_LIGHT_TEMPLATE 1 00057 00062 #define CS_SPR_LIGHT_LOCAL 2 00063 00068 #define CS_SPR_LOD_GLOBAL 0 00069 00073 #define CS_SPR_LOD_TEMPLATE 1 00074 00078 #define CS_SPR_LOD_LOCAL 2 00079 00080 // @@@ CONFIG TODO: global_lighting_quality 00081 // @@@ CONFIG TODO: global_lod_level 00082 00083 SCF_VERSION (iSpriteFrame, 0, 0, 2); 00084 00088 struct iSpriteFrame : public iBase 00089 { 00091 virtual void SetName (char const*) = 0; 00093 virtual char const* GetName () const = 0; 00095 virtual int GetAnmIndex () const = 0; 00097 virtual int GetTexIndex () const = 0; 00098 }; 00099 00100 SCF_VERSION (iSpriteAction, 0, 0, 1); 00101 00105 struct iSpriteAction : public iBase 00106 { 00108 virtual void SetName (char const*) = 0; 00110 virtual char const* GetName () const = 0; 00112 virtual int GetFrameCount () = 0; 00114 virtual iSpriteFrame* GetFrame (int f) = 0; 00116 virtual iSpriteFrame* GetNextFrame (int f) = 0; 00118 virtual int GetFrameDelay (int f) = 0; 00120 virtual float GetFrameDisplacement (int f) = 0; 00122 virtual void AddFrame (iSpriteFrame* frame, int delay, float displacement) = 0; 00123 }; 00124 00125 SCF_VERSION (iSpriteSocket, 0, 0, 1); 00126 00131 struct iSpriteSocket : public iBase 00132 { 00134 virtual void SetName (char const*) = 0; 00136 virtual char const* GetName () const = 0; 00137 00139 virtual void SetMeshWrapper (iMeshWrapper* mesh) = 0; 00141 virtual iMeshWrapper* GetMeshWrapper () const = 0; 00142 00144 virtual void SetTriangleIndex (int tri_index) = 0; 00146 virtual int GetTriangleIndex () const = 0; 00147 }; 00148 00149 SCF_VERSION (iSprite3DFactoryState, 0, 0, 3); 00150 00154 struct iSprite3DFactoryState : public iBase 00155 { 00157 virtual void SetMaterialWrapper (iMaterialWrapper* material) = 0; 00159 virtual iMaterialWrapper* GetMaterialWrapper () const = 0; 00160 00169 virtual void AddVertices (int num) = 0; 00171 virtual int GetVertexCount () const = 0; 00172 00174 virtual const csVector3& GetVertex (int frame, int vertex) const = 0; 00176 virtual void SetVertex (int frame, int vertex, const csVector3 &Value) = 0; 00178 virtual csVector3* GetVertices (int frame) const = 0; 00183 virtual void SetVertices (csVector3 const* vert, int frame) = 0; 00184 00186 virtual const csVector2& GetTexel (int frame, int vertex) const = 0; 00188 virtual void SetTexel (int frame, int vertex, const csVector2 &Value) = 0; 00190 virtual csVector2* GetTexels (int frame) const = 0; 00195 virtual void SetTexels (csVector2 const* tex, int frame) = 0; 00196 00198 virtual const csVector3& GetNormal (int frame, int vertex) const = 0; 00200 virtual void SetNormal (int frame, int vertex, const csVector3 &Value) = 0; 00202 virtual csVector3* GetNormals (int frame) const = 0; 00207 virtual void SetNormals (csVector3 const* norms, int frame) = 0; 00208 00213 virtual void AddTriangle (int a, int b, int c) = 0; 00215 virtual csTriangle GetTriangle (int x) const = 0; 00217 virtual csTriangle* GetTriangles () const = 0; 00219 virtual int GetTriangleCount () const = 0; 00221 virtual void SetTriangleCount (int count) = 0; 00223 virtual void SetTriangles( csTriangle const* trigs, int count) = 0; 00224 00226 virtual iSpriteFrame* AddFrame () = 0; 00228 virtual iSpriteFrame* FindFrame (const char* name) const = 0; 00230 virtual int GetFrameCount () const = 0; 00232 virtual iSpriteFrame* GetFrame (int f) const = 0; 00233 00235 virtual iSpriteAction* AddAction () = 0; 00237 virtual iSpriteAction* FindAction (const char* name) const = 0; 00239 virtual iSpriteAction* GetFirstAction () const = 0; 00241 virtual int GetActionCount () const = 0; 00243 virtual iSpriteAction* GetAction (int No) const = 0; 00244 00246 virtual iSpriteSocket* AddSocket () = 0; 00248 virtual iSpriteSocket* FindSocket (const char * name) const = 0; 00250 virtual iSpriteSocket* FindSocket (iMeshWrapper *mesh) const = 0; 00252 virtual int GetSocketCount () const = 0; 00254 virtual iSpriteSocket* GetSocket (int f) const = 0; 00255 00257 virtual void EnableTweening (bool en) = 0; 00259 virtual bool IsTweeningEnabled () const = 0; 00261 virtual void SetLightingQuality (int qual) = 0; 00263 virtual int GetLightingQuality () const = 0; 00274 virtual void SetLightingQualityConfig (int qual) = 0; 00276 virtual int GetLightingQualityConfig () const = 0; 00277 00288 virtual void SetLodLevelConfig (int config_flag) = 0; 00289 00291 virtual int GetLodLevelConfig () const = 0; 00292 00298 virtual void MergeNormals (int base, int frame) = 0; 00299 00305 virtual void MergeNormals (int base) = 0; 00306 00312 virtual void MergeNormals () = 0; 00313 00315 virtual void SetMixMode (uint mode) = 0; 00317 virtual uint GetMixMode () const = 0; 00318 }; 00319 00320 SCF_VERSION (iSprite3DState, 0, 0, 6); 00321 00325 struct iSprite3DState : public iBase 00326 { 00328 virtual void SetMaterialWrapper (iMaterialWrapper* material) = 0; 00330 virtual iMaterialWrapper* GetMaterialWrapper () const = 0; 00332 virtual void SetMixMode (uint mode) = 0; 00334 virtual uint GetMixMode () const = 0; 00336 virtual void SetLighting (bool l) = 0; 00338 virtual bool IsLighting () const = 0; 00339 00340 // @@@ TODO: what about convenience functions to set colors for verts? 00341 00343 virtual void SetFrame (int f) = 0; 00344 00346 virtual int GetCurFrame () const = 0; 00347 00349 virtual int GetFrameCount () const = 0; 00350 00355 virtual bool SetAction (const char * name, 00356 bool loop = true, float speed = 1) = 0; 00357 00362 virtual bool SetAction (int index, 00363 bool loop = true, float speed = 1) = 0; 00364 00366 virtual void SetReverseAction(bool reverse) = 0; 00367 00369 virtual void SetSingleStepAction(bool singlestep) = 0; 00370 00375 virtual bool SetOverrideAction(const char *name, 00376 float speed = 1) = 0; 00377 00382 virtual bool SetOverrideAction(int index, 00383 float speed = 1) = 0; 00384 00386 virtual bool PropagateAction (const char *name) = 0; 00387 00389 virtual iSpriteAction* GetCurAction () const = 0; 00390 00392 virtual bool GetReverseAction () const = 0; 00393 00395 virtual void EnableTweening (bool en) = 0; 00397 virtual bool IsTweeningEnabled () const = 0; 00398 00400 virtual void UnsetTexture () = 0; 00401 00407 virtual int GetLightingQuality () = 0; 00408 00413 virtual void SetLocalLightingQuality (int lighting_quality) = 0; 00414 00424 virtual void SetLightingQualityConfig (int config_flag) = 0; 00425 00429 virtual int GetLightingQualityConfig () const = 0; 00430 00440 virtual void SetLodLevelConfig (int config_flag) = 0; 00441 00445 virtual int GetLodLevelConfig () const = 0; 00446 00450 virtual bool IsLodEnabled () const = 0; 00451 00457 virtual void SetBaseColor (const csColor& col) = 0; 00458 00462 virtual void GetBaseColor (csColor& col) const = 0; 00463 00465 virtual iSpriteSocket* FindSocket (iMeshWrapper *mesh) const = 0; 00466 00468 virtual iSpriteSocket* FindSocket (const char * name) const = 0; 00469 }; 00470 00471 #endif // __CS_IMESH_SPRITE3D_H__ 00472
Generated for Crystal Space by doxygen 1.4.4