dialog.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_NWN_GUI_INGAME_DIALOG_H
#define ENGINES_NWN_GUI_INGAME_DIALOG_H

#include <list>

#include "src/common/scopedptr.h"
#include "src/common/ptrlist.h"

#include "src/events/types.h"
#include "src/events/notifyable.h"

#include "src/graphics/types.h"
#include "src/graphics/guielement.h"

#include "src/graphics/aurora/fonthandle.h"

#include "src/engines/nwn/gui/gui.h"

namespace Common {
    class UString;
}

namespace Aurora {
    class DLGFile;
}

namespace Graphics {
    namespace Aurora {
        class Text;
    }
}

namespace Engines {

namespace NWN {

class Portrait;

class Object;
class Creature;

class Module;

// TODO: Scrollbars. Need to restructure/rewrite the scrollbar element/widget for that

class DialogBox : public Graphics::GUIElement {
public:
    DialogBox(float width, float height);
    ~DialogBox();

    void show(); 
    void hide(); 

    // Size and position

    float getWidth () const; 
    float getHeight() const; 

    void getPosition(float &x, float &y, float &z) const;

    void setPosition(float x, float y, float z);

    // Changing contents

    void clear();

    void setPortrait(const Common::UString &portrait);
    void setName(const Common::UString &name);

    void clearEntry();
    void setEntry(const Common::UString &entry);

    void clearReplies();
    void addReply(const Common::UString &reply, uint32 id);
    void finishReplies();

    // Events

    void mouseMove(int x, int y);
    void mouseClick(int x, int y);
    void pickReply(uint32 n);

    uint32 getPickedID() const;


    // Renderable
    void calculateDistance();
    void render(Graphics::RenderPass pass);

private:
    struct Reply {
        Common::UString reply;
        uint32 id;

        Reply(const Common::UString &r = "", uint32 i = 0xFFFFFFFF);
    };

    struct ReplyLine {
        Graphics::Aurora::Text *count;
        Graphics::Aurora::Text *line;

        std::list<Reply>::const_iterator reply;

        ReplyLine();
        ReplyLine(std::list<Reply>::const_iterator &i);
    };

    float _width;  
    float _height; 

    float _x; 
    float _y; 
    float _z; 

    Common::ScopedPtr<Portrait> _portrait;
    Common::ScopedPtr<Graphics::Aurora::Text> _name;

    Graphics::Aurora::FontHandle _font;

    Common::UString _entry;    
    std::list<Reply> _replies; 

    Common::PtrList<Graphics::Aurora::Text> _entryLines; 
    std::list<ReplyLine> _replyLines; 

    uint32 _replyCount;      
    float  _replyCountWidth; 

    std::list<ReplyLine>::iterator _highlightedReply; 
    std::list<Reply>::const_iterator _pickedReply;    


    void showEntry(); 
    void hideEntry(); 

    void showReplies(); 
    void hideReplies(); 

    bool isIn(float x, float y) const;

    void setHighlight(const std::list<ReplyLine>::iterator &h);
};

class Dialog : public Events::Notifyable {
public:
    Dialog(const Common::UString &conv, Creature &pc, Object &obj,
           Module &module, bool playHello = true);
    ~Dialog();

    bool hasEnded() const;

    void show(); 
    void hide(); 

    void abort(); 

    void addEvent(const Events::Event &event);
    int processEventQueue();

protected:
    void notifyResized(int oldWidth, int oldHeight, int newWidth, int newHeight);

private:
    Common::UString _conv; 

    Creature *_pc;     
    Object   *_object; 

    Module *_module; 

    Common::ScopedPtr<DialogBox> _dlgBox; 

    Common::ScopedPtr<Aurora::DLGFile> _dlg; 

    std::list<Events::Event> _eventQueue; 


    void updateBox(); 

    Object *getSpeaker(); 

    void playSound(bool greeting); 

    void playAnimation(); 
    void stopAnimation(); 

    void mouseMove();
    void mouseClick(const Events::Event &event);
    void keyPressed(const Events::Event &event);

    void checkPicked();
};

} // End of namespace NWN

} // End of namespace Engines

#endif // ENGINES_NWN_GUI_INGAME_DIALOG_H