entitylabels.h

Go to the documentation of this file.

/*
 * entitylabels.h - Author: Ondrej Hurt
 *
 * Copyright (C) 2003 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation (version 2 of the License)
 * This program 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */



#ifndef ENTITYLABEL_HEADER
#define ENTITYLABEL_HEADER

// CS INCLUDES
#include <cstypes.h>
#include <csutil/ref.h>
#include <imesh/sprite2d.h>
#include <ivideo/fontserv.h>
#include <csutil/leakguard.h>

// PS INCLUDES
#include "pscelclient.h"
#include "util/genericevent.h"

struct iPluginManager;
struct iFont;
struct iEventQueue;
struct iEvent;

enum psEntityLabelVisib 
     { 
        LABEL_ALWAYS = 0,         
        LABEL_ONMOUSE,            
        LABEL_ONTARGET,           
        LABEL_NEVER               
     };
enum psEntityLabelType
    {
        ENTITY_DEFAULT=0,       
        ENTITY_PLAYER,          
        ENTITY_NPC,             
        ENTITY_DEAD,            
        ENTITY_GM1,             
        ENTITY_GM25,            
        ENTITY_TESTER,          
        ENTITY_DEV,             
        ENTITY_GROUP,           
        ENTITY_GUILD,           
        ENTITY_TYPES_AMOUNT     
    };

class psEntityLabels
{
public:
    psEntityLabels();
    virtual ~psEntityLabels();
    
    virtual void RemoveObject( GEMClientObject* object );
    
    // from iEventHandle:
    
    bool HandleEvent (iEvent &Event);
    

    bool Initialize(iObjectRegistry * object_reg, psCelClient * celClient);
    
    void Configure(psEntityLabelVisib visCreatures, psEntityLabelVisib visItems, bool showGuild, int* colors);
    
    void GetConfiguration(psEntityLabelVisib & visCreatures, psEntityLabelVisib & visItems, bool & showGuild, int* colors);
    
    bool LoadFromFile();
    
    bool SaveToFile();
    
    void OnObjectArrived( GEMClientObject* object );
    
    void RepaintAllLabels();
    void RepaintObjectLabel(GEMClientObject* object);
    
    void LoadAllEntityLabels();

protected:
    
    void UpdateVisibility();
    
    void UpdateMouseover();

    void UpdateTarget();
    
    typedef struct
    {
        csString text;
        int x, y;
        int width, height;
        int r,g,b; //addes by jacob to complete task
    } labelRow;
    
    void SetObjectText( GEMClientObject* object);

    void CreateLabelOfObject( GEMClientObject* object );

    void ShowLabelOfObject( GEMClientObject* object, bool show );
    
    void HideAllLabels();
    
    void RefreshGuildLabels();
    
    void DeleteLabelOfObject( GEMClientObject* object );
     
    
    bool MatchVisibility(GEMOBJECT_TYPE type, psEntityLabelVisib vis);
    psEntityLabelVisib visCreatures;
    psEntityLabelVisib visItems;
    bool showGuild;                    // should the label contain name of character's guild ?

    int entityColors[ENTITY_TYPES_AMOUNT];

    GEMClientObject * underMouse;

    GEMClientObject * underTarget;

    csRef<iEventQueue> eventQueue;
    iVFS* vfs;
    psCelClient* celClient;

    DeclareGenericEventHandler(EventHandler,psEntityLabels,"planeshift.entityevent");
    csRef<EventHandler> eventhandler;
};

#endif