text.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 *
 */

/*
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#ifndef SWORD25_TEXT_H
#define SWORD25_TEXT_H

#include "sword25/kernel/common.h"
#include "common/rect.h"
#include "sword25/gfx/renderobject.h"

namespace Sword25 {

class Kernel;
class FontResource;
class ResourceManager;

class Text : public RenderObject {
    friend class RenderObject;

public:
    bool setFont(const Common::String &font);

    void setText(const Common::String &text);

    void setAlpha(int alpha);

    void setAutoWrap(bool autoWrap);

    void setAutoWrapThreshold(uint32 autoWrapThreshold);

    const Common::String &getText() {
        return _text;
    }

    const Common::String &getFont() {
        return _font;
    }

    void setColor(uint32 modulationColor);

    int getAlpha() const {
        return _modulationColor >> BS_ASHIFT;
    }

    int getColor() const {
        return _modulationColor & BS_RGBMASK;
    }

    bool isAutoWrapActive() const {
        return _autoWrap;
    }

    uint32 getAutoWrapThreshold() const {
        return _autoWrapThreshold;
    }

    bool  persist(OutputPersistenceBlock &writer) override;
    bool  unpersist(InputPersistenceBlock &reader) override;

protected:
    bool doRender(RectangleList *updateRects) override;

private:
    Text(RenderObjectPtr<RenderObject> parentPtr);
    Text(InputPersistenceBlock &reader, RenderObjectPtr<RenderObject> parentPtr, uint handle);

    uint32 _modulationColor;
    Common::String _font;
    Common::String _text;
    bool _autoWrap;
    uint32 _autoWrapThreshold;

    struct Line {
        Common::Rect bbox;
        Common::String text;
    };

    Common::Array<Line> _lines;

    void updateFormat();
    void updateMetrics(FontResource &fontResource);
    ResourceManager *getResourceManager();
    FontResource *lockFontResource();
};

} // End of namespace Sword25

#endif