Public API Reference

imesh/sprite2d.h

Go to the documentation of this file.

/*
    Copyright (C) 2000 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_SPRITE2D_H__
#define __CS_IMESH_SPRITE2D_H__

#include "iutil/array.h"
#include "csutil/scf.h"
#include "csutil/dirtyaccessarray.h"
#include "csutil/cscolor.h"
#include "csgeom/vector2.h"

struct iMaterialWrapper;

struct csSprite2DVertex
{
  csVector2 pos;
  csColor color_init;
  csColor color;
  float u, v;
  bool operator== (const csSprite2DVertex& other)
  { 
    return (pos == other.pos) && (color_init == other.color_init)
      && (color == other.color) && (u == other.u) && (v == other.v);
  }
};

struct iColoredVertices : public iArrayChangeAll<csSprite2DVertex>
{
  SCF_IARRAYCHANGEALL_INTERFACE(iColoredVertices);
};

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

  virtual void SetName (const char *name) = 0;

  virtual const char *GetName () const = 0;

  virtual csVector2 &GetUVCoo (int idx) = 0;

  virtual const csVector2 *GetUVCoo () = 0;

  virtual int GetUVCount () = 0;

  virtual void SetUV (int idx, float u, float v) = 0;

  virtual void SetFrameData (const char *name, int duration, int num,
        float *uv) = 0;

  virtual void RemoveUV (int idx) = 0;

  virtual int GetDuration () = 0;

  virtual void SetDuration (int duration) = 0;
};

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

  virtual void SetName (const char *name) = 0;

  virtual const char *GetName () const = 0;

  virtual int GetFrameCount () = 0;

  virtual iSprite2DUVAnimationFrame *GetFrame (int idx) = 0;

  virtual iSprite2DUVAnimationFrame *GetFrame (const char *name) = 0;

  virtual iSprite2DUVAnimationFrame *CreateFrame (int idx) = 0;

  virtual void MoveFrame (int frame, int idx) = 0;

  virtual void RemoveFrame (int idx) = 0;

};

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

  virtual void SetLighting (bool l) = 0;

  virtual bool HasLighting () const = 0;

  virtual int GetUVAnimationCount () const = 0;

  virtual iSprite2DUVAnimation *CreateUVAnimation () = 0;

  virtual void RemoveUVAnimation (iSprite2DUVAnimation *anim) = 0;

  virtual iSprite2DUVAnimation *GetUVAnimation (const char *name) const = 0;

  virtual iSprite2DUVAnimation *GetUVAnimation (int idx) const = 0;

};

struct iSprite2DState : public iSprite2DFactoryState
{
  SCF_INTERFACE (iSprite2DState, 1, 1, 0);

  virtual iColoredVertices* GetVertices () = 0;
  virtual void CreateRegularVertices (int n, bool setuv) = 0;

  virtual void SetUVAnimation (const char *name, int style, bool loop) = 0;

  virtual iSprite2DUVAnimation *GetUVAnimation (const char *name) const = 0;

  virtual iSprite2DUVAnimation *GetUVAnimation (int idx) const = 0;

  virtual iSprite2DUVAnimation *GetUVAnimation (int idx, int &style,
                                                bool &loop) const = 0;

  virtual void StopUVAnimation (int idx) = 0;

  virtual void PlayUVAnimation (int idx, int style, bool loop) = 0;
};

#endif // __CS_IMESH_SPRITE2D_H__

---