Public API Reference

imesh/sprite3d.h

Go to the documentation of this file.

/*
    Copyright (C) 2000-2001 by Jorrit Tyberghein

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IMESH_SPRITE3D_H__
#define __CS_IMESH_SPRITE3D_H__

#include "csutil/scf.h"

struct iMaterialWrapper;
struct iMeshObject;
struct iMeshObjectFactory;
struct iMeshWrapper;
struct iRenderView;

class csColor;
class csVector2;
class csVector3;
struct csTriangle;

enum
{
  CS_SPR_LIGHTING_HQ = 0,
  CS_SPR_LIGHTING_LQ = 1,
  CS_SPR_LIGHTING_FAST = 2,
  CS_SPR_LIGHTING_RANDOM = 3
};

#define CS_SPR_LIGHT_GLOBAL 0

#define CS_SPR_LIGHT_TEMPLATE 1

#define CS_SPR_LIGHT_LOCAL 2

#define CS_SPR_LOD_GLOBAL 0

#define CS_SPR_LOD_TEMPLATE 1

#define CS_SPR_LOD_LOCAL 2

struct iSpriteFrame : public virtual iBase
{
  SCF_INTERFACE (iSpriteFrame, 1, 0, 0);

  virtual void SetName (char const*) = 0;
  virtual char const* GetName () const = 0;
  virtual int GetAnmIndex () const = 0;
  virtual int GetTexIndex () const = 0;
};

struct iSpriteAction : public virtual iBase
{
  SCF_INTERFACE (iSpriteAction, 1, 0, 0);

  virtual void SetName (char const*) = 0;
  virtual char const* GetName () const = 0;
  virtual int GetFrameCount () = 0;
  virtual iSpriteFrame* GetFrame (int f) = 0;
  virtual iSpriteFrame* GetNextFrame (int f) = 0;
  virtual int GetFrameDelay (int f) = 0;
  virtual float GetFrameDisplacement (int f) = 0;
  virtual void AddFrame (iSpriteFrame* frame, int delay,
        float displacement) = 0;
};

struct iSpriteSocket : public virtual iBase
{
  SCF_INTERFACE (iSpriteSocket, 1, 0, 0);

  virtual void SetName (char const*) = 0;
  virtual char const* GetName () const = 0;
  
  virtual void SetMeshWrapper (iMeshWrapper* mesh) = 0;
  virtual iMeshWrapper* GetMeshWrapper () const = 0;
  
  virtual void SetTriangleIndex (int tri_index) = 0;
  virtual int GetTriangleIndex () const = 0;
};

struct iSprite3DFactoryState : public virtual iBase
{
  SCF_INTERFACE (iSprite3DFactoryState, 1, 0, 0);

  virtual void AddVertices (int num) = 0;
  virtual int GetVertexCount () const = 0;

  virtual const csVector3& GetVertex (int frame, int vertex) const = 0;
  virtual void SetVertex (int frame, int vertex, const csVector3 &Value) = 0;
  virtual csVector3* GetVertices (int frame) const = 0;
  virtual void SetVertices (csVector3 const* vert, int frame) = 0;

  virtual const csVector2& GetTexel (int frame, int vertex) const = 0;
  virtual void SetTexel (int frame, int vertex, const csVector2 &Value) = 0;
  virtual csVector2* GetTexels (int frame) const = 0;
  virtual void SetTexels (csVector2 const* tex, int frame) = 0;

  virtual const csVector3& GetNormal (int frame, int vertex) const = 0;
  virtual void SetNormal (int frame, int vertex, const csVector3 &Value) = 0;
  virtual csVector3* GetNormals (int frame) const = 0;
  virtual void SetNormals (csVector3 const* norms, int frame) = 0;

  virtual void AddTriangle (int a, int b, int c) = 0;
  virtual csTriangle GetTriangle (int x) const = 0;
  virtual csTriangle* GetTriangles () const = 0;
  virtual int GetTriangleCount () const = 0;
  virtual void SetTriangleCount (int count) = 0;
  virtual void SetTriangles( csTriangle const* trigs, int count) = 0;

  virtual iSpriteFrame* AddFrame () = 0;
  virtual iSpriteFrame* FindFrame (const char* name) const = 0;
  virtual int GetFrameCount () const = 0;
  virtual iSpriteFrame* GetFrame (int f) const = 0;

  virtual iSpriteAction* AddAction () = 0;
  virtual iSpriteAction* FindAction (const char* name) const = 0;
  virtual iSpriteAction* GetFirstAction () const = 0;
  virtual int GetActionCount () const = 0;
  virtual iSpriteAction* GetAction (int No) const = 0;

  virtual iSpriteSocket* AddSocket () = 0;
  virtual iSpriteSocket* FindSocket (const char * name) const = 0;
  virtual iSpriteSocket* FindSocket (iMeshWrapper *mesh) const = 0;  
  virtual int GetSocketCount () const = 0;
  virtual iSpriteSocket* GetSocket (int f) const = 0;

  virtual void EnableTweening (bool en) = 0;
  virtual bool IsTweeningEnabled () const = 0;
  virtual void SetLightingQuality (int qual) = 0;
  virtual int GetLightingQuality () const = 0;
  virtual void SetLightingQualityConfig (int qual) = 0;
  virtual int GetLightingQualityConfig () const = 0;

  virtual void SetLodLevelConfig (int config_flag) = 0;

  virtual int GetLodLevelConfig () const = 0;

  virtual void MergeNormals (int base, int frame) = 0;

  virtual void MergeNormals (int base) = 0;

  virtual void MergeNormals () = 0;
};

struct iSprite3DState : public virtual iBase
{
  SCF_INTERFACE (iSprite3DState, 1, 0, 0);

  virtual void SetMixMode (uint mode) = 0;
  virtual uint GetMixMode () const = 0;
  virtual void SetLighting (bool l) = 0;
  virtual bool IsLighting () const = 0;

  virtual void SetFrame (int f) = 0;

  virtual int GetCurFrame () const = 0;

  virtual int GetFrameCount () const = 0;

  virtual bool SetAction (const char * name,
        bool loop = true, float speed = 1) = 0;

  virtual bool SetAction (int index,
        bool loop = true, float speed = 1) = 0;

  virtual void SetReverseAction(bool reverse) = 0;

  virtual void SetSingleStepAction(bool singlestep) = 0;

  virtual bool SetOverrideAction(const char *name,
        float speed = 1) = 0;

  virtual bool SetOverrideAction(int index,
        float speed = 1) = 0;

  virtual bool PropagateAction (const char *name) = 0;

  virtual iSpriteAction* GetCurAction () const = 0;

  virtual bool GetReverseAction () const = 0;

  virtual void EnableTweening (bool en) = 0;
  virtual bool IsTweeningEnabled () const = 0;

  virtual void UnsetTexture () = 0;

  virtual int GetLightingQuality () = 0;

  virtual void SetLocalLightingQuality (int lighting_quality) = 0;

  virtual void SetLightingQualityConfig (int config_flag) = 0;

  virtual int GetLightingQualityConfig () const = 0;

  virtual void SetLodLevelConfig (int config_flag) = 0;

  virtual int GetLodLevelConfig () const = 0;

  virtual bool IsLodEnabled () const = 0;

  virtual iSpriteSocket* FindSocket (iMeshWrapper *mesh) const = 0;  

  virtual iSpriteSocket* FindSocket (const char * name) const = 0;
};

#endif // __CS_IMESH_SPRITE3D_H__

---