imesh/spritecal3d.h
Go to the documentation of this file.00001 /* 00002 Copyright (C) 2003 by Keith Fulton 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_SPRITECAL3D_H__ 00020 #define __CS_IMESH_SPRITECAL3D_H__ 00021 00026 #include "csutil/scf.h" 00027 #include "imesh/sprite3d.h" 00028 00032 struct iMaterialWrapper; 00033 struct iMeshObject; 00034 struct iMeshWrapper; 00035 struct iMeshObjectFactory; 00036 struct iRenderView; 00037 struct iShaderVariableContext; 00038 struct iVFS; 00039 00040 class csColor; 00041 class csRandomGen; 00042 class csReversibleTransform; 00043 class csString; 00044 00045 class CalModel; 00046 class CalCoreModel; 00047 00051 struct iSpriteCal3DSocket : public virtual iSpriteSocket 00052 { 00053 SCF_INTERFACE (iSpriteCal3DSocket, 1, 0, 0); 00054 00056 virtual void SetSubmeshIndex (int subm_index) = 0; 00058 virtual int GetSubmeshIndex () const = 0; 00059 00061 virtual void SetMeshIndex (int m_index) = 0; 00063 virtual int GetMeshIndex () const = 0; 00064 00066 virtual void SetTransform (const csReversibleTransform & trans) = 0; 00068 virtual csReversibleTransform GetTransform () const = 0; 00069 00074 virtual size_t GetSecondaryCount () const = 0; 00076 virtual iMeshWrapper * GetSecondaryMesh (size_t index) = 0; 00078 virtual csReversibleTransform GetSecondaryTransform (size_t index) = 0; 00080 virtual void SetSecondaryTransform (size_t index, csReversibleTransform) = 0; 00082 virtual size_t AttachSecondary (iMeshWrapper*, csReversibleTransform) = 0; 00084 virtual void DetachSecondary (const char* mesh_name) = 0; 00086 virtual void DetachSecondary (size_t index) = 0; 00088 virtual size_t FindSecondary (const char* mesh_name) = 0; 00089 }; 00090 00091 00092 struct CalAnimationCallback; 00093 00097 struct iSpriteCal3DFactoryState : public virtual iBase 00098 { 00099 SCF_INTERFACE (iSpriteCal3DFactoryState, 2, 1, 0); 00100 00102 virtual bool Create(const char *name) = 0; 00103 00109 virtual void ReportLastError () = 0; 00110 00114 CS_DEPRECATED_METHOD_MSG("Pass load flags to Load*() functions instead") 00115 virtual void SetLoadFlags(int flags) = 0; 00116 00121 virtual void SetBasePath(const char *path) = 0; 00122 00127 virtual bool LoadCoreSkeleton (iVFS *vfs,const char *filename, 00128 int loadFlags = 0) = 0; 00129 00134 virtual void RescaleFactory(float factor) = 0; 00135 00168 virtual int LoadCoreAnimation( 00169 iVFS *vfs, 00170 const char *filename, 00171 const char *name, 00172 int type, 00173 float base_velocity, 00174 float min_velocity, 00175 float max_velocity, 00176 int min_interval, 00177 int max_interval, 00178 int idle_pct, 00179 bool lock, 00180 int loadFlags = 0) = 0; 00181 00194 virtual int LoadCoreMesh(iVFS *vfs,const char *filename, 00195 const char *name,bool attach,iMaterialWrapper *defmat, 00196 int loadFlags = 0) = 0; 00197 00210 virtual int LoadCoreMorphTarget(iVFS *vfs, int mesh_index, 00211 const char *filename, const char *name, 00212 int loadFlags = 0) = 0; 00213 00220 virtual int AddMorphAnimation(const char *name) = 0; 00221 00231 virtual bool AddMorphTarget(int morphanimation_index, 00232 const char *mesh_name, 00233 const char *morphtarget_name) = 0; 00234 00239 virtual bool AddCoreMaterial(iMaterialWrapper *mat) = 0; 00240 00242 virtual void CalculateAllBoneBoundingBoxes() = 0; 00243 00248 virtual void BindMaterials() = 0; 00249 00254 virtual int GetMeshCount() = 0; 00255 00259 virtual int GetMorphAnimationCount() = 0; 00260 00269 virtual int GetMorphTargetCount(int mesh_id) = 0; 00270 00274 virtual const char *GetMeshName(int idx) = 0; 00275 00279 virtual int FindMeshName(const char *meshName) = 0; 00280 00284 virtual const char* GetDefaultMaterial( const char* meshName ) = 0; 00285 00286 00291 virtual const char *GetMorphAnimationName(int idx) = 0; 00292 00297 virtual int FindMorphAnimationName(const char *meshName) = 0; 00298 00302 virtual bool IsMeshDefault(int idx) = 0; 00303 00305 virtual iSpriteCal3DSocket* AddSocket () = 0; 00307 virtual iSpriteCal3DSocket* FindSocket (const char * name) const = 0; 00309 virtual iSpriteCal3DSocket* FindSocket (iMeshWrapper *mesh) const = 0; 00311 virtual int GetSocketCount () const = 0; 00313 virtual iSpriteCal3DSocket* GetSocket (int f) const = 0; 00314 00320 virtual CalCoreModel *GetCal3DCoreModel() = 0; 00321 00326 virtual bool RegisterAnimCallback(const char *anim, 00327 CalAnimationCallback *callback, float min_interval) = 0; 00328 00333 virtual bool RemoveAnimCallback(const char *anim, 00334 CalAnimationCallback *callback) = 0; 00335 00341 virtual void AbsoluteRescaleFactory(float factor) = 0; 00342 00347 virtual float GetScaleFactor() = 0; 00348 }; 00349 00358 struct iAnimTimeUpdateHandler : public virtual iBase 00359 { 00360 SCF_INTERFACE (iAnimTimeUpdateHandler, 1, 0, 0); 00361 00368 virtual void UpdatePosition (float delta, CalModel*) = 0; 00369 }; 00370 00371 struct csSpriteCal3DActiveAnim 00372 { 00373 int index; 00374 float weight; 00375 }; 00376 00377 struct iSkeleton; 00378 00383 struct iSpriteCal3DState : public virtual iBase 00384 { 00385 SCF_INTERFACE (iSpriteCal3DState, 2, 1, 1); 00386 00390 00391 enum 00392 { 00393 C3D_ANIM_TYPE_NONE, 00394 C3D_ANIM_TYPE_IDLE, 00395 C3D_ANIM_TYPE_TRAVEL, 00396 C3D_ANIM_TYPE_CYCLE, 00397 C3D_ANIM_TYPE_STYLE_CYCLE, 00398 C3D_ANIM_TYPE_ACTION 00399 }; 00400 00402 virtual int GetAnimCount() = 0; 00403 00408 virtual const char *GetAnimName(int idx) = 0; 00409 00411 virtual int GetAnimType(int idx) = 0; 00412 00414 virtual int FindAnim(const char* name) = 0; 00415 00417 virtual void ClearAllAnims() = 0; 00418 00423 virtual bool SetAnimCycle(const char *name, float weight) = 0; 00424 00429 virtual bool SetAnimCycle(int idx, float weight) = 0; 00430 00439 virtual bool AddAnimCycle(const char *name, float weight, float delay) = 0; 00440 00444 virtual bool AddAnimCycle(int idx, float weight, float delay) = 0; 00445 00450 virtual bool ClearAnimCycle (int idx, float delay) = 0; 00451 00457 virtual bool ClearAnimCycle (const char *name, float delay) = 0; 00458 00463 virtual size_t GetActiveAnimCount() = 0; 00464 00474 virtual bool GetActiveAnims(csSpriteCal3DActiveAnim* buffer, 00475 size_t max_length) = 0; 00476 00481 virtual void SetActiveAnims(const csSpriteCal3DActiveAnim* buffer, 00482 size_t anim_count) = 0; 00483 00490 virtual bool SetAnimAction(const char *name, float delayIn, 00491 float delayOut) = 0; 00492 00499 virtual bool SetAnimAction(int idx, float delayIn, 00500 float delayOut) = 0; 00501 00510 virtual bool SetVelocity(float vel,csRandomGen *rng=0) = 0; 00511 00515 virtual void SetDefaultIdleAnim(const char *name) = 0; 00516 00521 virtual void SetCyclicBlendFactor(float factor) = 0; 00522 00531 virtual void SetLOD(float lod) = 0; 00540 virtual bool AttachCoreMesh(const char *meshname) = 0; 00541 00548 virtual bool DetachCoreMesh(const char *meshname) = 0; 00549 00558 virtual bool AttachCoreMesh(int mesh_id, iMaterialWrapper* iMatWrap = 0) = 0; 00565 virtual bool DetachCoreMesh(int mesh_id) = 0; 00579 virtual bool BlendMorphTarget(int morph_animation_id, float weight, 00580 float delay) = 0; 00581 00590 virtual bool ClearMorphTarget(int morph_animation_id, float delay) = 0; 00595 00596 virtual iSpriteCal3DSocket* FindSocket (iMeshWrapper *mesh) const = 0; 00597 00599 virtual iSpriteCal3DSocket* FindSocket (const char* name) const = 0; 00602 00603 virtual bool SetMaterial(const char *mesh_name,iMaterialWrapper *mat) = 0; 00604 00606 virtual iMaterialWrapper* GetMaterial(const char *mesh_name) = 0; 00607 00610 00611 virtual void SetTimeFactor(float timeFactor) = 0; 00612 00614 virtual float GetTimeFactor() = 0; 00615 00617 virtual float GetAnimationTime() = 0; 00618 00620 virtual float GetAnimationDuration() = 0; 00621 00623 virtual void SetAnimationTime(float animationTime) = 0; 00624 00632 virtual void SetAnimTimeUpdateHandler(iAnimTimeUpdateHandler*) = 0; 00635 00636 virtual void SetUserData(void *data) = 0; 00637 00644 virtual iShaderVariableContext* GetCoreMeshShaderVarContext ( 00645 const char* meshName) = 0; 00646 00648 virtual csPtr<iSkeleton> GetSkeleton () = 0; 00649 00657 00658 virtual CalModel *GetCal3DModel() = 0; 00660 }; 00661 00664 #endif// __CS_IMESH_SPRITECAL3D_H__
Generated for Crystal Space 2.1 by doxygen 1.6.1