item.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 STARK_RESOURCES_ITEM_H
#define STARK_RESOURCES_ITEM_H

#include "engines/stark/resources/object.h"
#include "engines/stark/resourcereference.h"

#include "common/rect.h"
#include "common/str.h"

#include "math/vector3d.h"

namespace Stark {

class AnimHandler;
class Movement;
class Visual;

namespace Gfx {
class RenderEntry;
}

namespace Formats {
class XRCReadStream;
}

namespace Resources {

class Anim;
class AnimHierarchy;
class BonesMesh;
class Bookmark;
class ItemVisual;
class Script;
class TextureSet;

class Item : public Object {
public:
    static const Type::ResourceType TYPE = Type::kItem;

    enum SubType {
        kItemGlobalTemplate = 1,
        kItemInventory = 2,
        kItemLevelTemplate = 3,
        kItemStaticProp = 5,
        kItemAnimatedProp = 6,
        kItemBackgroundElement = 7,
        kItemBackground = 8,
        kItemModel = 10
    };

    static Object *construct(Object *parent, byte subType, uint16 index, const Common::String &name);

    Item(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~Item();

    // Resource API
    void readData(Formats::XRCReadStream *stream) override;
    void onGameLoop() override;
    void saveLoad(ResourceSerializer *serializer) override;
    void saveLoadCurrent(ResourceSerializer *serializer) override;

    bool isEnabled() const;

    virtual void setEnabled(bool enabled);

    int32 getCharacterIndex() const;

    virtual Gfx::RenderEntry *getRenderEntry(const Common::Point &positionOffset);

    virtual ItemVisual *getSceneInstance() = 0;

    void setMovement(Movement *movement);

    Movement *getMovement() const;

    void setMovementSuspendedScript(Script *script);

    virtual void setAnimHierarchy(AnimHierarchy *animHierarchy) = 0;

    virtual Common::Array<Common::Point> listExitPositions();

protected:
    void printData() override;

    bool _enabled;
    int32 _characterIndex;

    Movement *_movement;
    Script *_movementSuspendedScript;
};

class ItemVisual : public Item {
public:
    ItemVisual(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~ItemVisual();

    // Resource API
    void readData(Formats::XRCReadStream *stream) override;
    void onAllLoaded() override;
    void saveLoad(ResourceSerializer *serializer) override;
    void saveLoadCurrent(ResourceSerializer *serializer) override;

    // Item API
    void setEnabled(bool enabled) override;
    ItemVisual *getSceneInstance() override;
    void setAnimHierarchy(AnimHierarchy *animHierarchy) override;

    virtual void setPosition2D(const Common::Point &position);

    int getHotspotIndexForPoint(const Common::Point &point);

    Common::String getHotspotTitle(uint32 hotspotIndex);

    bool canPerformAction(uint32 action, uint32 hotspotIndex);

    bool doAction(uint32 action, uint32 hotspotIndex);

    void setAnimActivity(int32 activity);

    int32 getAnimActivity() const;

    Anim *getAnim() const;

    Anim *getActionAnim() const;

    void playActionAnim(Anim *anim);

    void resetActionAnim();

protected:
    // Resource API
    void printData() override;

    Common::Array<Common::Point> listExitPositionsImpl();

    Visual *getVisual();

    Gfx::RenderEntry *_renderEntry;

    Anim *_actionAnim;
    AnimHierarchy *_animHierarchy;
    int32 _currentAnimActivity;
    bool _clickable;
};

class ItemTemplate : public Item {
public:
    ItemTemplate(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~ItemTemplate();

    // Resource API
    void onAllLoaded() override;
    void onEnterLocation() override;
    void saveLoadCurrent(ResourceSerializer *serializer) override;

    // Item API
    ItemVisual *getSceneInstance() override;
    void setAnimHierarchy(AnimHierarchy *animHierarchy) override;

    virtual BonesMesh *findBonesMesh() = 0;

    virtual TextureSet *findTextureSet(uint32 textureType) = 0;

    virtual AnimHierarchy *findStockAnimHierarchy() = 0;

    void setStockAnimHierachy(AnimHierarchy *animHierarchy);

    void setBonesMesh(int32 index);

    void setTexture(int32 index, uint32 textureType);

    void setInstanciatedItem(Item *instance);

protected:
    int32 _meshIndex;
    int32 _textureNormalIndex;
    int32 _textureFaceIndex;
    int32 _animHierarchyIndex;

    Item *_instanciatedItem;
    ItemTemplate *_referencedItem;
};

class GlobalItemTemplate : public ItemTemplate {
public:
    GlobalItemTemplate(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~GlobalItemTemplate();

    // ItemTemplate API
    BonesMesh *findBonesMesh() override;
    TextureSet *findTextureSet(uint32 textureType) override;
    AnimHierarchy *findStockAnimHierarchy() override;

protected:
};

class InventoryItem : public ItemVisual {
public:
    InventoryItem(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~InventoryItem();

    // Item API
    Gfx::RenderEntry *getRenderEntry(const Common::Point &positionOffset) override;
    void setEnabled(bool enabled) override;

    Visual *getActionVisual(bool active) const;

    Visual *getCursorVisual() const;

protected:
};

class LevelItemTemplate : public ItemTemplate {
public:
    LevelItemTemplate(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~LevelItemTemplate();

    // Resource API
    void readData(Formats::XRCReadStream *stream) override;
    void onAllLoaded() override;

    // ItemTemplate API
    BonesMesh *findBonesMesh() override;
    TextureSet *findTextureSet(uint32 textureType) override;
    AnimHierarchy *findStockAnimHierarchy() override;

    ItemTemplate *getItemTemplate() const;

protected:
    void printData() override;

    ResourceReference _reference;
};

class FloorPositionedItem : public ItemVisual {
public:
    FloorPositionedItem(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~FloorPositionedItem();

    // Object API
    void saveLoad(ResourceSerializer *serializer) override;

    void placeOnBookmark(Bookmark *target);

    void placeDefaultPosition();

    Math::Vector3d getPosition3D() const;
    void setPosition3D(const Math::Vector3d &position);

    int32 getFloorFaceIndex() const;
    void setFloorFaceIndex(int32 faceIndex);

    Math::Vector3d getDirectionVector() const;

    void setDirection(const Math::Angle &direction);

    float getSortKey() const;

    void overrideSortKey(float sortKey);

protected:
    int32 _floorFaceIndex;
    Math::Vector3d _position3D;
    float _direction3D;

    bool _sortKeyOverride;
    float _sortKeyOverridenValue;
};

class FloorPositionedImageItem : public FloorPositionedItem {
public:
    FloorPositionedImageItem(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~FloorPositionedImageItem();

    // Resource API
    void readData(Formats::XRCReadStream *stream) override;

    // Item API
    Gfx::RenderEntry *getRenderEntry(const Common::Point &positionOffset) override;
    Common::Array<Common::Point> listExitPositions() override;

    // ItemVisual API
    void setPosition2D(const Common::Point &position) override;

protected:
    void printData() override;

    Common::Point _position;
};

class ModelItem : public FloorPositionedItem {
public:
    ModelItem(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~ModelItem();

    // Resource API
    void readData(Formats::XRCReadStream *stream) override;
    void onAllLoaded() override;
    void onEnterLocation() override;
    void onExitLocation() override;
    void saveLoadCurrent(ResourceSerializer *serializer) override;

    // Item API
    Gfx::RenderEntry *getRenderEntry(const Common::Point &positionOffset) override;

    void setTexture(int32 index, uint32 textureType);

    void setBonesMesh(int32 index);

    BonesMesh *findBonesMesh();

    TextureSet *findTextureSet(uint32 textureType);

    ItemTemplate *getItemTemplate() const;

    void updateAnim();

    void resetAnimationBlending();

    Anim *getIdleActionAnim() const;

    AnimHandler *getAnimHandler() const;

protected:
    void printData() override;

    int32 _meshIndex;
    int32 _textureNormalIndex;
    int32 _textureFaceIndex;

    ResourceReference _reference;
    ItemTemplate *_referencedItem;

    AnimHandler *_animHandler;
};

class ImageItem : public ItemVisual {
public:
    ImageItem(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~ImageItem();

    // Resource API
    void readData(Formats::XRCReadStream *stream) override;

    // Item API
    Gfx::RenderEntry *getRenderEntry(const Common::Point &positionOffset) override;
    Common::Array<Common::Point> listExitPositions() override;

    // ItemVisual API
    void setPosition2D(const Common::Point &position) override;

protected:
    void printData() override;

    ResourceReference _reference;
    Common::Point _position;
};

} // End of namespace Resources
} // End of namespace Stark

#endif // STARK_RESOURCES_ITEM_H