screen_item32.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 SCI_GRAPHICS_SCREEN_ITEM32_H
#define SCI_GRAPHICS_SCREEN_ITEM32_H

#include "common/rect.h"
#include "sci/graphics/celobj32.h"
#include "sci/graphics/lists32.h"

namespace Sci {

enum ScaleSignals32 {
    kScaleSignalNone           = 0,
    kScaleSignalManual         = 1,
    kScaleSignalVanishingPoint = 2
};

struct ScaleInfo {
    int x, y, max;
    ScaleSignals32 signal;
    ScaleInfo() : x(128), y(128), max(100), signal(kScaleSignalNone) {}
};

class CelObj;
class Plane;
class SegManager;

#pragma mark -
#pragma mark ScreenItem

class ScreenItem {
private:
    static uint16 _nextObjectId;

    static uint32 _nextCreationId;

public:
    reg_t _plane;

    ScaleInfo _scale;

private:
    Common::Rect _screenItemRect;

    bool _useInsetRect;

    Common::Rect _insetRect;

    int _z;

    void setFromObject(SegManager *segMan, const reg_t object, const bool updateCel, const bool updateBitmap);

public:
    uint32 _creationId;

    CelInfo32 _celInfo;

    mutable Common::ScopedPtr<CelObj> _celObj;

    bool _fixedPriority;

    int16 _priority;

    Common::Point _position;

    reg_t _object;

    GuiResourceId _pictureId;

    int _created, _updated, _deleted;

    bool _mirrorX;

    Ratio _ratioX, _ratioY;

    Common::Point _scaledPosition;

    Common::Rect _screenRect;

    bool _drawBlackLines;

    static void init();

    ScreenItem(const reg_t screenItem);
    ScreenItem(const reg_t plane, const CelInfo32 &celInfo);
    ScreenItem(const reg_t plane, const CelInfo32 &celInfo, const Common::Rect &rect);
    ScreenItem(const reg_t plane, const CelInfo32 &celInfo, const Common::Point &position, const ScaleInfo &scaleInfo);
    ScreenItem(const ScreenItem &other);
    void operator=(const ScreenItem &);

    inline bool operator<(const ScreenItem &other) const {
        if (_priority < other._priority) {
            return true;
        }

        if (_priority == other._priority) {
            if (_position.y + _z < other._position.y + other._z) {
                return true;
            }

            if (_position.y + _z == other._position.y + other._z) {
                // Synthetic object IDs (numeric IDs) are used for screen items
                // generated by the kernel, like the screen items generated by
                // plane pics. In SSCI, these synthetic IDs started at 20000 so
                // would deterministically always sort higher than any
                // script-generated view in SSCI at the same position and
                // priority.
                if (other._object.isNumber() && !_object.isNumber()) {
                    return true;
                }

                // SSCI's last resort comparison here is to compare the _object
                // IDs, but this is wrong and randomly breaks (at least):
                //
                // (1) the death dialog at the end of Phant1, where the ID of
                //     the text is often higher than the ID of the border;
                // (2) text-based buttons and dialogues in Hoyle5, where the ID
                //     of the text is often lower than the ID of the
                //     button/dialogue background.
                //
                // This occurs because object IDs (in both ScummVM and SSCI) are
                // reused, so objects created later may receive a lower ID,
                // which makes them sort lower when the programmer intended them
                // to sort higher.
                //
                // To fix this problem, we give each ScreenItem a monotonically
                // increasing insertion ID at construction time, and compare
                // these insertion IDs instead. They are more stable and cause
                // objects with identical priority and z-index to be rendered in
                // the order that they were created.
                //
                // This also applies to ScreenItem::hasPriorityAbove.
                return _creationId < other._creationId;
            }
        }

        return false;
    }

    inline bool operator>(const ScreenItem &other) const {
        if (_priority > other._priority) {
            return true;
        }

        if (_priority == other._priority) {
            if (_position.y + _z > other._position.y + other._z) {
                return true;
            }

            if (_position.y + _z == other._position.y + other._z) {
                if (_object.isNumber() && !other._object.isNumber()) {
                    return true;
                }

                // This is different than SSCI; see ScreenItem::operator< for an
                // explanation
                return _creationId > other._creationId;
            }
        }

        return false;
    }

    inline bool hasPriorityAbove(const ScreenItem &other) const {
        if (_priority > other._priority) {
            return true;
        }

        if (_priority == other._priority) {
            if (_object.isNumber() && !other._object.isNumber()) {
                return true;
            }

            // This is different than SSCI; see ScreenItem::operator< for an
            // explanation
            return _creationId > other._creationId;
        }

        return false;
    }

    void calcRects(const Plane &plane);

    CelObj &getCelObj() const;

    void printDebugInfo(Console *con) const;

    void update(const reg_t object);

    void update();

    Common::Rect getNowSeenRect(const Plane &plane) const;
};

#pragma mark -
#pragma mark ScreenItemList

typedef StablePointerArray<ScreenItem, 250> ScreenItemListBase;
class ScreenItemList : public ScreenItemListBase {
private:
    size_type _unsorted[250];

public:
    ScreenItem *findByObject(const reg_t object) const;
    void sort();
    void unsort();
};

} // End of namespace Sci

#endif // SCI_GRAPHICS_SCREEN_ITEM32_H