hotspot_renderer.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/>.
 *
 */

#ifndef GRAPHICS_HOTSPOT_RENDERER_H
#define GRAPHICS_HOTSPOT_RENDERER_H

#include "common/array.h"
#include "common/rect.h"
#include "common/ustr.h"

namespace Graphics {

class Font;
struct Surface;
struct PixelFormat;

enum HotspotType {
    kHotspotDefault, 
    kHotspotObject,  
    kHotspotExit,    
    kHotspotNPC      
};

struct HotspotInfo {
    Common::Point position; 
    Common::U32String name; 
    HotspotType type;       

    HotspotInfo() : type(kHotspotDefault) {}
    HotspotInfo(const Common::Point &pos, const Common::U32String &n,
        HotspotType t = kHotspotDefault)
        : position(pos), name(n), type(t) {}
};

enum MarkerShape {
    kMarkerCrosshair,
    kMarkerSquare,
    kMarkerPoint
};

class HotspotRenderer {
public:
    HotspotRenderer();
    ~HotspotRenderer();

    void render(Surface *surface,
        const Common::Array<HotspotInfo> &hotspots,
        int gameWidth, int gameHeight,
        int overlayWidth, int overlayHeight,
        const PixelFormat &format,
        MarkerShape markerShape,
        bool showText);

private:
    enum {
        kBaseMarkerSize = 10,  
        kBasePointRadius = 3,  
        kBaseLineThickness = 1 
    };

    float _sizeScale;   
    int _markerSize;    
    int _pointRadius;   
    int _lineThickness; 

    void drawMarker(Surface *surface, int x, int y, const PixelFormat &format, MarkerShape markerShape);
    void drawCrosshairMarker(Surface *surface, int x, int y, int width, int height, const PixelFormat &format);
    void drawSquareMarker(Surface *surface, int x, int y, int width, int height, const PixelFormat &format);
    void drawPointMarker(Surface *surface, int x, int y, int width, int height, const PixelFormat &format);
    void drawHotspotLabel(Surface *surface, int overlayX, int overlayY, const Common::U32String &label,
        int overlayWidth, int overlayHeight, const PixelFormat &format, const Font *font);
    void drawLabelBox(Surface *surface, int x, int y, int w, int h,
        int overlayWidth, int overlayHeight, const PixelFormat &format);
    void drawRect(Surface *surface, int x, int y, int w, int h,
        int overlayWidth, int overlayHeight, const PixelFormat &format);

    void drawLine(Surface *surface, int x1, int y1, int x2, int y2,
        int width, int height, const PixelFormat &format, int lineThickness);

    void blendPixel(Surface *surface, int px, int py, const PixelFormat &format,
        int distance, int solidSize);
};

} // End of namespace Graphics

#endif // GRAPHICS_HOTSPOT_RENDERER_H