Public API Reference

tools/billboard.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2003 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef __CEL_MGR_BILLBOARD__
#define __CEL_MGR_BILLBOARD__

#include "cstypes.h"
#include "csutil/scf.h"
#include "csutil/flags.h"

struct iImage;
struct iBillboard;
struct iSector;
class csColor;
class csVector2;

SCF_VERSION (iBillboardLayer, 0, 0, 1);

struct iBillboardLayer : public iBase
{
  virtual void GetOffset (int& x, int& y) const = 0;

  virtual void SetOffset (int x, int y) = 0;

  virtual void Move (int dx, int dy) = 0;

  virtual const char* GetName () const = 0;
};

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

  virtual void Select (iBillboard* billboard, int mouse_button,
        int mousex, int mousey) = 0;

  virtual void MouseMove (iBillboard* billboard, int mouse_button,
        int mousex, int mousey) = 0;

  virtual void MouseMoveAway (iBillboard* billboard, int mouse_button,
        int mousex, int mousey) = 0;

  virtual void Unselect (iBillboard* billboard, int mouse_button,
        int mousex, int mousey) = 0;

  virtual void DoubleClick (iBillboard* billboard, int mouse_button,
        int mousex, int mousey) = 0;
};


#define CEL_BILLBOARD_VISIBLE 1

#define CEL_BILLBOARD_MOVABLE 2

#define CEL_BILLBOARD_CLICKABLE 4

#define CEL_BILLBOARD_RESTACK 8

#define CEL_BILLBOARD_SENDMOVE 16

SCF_VERSION (iBillboard, 0, 0, 1);

struct iBillboard : public iBase
{
  virtual const char* GetName () const = 0;

  virtual csFlags& GetFlags () = 0;

  virtual bool SetMaterialName (const char* matname) = 0;

  virtual bool SetMaterialNameFast (const char* matname) = 0;

  virtual const char* GetMaterialName () = 0;

  virtual bool DrawMesh (const char* material_name,
        const char* factory, const csVector3& rotate = csVector3 (0, 0, 0),
        float angle = 0.0f, float distance = -1.0f) = 0;

  virtual void SetSize (int w, int h) = 0;

  virtual void GetSize (int& w, int& h) = 0;

  virtual void GetImageSize (int& w, int& h) = 0;

  virtual void SetPosition (int x, int y) = 0;

  virtual void MoveToPosition (csTicks delta, int x, int y) = 0;

  virtual void GetPosition (int& x, int& y) const = 0;

  virtual void Move (int dx, int dy) = 0;

  virtual void SetRotation (float angle) = 0;

  virtual float GetRotation () const = 0;

  virtual void StackTop () = 0;

  virtual void StackBottom () = 0;

  virtual void StackUp () = 0;

  virtual void StackDown () = 0;

  virtual void SetUVTopLeft (const csVector2& uv) = 0;

  virtual const csVector2& GetUVTopLeft () const = 0;

  virtual void SetUVBottomRight (const csVector2& uv) = 0;

  virtual const csVector2& GetUVBottomRight () const = 0;

  virtual void SetColor (const csColor& c) = 0;

  virtual const csColor& GetColor () const = 0;

  virtual void SetLayer (iBillboardLayer* layer) = 0;

  virtual iBillboardLayer* GetLayer () const = 0;

  virtual void AddEventHandler (iBillboardEventHandler* evh) = 0;

  virtual void RemoveEventHandler (iBillboardEventHandler* evh) = 0;

  virtual void SetText (const char* txt) = 0;

  virtual const char* GetText () const = 0;

  virtual void GetTextDimensions (int& w, int& h) = 0;

  virtual void SetTextOffset (int dx, int dy) = 0;

  virtual int GetTextOffsetDX () const = 0;

  virtual int GetTextOffsetDY () const = 0;

  virtual bool SetTextFont (const char* fontname, float fontsize) = 0;

  virtual const char* GetTextFont () const = 0;

  virtual float GetTextFontSize () const = 0;

  virtual void SetTextFgColor (const csColor& color) = 0;

  virtual const csColor& GetTextFgColor () const = 0;

  virtual void ClearTextFgColor () = 0;

  virtual void SetTextBgColor (const csColor& color) = 0;

  virtual const csColor& GetTextBgColor () const = 0;

  virtual void SetTextBgTransparent () = 0;

  virtual bool IsTextBgTransparent () const = 0;

  virtual void ClearTextBgColor () = 0;
};

SCF_VERSION (iBillboardManager, 0, 0, 1);

struct iBillboardManager : public iBase
{
  virtual int ScreenToBillboardX (int x) const = 0;

  virtual int ScreenToBillboardY (int y) const = 0;

  virtual int BillboardToScreenX (int x) const = 0;

  virtual int BillboardToScreenY (int y) const = 0;

  virtual iBillboard* CreateBillboard (const char* name) = 0;

  virtual iBillboard* FindBillboard (const char* name) const = 0;

  virtual void RemoveBillboard (iBillboard* billboard) = 0;

  virtual size_t GetBillboardCount () const = 0;

  virtual iBillboard* GetBillboard (size_t idx) const = 0;

  virtual iBillboardLayer* CreateBillboardLayer (const char* name) = 0;

  virtual iBillboardLayer* FindBillboardLayer (const char* name) const = 0;

  virtual void RemoveBillboardLayer (iBillboardLayer* layer) = 0;

  virtual size_t GetBillboardLayerCount () const = 0;

  virtual iBillboardLayer* GetBillboardLayer (size_t idx) const = 0;

  virtual void RemoveAll () = 0;

  virtual void SetFlags (uint32 flags, uint32 mask) = 0;

  virtual void StackTop (iBillboard* bb) = 0;

  virtual void StackBottom (iBillboard* bb) = 0;

  virtual void StackUp (iBillboard* bb) = 0;

  virtual void StackDown (iBillboard* bb) = 0;

  virtual void StackBefore (iBillboard* bb, iBillboard* other) = 0;

  virtual void StackAfter (iBillboard* bb, iBillboard* other) = 0;

  virtual bool TestCollision (iBillboard* bb1, iBillboard* bb2) = 0;

  virtual bool SetDefaultTextFont (const char* fontname, float fontsize) = 0;

  virtual const char* GetDefaultTextFont () const = 0;

  virtual float GetDefaultTextFontSize () const = 0;

  virtual void SetDefaultTextFgColor (const csColor& color) = 0;

  virtual const csColor& GetDefaultTextFgColor () const = 0;

  virtual void SetDefaultTextBgColor (const csColor& color) = 0;

  virtual const csColor& GetDefaultTextBgColor () const = 0;

  virtual void SetDefaultTextBgTransparent () = 0;

  virtual iSector* GetShowroom () = 0;
};

#endif // __CEL_MGR_BILLBOARD__

---